Skip to content

Commit e22855d

Browse files
authored
Merge pull request #1100 from Nordix/fix-typo-in-cloud-provider-az
📖 Fix few typos in docs under /topics folder
2 parents b69480f + 3ef3ab5 commit e22855d

File tree

6 files changed

+9
-9
lines changed

6 files changed

+9
-9
lines changed

docs/book/src/topics/cloud-provider-config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22

33
The [Azure cloud provider](https://github.com/kubernetes-sigs/cloud-provider-azure) has a number of configuration options driven by a file on cluster nodes. This file canonically lives on a node at /etc/kubernetes/azure.json. The Azure cloud provider documentation details the [configuration options exposed](https://github.com/kubernetes-sigs/cloud-provider-azure/blob/master/docs/cloud-provider-config.md#cloud-provider-config) by this file.
44

5-
CAPZ automatically generates this file based on user-provided values in AzureMachineTemplate and AzureMachine. All AzureMachines in the same MachineDeployment or control plane will all share a single cloud provider secret, while AzureMachines created inidividially will have their own secret.
5+
CAPZ automatically generates this file based on user-provided values in AzureMachineTemplate and AzureMachine. All AzureMachines in the same MachineDeployment or control plane will all share a single cloud provider secret, while AzureMachines created inidividually will have their own secret.
66

77
For AzureMachineTemplate and standalone AzureMachines, the generated secret will have the name "${RESOURCE}-azure-json", where "${RESOURCE}" is the name of either the AzureMachineTemplate or AzureMachine. The secret will have one data field, `azure.json`, with the raw content for that file. When the secret `${RESOURCE}-azure-json` already exists in the same namespace as an AzureCluster and does not have the label `"${CLUSTER_NAME}": "owned"`, CAPZ will not generate the default described above. Instead it will directly use whatever the user provides in that secret.

docs/book/src/topics/ephemeral-os.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,14 @@ When `diffDiskSettings.option` is set to `Local`, ephemeral OS will be enabled.
3030

3131
## Known Limitations
3232

33-
Not all SKU sizes support ephemeral os. CAPZ will query Azure's resource
33+
Not all SKU sizes support ephemeral OS. CAPZ will query Azure's resource
3434
SKUs API to check if the requested VM size supports ephemeral OS. If
3535
not, the azuremachine controller will log an event with the
3636
corresponding error on the AzureMachine object.
3737

3838
## Example
3939

40-
The below example shows how to enable ephemeral OS for a machine template. For control plane nodes, we strongly recommend using [etcd data disks](data-disks.md)to avoid data loss.
40+
The below example shows how to enable ephemeral OS for a machine template. For control plane nodes, we strongly recommend using [etcd data disks](data-disks.md) to avoid data loss.
4141

4242
````yaml
4343
apiVersion: infrastructure.cluster.x-k8s.io/v1alpha3

docs/book/src/topics/gpu.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ azuremachinetemplate.infrastructure.cluster.x-k8s.io/azure-gpu-md-0 created
4848
kubeadmconfigtemplate.bootstrap.cluster.x-k8s.io/azure-gpu-md-0 created
4949
```
5050

51-
Wait until the cluster and nodes are finished provisioning. The GPU nodes make take several minutes
51+
Wait until the cluster and nodes are finished provisioning. The GPU nodes may take several minutes
5252
to provision, since each one must install drivers and supporting software.
5353

5454
```bash

docs/book/src/topics/machinepools.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
*Source: [MachinePool API Proposal](https://github.com/kubernetes-sigs/cluster-api/blob/bf51a2502f9007b531f6a9a2c1a4eae1586fb8ca/docs/proposals/20190919-machinepool-api.md)*
3333

3434
## AzureMachinePool
35-
Cluster API Provider Azure (CAPZ) has experimental support for `MachinePool` though the infrastructure
35+
Cluster API Provider Azure (CAPZ) has experimental support for `MachinePool` through the infrastructure
3636
type `AzureMachinePool`. An `AzureMachinePool` corresponds to an [Azure Virtual Machine Scale Set](https://docs.microsoft.com/en-us/azure/virtual-machine-scale-sets/overview),
3737
which provides the cloud provider specific resource for orchestrating a group of Virtual Machines.
3838

docs/book/src/topics/managedcluster.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ should be fairly clear from context.
154154
155155
AKS clusters deployed from CAPZ currently only support a limited,
156156
"blessed" configuration. This was primarily to keep the initial
157-
implementation simple. If you'd like to managed AKS cluster with CAPZ
157+
implementation simple. If you'd like to run managed AKS cluster with CAPZ
158158
and need an additional feature, please open a pull request or issue with
159159
details. We're happy to help!
160160

docs/book/src/topics/multitenancy.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ spec:
2323
- <cluster-namespace>
2424

2525
```
26-
The password will need to be added in a secret similar to the following example
26+
The password will need to be added in a secret similar to the following example:
2727

2828
```yaml
2929
apiVersion: v1
@@ -35,7 +35,7 @@ data:
3535
clientSecret: <client-secret-of-SP-identity>
3636
```
3737
38-
OR the password can also as a Certificate
38+
OR the password can also be added as a Certificate:
3939
4040
```yaml
4141
apiVersion: v1
@@ -78,6 +78,6 @@ spec:
7878

7979
For more details on how aad-pod-identity works, please check the guide [here](https://azure.github.io/aad-pod-identity/docs/).
8080

81-
## User Assiged Identity
81+
## User Assigned Identity
8282

8383
_will be supported in a future release_

0 commit comments

Comments
 (0)