diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index f19805d7..8027b057 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -2,9 +2,9 @@ ## Overview -In principle we seperate out items into 3 types of components +In principle we separate out items into 3 types of components 1. Cloud/On-Prem provider - This is all Terraform on equiv to setup the base infrastructure primitives to provide and k8s cluster - The terraform folder in the repo has an example -2. Kustomize (Cluster bootstrap) - Kustomize install of Argocd for declaritive setup +2. Kustomize (Cluster bootstrap) - Kustomize install of Argocd for declarative setup 3. Environment add-ons - All the extras the Organization needs A Foundation cluster comes with the following base components installed: diff --git a/docs/GETTING-STARTED.md b/docs/GETTING-STARTED.md index c60d2d4e..75c7d3b3 100644 --- a/docs/GETTING-STARTED.md +++ b/docs/GETTING-STARTED.md @@ -17,7 +17,7 @@ metadata: data: CLUSTER_NAME: "# name of your EKS cluster" AWS_REGION: "# AWS region of your EKS cluster" - ARGOCD_SERVER_HOST: "# hostname for the cluster's ArgoCD web interace, e.g. argocd.example-cluster.com" + ARGOCD_SERVER_HOST: "# hostname for the cluster's ArgoCD web interface, e.g. argocd.example-cluster.com" ACME_ISSUER_EMAIL: "# email used by cert-manager for ACME/letsencrypt requests" VPC_CIDR_BLOCK: "# the CIDR block of your cluster's VPC i.e. '172.16.0.0/16'" diff --git a/docs/README.md b/docs/README.md index 91c474a6..241eb270 100644 --- a/docs/README.md +++ b/docs/README.md @@ -6,7 +6,7 @@ Foundation is our repository of base, reusable manifests for setting up GitOps k8s clusters, currently targeted for AWS EKS. ArgoCD is installed as the GitOps agent in a self-managed fashion and also includes Pelotech's set of opinionated components to solve everything that K8s doesn't out of the box (DNS/TLS, storage, logs/metrics etc.) #### [Getting Started](./GETTING-STARTED.md) -#### [Architeture](./ARCHITECTURE.md) +#### [Architecture](./ARCHITECTURE.md) #### [Tools](./TOOLS.md)