diff --git a/README.md b/README.md index 38dae743..ec4bab28 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ General documentation for [BOSH](https://bosh.io/). We render these docs with [mkdocs](https://www.mkdocs.org/) using a [slightly-adapted](theme) [material](https://github.com/squidfunk/mkdocs-material) theme, and you can find a rendered version of these docs at [bosh.io/docs](https://bosh.io/docs/). ## Production -Commits made to the master branch of this repo will trigger a [councourse build](https://ci.bosh-ecosystem.cf-app.com/teams/main/pipelines/bosh-io-web) which will automatically push changes live. +Commits made to the `main` branch trigger documentation publication. ## Development diff --git a/content/azure-cpi.md b/content/azure-cpi.md index 9f231c49..1af366a8 100644 --- a/content/azure-cpi.md +++ b/content/azure-cpi.md @@ -4,7 +4,7 @@ This topic describes cloud properties for different resources created by the Azu ## AZs {: #azs } -- **availability_zone** [String, optional]: Availability zone to use for creating instances (available in v33+). Possible values: `'1'`, `'2'`, `'3'`. Read this [document](https://learn.microsoft.com/en-us/azure/reliability/availability-zones-overview) to get regions and VM sizes on Azure that support availability zones. [More details about availability zone](https://github.com/cloudfoundry/bosh-azure-cpi-release/tree/master/docs/advanced/availability-zone). +- **availability_zone** [String, optional]: Availability zone to use for creating instances (available in v33+). Possible values: `'1'`, `'2'`, `'3'`. Read this [document](https://learn.microsoft.com/en-us/azure/reliability/availability-zones-overview) to get regions and VM sizes on Azure that support availability zones. [More details about availability zone](https://github.com/cloudfoundry/bosh-azure-cpi-release/tree/main/docs/advanced/availability-zone). Example: @@ -161,9 +161,9 @@ Schema for `cloud_properties` section: - **assign\_dynamic\_public\_ip** [Boolean, optional]: Enable to create and assign dynamic public IP to the VM automatically (to solve the [azure SNAT issue](https://github.com/cloudfoundry/bosh-azure-cpi-release/issues/217)). Default value is `false`. Only the VM without vip will be assigned a dynamic public IP when this value is set to true, and the dynamic public IP will be deleted when the VM is deleted. -- **availability_zone** [String, optional]: Availability zone to use for creating instances (available in v33+). Possible values: `'1'`, `'2'`, `'3'`. Read this [document](https://learn.microsoft.com/en-us/azure/reliability/availability-zones-overview) to get regions and VM sizes on Azure that support availability zones. [More details about availability zone](https://github.com/cloudfoundry/bosh-azure-cpi-release/tree/master/docs/advanced/availability-zone). +- **availability_zone** [String, optional]: Availability zone to use for creating instances (available in v33+). Possible values: `'1'`, `'2'`, `'3'`. Read this [document](https://learn.microsoft.com/en-us/azure/reliability/availability-zones-overview) to get regions and VM sizes on Azure that support availability zones. [More details about availability zone](https://github.com/cloudfoundry/bosh-azure-cpi-release/tree/main/docs/advanced/availability-zone). -- **availability_set** [String, optional]: Name of an [availability set](https://learn.microsoft.com/en-us/azure/virtual-machines/availability-set-overview) to use for VMs. [More details](https://github.com/cloudfoundry/bosh-azure-cpi-release/tree/master/docs/advanced/deploy-cloudfoundry-with-availability-sets). +- **availability_set** [String, optional]: Name of an [availability set](https://learn.microsoft.com/en-us/azure/virtual-machines/availability-set-overview) to use for VMs. [More details](https://github.com/cloudfoundry/bosh-azure-cpi-release/tree/main/docs/advanced/deploy-cloudfoundry-with-availability-sets). - If available set does not exist, it will be automatically created. - If `availability_set` is not specified, Azure CPI will search `env.bosh.group` as the name of availability set. 1. [bosh release](https://bosh.io/releases/github.com/cloudfoundry/bosh?all=1) v258+ will generate a value for `env.bosh.group` automatically. @@ -177,7 +177,7 @@ Schema for `cloud_properties` section: - For Azure, the default value of an unmanaged availability set is `3`. The default value of a managed availability set is `2`, because [some regions support only two managed-disk fault domains](https://learn.microsoft.com/en-us/azure/virtual-machines/availability-set-overview#disk-fault-domains). - For Azure Stack Hub, the default value is `1`. Before the 1802 update, only `1` is allowed. After the 1802 update, you can configure up to 3 fault domains. -- **storage\_account\_name** [String, optional]: Storage account for VMs. Valid only when `use_managed_disks` is `false`. If this is not set, the VMs will be created in the default storage account. See [this document](https://github.com/cloudfoundry/bosh-azure-cpi-release/blob/master/docs/advanced/deploy-cloudfoundry-with-multiple-storage-accounts/README.md) for more details on why this option exists. +- **storage\_account\_name** [String, optional]: Storage account for VMs. Valid only when `use_managed_disks` is `false`. If this is not set, the VMs will be created in the default storage account. See [this document](https://github.com/cloudfoundry/bosh-azure-cpi-release/blob/main/docs/advanced/deploy-cloudfoundry-with-multiple-storage-accounts/README.md) for more details on why this option exists. - If you use `DS-series` or `GS-series` as `instance_type`, you should set this to a premium storage account. See more information about [Azure premium page blobs](https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blob-pageblob-overview). See [available regions](https://azure.microsoft.com/en-us/explore/global-infrastructure/products-by-region/) where you can create premium storage accounts. - If you use a different storage account which must be in the same resource group, please make sure: 1. The permissions for the container `stemcell` in the default storage account is set to `Public read access for blobs only`. @@ -416,7 +416,7 @@ Schema: - **tenant_id** [String, required]: Tenant ID of the service principal. - **client_id** [String, required]: Client ID of the service principal. - **client_secret** [String, optional]: Client secret of the service principal. -- **certificate** [String, optional]: The certificate for your service principal. Azure CPI v35.0.0+ supports the [service principal with a certificate](https://github.com/cloudfoundry/bosh-azure-cpi-release/tree/master/docs/advanced/use-service-principal-with-certificate). Only one of `client_secret` and `certificate` can be specified. +- **certificate** [String, optional]: The certificate for your service principal. Azure CPI v35.0.0+ supports the [service principal with a certificate](https://github.com/cloudfoundry/bosh-azure-cpi-release/tree/main/docs/advanced/use-service-principal-with-certificate). Only one of `client_secret` and `certificate` can be specified. - **resource\_group\_name** [String, required]: Resource group name. - **storage\_account\_name** [String, optional]: Storage account name. Used as the default storage account for VM disks and stemcells. Required when `use_managed_disks` is `false`. When omitted, the CPI auto-creates one (requires CPI v53.1.10+; see [AccountKindNotSupported](./azure-cpi-errors.md#accountkindnotsupported)). - **ssh_user** [String, required]: SSH username. Default: `vcap`. diff --git a/content/cpi-api-v2-method/update-disk.md b/content/cpi-api-v2-method/update-disk.md index 5e64a486..0e6bb509 100644 --- a/content/cpi-api-v2-method/update-disk.md +++ b/content/cpi-api-v2-method/update-disk.md @@ -62,7 +62,7 @@ null ### Implementations - [cloudfoundry/bosh-azure-cpi-release](https://github.com/cloudfoundry/bosh-azure-cpi-release/blob/fc16e6f65b0533f83052812dc0d6c1edefc9ac28/src/bosh_azure_cpi/lib/cloud/azure/cloud.rb#L482) -- [cloudfoundry/bosh-google-cpi-release](https://github.com/cloudfoundry/bosh-google-cpi-release/blob/master/src/bosh-google-cpi/action/update_disk.go) +- [cloudfoundry/bosh-google-cpi-release](https://github.com/cloudfoundry/bosh-google-cpi-release/blob/main/src/bosh-google-cpi/action/update_disk.go) - [cloudfoundry/bosh-alicloud-cpi-release](https://github.com/cloudfoundry/bosh-alicloud-cpi-release/blob/master/src/bosh-alicloud-cpi/action/update_disk.go) ## Related diff --git a/content/init-azure.md b/content/init-azure.md index 92933c1c..92965ef3 100644 --- a/content/init-azure.md +++ b/content/init-azure.md @@ -6,7 +6,7 @@ This document shows how to initialize new [environment](terminology.md#environme If you do not have an Azure account, [create one](https://azure.microsoft.com/en-us/pricing/purchase-options/azure-account). -Then follow this [guide](https://github.com/cloudfoundry/bosh-azure-cpi-release/blob/master/docs/get-started/create-service-principal.md) to create your Azure service principal. +Then follow this [guide](https://github.com/cloudfoundry/bosh-azure-cpi-release/blob/main/docs/get-started/create-service-principal.md) to create your Azure service principal. Use the [Azure templates in `bosh-deployment`](https://github.com/cloudfoundry/bosh-deployment/tree/master/azure) to initialize the new environment on Microsoft Azure. diff --git a/content/init-vsphere.md b/content/init-vsphere.md index 79cfd6a4..111db8e8 100644 --- a/content/init-vsphere.md +++ b/content/init-vsphere.md @@ -40,7 +40,7 @@ This document shows how to set up new [environment](terminology.md#environment) - Configure `vcenter_ip` with the IP or hostname of the vCenter (e.g. '192.168.0.10' or 'vc1.mycompany.com'). - Configure `vcenter_user` (e.g. 'root') and `vcenter_password` (e.g. 'vmware') with vCenter user name and password. - BOSH does not require user to be an admin, but it does require the following [privileges](https://github.com/cloudfoundry/bosh-vsphere-cpi-release/blob/master/docs/required_vcenter_privileges.md). + BOSH does not require user to be an admin, but it does require the following [privileges](https://github.com/cloudfoundry/bosh-vsphere-cpi-release/blob/main/docs/required_vcenter_privileges.md). - Configure `vcenter_dc` (e.g. 'my-dc') with the name of the datacenter the Director will use for VM creation. - Configure `vcenter_vms` (e.g. 'my-bosh-vms') and `TEMPLATES-FOLDER-NAME` (e.g. 'my-bosh-templates') with the name of the folder created to hold VMs and the name of the folder created to hold stemcells. Folders will be automatically created under the chosen datacenter. - Configure `vcenter_ds` (e.g. 'datastore[1-9]') with a regex matching the names of potential datastores the Director will use for storing VMs and associated persistent disks. diff --git a/content/jobs.md b/content/jobs.md index 10a87a3a..d0442f38 100644 --- a/content/jobs.md +++ b/content/jobs.md @@ -206,7 +206,7 @@ Whenever BPM would miss some required features, then contributions should be submitted as Pull Requests to [its Git repository][bpm_repo] so that more use-case are covered. -[bpm_repo]: https://github.com/cloudfoundry/bpm-release/tree/master/src/bpm +[bpm_repo]: https://github.com/cloudfoundry/bpm-release/tree/main/src/bpm #### BPM Configuration diff --git a/mkdocs.yml b/mkdocs.yml index 113e282e..fa5129da 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -4,7 +4,7 @@ site_url: "https://bosh.io/docs/" repo_name: cloudfoundry/bosh repo_url: https://github.com/cloudfoundry/bosh -edit_uri: https://github.com/cloudfoundry/docs-bosh/edit/master/content/ +edit_uri: https://github.com/cloudfoundry/docs-bosh/edit/main/content/ # non-default since our repo itself is called "docs" docs_dir: content diff --git a/theme/main.html b/theme/main.html index 4c55ecd4..72eac5b1 100644 --- a/theme/main.html +++ b/theme/main.html @@ -4,7 +4,7 @@ {% if page and page.meta.schema %}
{% endif %} - {{ super() | replace("https://github.com/cloudfoundry/docs-bosh/edit/master/content/bpm/", "https://github.com/cloudfoundry-incubator/bpm-release/edit/master/docs/") }} + {{ super() | replace("https://github.com/cloudfoundry/docs-bosh/edit/main/content/bpm/", "https://github.com/cloudfoundry-incubator/bpm-release/edit/main/docs/") }} {% if page and page.schema %}
{% endif %}