Skip to content

README.md

Latest commit

 

History

History
71 lines (50 loc) · 2.62 KB

README.md

File metadata and controls

71 lines (50 loc) · 2.62 KB

gitops-local-dev

Guide to gain hands-on experience with GitOps using k3d Kubernetes cluster We will use k3d for Kubernetes

Getting Started

  1. Create workspace directory and clone git repo

    WORKPSACE_PATH="$HOME/workspace/gitops"
GIT_REPO_PATH="$HOME/workspace/gitops/gitops-experiments"
[ ! -d  $WORKPSACE_PATH ] && mkdir -p $WORKPSACE_PATH
[ ! -d  $GIT_REPO_PATH ] && git clone https://github.com/rajasoun/gitops-experiments $WORKPSACE_PATH

  2. Setup local development environment for k3d

    Default local kubernetes cluster is k3d. To use kind, set export KUBERNETES_TYPE=kind before running setup command.

    local-dev/assist.sh setup

    Kubernetes 10 minutes Refresher

  3. Test local development environment

    local-dev/assist.sh test

  4. Check the status of the local development environment

    local-dev/assist.sh status

About assist.sh

setup

./assist.sh setup installs prerequisites tools, k3d cluster and populate .env file. It does the following:

  1. Build .env file and populate it with required values, using iaac/env/env.sh setup
  2. Installs required devops-tools using homebrew, using iaac/prerequisites/prerequisite.sh setup
  3. Builds Kubernetes cluster using k3d, using iaac/k3d/k3d.sh setup
  4. Perform customization to the k9s, using iaac/devops-tools/k9s/customize.sh setup

test

./assist.sh test tests the correctness of the cluster. It does the following:

  1. Test prerequisite, using iaac/prerequisites/prerequisite.sh test
  2. Test Kubernetes cluster using, iaac/kubernetes/k3d/k3d.sh test
  3. Test k9s customization using iaac/devops-tools/k9s/customize.sh test

status

./assist.sh status checks the status of the local dev environment. It does the following:

  1. Prints status of prerequisite, using iaac/prerequisites/prerequisite.sh status
  2. Prints status of Kubernetes cluster, using iaac/kubernetes/k3d/k3d.sh status

teardown

./assist.sh teardown teardown the entire local dev environment. It does the following:

  1. Teardown Kubernetes cluster, using iaac/kubernetes/k3d/k3d.sh teardown
  2. Teardown .env file, using iaac/env/env.sh teardown
  3. Teardown k9s customization, using iaac/devops-tools/k9s/customize.sh teardown
  4. Teardown prerequisite, using iaac/prerequisites/prerequisite.sh teardown.

Note: This will delete the entire cluster and all the data. Use with caution. iaac/prerequisites/prerequisite.sh teardown is commented out by default. Uncomment it if you want to remove the prerequisite tools.