chore: Group patterns under sub-directory to reduce length of sidebar…

… nav and better co-locate patterns by some categorization (#1997)
aws-ia · Aug 15, 2024 · ca7c0da · ca7c0da
1 parent 5ddc581
commit ca7c0da
Show file tree

Hide file tree

Showing 37 changed files with 138 additions and 122 deletions.
diff --git a/.github/workflows/markdown-link-check.yml b/.github/workflows/markdown-link-check.yml
@@ -28,9 +28,9 @@ jobs:
       - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332
       - uses: actions/setup-node@v4
         with:
-          node-version: '16.x'
+          node-version: '20.x'
       - name: install markdown-link-check
-        run: npm install -g markdown-link-check@3.10.2
+        run: npm install -g markdown-link-check@3.12.2
       - name: markdown-link-check version
         run: npm list -g markdown-link-check
       - name: Run markdown-link-check on MD files

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,11 +1,11 @@
 repos:
   - repo: https://github.com/streetsidesoftware/cspell-cli
-    rev: v8.10.0
+    rev: v8.13.3
     hooks:
       - id: cspell
         args: [--exclude, 'ADOPTERS.md', --exclude, '.pre-commit-config.yaml', --exclude, '.gitignore', --exclude, '*.drawio', --exclude, 'mkdocs.yml', --exclude, '.helmignore', --exclude, '.github/workflows/*', --exclude, 'patterns/istio-multi-cluster/*', --exclude, 'patterns/blue-green-upgrade/*']
   - repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
-    rev: v2.13.0
+    rev: v2.14.0
     hooks:
       - id: pretty-format-yaml
         args: [--autofix, --indent, '2', --offset, '2', --preserve-quotes]
@@ -19,7 +19,7 @@ repos:
       - id: detect-aws-credentials
         args: [--allow-missing-credentials]
   - repo: https://github.com/antonbabenko/pre-commit-terraform
-    rev: v1.92.0
+    rev: v1.92.1
     hooks:
       - id: terraform_fmt
       - id: terraform_docs

diff --git a/docs/patterns/.pages b/docs/patterns/.pages
@@ -0,0 +1,19 @@
+nav:
+  - Agones Game Controller: agones-game-controller.md
+  - Blue/Green Upgrade: blue-green-upgrade.md
+  - Bottlerocket: bottlerocket.md
+  - ECR Pull Through Cache: ecr-pull-through-cache.md
+  - External Secrets: external-secrets.md
+  - Fargate Serverless: fargate-serverless.md
+  - Fully Private Cluster: fully-private-cluster.md
+  - GitOps: gitops
+  - Istio: istio.md
+  - Karpenter on EKS Fargate: karpenter.md
+  - Karpenter on EKS MNG: karpenter-mng.md
+  - Kubecost: kubecost.md
+  - Machine Learning: machine-learning
+  - Multi-tenancy: multi-tenancy-with-teams.md
+  - Network: network
+  - SSO - IAM Identity Center: sso-iam-identity-center.md
+  - SSO - Okta: sso-okta.md
+  - Stateful: stateful.md
diff --git a/docs/patterns/aws-vpc-cni-network-policy.md b/docs/patterns/aws-vpc-cni-network-policy.md
diff --git a/docs/patterns/bottlerocket.md b/docs/patterns/bottlerocket.md
@@ -1,5 +1,5 @@
 ---
-title: Bottlerocket 
+title: Bottlerocket
 ---
 
 {%

diff --git a/docs/patterns/gitops-getting-started-argocd.md b/docs/patterns/gitops-getting-started-argocd.md
diff --git a/docs/patterns/gitops-multi-cluster-hub-spoke-argocd.md b/docs/patterns/gitops-multi-cluster-hub-spoke-argocd.md
diff --git a/docs/patterns/gitops/gitops-getting-started-argocd.md b/docs/patterns/gitops/gitops-getting-started-argocd.md
@@ -0,0 +1,7 @@
+---
+title: ArgoCD - Getting Started
+---
+
+{%
+   include-markdown "../../../patterns/gitops/getting-started-argocd/README.md"
+%}
diff --git a/docs/patterns/gitops/gitops-multi-cluster-hub-spoke-argocd.md b/docs/patterns/gitops/gitops-multi-cluster-hub-spoke-argocd.md
@@ -0,0 +1,7 @@
+---
+title: ArgoCD - Multi-Cluster Hub & Spoke
+---
+
+{%
+   include-markdown "../../../patterns/gitops/multi-cluster-hub-spoke-argocd/README.md"
+%}
diff --git a/docs/patterns/ipv6-eks-cluster.md b/docs/patterns/ipv6-eks-cluster.md
diff --git a/docs/patterns/machine-learning/ml-capacity-block.md b/docs/patterns/machine-learning/ml-capacity-block.md
@@ -0,0 +1,7 @@
+---
+title: ML Capacity Block Reservation (CBR)
+---
+
+{%
+   include-markdown "../../../patterns/ml-capacity-block/README.md"
+%}
diff --git a/docs/patterns/machine-learning/nvidia-gpu-efa.md b/docs/patterns/machine-learning/nvidia-gpu-efa.md
@@ -0,0 +1,7 @@
+---
+title: NVIDIA GPUs with EFA
+---
+
+{%
+   include-markdown "../../../patterns/nvidia-gpu-efa/README.md"
+%}
diff --git a/docs/patterns/targeted-odcr.md → ...atterns/machine-learning/targeted-odcr.md b/docs/patterns/targeted-odcr.md → ...atterns/machine-learning/targeted-odcr.md
@@ -3,5 +3,5 @@ title: Targeted On-Demand Capacity Reservation (ODCR)
 ---
 
 {%
-   include-markdown "../../patterns/targeted-odcr/README.md"
+   include-markdown "../../../patterns/targeted-odcr/README.md"
 %}
diff --git a/docs/patterns/ml-capacity-block.md b/docs/patterns/ml-capacity-block.md
diff --git a/docs/patterns/network/aws-vpc-cni-network-policy.md b/docs/patterns/network/aws-vpc-cni-network-policy.md
@@ -0,0 +1,7 @@
+---
+title: AWS VPC CNI Network Policy
+---
+
+{%
+   include-markdown "../../../patterns/aws-vpc-cni-network-policy/README.md"
+%}
diff --git a/...pc-lattice/client-server-communication.md → ...ns/network/client-server-communication.md b/...pc-lattice/client-server-communication.md → ...ns/network/client-server-communication.md
diff --git a/...attice/cross-cluster-pod-communication.md → ...etwork/cross-cluster-pod-communication.md b/...attice/cross-cluster-pod-communication.md → ...etwork/cross-cluster-pod-communication.md
diff --git a/docs/patterns/network/ipv6-eks-cluster.md b/docs/patterns/network/ipv6-eks-cluster.md
@@ -0,0 +1,7 @@
+---
+title: IPv6 Networking
+---
+
+{%
+   include-markdown "../../../patterns/ipv6-eks-cluster/README.md"
+%}
diff --git a/docs/patterns/network/private-public-ingress.md b/docs/patterns/network/private-public-ingress.md
@@ -0,0 +1,7 @@
+---
+title: Private and Public Ingress
+---
+
+{%
+   include-markdown "../../../patterns/private-public-ingress/README.md"
+%}
diff --git a/docs/patterns/network/privatelink-access.md b/docs/patterns/network/privatelink-access.md
@@ -0,0 +1,7 @@
+---
+title: PrivateLink Access
+---
+
+{%
+   include-markdown "../../../patterns/privatelink-access/README.md"
+%}
diff --git a/docs/patterns/network/tls-with-aws-pca-issuer.md b/docs/patterns/network/tls-with-aws-pca-issuer.md
@@ -0,0 +1,7 @@
+---
+title: TLS w/ AWS PCA Issuer
+---
+
+{%
+   include-markdown "../../../patterns/tls-with-aws-pca-issuer/README.md"
+%}
diff --git a/docs/patterns/network/vpc-lattice.md b/docs/patterns/network/vpc-lattice.md
@@ -0,0 +1,7 @@
+---
+title: VPC lattice
+---
+
+{%
+   include-markdown "../../../patterns/vpc-lattice/README.md"
+%}
diff --git a/docs/patterns/network/wireguard-with-cilium.md b/docs/patterns/network/wireguard-with-cilium.md
@@ -0,0 +1,7 @@
+---
+title: Wireguard /w Cilium
+---
+
+{%
+   include-markdown "../../../patterns/wireguard-with-cilium/README.md"
+%}
diff --git a/docs/patterns/nvidia-gpu-efa.md b/docs/patterns/nvidia-gpu-efa.md
diff --git a/docs/patterns/private-public-ingress.md b/docs/patterns/private-public-ingress.md
diff --git a/docs/patterns/privatelink-access.md b/docs/patterns/privatelink-access.md
diff --git a/docs/patterns/tls-with-aws-pca-issuer.md b/docs/patterns/tls-with-aws-pca-issuer.md
diff --git a/docs/patterns/vpc-lattice.md b/docs/patterns/vpc-lattice.md
diff --git a/docs/patterns/wireguard-with-cilium.md b/docs/patterns/wireguard-with-cilium.md
diff --git a/patterns/bottlerocket/karpenter-resources/templates/ec2nodeclass.yaml b/patterns/bottlerocket/karpenter-resources/templates/ec2nodeclass.yaml
@@ -25,4 +25,4 @@ spec:
         encrypted: true
         kmsKeyID: {{ .Values.ec2nodeclass.blockDeviceMappings.ebs.kmsKeyID }}
         deleteOnTermination: true
-        volumeSize: 20Gi
+        volumeSize: 20Gi
diff --git a/patterns/bottlerocket/karpenter-resources/templates/nodepool.yaml b/patterns/bottlerocket/karpenter-resources/templates/nodepool.yaml
@@ -44,4 +44,4 @@ spec:
       - key: kubernetes.io/os
         operator: In
         values:
-        - linux
+        - linux
diff --git a/patterns/bottlerocket/karpenter-resources/values.yaml b/patterns/bottlerocket/karpenter-resources/values.yaml
@@ -4,10 +4,10 @@ ec2nodeclass:
   role: ""
   securityGroupSelectorTerms:
     tags:
-       karpenter.sh/discovery: ""
+      karpenter.sh/discovery: ""
   subnetSelectorTerms:
     tags:
-       karpenter.sh/discovery: ""
+      karpenter.sh/discovery: ""
   blockDeviceMappings:
     ebs:
       kmsKeyID: ""

diff --git a/patterns/ecr-pull-through-cache/addons.tf b/patterns/ecr-pull-through-cache/addons.tf
@@ -1,5 +1,5 @@
 locals {
-  ecr_url        = "${data.aws_caller_identity.current.account_id}.dkr.ecr.${local.region}.amazonaws.com"
+  ecr_url = "${data.aws_caller_identity.current.account_id}.dkr.ecr.${local.region}.amazonaws.com"
 }
 
 module "eks_blueprints_addons" {