diff --git a/docs/README.md b/docs/README.md index 1c14ca0..07c071c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -10,12 +10,12 @@ The project is structured around individual best practices, each in its own file | Best Practice | Description | Link | |--------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------| | Cluster Separation | Deploy the GitOps agent in a separate Kubernetes cluster from the one it manages to protect against application-level compromises. | [Details](resources/cluster-separation/README.md) | -| Separation Of Concerns | Store Kubernetes manifests that manage GitOps agent resources in a separate repository from its application deployment files to ensure security. | [Details](resources/separation-of-concerns/README.md) | +| GitOps Manifest Segregation | Store Kubernetes manifests that manage GitOps agent resources in a separate repository from its application deployment files to ensure security. | [Details](resources/gitops-manifest-segregation/README.md) | | Network Policies Enforcement | Implement network policies to restrict access to GitOps Kubernetes resources and ensure that a CNI plugin enforces these rules correctly. | [Details](resources/network-policies-enforcement/README.md) | | Strict RBAC Policies | Enforce strict RBAC policies to ensure only authorized users can manage the GitOps system and grant appropriate permissions. | [Details](resources/strict-rbac-policies/README.md) | -| Restrict Repository Access | Keep GitOps configuration repositories private, granting access only to authorized teams or individuals. | [Details](resources/restrict-repository-access/README.md) | -| Branch Protection Rules | Implement code review requirements, CI/CD checks, and restrict access to critical branches on the GitOps repository to control deployments. | [Details](resources/branch-protection-rules/README.md) | -| Use Password Management Tool | Store sensitive data in a proper secret management tool rather than in plaintext. | [Details](resources/use-password-management-tool/README.md) | +| Restricted Repository Access | Keep GitOps configuration repositories private, granting access only to authorized teams or individuals. | [Details](resources/restricted-repository-access/README.md) | +| Branch Protection | Implement code review requirements, CI/CD checks, and restrict access to critical branches on the GitOps repository to control deployments. | [Details](resources/branch-protection/README.md) | +| Secure Secret Storage | Store sensitive data in a proper secret management tool rather than in plaintext. | [Details](resources/secure-secret-storage/README.md) | | SLSA Provenance Verification | Verify the SLSA provenance from GitOps suppliers (e.g., ArgoCD’s signed SLSA provenance) to ensure the integrity of GitOps deployments. | [Details](resources/slsa-provenance-verification/README.md) | diff --git a/docs/resources/branch-protection-rules/README.md b/docs/resources/branch-protection/README.md similarity index 95% rename from docs/resources/branch-protection-rules/README.md rename to docs/resources/branch-protection/README.md index a1096ec..3f31956 100644 --- a/docs/resources/branch-protection-rules/README.md +++ b/docs/resources/branch-protection/README.md @@ -1,10 +1,10 @@ --- -slug: /branchProtectionRules -id: branchProtectionRules -sidebar_position: 5 +slug: /branchProtection +id: branchProtection +sidebar_position: 6 --- -# Branch Protection Rules +# Branch Protection ## Overview diff --git a/docs/resources/separation-of-concerns/README.md b/docs/resources/gitops-manifest-segregation/README.md similarity index 95% rename from docs/resources/separation-of-concerns/README.md rename to docs/resources/gitops-manifest-segregation/README.md index c0ee9d4..0d00e61 100644 --- a/docs/resources/separation-of-concerns/README.md +++ b/docs/resources/gitops-manifest-segregation/README.md @@ -1,10 +1,10 @@ --- -slug: /separatingConfig -id: separatingConfig -sidebar_position: 6 +slug: /gitOpsManifestSegregation +id: gitOpsManifestSegregation +sidebar_position: 2 --- -# Separation Of Concerns +# GitOps Manifest Segregation ## Overview Separate the GitOps Kubernetes configurations (e.g., manifests) into a dedicated Git repository, distinct from your GitOps managed application source code. Isolating application configuration from the codebase enhances deployment control, simplifies auditing, and prevents unintended CI/CD pipeline triggers due to minor configuration changes. diff --git a/docs/resources/network-policies-enforcement/README.md b/docs/resources/network-policies-enforcement/README.md index bd4669a..773a50d 100644 --- a/docs/resources/network-policies-enforcement/README.md +++ b/docs/resources/network-policies-enforcement/README.md @@ -1,7 +1,7 @@ --- slug: /networkPoliciesEnforcement id: networkPoliciesEnforcement -sidebar_position: 2 +sidebar_position: 3 --- # Network Policies Enforcement diff --git a/docs/resources/restrict-repository-access/README.md b/docs/resources/restricted-repository-access/README.md similarity index 92% rename from docs/resources/restrict-repository-access/README.md rename to docs/resources/restricted-repository-access/README.md index c6c43cb..247a301 100644 --- a/docs/resources/restrict-repository-access/README.md +++ b/docs/resources/restricted-repository-access/README.md @@ -1,11 +1,11 @@ --- -slug: /restrictRepositoryAccess -id: restrictRepositoryAccess -sidebar_position: 4 +slug: /restrictedRepositoryAccess +id: restrictedRepositoryAccess +sidebar_position: 5 --- -# Restrict Repository Access +# Restricted Repository Access ## Overview In a GitOps workflow, repositories that store Kubernetes manifests, Helm charts, and other configuration files are essential for managing infrastructure. These repositories should be kept private, with access strictly limited to authorized individuals or teams. Allowing outside collaborators or broad access increases the risk of unauthorized changes, whether accidental or malicious. diff --git a/docs/resources/use-password-management-tool/README.md b/docs/resources/secure-secret-storage/README.md similarity index 97% rename from docs/resources/use-password-management-tool/README.md rename to docs/resources/secure-secret-storage/README.md index dd05723..aecd887 100644 --- a/docs/resources/use-password-management-tool/README.md +++ b/docs/resources/secure-secret-storage/README.md @@ -1,10 +1,10 @@ --- -slug: /passwordManagement -id: passwordManagement +slug: /secureSecretStorage +id: secureSecretStorage sidebar_position: 7 --- -# Use Password Management Tool +# Secure Secret Storage ## Overview