AWS prescriptive-guidance documentation change
Summary
Restructured document formatting by converting bold headings to plain text headings and consolidating best practice statements into single lines while removing redundant text.
Security assessment
The changes are purely structural/formatting improvements without introducing new security content. The existing 'Evaluate security features' section maintains identical recommendations about policy-as-code and compliance checks. No vulnerabilities or security incidents are addressed.
Diff
diff --git a/prescriptive-guidance/latest/eks-gitops-tools/best-practices.md b/prescriptive-guidance/latest/eks-gitops-tools/best-practices.md index f2024c5d1..93224d50f 100644 --- a//prescriptive-guidance/latest/eks-gitops-tools/best-practices.md +++ b//prescriptive-guidance/latest/eks-gitops-tools/best-practices.md @@ -11 +11 @@ This section provides considerations, tips, and best practices for choosing a Gi -**Assess your organization's needs and capabilities:** +Assess your organization's needs and capabilities: @@ -19 +19 @@ This section provides considerations, tips, and best practices for choosing a Gi -###### Best practice +Best practice: Create a detailed requirements document that outlines required features and useful, but not required, capabilities. @@ -21 +20,0 @@ This section provides considerations, tips, and best practices for choosing a Gi -Create a detailed requirements document that outlines required features and useful, but not required, capabilities. @@ -25,2 +24 @@ Create a detailed requirements document that outlines required features and usef - -**Evaluate tool maturity and adoption:** +Evaluate tool maturity and adoption: @@ -32,3 +30 @@ Create a detailed requirements document that outlines required features and usef -###### Best practice - -Prioritize tools that have been widely adopted and have a strong presence in the Cloud Native Computing Foundation (CNCF) network. +Best practice: Prioritize tools that have been widely adopted and have a strong presence in the Cloud Native Computing Foundation (CNCF) network. @@ -39 +35 @@ Prioritize tools that have been widely adopted and have a strong presence in the -**Consider integration with your existing toolchain:** +Consider integration with your existing toolchain: @@ -45 +41 @@ Prioritize tools that have been widely adopted and have a strong presence in the -###### Best practice +Best practice: Create a proof of concept to test integration capabilities before you make a final decision. @@ -47 +42,0 @@ Prioritize tools that have been widely adopted and have a strong presence in the -Create a proof of concept to test integration capabilities before you make a final decision. @@ -51,2 +46 @@ Create a proof of concept to test integration capabilities before you make a fin - -**Evaluate security features:** +Evaluate security features: @@ -58,3 +52 @@ Create a proof of concept to test integration capabilities before you make a fin -###### Best practice - -Choose a tool that supports GitOps-based security practices, including policy as code and automated compliance checks. +Best practice: Choose a tool that supports GitOps-based security practices, including policy as code and automated compliance checks. @@ -65 +57 @@ Choose a tool that supports GitOps-based security practices, including policy as -**Assess scalability and performance:** +Assess scalability and performance: @@ -71 +63 @@ Choose a tool that supports GitOps-based security practices, including policy as -###### Best practice +Best practice: Conduct performance testing with workloads that are similar to your production environment to make sure that the tool can handle your scale. @@ -73 +64,0 @@ Choose a tool that supports GitOps-based security practices, including policy as -Conduct performance testing with workloads that are similar to your production environment to make sure that the tool can handle your scale. @@ -77,2 +68 @@ Conduct performance testing with workloads that are similar to your production e - -**Consider multi-cluster and multi-environment support:** +Consider multi-cluster and multi-environment support: @@ -84,3 +74 @@ Conduct performance testing with workloads that are similar to your production e -###### Best practice - -Choose a tool that allows for centralized management of multiple clusters while maintaining environment-specific configurations. +Best practice: Choose a tool that allows for centralized management of multiple clusters while maintaining environment-specific configurations. @@ -91 +79 @@ Choose a tool that allows for centralized management of multiple clusters while -**Evaluate observability and monitoring capabilities:** +Evaluate observability and monitoring capabilities: @@ -97 +85 @@ Choose a tool that allows for centralized management of multiple clusters while -###### Best practice +Best practice: Prioritize tools that offer customizable dashboards and alerting mechanisms for proactive issue detection. @@ -99 +86,0 @@ Choose a tool that allows for centralized management of multiple clusters while -Prioritize tools that offer customizable dashboards and alerting mechanisms for proactive issue detection. @@ -103,2 +90 @@ Prioritize tools that offer customizable dashboards and alerting mechanisms for - -**Assess the learning curve and documentation:** +Assess the learning curve and documentation: @@ -110,3 +96 @@ Prioritize tools that offer customizable dashboards and alerting mechanisms for -###### Best practice - -Choose a tool that has well-maintained documentation, active community forums, and official training programs or certifications. +Best practice: Choose a tool that has well-maintained documentation, active community forums, and official training programs or certifications. @@ -117 +101 @@ Choose a tool that has well-maintained documentation, active community forums, a -**Consider cost and resource utilization:** +Consider cost and resource utilization: @@ -123 +107 @@ Choose a tool that has well-maintained documentation, active community forums, a -###### Best practice +Best practice: Perform a total cost of ownership (TCO) analysis that includes both short-term and long-term costs. @@ -125 +108,0 @@ Choose a tool that has well-maintained documentation, active community forums, a -Perform a total cost of ownership (TCO) analysis that includes both short-term and long-term costs. @@ -129,2 +112 @@ Perform a total cost of ownership (TCO) analysis that includes both short-term a - -**Evaluate flexibility and customization options:** +Evaluate flexibility and customization options: @@ -136,3 +118 @@ Perform a total cost of ownership (TCO) analysis that includes both short-term a -###### Best practice - -Choose a tool that balances default functionality with the ability to customize for your unique requirements. +Best practice: Choose a tool that balances default functionality with the ability to customize for your unique requirements. @@ -143 +123 @@ Choose a tool that balances default functionality with the ability to customize -**Assess continuous delivery and progressive deployment capabilities:** +Assess continuous delivery and progressive deployment capabilities: @@ -149 +129 @@ Choose a tool that balances default functionality with the ability to customize -###### Best practice +Best practices: Prioritize tools that offer built-in support for progressive delivery patterns to minimize risk in your deployments. @@ -151 +130,0 @@ Choose a tool that balances default functionality with the ability to customize -Prioritize tools that offer built-in support for progressive delivery patterns to minimize risk in your deployments. @@ -155,2 +134 @@ Prioritize tools that offer built-in support for progressive delivery patterns t - -**Consider vendor lock-in and portability:** +Consider vendor lock-in and portability: @@ -162,3 +140 @@ Prioritize tools that offer built-in support for progressive delivery patterns t -###### Best practice - -Favor tools that use open standards and provide export capabilities for your GitOps configurations. +Best practice: Favor tools that use open standards and provide export capabilities for your GitOps configurations. @@ -169 +145 @@ Favor tools that use open standards and provide export capabilities for your Git -**Evaluate community support and extensions:** +Evaluate community support and extensions: @@ -175 +151 @@ Favor tools that use open standards and provide export capabilities for your Git -###### Best practice +Best practice: Join community forums or user groups to get firsthand experiences from other users before you make a decision. @@ -177 +152,0 @@ Favor tools that use open standards and provide export capabilities for your Git -Join community forums or user groups to get firsthand experiences from other users before you make a decision. @@ -181,2 +156 @@ Join community forums or user groups to get firsthand experiences from other use - -**Consider compliance and audit requirements:** +Consider compliance and audit requirements: @@ -188,3 +162 @@ Join community forums or user groups to get firsthand experiences from other use -###### Best practice - -Choose a tool that provides comprehensive audit logs and supports the generation of compliance reports. +Best practice: Choose a tool that provides comprehensive audit logs and supports the generation of compliance reports. @@ -195 +167 @@ Choose a tool that provides comprehensive audit logs and supports the generation -**Assess rollback and disaster recovery capabilities:** +Assess rollback and disaster recovery capabilities: @@ -201,3 +173 @@ Choose a tool that provides comprehensive audit logs and supports the generation -###### Best practice - -Test rollback and recovery processes thoroughly as part of your evaluation. +Best practice: Test rollback and recovery processes thoroughly as part of your evaluation.