Skip to content

Commit 1afb080

Browse files
authored
Merge pull request #12139 from tobschli/doc-fix
📖 fix small inconsistencies in documentation
2 parents f71ab37 + 79afd83 commit 1afb080

File tree

3 files changed

+3
-2
lines changed

3 files changed

+3
-2
lines changed

docs/book/src/developer/providers/contracts/control-plane.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ each Cluster, the host and port of the generated control plane endpoint MUST sur
234234
in the ControlPlane resource.
235235

236236
```go
237-
type FooControlPlane struct {
237+
type FooControlPlaneSpec struct {
238238
// controlPlaneEndpoint represents the endpoint used to communicate with the control plane.
239239
// +optional
240240
ControlPlaneEndpoint APIEndpoint `json:"controlPlaneEndpoint"`
@@ -724,6 +724,7 @@ The kubeconfig secret MUST:
724724
- Have type `cluster.x-k8s.io/secret`
725725
- Be labelled with the key-pair `cluster.x-k8s.io/cluster-name=${CLUSTER_NAME}`.
726726
Note: this label is required for the secret to be retrievable in the cache used by CAPI managers.
727+
- Have the base64 encoded kubeconfig in the field called `value`
727728

728729
Important! If a control plane provider uses client certificates for authentication in these Kubeconfigs, the client certificate
729730
MUST be kept with a reasonably short expiration period and periodically regenerated to keep a valid set of credentials available.

docs/book/src/images/cluster-admission-machinepool-controller.plantuml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ endif
2525
#LightBlue:Patch MachinePool back to API server;
2626
repeat while (Reconcile returned RequeueError?) is (yes)
2727
if (Reconcile returned error) then (yes)
28-
#Pink:Error reconciling control plane;
28+
#Pink:Error reconciling MachinePool;
2929
else (no)
3030
endif
3131
stop
71 Bytes
Loading

0 commit comments

Comments
 (0)