Skip to content

Commit

Permalink
📖 infrastructure provider security guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
NareshKoduru committed Sep 3, 2024
1 parent 7062ab0 commit 376caae
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/book/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@
- [Diagnostics](./tasks/diagnostics.md)
- [Security Guidelines](./security/index.md)
- [Pod Security Standards](./security/pod-security-standards.md)
- [Infrastructure Provider Security Guidance](./security/infrastructure-provider-security-guidance.md)
- [clusterctl CLI](./clusterctl/overview.md)
- [clusterctl Commands](clusterctl/commands/commands.md)
- [init](clusterctl/commands/init.md)
Expand Down
4 changes: 4 additions & 0 deletions docs/book/src/developer/providers/cluster-infrastructure.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,3 +187,7 @@ Note, the write permissions allow the `Cluster` controller to set owner referenc
"infrastructure cluster" resources; they are not used for general mutations of these resources.

[aggregation label]: https://kubernetes.io/docs/reference/access-authn-authz/rbac/#aggregated-clusterroles

## Security Guidelines

Please refer to [Infrastructure Provider Security Guidance](../../security/infrastructure-provider-security-guidance.md).
4 changes: 4 additions & 0 deletions docs/book/src/developer/providers/machine-infrastructure.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,3 +209,7 @@ Note, the write permissions allow the `Machine` controller to set owner referenc
"infrastructure machine" resources; they are not used for general mutations of these resources.

[aggregation label]: https://kubernetes.io/docs/reference/access-authn-authz/rbac/#aggregated-clusterroles

## Security Guidelines

Please refer to [Infrastructure Provider Security Guidance](../../security/infrastructure-provider-security-guidance.md).
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Infrastructure Provider Security Guidance

- Ensure credentials used by Cluster API are least privileged and setting access control
on Cluster API controller namespaces to prevent unauthorized access by anyone other
than cloud admin.
- Implement 2FA for all maintainer accounts on Github. Apply the second pair of eyes
principle when performing privileged actions such as image building or updates to the
contents of the machine images.
- Use short-lived credentials that are auto-renewed using node level attestation.
- Implement rate limits for creation, deletion and update of cloud resources.
- Any cloud resource not linked to a cluster after a fixed configurable period of time
created by these cloud credentials, should be auto-deleted or marked for garbage collection.

0 comments on commit 376caae

Please sign in to comment.