Skip to content

Commit ff4645c

Browse files
authored
Merge pull request #11274 from sbueringer/pr-bootstrap-config-nits
📖 Fix some nits in BootstrapConfig docs
2 parents f251a7b + e866eb9 commit ff4645c

File tree

4 files changed

+10
-10
lines changed

4 files changed

+10
-10
lines changed

docs/book/src/developer/core/controllers/machine.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ When a node appears with `Node.Spec.ProviderID` matching `Machine.Spec.ProviderI
5353
transitions the associated machine into the `Provisioned` state. When the infrastructure ref is also
5454
`Ready`, the machine controller marks the machine as `Running`.
5555

56-
The following schema goes trough machine phases and interactions with InfraMachine and BootstrapConfig
56+
The following schema goes through machine phases and interactions with InfraMachine and BootstrapConfig
5757
happening at each step.
5858

5959
![](../../../images/machine-phases.png)

docs/book/src/developer/providers/contracts/bootstrap-config.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Contract rules for BootstrapConfig
22

3-
Bootstrap providers SHOULD implement an BootstrapConfig resource.
3+
Bootstrap providers SHOULD implement a BootstrapConfig resource.
44

5-
The goal of an BootstrapConfig resource is to generates bootstrap data that is used to bootstrap a Kubernetes node.
5+
The goal of a BootstrapConfig resource is to generates bootstrap data that is used to bootstrap a Kubernetes node.
66
These may be e.g. [cloud-init] scripts.
77

88
The BootstrapConfig resource will be referenced by one of the Cluster API core resources, Machine.
@@ -11,7 +11,7 @@ The [Machine's controller](../../core/controllers/machine.md) will be responsibl
1111
and the interaction between the Machine's controller and the BootstrapConfig resource is based on the contract
1212
rules defined in this page.
1313

14-
Once contract rules are satisfied by an BootstrapConfig implementation, other implementation details
14+
Once contract rules are satisfied by a BootstrapConfig implementation, other implementation details
1515
could be addressed according to the specific needs (Cluster API is not prescriptive).
1616

1717
Nevertheless, it is always recommended to take a look at Cluster API controllers,
@@ -29,7 +29,7 @@ When developing a provider, you MUST consider any Cluster API behaviour that is
2929
as a Cluster API internal implementation detail, and internal implementation details can change at any time.
3030

3131
Accordingly, in order to not expose users to the risk that your provider breaks when the Cluster API internal behavior
32-
changes, you MUST NOT rely on any Cluster API internal behaviour when implementing an BootstrapConfig resource.
32+
changes, you MUST NOT rely on any Cluster API internal behaviour when implementing a BootstrapConfig resource.
3333

3434
Instead, whenever you need something more from the Cluster API contract, you MUST engage the community.
3535

@@ -215,7 +215,7 @@ the Machine controller will surface this info in Machine's `spec.boostrap.dataSe
215215

216216
### BootstrapConfig: initialization completed
217217

218-
Each BootstrapConfig MUST report when the the bootstrap data secret is fully provisioned (initialization) by setting
218+
Each BootstrapConfig MUST report when the bootstrap data secret is fully provisioned (initialization) by setting
219219
`status.ready` in the BootstrapConfig resource.
220220

221221
```go
@@ -229,7 +229,7 @@ type FooConfigStatus struct {
229229
}
230230
```
231231

232-
Once `status.ready` the Machine "core" controller will bubbles up this info in Machine's `status.bootstrapConfigReady`;
232+
Once `status.ready` the Machine "core" controller will bubble up this info in Machine's `status.bootstrapConfigReady`;
233233
Also BootstrapConfig's `status.dataSecretName` will be surfaced on Machine's corresponding fields at the same time.
234234

235235
<aside class="note warning">

docs/book/src/developer/providers/contracts/infra-machine.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,7 @@ type FooMachineStatus struct {
293293
}
294294
```
295295

296-
Once `status.ready` the Machine "core" controller will bubbles up this info in Machine's `status.infrastructureReady`;
296+
Once `status.ready` the Machine "core" controller will bubble up this info in Machine's `status.infrastructureReady`;
297297
Also InfraMachine's `spec.providerID` and `status.addresses` will be surfaced on Machine's
298298
corresponding fields at the same time.
299299

docs/book/src/developer/providers/security-guidelines.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ There are several critical areas that any infrastructure provider implementer mu
66
- **Ensuring secure access to VMs** for troubleshooting, with proper authentication methods.
77
- **Controlling manual operations** performed on cloud infrastructure targeted by the provider.
88
- **Housekeeping** of the cloud infrastructure, ensuring timely cleanup and garbage collection of unused resources.
9-
- **Securing Machine's bootstrap data** ensuring protection oversensitive data that might be included in it.
9+
- **Securing Machine's bootstrap data** ensuring protection of oversensitive data that might be included in it.
1010

1111
The following list outlines high-level security recommendations. It is a community-maintained resource, and everyone’s contributions are essential to continuously improve and adapt these best practices. Each provider implementer is responsible for translating these recommendations to fit the context of their specific cloud provider:
1212

@@ -26,4 +26,4 @@ The following list outlines high-level security recommendations. It is a communi
2626
Any cloud resource not linked to a cluster after a fixed configurable period, created by cloud credentials, should be automatically deleted or marked for garbage collection to avoid resource sprawl.
2727

2828
6. **Securing Machine's bootstrap data**:
29-
Bootstrap data are usually stored in machine's metadata, and they might contain sensitive data, like e.g. Cluster secrets, user credentials, ssh certificates etc. It is important to ensure protections of those metadata, or if not possible, to clean up them immediately after machine bootstrap.
29+
Bootstrap data are usually stored in machine's metadata, and they might contain sensitive data, like e.g. Cluster secrets, user credentials, ssh certificates etc. It is important to ensure protection of this metadata, or if not possible, to clean it up immediately after machine bootstrap.

0 commit comments

Comments
 (0)