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

Minor clarification in rancher provider example config.yaml #7266

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

diegonayalazo
Copy link

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.:


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 :)
@k8s-ci-robot k8s-ci-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Sep 7, 2024
Copy link

linux-foundation-easycla bot commented Sep 7, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

@k8s-ci-robot
Copy link
Contributor

Welcome @diegonayalazo!

It looks like this is your first PR to kubernetes/autoscaler 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/autoscaler has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot
Copy link
Contributor

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 /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

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.

@k8s-ci-robot k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Sep 7, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: diegonayalazo
Once this PR has been reviewed and has the lgtm label, please assign x13n for approval. For more information see the Kubernetes Code Review Process.

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added area/cluster-autoscaler area/provider/rancher cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Sep 7, 2024
@Shubham82
Copy link
Contributor

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Sep 9, 2024
@Shubham82
Copy link
Contributor

cc @ctrox

Copy link
Contributor

@ctrox ctrox left a 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!

@Shubham82
Copy link
Contributor

@diegonayalazo, could you please update this PR, as per the @ctrox suggestions, so that we can review and merge this PR?

Thanks!

@diegonayalazo
Copy link
Author

Minor nits, but otherwise looks good to me. Thanks for improving the docs!

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)
Copy link
Contributor

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.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
# Make sure the URL does not contains this /v3 appended.
# Make sure the URL does not contain this /v3 appended.

Copy link
Contributor

@Shubham82 Shubham82 Oct 15, 2024

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

@Shubham82
Copy link
Contributor

@diegonayalazo, Please address the above comments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/cluster-autoscaler area/provider/rancher cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants