Skip to content

docs: refresh CLI examples and manifests for kOps 1.37 - #18754

Merged
kubernetes-prow[bot] merged 1 commit into
kubernetes:masterfrom
rifelpet:docs-refresh-examples
Aug 27, 2026
Merged

docs: refresh CLI examples and manifests for kOps 1.37#18754
kubernetes-prow[bot] merged 1 commit into
kubernetes:masterfrom
rifelpet:docs-refresh-examples

Conversation

@rifelpet

Copy link
Copy Markdown
Member

Every YAML example under docs/ was strict-decoded through the kOps API scheme, and every documented kops command was checked against the 1.37 flag set. That surfaced a number of examples that current kOps would reject outright.

Examples that would be rejected today

  • networking.kubeRouter and calico.IPIPMode do not match the JSON tags in the API types — they are kuberouter and ipipMode.
  • clusterAutoscaler.scaleDownUtilizationThreshold and a kubeAPIServer env value were unquoted numbers, but both fields are strings.
  • An InstanceGroup in the Spot Ocean docs had its spec nested under metadata.
  • iam_roles.md used the long-removed zones field instead of subnets.
  • The GPU taint was shown as a Kubernetes taint object, but the kOps taints field takes strings; the value kOps actually sets is nvidia.com/gpu:NoSchedule.
  • A missing line continuation split the GCE kops create cluster command.

Renamed flags

--master-zones, --master-size, --master-count, --master-volume-size and --master-interval moved to --control-plane-*, and --vpc is now --network-id. kops toolbox instance-selector takes the instance group name as a positional argument.

Removed features

Dropped the containerRuntime and spec.docker sections — validation now rejects containerRuntime: docker outright, and docker.service in the hooks example became containerd.service.

Stale versions and images

Kubernetes 1.36.4 (latest recommended in channels/stable), containerd 2.3.4, and Ubuntu 24.04 in place of focal, CoreOS, kope.io and debian-9 references. The exported manifest in manifests_and_customizing_via_api.md was regenerated with kops create cluster --dry-run -o yaml rather than hand-edited.

Worth a look during review

  • images.md — I removed the "Ubuntu 20.04 (Focal)" and "Debian 10 (Buster)" sections. Both were removed in kOps 1.36 and were the only removed distros still listed under "Supported Distros". This leaves a dead fragment in an old release note (the page still resolves, just not the anchor). Happy to drop this hunk if you'd rather keep them.
  • coreos-kops-tests-multimaster.md — only the flags were fixed. The doc is an end-to-end CoreOS tutorial and CoreOS was removed in kOps 1.18, so the AMI IDs and coreos.com URLs are all dead. It probably wants deleting or rewriting against a supported distro, which felt out of scope here.

Examples stay on the v1alpha2 apiVersion, which is what kOps writes today.

59 YAML blocks still do not strict-decode; each was checked by hand and they are intentional ... elisions, Go templates in cluster_template.md, non-kOps manifests, and shell transcripts.

🤖 Generated with Claude Code

https://claude.ai/code/session_01UwhWXUuoWwsv9WSzGAkanj

Every YAML example under docs/ was strict-decoded through the kOps API
scheme, and every documented kops command was checked against the 1.37
flag set.

Fix examples that current kOps would reject:

* networking.kubeRouter and calico.IPIPMode do not match the JSON tags
  in the API types; they are kuberouter and ipipMode
* clusterAutoscaler.scaleDownUtilizationThreshold and a kubeAPIServer
  env value were unquoted numbers, but both fields are strings
* an InstanceGroup in the Spot Ocean docs had its spec nested under
  metadata
* iam_roles used the long-removed zones field instead of subnets
* the GPU taint was shown as a Kubernetes taint object, but the kOps
  taints field takes strings
* a missing line continuation split the GCE create cluster command

Rename the flags that moved to control-plane naming (--master-zones,
--master-size, --master-count, --master-volume-size, --master-interval)
and --vpc, which is now --network-id. kops toolbox instance-selector
takes the instance group name as a positional argument.

Drop the containerRuntime and spec.docker sections, as validation now
rejects containerRuntime: docker outright.

Refresh stale versions and images: Kubernetes 1.36.4, containerd 2.3.4,
and Ubuntu 24.04 in place of focal, CoreOS, kope.io and debian-9
references. The exported manifest in manifests_and_customizing_via_api
was regenerated with kops create cluster --dry-run -o yaml.

Remove the Ubuntu 20.04 and Debian 10 sections from the images doc.
Both distros were removed in kOps 1.36 and were the only removed
distros still listed under Supported Distros.

Examples stay on the v1alpha2 apiVersion, which is what kOps writes.
@kubernetes-prow kubernetes-prow Bot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Aug 27, 2026
@kubernetes-prow
kubernetes-prow Bot requested review from olemarkus and zetaab August 27, 2026 03:38
@hakman

hakman commented Aug 27, 2026

Copy link
Copy Markdown
Member

/override pull-kops-e2e-k8s-aws-calico

@kubernetes-prow

Copy link
Copy Markdown
Contributor

@hakman: Overrode contexts on behalf of hakman: pull-kops-e2e-k8s-aws-calico

Details

In response to this:

/override pull-kops-e2e-k8s-aws-calico

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.

@hakman

hakman commented Aug 27, 2026

Copy link
Copy Markdown
Member

/lgtm
/approve

@kubernetes-prow kubernetes-prow Bot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 27, 2026
@kubernetes-prow

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: hakman

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details 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

@kubernetes-prow kubernetes-prow Bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 27, 2026
@kubernetes-prow
kubernetes-prow Bot merged commit a3b404d into kubernetes:master Aug 27, 2026
26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. area/documentation cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. 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.

2 participants