-
Notifications
You must be signed in to change notification settings - Fork 4k
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
Minor clarification in rancher provider example config.yaml #7266
base: master
Are you sure you want to change the base?
Minor clarification in rancher provider example config.yaml #7266
Conversation
Added clarification on the URL. I made the mistake of copying the API endpoint provided in the Rancher UI when you create a token. Of course, this wrong URL generated confusing errors that took me hours to understand. Wishing no one in the community loses this much time as me :)
Welcome @diegonayalazo! |
Hi @diegonayalazo. Thanks for your PR. I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: diegonayalazo The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
/ok-to-test |
cc @ctrox |
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.
Minor nits, but otherwise looks good to me. Thanks for improving the docs!
@diegonayalazo, could you please update this PR, as per the @ctrox suggestions, so that we can review and merge this PR? Thanks! |
Co-authored-by: Cyrill Troxler <cyrilltroxler@gmail.com>
Thanks for your suggestion @ctrox . @Shubham82 please let me know if anything else is required for me. Thanks as well for reaching out. |
# When you create a token in the Rancher UI, | ||
# it shows you the API endpoint, that is the Rancher URL with the /v3 appended at the end. | ||
# Make sure the URL does not contains this /v3 appended. | ||
# Rancher Base URL (Not API endpoint) |
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.
@diegonayalazo, It would be good if we could write the comment like this: (Rancher Base URL (Not API endpoint) should come first).
# Rancher Base URL (Not API endpoint)
# When you create a token in the Rancher UI,
# it shows you the API endpoint, that is the Rancher URL with the /v3 appended at the end.
# Make sure the URL does not contain this /v3 appended.
# rancher server credentials | ||
# When you create a token in the Rancher UI, | ||
# it shows you the API endpoint, that is the Rancher URL with the /v3 appended at the end. | ||
# Make sure the URL does not contains this /v3 appended. |
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.
# Make sure the URL does not contains this /v3 appended. | |
# Make sure the URL does not contain this /v3 appended. |
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.
small nit: It should be contain
not contains
@diegonayalazo, Please address the above comments. |
Added clarification on the URL. I made the mistake of copying the API endpoint provided in the Rancher UI when you create a token. Of course, this wrong URL generated confusing errors that took me hours to understand. Wishing no one in the community loses this much time as me :)
What type of PR is this?
/kind documentation
What this PR does / why we need it:
Minor clarification on the example config.yaml to avoid confusion.
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
Does this PR introduce a user-facing change?
Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.: