Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix auth secretRef in API docs #2077

Merged
merged 1 commit into from
Mar 2, 2023
Merged

Conversation

mubarak-j
Copy link
Contributor

Problem Statement

The API docs reference accessKeyID and secretAccessKey but looking at SecretStore CRD, it seems the correct field names should be accessKeyIDSecretRef and accessKeySecretSecretRef respectively.

Related Issue

Faced this validation error when using the example in API docs

error: error validating "secretstore.yaml": error validating data: [ValidationError(SecretStore.spec.provider.aws.auth.secretRef): unknown field "accessKeyID" in io.external-secrets.v1beta1.SecretStore.spec.provider.aws.auth.secretRef, ValidationError(SecretStore.spec.provider.aws.auth.secretRef): unknown field "secretAccessKey" in io.external-secrets.v1beta1.SecretStore.spec.provider.aws.auth.secretRef]; if you choose to ignore these errors, turn validation off with --validate=false

Proposed Changes

How do you like to solve the issue and why?

Checklist

  • I have read the contribution guidelines
  • All commits are signed with git commit --signoff
  • My changes have reasonable test coverage
  • All tests pass with make test
  • I ensured my PR is ready for review with make reviewable

Signed-off-by: Mubarak Jama <83465122+mubarak-j@users.noreply.github.com>
@mubarak-j mubarak-j requested a review from a team as a code owner March 1, 2023 18:17
@mubarak-j mubarak-j requested review from moolen and removed request for a team March 1, 2023 18:17
Copy link
Contributor

@paul-the-alien paul-the-alien bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Greetings!
Thank you for contributing to this project!
If this is your first time contributing, please make
sure to read the Developer and Contributing Process guides.
Please also mind and follow our Code of Conduct.

Useful commands:

  • make fmt: Formats the code
  • make check-diff: Ensures the branch is clean
  • make reviewable: Ensures a PR is ready for review

@sonarcloud
Copy link

sonarcloud bot commented Mar 1, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

Copy link
Member

@moolen moolen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for fixing this 🏅 ! i've stumbled over this a couple of times, too! Never took the time to fix it 😅

Much appreciated!

@moolen moolen merged commit 043db7e into external-secrets:main Mar 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants