-
Notifications
You must be signed in to change notification settings - Fork 40
fix(docs): Update documentation about adding new resources #1136
fix(docs): Update documentation about adding new resources #1136
Conversation
export AWS_ACCESS_KEY_ID={Your AWS Access Key ID} | ||
export AWS_SECRET_ACCESS_KEY={Your AWS secret access key} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would say it is better to set the AWS_PROFILE
environment variable. That way credentials can be managed in the ~/.aws/config
and can use any of credential sources like AWS_SSO, credential_process or worst case scenario hard coded credentials
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fair enough! I think AWS_SECRET_ACCESS_KEY
is probably the easiest way to get started quickly, so it's worth mentioning we support that too. I've changed it now to recommend AWS_PROFILE
, but mention that we support other methods in a comment. WDYT?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree that we cannot not support hard coded credentials! I think that we should be helping/pushing users to follow the best practices. I like that idea of putting the link to the docs! Here is a good article about this
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can just link to this one - https://hub.cloudquery.io/providers/cloudquery/aws/latest#authentication
This will also serve as nice cross link to our docs
Looks like the unit tests are failing for some unrelated reason:
@yevgenypats or @bbernays do you happen to know something about this? Otherwise I can investigate |
I have never seen this occur before. Maybe it is just the go-faker that randomly set a value to If we re-run the check does it pass? |
🤖 I have created a release *beep* *boop* --- ## [0.12.25](v0.12.24...v0.12.25) (2022-07-04) ### Bug Fixes * **deps:** Update github.com/gocarina/gocsv digest to 72f2e84 ([#1151](#1151)) ([1c870e8](1c870e8)) * **deps:** Update module github.com/aws/aws-sdk-go-v2 to v1.16.6 ([#1152](#1152)) ([4ac2583](4ac2583)) * **deps:** Update module github.com/aws/aws-sdk-go-v2/service/accessanalyzer to v1.15.7 ([#1153](#1153)) ([9ed2343](9ed2343)) * **deps:** Update module github.com/aws/aws-sdk-go-v2/service/codepipeline to v1.13.7 ([#1154](#1154)) ([0a34f8e](0a34f8e)) * **deps:** Update module github.com/cloudquery/cq-provider-sdk to v0.13.3 ([#1156](#1156)) ([d4b0701](d4b0701)) * **docs:** Update documentation about adding new resources ([#1136](#1136)) ([fe5a5ad](fe5a5ad)) * **tests:** Update Lightsail terraform for Integration testing of Instances ([#1137](#1137)) ([488a003](488a003)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
🤖 I have created a release *beep* *boop* --- ## [0.12.25](cloudquery/cq-provider-aws@v0.12.24...v0.12.25) (2022-07-04) ### Bug Fixes * **deps:** Update github.com/gocarina/gocsv digest to 72f2e84 ([#1151](cloudquery/cq-provider-aws#1151)) ([1c870e8](cloudquery/cq-provider-aws@1c870e8)) * **deps:** Update module github.com/aws/aws-sdk-go-v2 to v1.16.6 ([#1152](cloudquery/cq-provider-aws#1152)) ([4ac2583](cloudquery/cq-provider-aws@4ac2583)) * **deps:** Update module github.com/aws/aws-sdk-go-v2/service/accessanalyzer to v1.15.7 ([#1153](cloudquery/cq-provider-aws#1153)) ([9ed2343](cloudquery/cq-provider-aws@9ed2343)) * **deps:** Update module github.com/aws/aws-sdk-go-v2/service/codepipeline to v1.13.7 ([#1154](cloudquery/cq-provider-aws#1154)) ([0a34f8e](cloudquery/cq-provider-aws@0a34f8e)) * **deps:** Update module github.com/cloudquery/cq-provider-sdk to v0.13.3 ([#1156](cloudquery/cq-provider-aws#1156)) ([d4b0701](cloudquery/cq-provider-aws@d4b0701)) * **docs:** Update documentation about adding new resources ([#1136](cloudquery/cq-provider-aws#1136)) ([fe5a5ad](cloudquery/cq-provider-aws@fe5a5ad)) * **tests:** Update Lightsail terraform for Integration testing of Instances ([#1137](cloudquery/cq-provider-aws#1137)) ([488a003](cloudquery/cq-provider-aws@488a003)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
Some small fixes and updates to
adding_a_new_resource.md
for correctness.