@cloud-copilot/iam-collect 0.1.59 → 0.1.60
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -16,12 +16,12 @@ Get every possible policy in any set of AWS accounts. This is built to run out o
|
|
|
16
16
|
8. [Indexing](docs/Indexing.md)
|
|
17
17
|
9. [CLI](docs/CLI.md)
|
|
18
18
|
10. [History](docs/History.md)
|
|
19
|
-
11. [Supported Services and Data
|
|
19
|
+
11. [Supported Services and Data](#supported-services-and-data)
|
|
20
20
|
|
|
21
21
|
## iam-collect Tenets
|
|
22
22
|
|
|
23
23
|
1. _Centralized_ Store [all your data](#supported-services-and-data-downloaded) across all partitions, organizations, accounts, and regions in one place. This is a single source of truth for all your IAM data.
|
|
24
|
-
2. _Easy_ A few commands and you can get started and everything should just work. If resources no longer exist, data is cleaned up automatically
|
|
24
|
+
2. _Easy_ A few commands and you can get started and everything should just work. If resources no longer exist, data is cleaned up automatically.
|
|
25
25
|
3. _Configurable_ Store your data on [disk or in S3](docs/Storage.md). You can configure exactly what [accounts, regions, and services](docs/Filtering.md) you want to collect data for; and [customize auth](docs/Authentication.md) for each.
|
|
26
26
|
|
|
27
27
|
## Introduction
|
|
@@ -70,8 +70,6 @@ npm install -g @cloud-copilot/iam-collect
|
|
|
70
70
|
|
|
71
71
|
### Initialize
|
|
72
72
|
|
|
73
|
-
First you need to initialize the configuration file. This will create a commented iam-collect.jsonc file with comments for the different elements.
|
|
74
|
-
|
|
75
73
|
```bash
|
|
76
74
|
iam-collect init
|
|
77
75
|
```
|
|
@@ -84,7 +82,7 @@ This will create a file called `iam-collect.jsonc` in the current directory with
|
|
|
84
82
|
iam-collect download
|
|
85
83
|
```
|
|
86
84
|
|
|
87
|
-
This will download the IAM data from the current account to the `./iam-data` directory. You can change the output directory by modifying the `path` property in the
|
|
85
|
+
This will download the IAM data from the current account to the `./iam-data` directory. You can change the output directory by modifying the `storage.path` property in the configuration. See the [storage docs](docs/Storage.md) for more details.
|
|
88
86
|
|
|
89
87
|
### Enjoy
|
|
90
88
|
|
|
@@ -92,7 +90,7 @@ This will download the IAM data from the current account to the `./iam-data` dir
|
|
|
92
90
|
ls -R ./iam-data
|
|
93
91
|
```
|
|
94
92
|
|
|
95
|
-
This will show you your data that was downloaded. See the [storage docs](docs/Storage.md#
|
|
93
|
+
This will show you your data that was downloaded. See the [storage docs](docs/Storage.md#storage-layout-explained) for more details on the layout of the data.
|
|
96
94
|
|
|
97
95
|
## Additional Docs
|
|
98
96
|
|
|
@@ -104,7 +102,7 @@ This will show you your data that was downloaded. See the [storage docs](docs/St
|
|
|
104
102
|
- [CLI](docs/CLI.md) - Details on the CLI commands and options.
|
|
105
103
|
- [History](docs/History.md) - How to track history of changes.
|
|
106
104
|
|
|
107
|
-
## Supported Services and Data
|
|
105
|
+
## Supported Services and Data
|
|
108
106
|
|
|
109
107
|
| Service | Resource Type | Data Downloaded |
|
|
110
108
|
| ----------------- | --------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
|