diff --git a/RELEASE.md b/RELEASE.md index 9e6e2df668..0639fd1c5b 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -19,7 +19,7 @@ 1. Make sure your repo is clean by git's standards. -1. Make sure you are on the correct branch (`master` for the current release and `release-0.x` for older releases). +1. Make sure you are on the correct branch (`main` for the current release and `release-0.x` for older releases). 1. Set an environment variable with the version, e.g.: - `VERSION=v0.4.0` 3. Create an annotated tag @@ -51,11 +51,11 @@ Releasing requires a particular set of permissions. * Approver role for the image promoter process ([kubernetes/k8s.io/blob/main/k8s.gcr.io/images/k8s-staging-capi-openstack/OWNERS](https://github.com/kubernetes/k8s.io/blob/main/k8s.gcr.io/images/k8s-staging-capi-openstack/OWNERS)) -* Tag push and release creation rights to the GitHub repository (team `cluster-api-provider-openstack-maintainers` in [kubernetes/org/config/kubernetes-sigs/sig-cluster-lifecycle/teams.yaml](https://github.com/kubernetes/org/blob/master/config/kubernetes-sigs/sig-cluster-lifecycle/teams.yaml)) +* Tag push and release creation rights to the GitHub repository (team `cluster-api-provider-openstack-maintainers` in [kubernetes/org/config/kubernetes-sigs/sig-cluster-lifecycle/teams.yaml](https://github.com/kubernetes/org/blob/main/config/kubernetes-sigs/sig-cluster-lifecycle/teams.yaml)) ## Staging -There is a post-submit Prow job running after each commit on master which pushes a new image to the staging repo (`gcr.io/k8s-staging-capi-openstack/capi-openstack-controller:latest`). Following configuration is involved: +There is a post-submit Prow job running after each commit on `main` which pushes a new image to the staging repo (`gcr.io/k8s-staging-capi-openstack/capi-openstack-controller:latest`). Following configuration is involved: * staging gcr bucket: [kubernetes/k8s.io/blob/main/k8s.gcr.io/manifests/k8s-staging-capi-openstack/promoter-manifest.yaml](https://github.com/kubernetes/k8s.io/blob/main/k8s.gcr.io/manifests/k8s-staging-capi-openstack/promoter-manifest.yaml) * post-submit `post-capi-openstack-push-images` Prow job: [kubernetes/test-infra/blob/master/config/jobs/image-pushing/k8s-staging-cluster-api.yaml](https://github.com/kubernetes/test-infra/blob/master/config/jobs/image-pushing/k8s-staging-cluster-api.yaml)) (corresponding dashboard is located at [https://testgrid.k8s.io/sig-cluster-lifecycle-image-pushes#post-capi-openstack-push-images](https://testgrid.k8s.io/sig-cluster-lifecycle-image-pushes#post-capi-openstack-push-images)) -* Google Cloud Build configuration which is used by the Prow job: [kubernetes-sigs/cluster-api-provider-openstack/cloudbuild.yaml](https://github.com/kubernetes-sigs/cluster-api-provider-openstack/blob/master/cloudbuild.yaml) +* Google Cloud Build configuration which is used by the Prow job: [kubernetes-sigs/cluster-api-provider-openstack/cloudbuild.yaml](https://github.com/kubernetes-sigs/cluster-api-provider-openstack/blob/main/cloudbuild.yaml) diff --git a/docs/book/src/clusteropenstack/configuration.md b/docs/book/src/clusteropenstack/configuration.md index df8ac15e02..67b14eaf14 100644 --- a/docs/book/src/clusteropenstack/configuration.md +++ b/docs/book/src/clusteropenstack/configuration.md @@ -35,9 +35,9 @@ # Required configuration The cluster configuration file can be generated by using [`clusterctl config cluster`](https://cluster-api.sigs.k8s.io/user/quick-start.html#generating-the-cluster-configuration) command. -This command actually uses [the template file](https://github.com/kubernetes-sigs/cluster-api-provider-openstack/blob/master/templates/cluster-template.yaml) and replace the values surrounded by `${}` with environment variables. You have to set all required environment variables in advance. The following sections explain some more details about what should be configured. +This command actually uses [the template file](https://github.com/kubernetes-sigs/cluster-api-provider-openstack/blob/main/templates/cluster-template.yaml) and replace the values surrounded by `${}` with environment variables. You have to set all required environment variables in advance. The following sections explain some more details about what should be configured. -Note: You can use [the template file](https://github.com/kubernetes-sigs/cluster-api-provider-openstack/blob/master/templates/cluster-template.yaml) by manually replacing values. +Note: You can use [the template file](https://github.com/kubernetes-sigs/cluster-api-provider-openstack/blob/main/templates/cluster-template.yaml) by manually replacing values. **Note:** By default the command creates highly available control plane with internal OpenStack cloud provider. If you wish to create highly available control plane with external OpenStack cloud provider or single control plane without load balancer, use external-cloud-provider or without-lb [flavor](https://cluster-api.sigs.k8s.io/clusterctl/commands/config-cluster.html#flavors) respectively. For example, diff --git a/docs/book/src/development/development.md b/docs/book/src/development/development.md index 66558f7767..f2b2424769 100644 --- a/docs/book/src/development/development.md +++ b/docs/book/src/development/development.md @@ -48,7 +48,7 @@ After generating `infrastructure-components.yaml`, replace the `us.gcr.io/k8s-ar ## Developing with Tilt -We have support for using [Tilt](https://tilt.dev/) for rapid iterative development. Please visit the [Cluster API documentation on Tilt](https://master.cluster-api.sigs.k8s.io/developer/tilt.html) for information on how to set up your development environment. +We have support for using [Tilt](https://tilt.dev/) for rapid iterative development. Please visit the [Cluster API documentation on Tilt](https://cluster-api.sigs.k8s.io/developer/tilt.html) for information on how to set up your development environment. ## Running E2E tests locally @@ -104,7 +104,7 @@ $ openstack network list --external ### OpenStack prerequisites -The file [`test/e2e/data/e2e_conf.yaml`](https://github.com/kubernetes-sigs/cluster-api-provider-openstack/blob/master/test/e2e/data/e2e_conf.yaml) and the test templates under [`test/e2e/data/infrastructure-openstack`](https://github.com/kubernetes-sigs/cluster-api-provider-openstack/tree/master/test/e2e/data/infrastructure-openstack) reference several OpenStack resources which must exist before running the test: +The file [`test/e2e/data/e2e_conf.yaml`](https://github.com/kubernetes-sigs/cluster-api-provider-openstack/blob/main/test/e2e/data/e2e_conf.yaml) and the test templates under [`test/e2e/data/infrastructure-openstack`](https://github.com/kubernetes-sigs/cluster-api-provider-openstack/tree/main/test/e2e/data/infrastructure-openstack) reference several OpenStack resources which must exist before running the test: * Glance images * `cirros-0.5.1-x86_64-disk` diff --git a/docs/book/src/topics/external-cloud-provider.md b/docs/book/src/topics/external-cloud-provider.md index 12daf955da..4b1bbcaabf 100644 --- a/docs/book/src/topics/external-cloud-provider.md +++ b/docs/book/src/topics/external-cloud-provider.md @@ -9,7 +9,7 @@ # External Cloud Provider -To deploy a cluster using [external cloud provider](https://github.com/kubernetes/cloud-provider-openstack), create a cluster configuration with the [external cloud provider template](https://github.com/kubernetes-sigs/cluster-api-provider-openstack/blob/master/templates/cluster-template-external-cloud-provider.yaml). +To deploy a cluster using [external cloud provider](https://github.com/kubernetes/cloud-provider-openstack), create a cluster configuration with the [external cloud provider template](https://github.com/kubernetes-sigs/cluster-api-provider-openstack/blob/main/templates/cluster-template-external-cloud-provider.yaml). ## Steps diff --git a/netlify.toml b/netlify.toml index 779d56c71e..b8fd8cc68c 100644 --- a/netlify.toml +++ b/netlify.toml @@ -8,20 +8,20 @@ GO_VERSION = "1.16" # Standard Netlify redirects [[redirects]] -from = "https://master--kubernetes-sigs-cluster-api-openstack.netlify.com/*" -to = "https://master.cluster-api-openstack.sigs.k8s.io/:splat" +from = "https://main--kubernetes-sigs-cluster-api-openstack.netlify.com/*" +to = "https://main.cluster-api-openstack.sigs.k8s.io/:splat" status = 301 force = true [[redirects]] -from = "http://master--kubernetes-sigs-cluster-api-openstack.netlify.com/*" -to = "http://master.cluster-api-openstack.sigs.k8s.io/:splat" +from = "http://main--kubernetes-sigs-cluster-api-openstack.netlify.com/*" +to = "http://main.cluster-api-openstack.sigs.k8s.io/:splat" status = 301 force = true # HTTP-to-HTTPS rules [[redirects]] -from = "http://master.cluster-api-openstack.sigs.k8s.io/*" -to = "https://master.cluster-api-openstack.sigs.k8s.io/:splat" +from = "http://main.cluster-api-openstack.sigs.k8s.io/*" +to = "https://main.cluster-api-openstack.sigs.k8s.io/:splat" status = 301 force = true