Skip to content

Commit e2fc595

Browse files
More feedback
1 parent 79f762d commit e2fc595

File tree

4 files changed

+83
-66
lines changed

4 files changed

+83
-66
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Among those rules:
1515
- InfraCluster SHOULD report [conditions](../../providers/contracts/infra-cluster.md#infracluster-conditions)
1616
- InfraCluster SHOULD report [terminal failures](../../providers/contracts/infra-cluster.md#infracluster-terminal-failures)
1717

18-
Similarly, the in order to support different solutions for control plane management, The Cluster resource references
18+
Similarly, in order to support different solutions for control plane management, The Cluster resource references
1919
an ControlPlane object, e.g. KubeadmControlPlane, EKSControlPlane etc.
2020

2121
The [ControlPlane resource contract](../../providers/contracts/control-plane.md) defines a set of rules a provider is expected to comply in order to allow
@@ -26,7 +26,7 @@ Considering all the info above, the Cluster controller's main responsibilities a
2626
* Setting an OwnerReference on the infrastructure object referenced in `Cluster.spec.infrastructureRef`.
2727
* Setting an OwnerReference on the control plane object referenced in `Cluster.spec.controlPlaneRef`.
2828
* Keeping the Cluster's status in sync with the InfraCluster and ControlPlane's status.
29-
* Creating a kubeconfig secret for [workload clusters](../../../reference/glossary.md#workload-cluster).
29+
* If no ControlPlane object is referenced, create a kubeconfig secret for [workload clusters](../../../reference/glossary.md#workload-cluster).
3030
* Cleanup of all owned objects so that nothing is dangling after deletion.
3131

3232
![](../../../images/cluster-admission-cluster-controller.png)

docs/book/src/developer/providers/best-practices.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ However, some best practice are worth to notice:
88
convention that directly links to the Kubernetes resource that originated those objects.
99
Please note that in most cases external constraints might impact this decision, like e.g.
1010
- differences in naming conversions from Kubernetes CRDs and the target infrastructure
11-
- the fact that the InfraCluster Kubernetes is namespaces while target infrastructure might have different approaches
11+
- the fact that the InfraCluster Kubernetes is namespaced while target infrastructure might have different approaches
1212
to grouping resources
1313

1414
- Naming convention above should not be used and advertised as a contract to build on top. Instead more robust mechanism
@@ -28,9 +28,9 @@ However, some best practice are worth to notice:
2828
- [Testing]
2929
- [Developing E2E tests]
3030

31-
- While standard security practice for developing Kubernetes controllers applies, it is important to recognize that
31+
- While standard security practices for developing Kubernetes controllers apply, it is important to recognize that
3232
given that infrastructure provider deal with cloud credentials and cloud infrastructure, there are additional critical
33-
security concern that must address to ensure secure operations. See:
33+
security concern that must be addressed to ensure secure operations. See:
3434
- [Infrastructure Provider Security Guidance]
3535

3636
[Rapid iterative development with Tilt]: ../core/tilt.md

0 commit comments

Comments
 (0)