Skip to content

Commit b95cebb

Browse files
author
Cecile Robert-Michon
committed
Change all references to master branch in docs to main branch
1 parent 2ebdffb commit b95cebb

24 files changed

+42
-42
lines changed

CONTRIBUTING.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ The documentation is published in form of a book at:
6464
- [Stable release](https://cluster-api.sigs.k8s.io)
6565
- [Tip of the main branch](https://tip.cluster-api.sigs.k8s.io/)
6666

67-
The source for the book is [this folder](https://github.com/kubernetes-sigs/cluster-api/tree/master/docs/book/src)
67+
The source for the book is [this folder](https://github.com/kubernetes-sigs/cluster-api/tree/main/docs/book/src)
6868
containing markdown files and we use [mdBook][] to build it into a static
6969
website.
7070

@@ -104,7 +104,7 @@ Cluster API uses [GitHub milestones](https://github.com/kubernetes-sigs/cluster-
104104

105105
The Cluster API Enhacement Proposal is the process this project uses to adopt new features, changes to the APIs, changes to contracts between components, or changes to CLI interfaces.
106106

107-
The [template](https://github.com/kubernetes-sigs/cluster-api/blob/master/docs/proposals/YYYYMMDD-template.md), and accepted proposals live under [docs/proposals](https://github.com/kubernetes-sigs/cluster-api/tree/master/docs/proposals).
107+
The [template](https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/YYYYMMDD-template.md), and accepted proposals live under [docs/proposals](https://github.com/kubernetes-sigs/cluster-api/tree/main/docs/proposals).
108108

109109
- Proposals or requests for enhacements (RFEs) MUST be associated with an issue.
110110
- Issues can be placed on the roadmap during planning if there is one or more folks
@@ -229,10 +229,10 @@ Proof of concepts, code experiments, or other initiatives can live under the `ex
229229

230230
## Breaking Changes
231231

232-
Breaking changes are generally allowed in the `master` branch, as this is the branch used to develop the next minor
232+
Breaking changes are generally allowed in the `main` branch, as this is the branch used to develop the next minor
233233
release of Cluster API.
234234

235-
There may be times, however, when `master` is closed for breaking changes. This is likely to happen as we near the
235+
There may be times, however, when `main` is closed for breaking changes. This is likely to happen as we near the
236236
release of a new minor version.
237237

238238
Breaking changes are not allowed in release branches, as these represent minor versions that have already been released.

REVIEWING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ This makes any change that can impact the Cluster API contract critical and usua
120120
### Logging
121121

122122
- For CAPI controllers see [Kubernetes logging conventions](https://git.k8s.io/community/contributors/devel/sig-instrumentation/logging.md).
123-
- For clusterctl see [clusterctl logging conventions](https://github.com/kubernetes-sigs/cluster-api/blob/master/cmd/clusterctl/log/doc.go).
123+
- For clusterctl see [clusterctl logging conventions](https://github.com/kubernetes-sigs/cluster-api/blob/main/cmd/clusterctl/log/doc.go).
124124

125125
### Testing
126126

VERSIONING.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
- We follow [Semantic Versioning (semver)](https://semver.org/).
66
- Cluster API release cadence is Kubernetes Release + 6 weeks.
77
- The cadence is subject to change if necessary, refer to the [Milestones](https://github.com/kubernetes-sigs/cluster-api/milestones) page for up-to-date information.
8-
- The _master_ branch is where development happens, this might include breaking changes.
8+
- The _main_ branch is where development happens, this might include breaking changes.
99
- The _release-X_ branches contain stable, backward compatible code. A new _release-X_ branch is created at every major (X) release.
1010

1111
## Overview
@@ -36,11 +36,11 @@ that we follow.
3636

3737
## Branches
3838

39-
Cluster API contains two types of branches: the *master* branch and
39+
Cluster API contains two types of branches: the *main* branch and
4040
*release-X* branches.
4141

42-
The *master* branch is where development happens. All the latest and
43-
greatest code, including breaking changes, happens on master.
42+
The *main* branch is where development happens. All the latest and
43+
greatest code, including breaking changes, happens on main.
4444

4545
The *release-X* branches contain stable, backwards compatible code. Every
4646
major (X) release, a new such branch is created. It is from these
@@ -109,11 +109,11 @@ Refer to the [releasing document](./docs/developer/releasing.md) for the exact s
109109

110110
Try to avoid breaking changes. They make life difficult for users, who
111111
have to rewrite their code when they eventually upgrade, and for
112-
maintainers/contributors, who have to deal with differences between master
112+
maintainers/contributors, who have to deal with differences between main
113113
and stable branches.
114114

115115
That being said, we'll occasionally want to make breaking changes. They'll
116-
be merged onto master, and will then trigger a major release (see [Release
116+
be merged onto main, and will then trigger a major release (see [Release
117117
Process](#release-process)). Because breaking changes induce a major
118118
revision, the maintainers may delay a particular breaking change until
119119
a later date when they are ready to make a major revision with a few
@@ -145,7 +145,7 @@ Development branches:
145145
changes (we still have to merge/manage multiple branches for development
146146
and stable)
147147

148-
- can be confusing to contributors, who often expect master to have the
148+
- can be confusing to contributors, who often expect main to have the
149149
latest changes.
150150

151151
### Never break compatibility

docs/book/src/clusterctl/commands/config-cluster.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ Use the `--from` flag to read cluster templates stored in a GitHub repository or
8484

8585
```
8686
clusterctl config cluster my-cluster --kubernetes-version v1.16.3 \
87-
--from https://github.com/my-org/my-repository/blob/master/my-template.yaml > my-cluster.yaml
87+
--from https://github.com/my-org/my-repository/blob/main/my-template.yaml > my-cluster.yaml
8888
```
8989

9090
or

docs/book/src/clusterctl/commands/generate-cluster.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Use the `--from` flag to read cluster templates stored in a GitHub repository or
7575

7676
```
7777
clusterctl generate cluster my-cluster --kubernetes-version v1.16.3 \
78-
--from https://github.com/my-org/my-repository/blob/master/my-template.yaml > my-cluster.yaml
78+
--from https://github.com/my-org/my-repository/blob/main/my-template.yaml > my-cluster.yaml
7979
```
8080

8181
or

docs/book/src/clusterctl/commands/generate-yaml.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Current usage of the command is as follows:
2121
```bash
2222
# Generates a configuration file with variable values using a template from a
2323
# specific URL.
24-
clusterctl generate yaml --from https://github.com/foo-org/foo-repository/blob/master/cluster-template.yaml
24+
clusterctl generate yaml --from https://github.com/foo-org/foo-repository/blob/main/cluster-template.yaml
2525

2626
# Generates a configuration file with variable values using
2727
# a template stored locally.

docs/book/src/developer/architecture/controllers/bootstrap.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ Bootstrapping is the process in which:
55
1. A cluster is bootstrapped
66
1. A machine is bootstrapped and takes on a role within a cluster
77

8-
[CABPK](https://github.com/kubernetes-sigs/cluster-api/tree/master/bootstrap/kubeadm) is the reference bootstrap provider and is based on `kubeadm`. CABPK codifies the steps for [creating a cluster](https://kubernetes.io/docs/setup/production-environment/tools/kubeadm/create-cluster-kubeadm/) in multiple configurations.
8+
[CABPK](https://github.com/kubernetes-sigs/cluster-api/tree/main/bootstrap/kubeadm) is the reference bootstrap provider and is based on `kubeadm`. CABPK codifies the steps for [creating a cluster](https://kubernetes.io/docs/setup/production-environment/tools/kubeadm/create-cluster-kubeadm/) in multiple configurations.
99

1010
![](../../../images/bootstrap-controller.png)
1111

12-
See [proposal](https://github.com/kubernetes-sigs/cluster-api/blob/master/docs/proposals/20190610-machine-states-preboot-bootstrapping.md) for the full details on how the bootstrap process works.
12+
See [proposal](https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20190610-machine-states-preboot-bootstrapping.md) for the full details on how the bootstrap process works.
1313

1414
### Implementations
1515

16-
* [Kubeadm](https://github.com/kubernetes-sigs/cluster-api/tree/master/bootstrap/kubeadm) (Reference Implementation)
16+
* [Kubeadm](https://github.com/kubernetes-sigs/cluster-api/tree/main/bootstrap/kubeadm) (Reference Implementation)

docs/book/src/developer/e2e.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -204,14 +204,14 @@ test specs for the most common Cluster API use cases.
204204
[deprecated E2E config file]: https://pkg.go.dev/sigs.k8s.io/cluster-api/test/framework?tab=doc#Config
205205
[deprecated InitManagementCluster method]: https://pkg.go.dev/sigs.k8s.io/cluster-api/test/framework?tab=doc#InitManagementCluster
206206
[Apply method]: https://pkg.go.dev/sigs.k8s.io/cluster-api/test/framework?tab=doc#Applier
207-
[CAPA E2E tests]: https://github.com/kubernetes-sigs/cluster-api-provider-aws/blob/master/scripts/ci-e2e.sh
207+
[CAPA E2E tests]: https://github.com/kubernetes-sigs/cluster-api-provider-aws/blob/main/scripts/ci-e2e.sh
208208
[CAPG E2E tests]: https://github.com/kubernetes-sigs/cluster-api-provider-gcp/blob/master/scripts/ci-e2e.sh
209209
[WaitForClusterToProvision]: https://pkg.go.dev/sigs.k8s.io/cluster-api/test/framework?tab=doc#WaitForClusterToProvision
210210
[WaitForKubeadmControlPlaneMachinesToExist]: https://pkg.go.dev/sigs.k8s.io/cluster-api/test/framework?tab=doc#WaitForKubeadmControlPlaneMachinesToExist
211211
[controller-runtime Client]: https://pkg.go.dev/sigs.k8s.io/[email protected]/pkg/client?tab=doc#Client
212212
[boskos]: https://git.k8s.io/test-infra/boskos
213213
[E2E config file]: https://pkg.go.dev/sigs.k8s.io/cluster-api/test/framework/clusterctl?tab=doc#E2EConfig
214-
[example E2E config file]: https://github.com/kubernetes-sigs/cluster-api/blob/master/test/e2e/config/docker.yaml
214+
[example E2E config file]: https://github.com/kubernetes-sigs/cluster-api/blob/main/test/e2e/config/docker.yaml
215215
[NewKindClusterProvider]: https://pkg.go.dev/sigs.k8s.io/cluster-api/test/framework/bootstrap?tab=doc#NewKindClusterProvider
216216
[InitManagementClusterAndWatchControllerLogs method]: https://pkg.go.dev/sigs.k8s.io/cluster-api/test/framework/clusterctl?tab=doc#InitManagementClusterAndWatchControllerLogs
217217
[ClusterTemplate method]: https://pkg.go.dev/sigs.k8s.io/cluster-api/test/framework/clusterctl?tab=doc#ConfigCluster

docs/book/src/developer/guide.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ This guide will walk you through getting that daemon, known as [CAPD], up and ru
1111
Other providers may have additional steps you need to follow to get up and running.
1212

1313
[capa]: https://github.com/kubernetes-sigs/cluster-api-provider-aws
14-
[capi-manager]: https://github.com/kubernetes-sigs/cluster-api/blob/master/main.go
15-
[capa-manager]: https://github.com/kubernetes-sigs/cluster-api-provider-aws/blob/master/main.go
16-
[Docker]: https://github.com/kubernetes-sigs/cluster-api/tree/master/test/infrastructure/docker
17-
[CAPD]: https://github.com/kubernetes-sigs/cluster-api/blob/master/test/infrastructure/docker/README.md
14+
[capi-manager]: https://github.com/kubernetes-sigs/cluster-api/blob/main/main.go
15+
[capa-manager]: https://github.com/kubernetes-sigs/cluster-api-provider-aws/blob/main/main.go
16+
[Docker]: https://github.com/kubernetes-sigs/cluster-api/tree/main/test/infrastructure/docker
17+
[CAPD]: https://github.com/kubernetes-sigs/cluster-api/blob/main/test/infrastructure/docker/README.md
1818

1919
## Prerequisites
2020

docs/book/src/developer/testing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -404,4 +404,4 @@ In Cluster API Unit and integration test MUST use [go test].
404404
[controller-runtime]: https://github.com/kubernetes-sigs/controller-runtime
405405
[envtest]: https://github.com/kubernetes-sigs/controller-runtime/tree/master/pkg/envtest
406406
[fakeclient]: https://github.com/kubernetes-sigs/controller-runtime/tree/master/pkg/client/fake
407-
[test/helpers]: https://github.com/kubernetes-sigs/cluster-api/tree/master/test/helpers
407+
[test/helpers]: https://github.com/kubernetes-sigs/cluster-api/tree/main/test/helpers

docs/book/src/developer/tilt.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ tilt up
188188
This will open the command-line HUD as well as a web browser interface. You can monitor Tilt's status in either
189189
location. After a brief amount of time, you should have a running development environment, and you should now be able to
190190
create a cluster. There are [example worker cluster
191-
configs](https://github.com/kubernetes-sigs/cluster-api/tree/master/test/infrastructure/docker/examples) available.
191+
configs](https://github.com/kubernetes-sigs/cluster-api/tree/main/test/infrastructure/docker/examples) available.
192192
These can be customized for your specific needs.
193193
194194
<aside class="note">

docs/book/src/introduction.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Cluster API is a Kubernetes sub-project focused on providing declarative APIs and tooling to simplify provisioning, upgrading, and operating multiple Kubernetes clusters.
44

5-
Started by the Kubernetes Special Interest Group (SIG) [Cluster Lifecycle](https://github.com/kubernetes/community/tree/master/sig-cluster-lifecycle#readme), the Cluster API project uses Kubernetes-style APIs and patterns to automate cluster lifecycle management for platform operators. The supporting infrastructure, like virtual machines, networks, load balancers, and VPCs, as well as the Kubernetes cluster configuration are all defined in the same way that application developers operate deploying and managing their workloads. This enables consistent and repeatable cluster deployments across a wide variety of infrastructure environments.
5+
Started by the Kubernetes Special Interest Group (SIG) [Cluster Lifecycle](https://github.com/kubernetes/community/tree/main/sig-cluster-lifecycle#readme), the Cluster API project uses Kubernetes-style APIs and patterns to automate cluster lifecycle management for platform operators. The supporting infrastructure, like virtual machines, networks, load balancers, and VPCs, as well as the Kubernetes cluster configuration are all defined in the same way that application developers operate deploying and managing their workloads. This enables consistent and repeatable cluster deployments across a wide variety of infrastructure environments.
66

77
## Getting started
88

docs/book/src/reference/glossary.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ A temporary cluster that is used to provision a Target Management cluster.
2727
---
2828

2929
### CAEP
30-
Cluster API Enhancement Proposal - patterned after [KEP](https://git.k8s.io/enhancements/keps/README.md). See [template](https://github.com/kubernetes-sigs/cluster-api/blob/master/docs/proposals/YYYYMMDD-template.md)
30+
Cluster API Enhancement Proposal - patterned after [KEP](https://git.k8s.io/enhancements/keps/README.md). See [template](https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/YYYYMMDD-template.md)
3131

3232
### CAPI
3333
Core Cluster API

docs/book/src/reference/providers.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ are also sponsored by SIG Cluster Lifecycle. Check provider's documentation for
66
updated info about which API version they are supporting.
77

88
## Bootstrap
9-
- [Kubeadm](https://github.com/kubernetes-sigs/cluster-api/tree/master/bootstrap/kubeadm)
9+
- [Kubeadm](https://github.com/kubernetes-sigs/cluster-api/tree/main/bootstrap/kubeadm)
1010
- [Talos](https://github.com/talos-systems/cluster-api-bootstrap-provider-talos)
11-
- [EKS](https://github.com/kubernetes-sigs/cluster-api-provider-aws/tree/master/bootstrap/eks)
11+
- [EKS](https://github.com/kubernetes-sigs/cluster-api-provider-aws/tree/main/bootstrap/eks)
1212

1313
## Infrastructure
1414
- [Alibaba Cloud](https://github.com/oam-oss/cluster-api-provider-alicloud)

docs/book/src/tasks/experimental-features/cluster-resource-set.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ The `ClusterResourceSet` feature is introduced to provide a way to automatically
77
**Variable name to enable/disable the feature gate**: `EXP_CLUSTER_RESOURCE_SET`
88

99
More details on `ClusterResourceSet` and an example to test it can be found at:
10-
[ClusterResourceSet CAEP](https://github.com/kubernetes-sigs/cluster-api/blob/master/docs/proposals/20200220-cluster-resource-set.md)
10+
[ClusterResourceSet CAEP](https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20200220-cluster-resource-set.md)

docs/book/src/tasks/experimental-features/machine-pools.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,6 @@ each infrastructure provider has a specific solution for orchestrating these `Ma
2222
Infrastructure providers can support this feature by implementing their specific `MachinePool` such as `AzureMachinePool`.
2323

2424
More details on `MachinePool` can be found at:
25-
[MachinePool CAEP](https://github.com/kubernetes-sigs/cluster-api/blob/master/docs/proposals/20190919-machinepool-api.md)
25+
[MachinePool CAEP](https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20190919-machinepool-api.md)
2626

2727
For developer docs on the MachinePool controller, see [here](./../../developer/architecture/controllers/machine-pool.md).

docs/book/src/tasks/healthcheck.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ Explicit skipping using `cluster.x-k8s.io/skip-remediation` annotation:
173173
Before deploying a MachineHealthCheck, please familiarise yourself with the following limitations and caveats:
174174

175175
- Only Machines owned by a MachineSet or a KubeadmControlPlane can be remediated by a MachineHealthCheck (since a MachineDeployment uses a MachineSet, then this includes Machines that are part of a MachineDeployment)
176-
- Machines managed by a KubeadmControlPlane are remediated according to [the delete-and-recreate guidelines described in the KubeadmControlPlane proposal](https://github.com/kubernetes-sigs/cluster-api/blob/master/docs/proposals/20191017-kubeadm-based-control-plane.md#remediation-using-delete-and-recreate)
176+
- Machines managed by a KubeadmControlPlane are remediated according to [the delete-and-recreate guidelines described in the KubeadmControlPlane proposal](https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20191017-kubeadm-based-control-plane.md#remediation-using-delete-and-recreate)
177177
- If the Node for a Machine is removed from the cluster, a MachineHealthCheck will consider this Machine unhealthy and remediate it immediately
178178
- If no Node joins the cluster for a Machine after the `NodeStartupTimeout`, the Machine will be remediated
179179
- If a Machine fails for any reason (if the FailureReason is set), the Machine will be remediated immediately

docs/book/src/tasks/kubeadm-bootstrap.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ for Kubernetes bootstrap.
77

88
### Resources
99

10-
* [design doc](https://github.com/kubernetes-sigs/cluster-api/blob/master/docs/proposals/20190610-machine-states-preboot-bootstrapping.md)
10+
* [design doc](https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20190610-machine-states-preboot-bootstrapping.md)
1111
* [The Kubebuilder Book](https://book.kubebuilder.io)
1212

1313
## How does CABPK work?

docs/book/src/tasks/kubeadm-control-plane.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Cluster API Machines:
3838
- The Kubernetes node hosted on the Machine will be cordoned & drained before removal (with well
3939
known exceptions like full Cluster deletion).
4040
- The Machine will respect PreDrainDeleteHook and PreTerminateDeleteHook. see the
41-
[Machine Deletion Phase Hooks proposal](https://github.com/kubernetes-sigs/cluster-api/blob/master/docs/proposals/20200602-machine-deletion-phase-hooks.md)
41+
[Machine Deletion Phase Hooks proposal](https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/proposals/20200602-machine-deletion-phase-hooks.md)
4242
for additional details.
4343

4444
<!-- links -->

docs/book/src/user/troubleshooting.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ be troubleshooted systematically.
2121
## Labeling nodes with reserved labels such as `node-role.kubernetes.io` fails with kubeadm error during bootstrap
2222

2323
Self-assigning Node labels such as `node-role.kubernetes.io` using the kubelet `--node-labels` flag
24-
(see `kubeletExtraArgs` in the [CABPK examples](https://github.com/kubernetes-sigs/cluster-api/tree/master/bootstrap/kubeadm))
24+
(see `kubeletExtraArgs` in the [CABPK examples](https://github.com/kubernetes-sigs/cluster-api/tree/main/bootstrap/kubeadm))
2525
is not possible due to a security measure imposed by the
2626
[`NodeRestriction` admission controller](https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/#noderestriction)
2727
that kubeadm enables by default.

docs/proposals/20190919-machinepool-api.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ status: provisional
7070

7171
## Glossary
7272
The lexicon used in this document is described in more detail
73-
[here](https://github.com/kubernetes-sigs/cluster-api/blob/master/docs/book/src/reference/glossary.md).
73+
[here](https://github.com/kubernetes-sigs/cluster-api/blob/main/docs/book/src/reference/glossary.md).
7474
Any discrepancies should be rectified in the main Cluster API glossary.
7575

7676
- **ASG** - AWS Auto Scale Group

0 commit comments

Comments
 (0)