Skip to content

Commit 7bb4e70

Browse files
authored
chore: Update mkdocs CD deploy to use standard mkdocs without versioning (aws-ia#1760)
1 parent 2d96b78 commit 7bb4e70

File tree

24 files changed

+37
-48
lines changed

24 files changed

+37
-48
lines changed

.github/workflows/publish-docs.yml

+4-14
Original file line numberDiff line numberDiff line change
@@ -35,23 +35,13 @@ jobs:
3535
- name: Install dependencies
3636
run: |
3737
python -m pip install --upgrade pip
38-
pip install mike==1.1.2 \
39-
mkdocs-material==9.1.19 \
40-
mkdocs-include-markdown-plugin==4.0.4 \
41-
mkdocs-awesome-pages-plugin==2.9.1
38+
python -m pip install mkdocs-material==9.3.1 \
39+
mkdocs-include-markdown-plugin==6.0.1 \
40+
mkdocs-awesome-pages-plugin==2.9.2
4241
4342
- name: git config
4443
run: |
4544
git config --local user.email "[email protected]"
4645
git config --local user.name "GitHub Action"
4746
48-
- name: mike deploy main
49-
if: contains(github.ref, 'refs/heads/main')
50-
run: |
51-
mike deploy --push main
52-
53-
- name: mike deploy new version
54-
if: contains(github.ref, 'refs/tags/v') && !github.event.release.prerelease
55-
run: |
56-
VERSION=${GITHUB_REF/refs\/tags\//}
57-
mike deploy --rebase --push --update-aliases "${VERSION}" latest
47+
- run: mkdocs gh-deploy --force

.pre-commit-config.yaml

-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ repos:
2929
- '--args=--only=terraform_naming_convention'
3030
- '--args=--only=terraform_required_version'
3131
- '--args=--only=terraform_required_providers'
32-
- '--args=--only=terraform_standard_module_structure'
3332
- '--args=--only=terraform_workspace_remote'
3433
- id: terraform_validate
3534
exclude: (docs|modules)

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ order to avoid confusion around the consumption model.
4545
However, we do have a number of Terraform modules that were created to support
4646
EKS Blueprints in addition to the community hosted modules. Please see the respective projects for more
4747
details on the modules constructed to support EKS Blueprints for Terraform; those projects are listed
48-
[below](https://aws-ia.github.io/terraform-aws-eks-blueprints/main/#related-projects).
48+
[below](https://aws-ia.github.io/terraform-aws-eks-blueprints/#related-projects).
4949

5050
- [`terraform-aws-eks-blueprint-addon`](https://github.com/aws-ia/terraform-aws-eks-blueprints-addon) -
5151
(Note the singular form) Terraform module which can provision an addon using the Terraform
@@ -108,7 +108,7 @@ EKS Blueprints for Terraform does not have an opinion in this matter and will de
108108
Therefore, we do not provide variables and outputs to expose various levels of configuration for the examples.
109109
Users can modify the pattern locally after cloning to suite their requirements.
110110

111-
4. Please see the [FAQ section](https://aws-ia.github.io/terraform-aws-eks-blueprints/main/faq/#provider-authentication)
111+
4. Please see the [FAQ section](https://aws-ia.github.io/terraform-aws-eks-blueprints/faq/#provider-authentication)
112112
on authenticating Kubernetes based providers (`kubernetes`, `helm`, `kubectl`) to Amazon EKS clusters
113113
regarding the use of static tokens versus dynamic tokens using the `awscli`.
114114

docs/_partials/destroy.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ terraform destroy -target="module.eks" -auto-approve
44
terraform destroy -auto-approve
55
```
66

7-
See [here](https://aws-ia.github.io/terraform-aws-eks-blueprints/main/getting-started/#destroy) for more details on cleaning up the resources created.
7+
See [here](https://aws-ia.github.io/terraform-aws-eks-blueprints/getting-started/#destroy) for more details on cleaning up the resources created.

docs/getting-started.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Ensure that you have installed the following tools locally:
1212

1313
## Deploy
1414

15-
1. For consuming EKS Blueprints, please see the [Consumption](https://aws-ia.github.io/terraform-aws-eks-blueprints/main/#consumption) section. For exploring and trying out the patterns provided, please
15+
1. For consuming EKS Blueprints, please see the [Consumption](https://aws-ia.github.io/terraform-aws-eks-blueprints/#consumption) section. For exploring and trying out the patterns provided, please
1616
clone the project locally to quickly get up and running with a pattern. After cloning the project locally, `cd` into the pattern
1717
directory of your choice.
1818

@@ -28,7 +28,7 @@ directory of your choice.
2828
For patterns that deviate from this general flow, see the pattern's respective `REAMDE.md` for more details.
2929
3030
!!! info "Terraform targetted apply"
31-
Please see the [Terraform Caveats](https://aws-ia.github.io/terraform-aws-eks-blueprints/main/#terraform-caveats) section for details on the use of targeted Terraform apply's
31+
Please see the [Terraform Caveats](https://aws-ia.github.io/terraform-aws-eks-blueprints/#terraform-caveats) section for details on the use of targeted Terraform apply's
3232

3333
3. Once all of the resources have successfully been provisioned, the following command can be used to update the `kubeconfig`
3434
on your local machine and allow you to interact with your EKS Cluster using `kubectl`.

patterns/agones-game-controller/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ through the details of deploying EKS Cluster using eksctl and deploy Agones with
2121

2222
## Deploy
2323

24-
See [here](https://aws-ia.github.io/terraform-aws-eks-blueprints/main/getting-started/#prerequisites) for the prerequisites and steps to deploy this pattern.
24+
See [here](https://aws-ia.github.io/terraform-aws-eks-blueprints/getting-started/#prerequisites) for the prerequisites and steps to deploy this pattern.
2525

2626
## Validate
2727

patterns/appmesh-mtls/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This pattern demonstrates how to deploy and configure AppMesh mTLS on an Amazon
44

55
## Deploy
66

7-
See [here](https://aws-ia.github.io/terraform-aws-eks-blueprints/main/getting-started/#prerequisites) for the prerequisites and steps to deploy this pattern.
7+
See [here](https://aws-ia.github.io/terraform-aws-eks-blueprints/getting-started/#prerequisites) for the prerequisites and steps to deploy this pattern.
88

99
## Validate
1010

patterns/argocd/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This pattern demonstrates an EKS cluster that uses ArgoCD for application deploy
88

99
## Deploy
1010

11-
See [here](https://aws-ia.github.io/terraform-aws-eks-blueprints/main/getting-started/#prerequisites) for the prerequisites and steps to deploy this pattern.
11+
See [here](https://aws-ia.github.io/terraform-aws-eks-blueprints/getting-started/#prerequisites) for the prerequisites and steps to deploy this pattern.
1212

1313
## Validate
1414

patterns/blue-green-upgrade/modules/eks_cluster/README.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -32,25 +32,25 @@ The AWS resources created by the script are detailed bellow:
3232
- ecsdemo-nodejs
3333
- ecsdemo-crystal
3434
- Kubernetes addon deployed with Terraform
35-
- [ArgoCD](https://aws-ia.github.io/terraform-aws-eks-blueprints/main/add-ons/argocd/)
35+
- ArgoCD
3636
- to deploy additional addons
3737
- to deploy our demo workloads
3838
- configured to be exposed through a service loadbalancer (for testing)
39-
- [EKS Managed Add-ons](https://aws-ia.github.io/terraform-aws-eks-blueprints/add-ons/managed-add-ons/)
39+
- EKS Managed Add-ons
4040
- CoreDNS
4141
- Kube Proxy
4242
- VPC CNI
4343
- EBS CSI Driver
4444
- Kubernetes addon deployed half with terraform and half with dedicated [ArgoCD addon repo](https://github.com/aws-samples/eks-blueprints-add-ons)
45-
- [Metrics server](https://aws-ia.github.io/terraform-aws-eks-blueprints/main/add-ons/metrics-server/)
46-
- [Vertical Pod Autoscaler](https://aws-ia.github.io/terraform-aws-eks-blueprints/main/add-ons/vpa/)
47-
- [Aws Load Balancer Controller](https://aws-ia.github.io/terraform-aws-eks-blueprints/main/add-ons/aws-load-balancer-controller/)
48-
- [Karpenter](https://aws-ia.github.io/terraform-aws-eks-blueprints/main/add-ons/karpenter/)
49-
- [External DNS](https://aws-ia.github.io/terraform-aws-eks-blueprints/main/add-ons/external-dns/)
45+
- Metrics server
46+
- Vertical Pod Autoscaler
47+
- Aws Load Balancer Controller
48+
- Karpenter
49+
- External DNS
5050
- configured to target the environment infrastructure Hosted Zone
51-
- [AWS for FluentBit](https://aws-ia.github.io/terraform-aws-eks-blueprints/main/add-ons/aws-for-fluent-bit/) to centralized logs in Amazon CloudWatch
52-
- [AWS CloudWatch Metrics](https://aws-ia.github.io/terraform-aws-eks-blueprints/main/add-ons/aws-cloudwatch-metrics/) to enable [Container Insight](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContainerInsights.html)
53-
- [Kubecost](https://aws-ia.github.io/terraform-aws-eks-blueprints/main/add-ons/kubecost/)
51+
- AWS for FluentBit
52+
- AWS CloudWatch Metrics
53+
- Kubecost
5454
- Kubernetes workloads (defined in a dedicated github repository repository)
5555
- team-burnham
5656
- burnham-ingress configured with weighted target groups

patterns/elastic-fabric-adapter/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This pattern demonstrates an Amazon EKS Cluster with an EFA-enabled nodegroup.
44

55
## Deploy
66

7-
See [here](https://aws-ia.github.io/terraform-aws-eks-blueprints/main/getting-started/#prerequisites) for the prerequisites and steps to deploy this pattern.
7+
See [here](https://aws-ia.github.io/terraform-aws-eks-blueprints/getting-started/#prerequisites) for the prerequisites and steps to deploy this pattern.
88

99
## Validate
1010

patterns/external-secrets/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ store is also created. Both stores use IRSA to retrieve the secret values from A
77

88
## Deploy
99

10-
See [here](https://aws-ia.github.io/terraform-aws-eks-blueprints/main/getting-started/#prerequisites) for the prerequisites and steps to deploy this pattern.
10+
See [here](https://aws-ia.github.io/terraform-aws-eks-blueprints/getting-started/#prerequisites) for the prerequisites and steps to deploy this pattern.
1111

1212
## Validate
1313

patterns/fargate-serverless/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This pattern demonstrates an Amazon EKS Cluster that utilizes Fargate profiles f
44

55
## Deploy
66

7-
See [here](https://aws-ia.github.io/terraform-aws-eks-blueprints/main/getting-started/#prerequisites) for the prerequisites and steps to deploy this pattern.
7+
See [here](https://aws-ia.github.io/terraform-aws-eks-blueprints/getting-started/#prerequisites) for the prerequisites and steps to deploy this pattern.
88

99
## Validate
1010

patterns/fully-private-cluster/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ If you are using an existing VPC then you may need to ensure these endpoints are
2424

2525
## Deploy
2626

27-
See [here](https://aws-ia.github.io/terraform-aws-eks-blueprints/main/getting-started/#prerequisites) for the prerequisites and steps to deploy this pattern.
27+
See [here](https://aws-ia.github.io/terraform-aws-eks-blueprints/getting-started/#prerequisites) for the prerequisites and steps to deploy this pattern.
2828

2929
## Validate
3030

patterns/ipv6-eks-cluster/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This pattern demonstrates an EKS cluster that utilizes IPv6 networking.
44

55
## Deploy
66

7-
See [here](https://aws-ia.github.io/terraform-aws-eks-blueprints/main/getting-started/#prerequisites) for the prerequisites and steps to deploy this pattern.
7+
See [here](https://aws-ia.github.io/terraform-aws-eks-blueprints/getting-started/#prerequisites) for the prerequisites and steps to deploy this pattern.
88

99
## Validate
1010

patterns/istio/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ concepts.
1414

1515
## Deploy
1616

17-
See [here](https://aws-ia.github.io/terraform-aws-eks-blueprints/main/getting-started/#prerequisites) for the prerequisites and steps to deploy this pattern.
17+
See [here](https://aws-ia.github.io/terraform-aws-eks-blueprints/getting-started/#prerequisites) for the prerequisites and steps to deploy this pattern.
1818

1919
### Observability Add-ons
2020

patterns/karpenter/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This pattern demonstrates how to provision Karpenter on a serverless cluster (se
44

55
## Deploy
66

7-
See [here](https://aws-ia.github.io/terraform-aws-eks-blueprints/main/getting-started/#prerequisites) for the prerequisites and steps to deploy this pattern.
7+
See [here](https://aws-ia.github.io/terraform-aws-eks-blueprints/getting-started/#prerequisites) for the prerequisites and steps to deploy this pattern.
88

99
## Validate
1010

patterns/multi-tenancy-with-teams/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This example solution provides:
99

1010
## Deploy
1111

12-
See [here](https://aws-ia.github.io/terraform-aws-eks-blueprints/main/getting-started/#prerequisites) for the prerequisites and steps to deploy this pattern.
12+
See [here](https://aws-ia.github.io/terraform-aws-eks-blueprints/getting-started/#prerequisites) for the prerequisites and steps to deploy this pattern.
1313

1414
## Validate
1515

patterns/private-public-ingress/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Refer to the [documentation](https://kubernetes-sigs.github.io/aws-load-balancer
1313

1414
## Deploy
1515

16-
See [here](https://aws-ia.github.io/terraform-aws-eks-blueprints/main/getting-started/#prerequisites) for the prerequisites and steps to deploy this pattern.
16+
See [here](https://aws-ia.github.io/terraform-aws-eks-blueprints/getting-started/#prerequisites) for the prerequisites and steps to deploy this pattern.
1717

1818
## Validate
1919

patterns/privatelink-access/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ for further details on `AWS PrivateLink`.
77

88
## Deploy
99

10-
See [here](https://aws-ia.github.io/terraform-aws-eks-blueprints/main/getting-started/#prerequisites) for the prerequisites and steps to deploy this pattern.
10+
See [here](https://aws-ia.github.io/terraform-aws-eks-blueprints/getting-started/#prerequisites) for the prerequisites and steps to deploy this pattern.
1111

1212
## Validate
1313

patterns/sso-iam-identity-center/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This example demonstrates how to deploy an Amazon EKS cluster that is deployed o
44

55
## Deploy
66

7-
See [here](https://aws-ia.github.io/terraform-aws-eks-blueprints/main/getting-started/#prerequisites) for the prerequisites and steps to deploy this pattern.
7+
See [here](https://aws-ia.github.io/terraform-aws-eks-blueprints/getting-started/#prerequisites) for the prerequisites and steps to deploy this pattern.
88

99
## Validate
1010

patterns/sso-okta/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This example demonstrates how to deploy an Amazon EKS cluster that is deployed o
44

55
## Deploy
66

7-
See [here](https://aws-ia.github.io/terraform-aws-eks-blueprints/main/getting-started/#prerequisites) for the prerequisites and steps to deploy this pattern.
7+
See [here](https://aws-ia.github.io/terraform-aws-eks-blueprints/getting-started/#prerequisites) for the prerequisites and steps to deploy this pattern.
88

99
## Validate
1010

patterns/stateful/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ In addition, the following properties are configured on the nodegroup volumes:
3838

3939
## Deploy
4040

41-
See [here](https://aws-ia.github.io/terraform-aws-eks-blueprints/main/getting-started/#prerequisites) for the prerequisites and steps to deploy this pattern.
41+
See [here](https://aws-ia.github.io/terraform-aws-eks-blueprints/getting-started/#prerequisites) for the prerequisites and steps to deploy this pattern.
4242

4343
## Validate
4444

patterns/tls-with-aws-pca-issuer/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This pattern demonstrates how to enable TLS with AWS PCA issuer on an Amazon EKS
44

55
## Deploy
66

7-
See [here](https://aws-ia.github.io/terraform-aws-eks-blueprints/main/getting-started/#prerequisites) for the prerequisites and steps to deploy this pattern.
7+
See [here](https://aws-ia.github.io/terraform-aws-eks-blueprints/getting-started/#prerequisites) for the prerequisites and steps to deploy this pattern.
88

99
## Validate
1010

patterns/wireguard-with-cilium/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This pattern demonstrates Cilium configured in CNI chaining mode with VPC CNI an
77

88
## Deploy
99

10-
See [here](https://aws-ia.github.io/terraform-aws-eks-blueprints/main/getting-started/#prerequisites) for the prerequisites and steps to deploy this pattern.
10+
See [here](https://aws-ia.github.io/terraform-aws-eks-blueprints/getting-started/#prerequisites) for the prerequisites and steps to deploy this pattern.
1111

1212
## Validate
1313

0 commit comments

Comments
 (0)