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

Update user example README to better explain the credentials woraround #589

Merged

Conversation

DanielePalaia
Copy link
Contributor

This closes #571

Note to reviewers: remember to look at the commits in this PR and consider if they can be squashed
Note to contributors: remember to re-generate client set if there are any API changes

Summary Of Changes

Small modification on the User controller README example to better explain the workaround as described in #571

Additional Context

Copy link
Member

@MirahImage MirahImage left a comment

Choose a reason for hiding this comment

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

The User controller will generate a new secret from the provided secret named by appending the suffix -user-credentials to the username. For example, if your User is named user-test the controller will generate a secret user-test-user-credentials.
If you wish to update User credentials, you can update the secret generated by the controller and then add a label or annotation to the User object to trigger a reconcile loop.

@DanielePalaia DanielePalaia force-pushed the update_user_controller_example_description_readme branch from 0e598dc to 5d2830f Compare April 3, 2023 12:35
Copy link
Member

@MirahImage MirahImage left a comment

Choose a reason for hiding this comment

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

-user-credentials, user-test, and user-test-user-credentials should all be markdown code snippets (using backtick).

@DanielePalaia DanielePalaia force-pushed the update_user_controller_example_description_readme branch from 5d2830f to c82064a Compare April 3, 2023 13:15
@DanielePalaia
Copy link
Contributor Author

Thank you @MirahImage

@DanielePalaia DanielePalaia merged commit e5fc135 into main Apr 3, 2023
@DanielePalaia DanielePalaia deleted the update_user_controller_example_description_readme branch April 3, 2023 14:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update user credentials does not work
3 participants