{"id":30339840,"url":"https://github.com/wearetechnative/cloudia-reader-aws","last_synced_at":"2026-03-06T05:33:59.307Z","repository":{"id":285745002,"uuid":"959120264","full_name":"wearetechnative/cloudia-reader-aws","owner":"wearetechnative","description":"A Cloud Infrastructure Abstraction service which reads Clouds and writes Diagrams.","archived":false,"fork":false,"pushed_at":"2025-05-31T12:16:33.000Z","size":13475,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-01T00:41:09.900Z","etag":null,"topics":["aws"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wearetechnative.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-04-02T09:50:27.000Z","updated_at":"2025-05-31T12:16:36.000Z","dependencies_parsed_at":"2025-06-01T00:41:39.094Z","dependency_job_id":"cb9566b4-fe3a-41d0-a4ae-6cdfc13c3afd","html_url":"https://github.com/wearetechnative/cloudia-reader-aws","commit_stats":null,"previous_names":["wearetechnative/cloudia","wearetechnative/cloudia-reader-aws"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/wearetechnative/cloudia-reader-aws","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wearetechnative%2Fcloudia-reader-aws","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wearetechnative%2Fcloudia-reader-aws/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wearetechnative%2Fcloudia-reader-aws/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wearetechnative%2Fcloudia-reader-aws/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wearetechnative","download_url":"https://codeload.github.com/wearetechnative/cloudia-reader-aws/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wearetechnative%2Fcloudia-reader-aws/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270961795,"owners_count":24675916,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-18T02:00:08.743Z","response_time":89,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws"],"created_at":"2025-08-18T07:32:31.795Z","updated_at":"2026-03-06T05:33:59.219Z","avatar_url":"https://github.com/wearetechnative.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Cloudia AWS Reader\n\nCloudia-aws-reader is part of the cloudia project.\n\n**WARNING WIP** application and documentation will change.\n\n## Usage\n\nFirst read general [Setup](#setup) documentation.\n\n### nix develop\n\nOpen the development shell.\n\n```bash\nnix develop github:wearetechnative/cloudia\n```\n\nYou can now run `./cloudia-aws-reader [command]` e.g. `./cloudia-aws-reader collect`\n\n## Supported commands\n\nNot all commands are working because not all python modules are backported.\nThese commands has been tested to function correctly.\n\n- collect\n- configure\n- cytoscape_generate\n- cytoscape_serve\n- sync_data\n\n# Commands\n\n- `collect`: Collect metadata about an account. More details\n  [here](https://summitroute.com/blog/2018/06/05/cloudmapper_collect/).\n- `cytoscape_generate`/`webserver`: See [CloudMapper Writer](docs/cloudmapper/README.md)\n\nIf you want to add your own private commands, you can create a\n`private_commands` directory and add them there.\n\n# Screenshot or CloudMapper Writer Plugin\n\n![](docs/cloudmapper/images/ideal_layout.png)\n\n# Installation\n\n- [Install on Linux or macOS](docs/install.md)\n\n## Run with demo data\n\nA small set of demo data is provided.  This will display the same environment\nas the demo site https://duo-labs.github.io/cloudmapper/ \n\n```\n# Generate the data for the network map\npython cloudia.py cytoscape_generate --config config.json.demo --account demo\npython cloudia.py webserver\n```\n\nThis will run a local webserver at http://127.0.0.1:8000/\nView the network map from that link, or view the report at\nhttp://127.0.0.1:8000/account-data/report.html\n\n# Setup\n\n1. Configure information about your account.\n2. Collect information about an AWS account.\n\n## 1. Configure your account\n\nCopy the `config.json.demo` to `config.json` and edit it to include your\naccount ID and name (ex. \"prod\"), along with any external CIDR names. A CIDR is\nan IP range such as `1.2.3.4/32` which means only the IP `1.2.3.4`.\n\n## 2. Collect data about the account\n\nThis step uses the CLI to make `describe` and `list` calls and records the json\nin the folder specified by the account name under `account-data`.\n\n### AWS Privileges required\n\nYou must have AWS credentials configured that can be used by the CLI with read\npermissions for the different metadata to collect.  I recommend using\n[aws-vault](https://github.com/99designs/aws-vault).  Cloudia will collect\nIAM information, which means you MUST use MFA.  Only the `collect` step\nrequires AWS access.\n\nYou must have the following privileges (these grant various read access of\nmetadata):\n\n- `arn:aws:iam::aws:policy/SecurityAudit`\n- `arn:aws:iam::aws:policy/job-function/ViewOnlyAccess`\n\n### Collect the data\n\nCollecting the data is done as follows:\n\n```\npython cloudia.py collect --account my_account\n```\n\n## Create the Cytoscape Diagram \nFrom here, try running the different commands, such as:\n\n```\npython cloudia.py cytoscape_generate --account my_account\npython cloudia.py webserver\n```\n\nThen view the report in your browser at http://127.0.0.1:8000/account-data/report.html\n\n## Further configuration\n\n### Generating a config file\n\nInstead of modifying `config.json` directly, there is a command to configure\nthe data there, in case that is needed:\n\n```\npython cloudia.py configure {add-account|remove-account} --config-file CONFIG_FILE --name NAME --id ID [--default DEFAULT]\npython cloudia.py configure {add-cidr|remove-cidr} --config-file CONFIG_FILE --cidr CIDR --name NAME\n```\n\nThis will allow you to define the different AWS accounts you use in your\nenvironment and the known CIDR IPs.\n\nIf you use [AWS Organizations](https://aws.amazon.com/organizations/), you can\nalso automatically add organization member accounts to `config.json` using:\n\n```\npython cloudia.py configure discover-organization-accounts\n```\n\nYou need to be authenticated to the AWS CLI and have the permission\n`organization:ListAccounts` prior to running this command.\n\n## Credits\n\nCurrently Cloudia AWS Reader is just a fork of CloudMapper. The ambition of the\nCloudia project is to serve as man in the middle between Cloud Platforms and\nDiagram authoring applications.\n\nStar us and keep following the project. If you just want a working version of\nCloudMapper, have a look at our [cloudmapper-flake-fork](https://github.com/wearetechnative/cloudmapper-flake).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwearetechnative%2Fcloudia-reader-aws","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwearetechnative%2Fcloudia-reader-aws","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwearetechnative%2Fcloudia-reader-aws/lists"}