Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Update azure.md #1494

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update azure.md #1494

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 10 additions & 6 deletions ...ser-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/azure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@
<details id="v2.6.0-cloud-provider-config-file">
<summary>Example Cloud Provider Config</summary>

```yaml
```yaml
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the expected rendered output here? This block doesn't seem to have the same missing indentation as the other blocks.

The build is also failing without the existing indentation.

{
"cloud":"AzurePublicCloud",
"tenantId": "YOUR TENANTID HERE",
Expand All @@ -120,7 +120,7 @@
"useManagedIdentityExtension": false,
"useInstanceMetadata": true
}
```
```

</details>

Expand All @@ -144,7 +144,7 @@

Note that the chart reads the Cloud Provider Config from a given secret name in the `kube-system` namespace. Since Azure reads Kubernetes secrets, RBAC also needs to be configured. An example secret for the Cloud Provider Config is shown below. Modify it as needed and create the secret.

```yaml
```yaml
# azure-cloud-config.yaml
apiVersion: v1
kind: Secret
Expand Down Expand Up @@ -203,7 +203,7 @@
- kind: ServiceAccount
name: azure-cloud-config
namespace: kube-system
```
```

## Using the Out-of-tree Azure Cloud Provider

Expand All @@ -212,14 +212,18 @@

1. Select **External** from the **Cloud Provider** drop-down in the **Cluster Configuration** section.

:::note
When setting **Cloud Provider** to **External**, all nodes will automatically be tainted with node.cloudprovider.kubernetes.io/uninitialized=true until the Cloud Provder is installed. It is recommended to deploy the CPI as an add-on job as described below.

Check warning on line 216 in docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/azure.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[common.Will] Avoid using future tense where possible

Raw Output:
{"message": "[common.Will] Avoid using future tense where possible", "location": {"path": "docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/azure.md", "range": {"start": {"line": 216, "column": 60}}}, "severity": "WARNING"}
:::
Comment on lines +215 to +217
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
:::note
When setting **Cloud Provider** to **External**, all nodes will automatically be tainted with node.cloudprovider.kubernetes.io/uninitialized=true until the Cloud Provder is installed. It is recommended to deploy the CPI as an add-on job as described below.
:::
:::note
When setting **Cloud Provider** to **External**, all nodes are automatically tainted with `node.cloudprovider.kubernetes.io/uninitialized=true` until the Cloud Provider is installed. It is recommended to deploy the CPI as an add-on job as described below.
:::

Suggestion updates the text to present tense and adds indentation so the note aligns with the text of step 1.


2. Prepare the Cloud Provider Configuration to set it in the next step. Note that Rancher automatically creates a new Network Security Group, Resource Group, Availability Set, Subnet, and Virtual Network. If you already have some or all of these created, you must specify them before creating the cluster.
- Click **Show Advanced** to view or edit these automatically generated names. Your Cloud Provider Configuration **must** match the fields in the **Machine Pools** section. If you have multiple pools, they must all use the same Resource Group, Availability Set, Subnet, Virtual Network, and Network Security Group.

3. Under **Cluster Configuration > Advanced**, click **Add** under **Additional Controller Manager Args** and add this flag: `--configure-cloud-routes=false`.

Note that the chart reads the Cloud Provider Config from the secret in the `kube-system` namespace. An example secret for the Cloud Provider Config is shown below. Modify it as needed. Refer to the full list of configuration options in the [upstream docs](https://cloud-provider-azure.sigs.k8s.io/install/configs/).

```yaml
```yaml
apiVersion: helm.cattle.io/v1
kind: HelmChart
metadata:
Expand Down Expand Up @@ -312,7 +316,7 @@
- kind: ServiceAccount
name: azure-cloud-config
namespace: kube-system
```
```

4. Click **Create** to submit the form and create the cluster.

Expand Down
Loading