Skip to content

🌱 Fixing broken links #12428

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

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGELOG/v1.6.0-beta.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
## Deprecation Warning

- The API version `v1alpha4` is no longer served in this release.
- [Version migration guide](https://main.cluster-api.sigs.k8s.io/developer/providers/version-migration.html)
- [Version migration guide](https://cluster-api.sigs.k8s.io/developer/providers/migrations/overview.html)
- [GitHub issue #8038](https://github.com/kubernetes-sigs/cluster-api/issues/8038)
- [API deprecation details](https://main.cluster-api.sigs.k8s.io/contributing#removal-of-v1alpha3--v1alpha4-apiversions)
- The API version `v1alpha3` has been completely removed in this release.
Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG/v1.6.0-beta.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
## Deprecation Warning

- The API version `v1alpha4` is no longer served in this release.
- [Version migration guide](https://main.cluster-api.sigs.k8s.io/developer/providers/version-migration.html)
- [Version migration guide](https://cluster-api.sigs.k8s.io/developer/providers/migrations/overview.html)
- [GitHub issue #8038](https://github.com/kubernetes-sigs/cluster-api/issues/8038)
- [API deprecation details](https://main.cluster-api.sigs.k8s.io/contributing#removal-of-v1alpha3--v1alpha4-apiversions)
- The API version `v1alpha3` has been completely removed in this release.
Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG/v1.6.0-rc.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
## Deprecation Warning

- The API version `v1alpha4` is no longer served in this release.
- [Version migration guide](https://main.cluster-api.sigs.k8s.io/developer/providers/version-migration.html)
- [Version migration guide](https://cluster-api.sigs.k8s.io/developer/providers/migrations/overview.html)
- [GitHub issue #8038](https://github.com/kubernetes-sigs/cluster-api/issues/8038)
- [API deprecation details](https://main.cluster-api.sigs.k8s.io/contributing#removal-of-v1alpha3--v1alpha4-apiversions)
- The API version `v1alpha3` has been completely removed in this release.
Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG/v1.6.0-rc.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
## Deprecation Warning

- The API version `v1alpha4` is no longer served in this release.
- [Version migration guide](https://main.cluster-api.sigs.k8s.io/developer/providers/version-migration.html)
- [Version migration guide](https://cluster-api.sigs.k8s.io/developer/providers/migrations/overview.html)
- [GitHub issue #8038](https://github.com/kubernetes-sigs/cluster-api/issues/8038)
- [API deprecation details](https://main.cluster-api.sigs.k8s.io/contributing#removal-of-v1alpha3--v1alpha4-apiversions)
- The API version `v1alpha3` has been completely removed in this release.
Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG/v1.6.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
## Deprecation Warning

- The API version `v1alpha4` is no longer served in this release.
- [Version migration guide](https://main.cluster-api.sigs.k8s.io/developer/providers/version-migration.html)
- [Version migration guide](https://cluster-api.sigs.k8s.io/developer/providers/migrations/overview.html)
- [GitHub issue #8038](https://github.com/kubernetes-sigs/cluster-api/issues/8038)
- [API deprecation details](https://main.cluster-api.sigs.k8s.io/contributing#removal-of-v1alpha3--v1alpha4-apiversions)
- The API version `v1alpha3` has been completely removed in this release.
Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG/v1.9.0-beta.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
- Improvements to status fields: (#11105)
- Proposal: [Improving status in CAPI resources](https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20240916-improve-status-in-CAPI-resources.md)
- Just a few highlights:
- Overhaul of our contract documentation: [Provider contracts](https://cluster-api.sigs.k8s.io/developer/providers/contracts)
- Overhaul of our contract documentation: [Provider contracts](https://cluster-api.sigs.k8s.io/developer/providers/contracts/overview)
- Implemented v1beta2 conditions for core Cluster API objects
- Huge improvements to `Deleting` conditions of Cluster, KCP, MD, MS and Machines
- Added `Available` conditions to Cluster, KCP and MD
Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG/v1.9.0-rc.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
- Improvements to status fields: (#11105)
- Proposal: [Improving status in CAPI resources](https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20240916-improve-status-in-CAPI-resources.md)
- Just a few highlights:
- Overhaul of our contract documentation: [Provider contracts](https://cluster-api.sigs.k8s.io/developer/providers/contracts)
- Overhaul of our contract documentation: [Provider contracts](https://cluster-api.sigs.k8s.io/developer/providers/contracts/overview)
- Implemented v1beta2 conditions for core Cluster API objects
- Huge improvements to `Deleting` conditions of Cluster, KCP, MD, MS and Machines
- Added `Available` conditions to Cluster, KCP and MD
Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG/v1.9.0-rc.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
- Improvements to status fields: (#11105)
- Proposal: [Improving status in CAPI resources](https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20240916-improve-status-in-CAPI-resources.md)
- Just a few highlights:
- Overhaul of our contract documentation: [Provider contracts](https://cluster-api.sigs.k8s.io/developer/providers/contracts)
- Overhaul of our contract documentation: [Provider contracts](https://cluster-api.sigs.k8s.io/developer/providers/contracts/overview)
- Implemented v1beta2 conditions for core Cluster API objects
- Huge improvements to `Deleting` conditions of Cluster, KCP, MD, MS and Machines
- Added `Available` conditions to Cluster, KCP and MD
Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG/v1.9.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
- Improvements to status fields: (#11105)
- Proposal: [Improving status in CAPI resources](https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20240916-improve-status-in-CAPI-resources.md)
- Just a few highlights:
- Overhaul of our contract documentation: [Provider contracts](https://cluster-api.sigs.k8s.io/developer/providers/contracts)
- Overhaul of our contract documentation: [Provider contracts](https://cluster-api.sigs.k8s.io/developer/providers/contracts/overview)
- Implemented v1beta2 conditions for core Cluster API objects
- Huge improvements to `Deleting` conditions of Cluster, KCP, MD, MS and Machines
- Added `Available` conditions to Cluster, KCP and MD
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ and instructions for signing it [can be found here](https://git.k8s.io/community
If you're new to the project and want to help, but don't know where to start, we have a semi-curated list of issues that
should not need deep knowledge of the system. [Have a look and see if anything sounds
interesting](https://github.com/kubernetes-sigs/cluster-api/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22).
Before starting to work on the issue, make sure that it doesn't have a [lifecycle/active](https://github.com/kubernetes-sigs/cluster-api/labels/lifecycle%2Factive) label. If the issue has been assigned, reach out to the assignee.
Before starting to work on the issue, make sure that it doesn't have a `lifecycle/active` label. If the issue has been assigned, reach out to the assignee.
Alternatively, read some docs on other controllers and try to write your own, file and fix any/all issues that
come up, including gaps in documentation!

Expand Down Expand Up @@ -375,7 +375,7 @@ breaking change might be a fix for a behavioral bug that was released in an init

## Dependency Licence Management

Cluster API follows the [license policy of the CNCF](https://github.com/cncf/foundation/blob/main/allowed-third-party-license-policy.md). This sets limits on which
Cluster API follows the [license policy of the CNCF](https://github.com/cncf/foundation/blob/main/policies-guidance/allowed-third-party-license-policy.md). This sets limits on which
licenses dependencies and other artifacts use. For go dependencies only dependencies listed in the `go.mod` are considered dependencies. This is in line with [how dependencies are reviewed in Kubernetes](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/vendor.md#reviewing-and-approving-dependency-changes).

## API conventions
Expand Down
28 changes: 14 additions & 14 deletions REVIEWING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,17 @@
IMPORTANT: improving and maintaining this document is a collaborative effort, so we are encouraging constructive
feedback and suggestions.

* [Code Review in Cluster API](#code-review-in-cluster-api)
* [Goal of this document](#goal-of-this-document)
* [Resources](#resources)
* [Definition](#definition)
* [Controller reentrancy](#controller-reentrancy)
* [API design](#api-design)
* [Serialization](#serialization)
* [Owner References](#owner-references)
* [The Cluster API contract](#the-cluster-api-contract)
* [Logging](#logging)
* [Testing](#testing)
- [Code Review in Cluster API](#code-review-in-cluster-api)
- [Goal of this document](#goal-of-this-document)
- [Resources](#resources)
- [Definition](#definition)
- [Controller reentrancy](#controller-reentrancy)
- [API design](#api-design)
- [Serialization](#serialization)
- [Owner References](#owner-references)
- [The Cluster API contract](#the-cluster-api-contract)
- [Logging](#logging)
- [Testing](#testing)

## Resources

Expand Down Expand Up @@ -100,7 +100,7 @@ impacts of any change that can impact this area. Above all:

The Cluster API rules define a set of rules/conventions the different provider authors should follow in
order to implement providers that can interact with the core Cluster API controllers, as
documented [here](https://cluster-api.sigs.k8s.io/developer/guide.html) and [here](https://cluster-api.sigs.k8s.io/clusterctl/provider-contract.html).
documented [here](https://cluster-api.sigs.k8s.io/developer/getting-started.html) and [here](https://cluster-api.sigs.k8s.io/developer/providers/contracts/overview.html).

By extension, the Cluster API contract includes all the util methods that Cluster API exposes for
making the development of providers simpler and consistent (e.g. everything under `/util` or in `/test/framework`);
Expand All @@ -123,12 +123,12 @@ This makes any change that can impact the Cluster API contract critical and usua
While developing controllers in Cluster API a key requirement is to add logging to observe the system and
to help troubleshooting issues.

- For CAPI controllers see [Cluster API logging conventions](https://cluster-api.sigs.k8s.io/developer/logging.html).
- For CAPI controllers see [Cluster API logging conventions](https://cluster-api.sigs.k8s.io/developer/core/logging.html).
- For clusterctl see [clusterctl logging conventions](https://github.com/kubernetes-sigs/cluster-api/blob/main/cmd/clusterctl/log/doc.go).

### Testing

Testing plays a crucial role in ensuring the long term maintainability of the project.

In Cluster API we are committed to have a good test coverage and also to have a nice and consistent style in implementing
tests. For more information see [testing Cluster API](https://cluster-api.sigs.k8s.io/developer/testing.html).
tests. For more information see [testing Cluster API](https://cluster-api.sigs.k8s.io/developer/core/testing.html).
2 changes: 1 addition & 1 deletion docs/book/src/developer/core/repository-layout.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ This is a place for defining errors returned by CAPI. Error types defined here c

[~/exp](https://github.com/kubernetes-sigs/cluster-api/tree/main/exp)

This folder contains experimental features of CAPI. Experimental features are unreliable until they are promoted to the main repository. Each experimental feature is supposed to be present in a subfolder of [~/exp](https://github.com/kubernetes-sigs/cluster-api/tree/main/exp) folder e.g. ClusterResourceSet is present inside [~/exp/addons](https://github.com/kubernetes-sigs/cluster-api/tree/main/exp/addons) folder. Historically, machine pool resources are not present in a sub-directory. Migrating them to a subfolder like `~/exp/machinepools` is still pending as it can potentially break existing users who are relying on existing folder structure.
This folder contains experimental features of CAPI. Experimental features are unreliable until they are promoted to the main repository. Each experimental feature is supposed to be present in a subfolder of [~/exp](https://github.com/kubernetes-sigs/cluster-api/tree/main/exp) folder e.g. ClusterResourceSet is present inside [~/exp/addons](https://github.com/kubernetes-sigs/cluster-api/tree/main/api/addons) folder. Historically, machine pool resources are not present in a sub-directory. Migrating them to a subfolder like `~/exp/machinepools` is still pending as it can potentially break existing users who are relying on existing folder structure.

CRDs for experimental features are present outside [~/exp](https://github.com/kubernetes-sigs/cluster-api/tree/main/exp) directory in [~/config](https://github.com/kubernetes-sigs/cluster-api/tree/main/config) folder. Also, these CRDs are deployed in the cluster irrespective of the feature gate value. These features can be enabled and disabled using feature gates supplied to the core Cluster API controller.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -114,9 +114,6 @@ potentially dangerous changes on those objects.

</aside>

For additional info see [compatibility rules](https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20210526-cluster-class-and-managed-topologies.md#clusterclass-compatibility)
defined in the ClusterClass proposal.

## Planning ClusterClass changes

Some general notes that can help you to understand what you should
Expand Down
2 changes: 1 addition & 1 deletion docs/book/src/tasks/verify-container-images.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Requirements
You will need to have the following tools installed:
- cosign [(install guide)](https://docs.sigstore.dev/system_config/installation/)
- cosign [(install guide)](https://docs.sigstore.dev/cosign/system_config/installation/)
- jq [(download jq)](https://stedolan.github.io/jq/download/)

## CAPI Images
Expand Down
4 changes: 2 additions & 2 deletions docs/proposals/20191017-kubeadm-based-control-plane.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ Non-Goals listed in this document are intended to scope bound the current v1alph
- To manage etcd clusters in any topology other than stacked etcd (externally managed etcd clusters can still be leveraged).
- To address disaster recovery constraints, e.g. restoring a control plane from 0 replicas using a filesystem or volume snapshot copy of data persisted in etcd.
- To support rollbacks, as there is no data store rollback guarantee for Kubernetes. Consumers should perform backups of the cluster prior to performing potentially destructive operations.
- To mutate the configuration of live, running clusters (e.g. changing api-server flags), as this is the responsibility of the [component configuration working group](https://github.com/orgs/kubernetes/projects/26).
- To mutate the configuration of live, running clusters (e.g. changing api-server flags), as this is the responsibility of the `component configuration working group`.
- To provide configuration of external cloud providers (i.e. the [cloud-controller-manager](https://kubernetes.io/docs/tasks/administer-cluster/running-cloud-controller/)). This is deferred to kubeadm.
- To provide CNI configuration. This is deferred to external, higher level tooling.
- To provide the upgrade logic to handle changes to infrastructure (networks, firewalls etc…) that may need to be done to support a control plane on a newer version of Kubernetes (e.g. a cloud controller manager requires updated permissions against infrastructure APIs). We expect the work on [add-on components](https://git.k8s.io/community/sig-cluster-lifecycle#cluster-addons) to help to resolve some of these issues.
Expand Down Expand Up @@ -417,7 +417,7 @@ spec:

##### KubeadmControlPlane rollout

KubeadmControlPlane rollout operations rely on [scale up](#scale up) and [scale down](#scale_down) which are be blocked based on Etcd and control plane preflight checks.
KubeadmControlPlane rollout operations rely on [scale up](#scale-up) and [scale down](#scale-down) which are be blocked based on Etcd and control plane preflight checks.
- See [Preflight checks](#preflight-checks) below.

KubeadmControlPlane rollout is triggered by:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Some templating tools that can be used to manage your templates.
* Kubernetes Library: https://github.com/dhall-lang/dhall-kubernetes
* Helm Template
* Doc: https://helm.sh/docs/helm/helm_template/
* Code: https://github.com/helm/helm/blob/main/cmd/helm/template.go
* Code: https://github.com/helm/helm/blob/main/pkg/cmd/template.go


## Summary
Expand Down
12 changes: 6 additions & 6 deletions docs/proposals/20200804-windows-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ see-also:
- [As an operator, I would like to create Windows OS worker nodes with the CAPI API.](#as-an-operator-i-would-like-to-create-windows-os-worker-nodes-with-the-capi-api)
- [As an operator, I would like to manage Windows OS worker nodes with the CAPI API.](#as-an-operator-i-would-like-to-manage-windows-os-worker-nodes-with-the-capi-api)
- [Implementation Details/Notes/Constraints](#implementation-detailsnotesconstraints)
- [Signing of the components.](#signing-of-the-components)
- [Known prototypes and prior work:](#known-prototypes-and-prior-work)
- [Signing of the components](#signing-of-the-components)
- [Known prototypes and prior work](#known-prototypes-and-prior-work)
- [Security Model](#security-model)
- [Risks and Mitigations](#risks-and-mitigations)
- [Alternatives](#alternatives)
Expand Down Expand Up @@ -170,15 +170,15 @@ While this is the best choice for the alpha and the community direction there ar
not be able to use wins due to signing or security concerns since wins allows the execution of any arbitrary command on
the host. Pre/post commands can be used as an alternative with additional scripts cached on the image that enable the configuration.

#### Signing of the components.
#### Signing of the components

Some infrastructure providers will require any scripts and binaries are signed before deployment.
This will be managed by providing the ability to provide url's to override external scripts and binaries
during the image building process. An example of how this is could be accomplished is in the Linux
implementation is the [containerd_url](https://github.com/kubernetes-sigs/image-builder/blob/58a08a1a8241356bab4afb1c6d8d2fbb8ef54bcf/images/capi/packer/config/ansible-args.json). In this case, the
`containerd_url` could point to a location that would contain a packaged with signed binaries from the infrastructure provider.

#### Known prototypes and prior work:
#### Known prototypes and prior work

- https://github.com/adelina-t/cloudbase-init-capz-demo
- https://github.com/benmoss/kubeadm-windows/tree/master/cluster-api-aws
Expand Down Expand Up @@ -209,7 +209,7 @@ to issue [#3761](https://github.com/kubernetes-sigs/cluster-api/issues/3761) for
- Privileged containers are not implemented.
- There is an active discussion and [KEP](https://docs.google.com/document/d/12EUtMdWFxhTCfFrqhlBGWV70MkZZPOgxw0X-LTR0VAo/edit#) in place. At the Beta stage the community can do a checkpoint to determine if the solution fits user needs
- Cloudbase-init is a third party dependency
- This project is under Apache 2.0 License : https://github.com/cloudbase/cloudbase-init which is cleared under the CNCF Allow list: https://github.com/cncf/foundation/blob/master/allowed-third-party-license-policy.md
- This project is under Apache 2.0 License : https://github.com/cloudbase/cloudbase-init which is cleared under the CNCF Allow list: https://github.com/cncf/foundation/blob/main/policies-guidance/allowed-third-party-license-policy.md
- Windows image Distribution
- Infrastructure providers can provide the ability to use user provided images and images provided by image-promoter are recommended for testing and demonstration purposes. It is recommended the user creates their own image.
- Users using the image scripts must ensure they are following [Windows licensing requirements](https://learn.microsoft.com/windows-server/windows-server-licensing/windows-server-licensing)
Expand Down Expand Up @@ -268,7 +268,7 @@ the existing upstream Kubernetes Windows tests to show that Windows nodes are op
#### Stable
Use of privileged containers.

### Version Skew Strategy
### Version Skew Strategy

The version of support for the Windows operating system is outside the scope of cluster creation. Please refer
to the Kubernetes Windows documentation for the latest version skew support, features, and functionality.
Expand Down
Loading