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

doc(gce): Update manual MIG specification URL #7590

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

whisperity
Copy link

What type of PR is this?

/kind documentation

What this PR does / why we need it:

The documentation can not be applied cleanly and results in errors, the code claims to expect …/instanceGroups/ in the URL but the documentation specifies …/instanceGroupManagers/:

I1211 11:40:11.612854       1 gce_manager.go:176] GCE projectId=foobar-... location=europe-...
F1211 11:40:11.613108       1 gce_cloud_provider.go:388] Failed to create GCE Manager:
  failed to fetch MIGs:
  failed to parse mig URL:
    https://content.googleapis.com/compute/v1/projects/foobar-.../zones/europe-.../instanceGroupManagers/kubernetes-...
  got error: wrong URL:
    expected format https://.*/projects/<project-id>/zones/<zone>/instanceGroups/<name>,
    got https://content.googleapis.com/compute/v1/projects/foobar-.../zones/europe-.../instanceGroupManagers/kubernetes-...

Which issue(s) this PR fixes:

No corresponding issue.

Special notes for your reviewer:

Does this PR introduce a user-facing change?

NONE

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:


@k8s-ci-robot k8s-ci-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Dec 11, 2024
Copy link

linux-foundation-easycla bot commented Dec 11, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Dec 11, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: whisperity
Once this PR has been reviewed and has the lgtm label, please assign gjtempleton 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
Copy link
Contributor

Welcome @whisperity!

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 @whisperity. 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 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. 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 Dec 11, 2024
@Shubham82
Copy link
Contributor

Hi @whisperity, Please address the failed Test Cases, i.e. Lint and Test Charts / Helm chart (pull_request) and Lint and Test Charts / Helm Docs (pull_request), which are required to be passed.

@Shubham82
Copy link
Contributor

The Lint and Test Charts / Helm chart (pull_request) test case failed because no bump version was performed.
Below is the error message:

✖︎ cluster-autoscaler => (version: "9.43.2", path: "charts/cluster-autoscaler") > Chart version not ok. Needs a version bump!

So you need to bump the chart version to 9.43.3 (as per current chart version)

@Shubham82
Copy link
Contributor

The Lint and Test Charts / Helm Docs (pull_request) test case failed because you directly made the changes in the README.md file, we use Pre-commit hooks to update README.md file.

So The README.md is generated by helm-docs from the README.md.gotmpl file, So if you want to make changes to the README.md file other than those in the values.yaml file, you need to make changes in the README.md.gotmpl file.

@whisperity
Copy link
Author

The Lint and Test Charts / Helm chart (pull_request) test case failed because no bump version was performed. Below is the error message:

✖︎ cluster-autoscaler => (version: "9.43.2", path: "charts/cluster-autoscaler") > Chart version not ok. Needs a version bump!

So you need to bump the chart version to 9.43.3 (as per current chart version)

This looks like a false positive, because I am only touching the documentation. Or is the README.md also versioned? They usually are not part of the "distribution", this is the first time I am encountering such an issue.

So The README.md is generated by helm-docs from the README.md.gotmpl file, So if you want to make changes to the README.md file other than those in the values.yaml file, you need to make changes in the README.md.gotmpl file.

Will do this tomorrow!

@Shubham82
Copy link
Contributor

This looks like a false positive, because I am only touching the documentation. Or is the README.md also versioned? They usually are not part of the "distribution", this is the first time I am encountering such an issue.

@whisperity, we have to update the helm charts version whenever we make changes in the Charts.
Also, we use automated tooling to build and publish the releases of the helm chart, here is the workflow link:

https://github.com/kubernetes/autoscaler/blob/master/.github/workflows/release.yaml#L4-L29

@Shubham82
Copy link
Contributor

@jackfrancis, can we add this PR to the Dashboard that you created for tracking helm chart PR, so we can avoid merge conflict errors (due to chart version) on this PR?

putting this PR on hold till then.

/hold

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Dec 11, 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 Dec 11, 2024
@whisperity whisperity force-pushed the fix/doc-gce/autoscalergroup-url branch from 761f75a to bdcb977 Compare December 13, 2024 08:12
@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Dec 29, 2024
@k8s-ci-robot
Copy link
Contributor

PR needs rebase.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/helm-charts cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. kind/documentation Categorizes issue or PR as related to documentation. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. 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.

3 participants