Skip to content

feat(tools): Add script to deploy local CCM with kops #877

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

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

Conversation

cowsking
Copy link

This commit introduces a new bash script, deploy-kops-gcp.sh, to automate the deployment of a Kubernetes cluster on GCP using kops, specifically configured to run a locally built version of the cloud-controller-manager.

This script streamlines the development and testing workflow by handling the entire process:

  • Building the cloud-controller-manager Docker image.
  • Pushing the image to the user's Google Container Registry (GCR).
  • Copying the default CCM manifest and using sed to replace the image with the newly built version.
  • Creating and updating a kops cluster with the ClusterAddons feature flag, injecting the custom manifest.

The script requires the GCP_PROJECT environment variable to be set. It includes a cleanup function to automatically delete the cluster upon completion, which can be disabled by setting DELETE_CLUSTER=false. This provides developers with a quick and repeatable way to test their changes on a real cluster.

This commit introduces a new bash script, `deploy-kops-gcp.sh`, to automate the deployment of a Kubernetes cluster on GCP using kops, specifically configured to run a locally built version of the cloud-controller-manager.

This script streamlines the development and testing workflow by handling the entire process:
- Building the cloud-controller-manager Docker image.
- Pushing the image to the user's Google Container Registry (GCR).
- Copying the default CCM manifest and using `sed` to replace the image with the newly built version.
- Creating and updating a kops cluster with the `ClusterAddons` feature flag, injecting the custom manifest.

The script requires the `GCP_PROJECT` environment variable to be set. It includes a cleanup function to automatically delete the cluster upon completion, which can be disabled by setting `DELETE_CLUSTER=false`. This provides developers with a quick and repeatable way to test their changes on a real cluster.
Copy link

linux-foundation-easycla bot commented Jun 27, 2025

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 Jun 27, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: cowsking
Once this PR has been reviewed and has the lgtm label, please assign jprzychodzen for approval. For more information see the 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 the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Jun 27, 2025
@k8s-ci-robot k8s-ci-robot requested review from justinsb and seans3 June 27, 2025 22:23
@k8s-ci-robot
Copy link
Contributor

This issue is currently awaiting triage.

If the repository mantainers determine this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

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

Welcome @cowsking!

It looks like this is your first PR to kubernetes/cloud-provider-gcp 🎉. 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/cloud-provider-gcp 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 k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jun 27, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @cowsking. 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 the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jun 27, 2025
if [[ -z "${CLUSTER_NAME:-}" ]]; then
CLUSTER_NAME="${SCRIPT_NAME}.k8s.local"
fi
echo "CLUSTER_NAME=${CLUSTER_NAME}"
Copy link
Member

Choose a reason for hiding this comment

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

Personally I would rather we just required the cluster name rather than defaulting to the script name. Willing to be over ruled on this though.


if [[ -z "${GCP_PROJECT:-}" ]]; then
echo "GCP_PROJECT must be set"
exit 1
Copy link
Member

Choose a reason for hiding this comment

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

Can we move the requirements checks closer to the beginning? Seems like we should do this first, then start taking actions.

@cheftako
Copy link
Member

/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 Jun 27, 2025
@aojea
Copy link
Member

aojea commented Jun 27, 2025

just FYI there is already a job that test this ccm with kops https://github.com/kubernetes/cloud-provider-gcp/blob/master/e2e/scenarios/kops-simple

cc: @justinsb

@cowsking
Copy link
Author

just FYI there is already a job that test this ccm with kops https://github.com/kubernetes/cloud-provider-gcp/blob/master/e2e/scenarios/kops-simple

cc: @justinsb

You're right that e2e/scenarios/kops-simple handles the automated testing. This script serves a different purpose as a direct response to developer requests for a simpler, kubetest2-free way to quickly stand up a kops cluster for local manual testing and debugging. Let me know how you think @cheftako @aojea @justinsb

@k8s-ci-robot k8s-ci-robot added 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 Jun 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants