Skip to content

Commit

Permalink
More feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
fabriziopandini committed Sep 23, 2024
1 parent 79f762d commit e2fc595
Show file tree
Hide file tree
Showing 4 changed files with 83 additions and 66 deletions.
4 changes: 2 additions & 2 deletions docs/book/src/developer/core/controllers/cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Among those rules:
- InfraCluster SHOULD report [conditions](../../providers/contracts/infra-cluster.md#infracluster-conditions)
- InfraCluster SHOULD report [terminal failures](../../providers/contracts/infra-cluster.md#infracluster-terminal-failures)

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

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

![](../../../images/cluster-admission-cluster-controller.png)
Expand Down
6 changes: 3 additions & 3 deletions docs/book/src/developer/providers/best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ However, some best practice are worth to notice:
convention that directly links to the Kubernetes resource that originated those objects.
Please note that in most cases external constraints might impact this decision, like e.g.
- differences in naming conversions from Kubernetes CRDs and the target infrastructure
- the fact that the InfraCluster Kubernetes is namespaces while target infrastructure might have different approaches
- the fact that the InfraCluster Kubernetes is namespaced while target infrastructure might have different approaches
to grouping resources

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

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

[Rapid iterative development with Tilt]: ../core/tilt.md
Expand Down
Loading

0 comments on commit e2fc595

Please sign in to comment.