From 9df0992c73707278ef2acdfc711646dba21307aa Mon Sep 17 00:00:00 2001 From: Islam M Date: Mon, 30 Sep 2024 20:56:56 +0100 Subject: [PATCH] fix(examples): rename folder and fix spelling mistakes --- examples/{cluster-mgmt => eks-cluster-mgmt}/README.md | 10 +++++----- .../charts/karpenter-iam/.helmignore | 0 .../charts/karpenter-iam/Chart.yaml | 0 .../charts/karpenter-iam/_helpers.tpl | 0 .../charts/karpenter-iam/templates/policy.yaml | 0 .../charts/karpenter-iam/templates/role.yaml | 0 .../charts/karpenter-iam/values.yaml | 0 .../clusters/kustomization.yaml | 0 .../clusters/rg/eks-w-vpc.yaml | 0 .../clusters/rg/eks.yaml | 0 .../clusters/rg/kustomization.yaml | 0 .../clusters/rg/vpc.yaml | 0 .../clusters/workload-cluster1.yaml | 0 .../clusters/workload-cluster2.yaml | 0 .../gitops/bootstrap.yaml | 0 .../gitops/bootstrap/clusters.yaml | 0 .../gitops/bootstrap/karpenter-iam.yaml | 0 .../gitops/bootstrap/karpenter.yaml | 0 .../gitops/bootstrap/kustomization.yaml | 0 19 files changed, 5 insertions(+), 5 deletions(-) rename examples/{cluster-mgmt => eks-cluster-mgmt}/README.md (91%) rename examples/{cluster-mgmt => eks-cluster-mgmt}/charts/karpenter-iam/.helmignore (100%) rename examples/{cluster-mgmt => eks-cluster-mgmt}/charts/karpenter-iam/Chart.yaml (100%) rename examples/{cluster-mgmt => eks-cluster-mgmt}/charts/karpenter-iam/_helpers.tpl (100%) rename examples/{cluster-mgmt => eks-cluster-mgmt}/charts/karpenter-iam/templates/policy.yaml (100%) rename examples/{cluster-mgmt => eks-cluster-mgmt}/charts/karpenter-iam/templates/role.yaml (100%) rename examples/{cluster-mgmt => eks-cluster-mgmt}/charts/karpenter-iam/values.yaml (100%) rename examples/{cluster-mgmt => eks-cluster-mgmt}/clusters/kustomization.yaml (100%) rename examples/{cluster-mgmt => eks-cluster-mgmt}/clusters/rg/eks-w-vpc.yaml (100%) rename examples/{cluster-mgmt => eks-cluster-mgmt}/clusters/rg/eks.yaml (100%) rename examples/{cluster-mgmt => eks-cluster-mgmt}/clusters/rg/kustomization.yaml (100%) rename examples/{cluster-mgmt => eks-cluster-mgmt}/clusters/rg/vpc.yaml (100%) rename examples/{cluster-mgmt => eks-cluster-mgmt}/clusters/workload-cluster1.yaml (100%) rename examples/{cluster-mgmt => eks-cluster-mgmt}/clusters/workload-cluster2.yaml (100%) rename examples/{cluster-mgmt => eks-cluster-mgmt}/gitops/bootstrap.yaml (100%) rename examples/{cluster-mgmt => eks-cluster-mgmt}/gitops/bootstrap/clusters.yaml (100%) rename examples/{cluster-mgmt => eks-cluster-mgmt}/gitops/bootstrap/karpenter-iam.yaml (100%) rename examples/{cluster-mgmt => eks-cluster-mgmt}/gitops/bootstrap/karpenter.yaml (100%) rename examples/{cluster-mgmt => eks-cluster-mgmt}/gitops/bootstrap/kustomization.yaml (100%) diff --git a/examples/cluster-mgmt/README.md b/examples/eks-cluster-mgmt/README.md similarity index 91% rename from examples/cluster-mgmt/README.md rename to examples/eks-cluster-mgmt/README.md index 6c736429..2d618314 100644 --- a/examples/cluster-mgmt/README.md +++ b/examples/eks-cluster-mgmt/README.md @@ -1,7 +1,7 @@ -# Cluster management using Symphony & ACK -This example demonstrate how to manage a fleet of EKS clusters using Symphony, ACK, and ArgoCD -- it creates EKS clusters, and bootstraps them with the required add-ons +# Amazon EKS cluster management using Symphony & ACK +This example demonstrates how to manage a fleet of EKS clusters using Symphony, ACK, and ArgoCD -- it creates EKS clusters, and bootstraps them with the required add-ons -A hub-spoke model is used in this example; a management cluster (hub) is created as part of the initial setup and the controllers needed for provisining and bootstrapping workload clusters (spokes) are installed on top. +A hub-spoke model is used in this example; a management cluster (hub) is created as part of the initial setup and the controllers needed for provisioning and bootstrapping workload clusters (spokes) are installed on top. **NOTE:** As this example evolves, some of the instructions below will be detailed further (e.g. the creation of the management cluster), others (e.g. controllers installation) will be automated via the GitOps flow. @@ -9,7 +9,7 @@ A hub-spoke model is used in this example; a management cluster (hub) is created ## Instructions ### Environment variables -1. Use the snippet below to set environmenet variables. Replace the placeholders first (surrounded with`<>`): +1. Use the snippet below to set environment variables. Replace the placeholders first (surrounded with`<>`): ```sh export SYMPHONY_REPO_URL="https://github.com/aws-controllers-k8s/private-symphony.git" export WORKSPACE_PATH= #the directory where repos will be cloned e.g. ~/environment/ @@ -46,7 +46,7 @@ git clone $SYMPHONY_REPO_URL $WORKSPACE_PATH/symphony 9. Create the GitHub repo `cluster-mgmt` in your organization; it will contain the clusters definition, and it will be reconciled to the management cluster via the GitOps flow -**NOTE:** Until Symphone is released, make sure the repo you create is private. +**NOTE:** Until Symphony is released, make sure the repo you create is private. 10. Save the URL of the created repo in an environment variable: ```sh diff --git a/examples/cluster-mgmt/charts/karpenter-iam/.helmignore b/examples/eks-cluster-mgmt/charts/karpenter-iam/.helmignore similarity index 100% rename from examples/cluster-mgmt/charts/karpenter-iam/.helmignore rename to examples/eks-cluster-mgmt/charts/karpenter-iam/.helmignore diff --git a/examples/cluster-mgmt/charts/karpenter-iam/Chart.yaml b/examples/eks-cluster-mgmt/charts/karpenter-iam/Chart.yaml similarity index 100% rename from examples/cluster-mgmt/charts/karpenter-iam/Chart.yaml rename to examples/eks-cluster-mgmt/charts/karpenter-iam/Chart.yaml diff --git a/examples/cluster-mgmt/charts/karpenter-iam/_helpers.tpl b/examples/eks-cluster-mgmt/charts/karpenter-iam/_helpers.tpl similarity index 100% rename from examples/cluster-mgmt/charts/karpenter-iam/_helpers.tpl rename to examples/eks-cluster-mgmt/charts/karpenter-iam/_helpers.tpl diff --git a/examples/cluster-mgmt/charts/karpenter-iam/templates/policy.yaml b/examples/eks-cluster-mgmt/charts/karpenter-iam/templates/policy.yaml similarity index 100% rename from examples/cluster-mgmt/charts/karpenter-iam/templates/policy.yaml rename to examples/eks-cluster-mgmt/charts/karpenter-iam/templates/policy.yaml diff --git a/examples/cluster-mgmt/charts/karpenter-iam/templates/role.yaml b/examples/eks-cluster-mgmt/charts/karpenter-iam/templates/role.yaml similarity index 100% rename from examples/cluster-mgmt/charts/karpenter-iam/templates/role.yaml rename to examples/eks-cluster-mgmt/charts/karpenter-iam/templates/role.yaml diff --git a/examples/cluster-mgmt/charts/karpenter-iam/values.yaml b/examples/eks-cluster-mgmt/charts/karpenter-iam/values.yaml similarity index 100% rename from examples/cluster-mgmt/charts/karpenter-iam/values.yaml rename to examples/eks-cluster-mgmt/charts/karpenter-iam/values.yaml diff --git a/examples/cluster-mgmt/clusters/kustomization.yaml b/examples/eks-cluster-mgmt/clusters/kustomization.yaml similarity index 100% rename from examples/cluster-mgmt/clusters/kustomization.yaml rename to examples/eks-cluster-mgmt/clusters/kustomization.yaml diff --git a/examples/cluster-mgmt/clusters/rg/eks-w-vpc.yaml b/examples/eks-cluster-mgmt/clusters/rg/eks-w-vpc.yaml similarity index 100% rename from examples/cluster-mgmt/clusters/rg/eks-w-vpc.yaml rename to examples/eks-cluster-mgmt/clusters/rg/eks-w-vpc.yaml diff --git a/examples/cluster-mgmt/clusters/rg/eks.yaml b/examples/eks-cluster-mgmt/clusters/rg/eks.yaml similarity index 100% rename from examples/cluster-mgmt/clusters/rg/eks.yaml rename to examples/eks-cluster-mgmt/clusters/rg/eks.yaml diff --git a/examples/cluster-mgmt/clusters/rg/kustomization.yaml b/examples/eks-cluster-mgmt/clusters/rg/kustomization.yaml similarity index 100% rename from examples/cluster-mgmt/clusters/rg/kustomization.yaml rename to examples/eks-cluster-mgmt/clusters/rg/kustomization.yaml diff --git a/examples/cluster-mgmt/clusters/rg/vpc.yaml b/examples/eks-cluster-mgmt/clusters/rg/vpc.yaml similarity index 100% rename from examples/cluster-mgmt/clusters/rg/vpc.yaml rename to examples/eks-cluster-mgmt/clusters/rg/vpc.yaml diff --git a/examples/cluster-mgmt/clusters/workload-cluster1.yaml b/examples/eks-cluster-mgmt/clusters/workload-cluster1.yaml similarity index 100% rename from examples/cluster-mgmt/clusters/workload-cluster1.yaml rename to examples/eks-cluster-mgmt/clusters/workload-cluster1.yaml diff --git a/examples/cluster-mgmt/clusters/workload-cluster2.yaml b/examples/eks-cluster-mgmt/clusters/workload-cluster2.yaml similarity index 100% rename from examples/cluster-mgmt/clusters/workload-cluster2.yaml rename to examples/eks-cluster-mgmt/clusters/workload-cluster2.yaml diff --git a/examples/cluster-mgmt/gitops/bootstrap.yaml b/examples/eks-cluster-mgmt/gitops/bootstrap.yaml similarity index 100% rename from examples/cluster-mgmt/gitops/bootstrap.yaml rename to examples/eks-cluster-mgmt/gitops/bootstrap.yaml diff --git a/examples/cluster-mgmt/gitops/bootstrap/clusters.yaml b/examples/eks-cluster-mgmt/gitops/bootstrap/clusters.yaml similarity index 100% rename from examples/cluster-mgmt/gitops/bootstrap/clusters.yaml rename to examples/eks-cluster-mgmt/gitops/bootstrap/clusters.yaml diff --git a/examples/cluster-mgmt/gitops/bootstrap/karpenter-iam.yaml b/examples/eks-cluster-mgmt/gitops/bootstrap/karpenter-iam.yaml similarity index 100% rename from examples/cluster-mgmt/gitops/bootstrap/karpenter-iam.yaml rename to examples/eks-cluster-mgmt/gitops/bootstrap/karpenter-iam.yaml diff --git a/examples/cluster-mgmt/gitops/bootstrap/karpenter.yaml b/examples/eks-cluster-mgmt/gitops/bootstrap/karpenter.yaml similarity index 100% rename from examples/cluster-mgmt/gitops/bootstrap/karpenter.yaml rename to examples/eks-cluster-mgmt/gitops/bootstrap/karpenter.yaml diff --git a/examples/cluster-mgmt/gitops/bootstrap/kustomization.yaml b/examples/eks-cluster-mgmt/gitops/bootstrap/kustomization.yaml similarity index 100% rename from examples/cluster-mgmt/gitops/bootstrap/kustomization.yaml rename to examples/eks-cluster-mgmt/gitops/bootstrap/kustomization.yaml