argo-installer

Overview:

The installer utilizes the gitops pattern in order to control the install,uninstall and upgrade flows for kustomize based installations. The installer creates (or modifies) a git repository while leverging the Argo CD apps patttern.

Architecture:

Bootstrap:

The installer clones the template repository, copies the templates into the target repository, and bootstrap Argo CD and sealed-secrets (controlled by bootstrap/kustomization.yaml in template repository) by applying the kustomized output to K8S cluster.

controlling the installation flow:

The follwing folders and files in the user's repository contorls the installation's content :

• argocd-apps/{envName}/components - contains Argo CD apps for envName
• kustomize/entities/overlays/{envName}/kustomization.yaml - contains the entities that are synced by Argo CD app for envName
• kustomize/components/{appName}/overlays/{envName} - this folder contains the the overlays to control appName app

Usage:

Installing a new environment

~ cf-argo install --help
This command will create a new git repository that manages an Argo Enterprise solution using Argo-CD with gitops.

Usage:
  cf-argo install [flags]

Flags:
      --dry-run               when true, the command will have no side effects, and will only output the manifests to stdout
      --env-name string       name of the Argo Enterprise environment to create (default "production")
      --git-token string      git token which will be used by argo-cd to create the gitops repository
  -h, --help                  help for install
      --kube-context string   name of the kubeconfig context to use (default: current context)
      --kubeconfig string     path to the kubeconfig file [KUBECONFIG] (default: ~/.kube/config)
      --repo-name string      the name of the gitops repository to be created [REPO_NAME]
      --repo-owner string     the name of the owner of the gitops repository to be created [REPO_OWNER]
      --repo-url string       the clone url of an existing gitops repository url [REPO_URL]

Global Flags:
      --log-format string   set the log format: "text", "json" (defaults to text) (default "text")
      --log-level string    set the log level, e.g. "debug", "info", "warn", "error" (default "info")

• Use cf-argo install --repo-owner <owner> --repo-name <name> ... when creating a new Gitops repository
• Use cf-argo install --repo-url <url> ... when installing a new environment into an existing Gitops repository

Uninstalling an existing environment

~ cf-argo uninstall --help
This command will clear all Argo-CD managed resources relating to a specific installation, from a specific cluster

Usage:
  cf-argo uninstall [flags]

Flags:
      --dry-run               when true, the command will have no side effects, and will only output the manifests to stdout
      --env-name string       name of the Argo Enterprise environment to create (default "production")
      --git-token string      git token which will be used by argo-cd to create the gitops repository
  -h, --help                  help for uninstall
      --kube-context string   name of the kubeconfig context to use (default: current context)
      --kubeconfig string     path to the kubeconfig file [KUBECONFIG] (default: ~/.kube/config) (default "/Users/noamgal/.kube/config")
      --repo-url string       the gitops repository url. If it does not exist we will try to create it for you [REPO_URL]

Global Flags:
      --log-format string   set the log format: "text", "json" (defaults to text) (default "text")
      --log-level string    set the log level, e.g. "debug", "info", "warn", "error" (default "info")

Will remove all managed applications from the environment. If there are no other applications remaining in the root app-of-apps, will also remove it, and uninstall the argo-cd server itself.

Development

Building from Source:

To build a binary from the source code, make sure:

• you have go >=1.15 installed.
• and that the GOPATH environment variable is set.

Then run:

• make to build the binary to ./dist/

or

• make install to make it available as cf-argo in the PATH

Linting:

We are using https://github.com/golangci/golangci-lint as our linter, you can integrate golangci-lint with the following IDEs:

• vscode: make sure GOPATH is setup correctly and run make lint this will download golangci-lint if it was not already installed on your machine. Then add the following to your settings.json:

"go.lintTool": "golangci-lint",
"go.lintFlags": [
    "--fast"
],

Using pre-commit hooks:

When installed correctly, this will run golangci-lint before every commit, and go test before every push. Any error will cause the commit or push to fail.

1. Install:
   brew install pre-commit
2. Install the git hook scripts:
   pre-commit install -t pre-commit -t pre-push

Bumping template repository version:

By default the cli will use the repository set in the makefile as BASE_GIT_URL as the base template repository, when there is a new version of the template repository, you need to release a new version of the installer and bump the version of the BASE_GIT_URL in the makefile. The base repository can also be controlled with the hidden flag --base-repo.