From 8ef49a1ca69c26b96a818ec0376e615bd19c123b Mon Sep 17 00:00:00 2001 From: Thomas Eckert Date: Mon, 11 Apr 2022 16:05:15 -0400 Subject: [PATCH] Removed README (info is now in docs) (#1157) --- cli/README.md | 127 -------------------------------------------------- 1 file changed, 127 deletions(-) delete mode 100644 cli/README.md diff --git a/cli/README.md b/cli/README.md deleted file mode 100644 index cad0f51b7e..0000000000 --- a/cli/README.md +++ /dev/null @@ -1,127 +0,0 @@ -# Consul Kubernetes CLI -This repository contains a CLI tool for installing and operating [Consul](https://www.consul.io/) on Kubernetes. -**Warning** this tool is currently experimental. Do not use it on Consul clusters you care about. - -## Installation & Setup -Currently the tool is not available on any releases page. Instead clone the repository and run `go build -o bin/consul-k8s` -from this directory and proceed to run the binary. - -## Commands -* [consul-k8s install](#consul-k8s-install) -* [consul-k8s uninstall](#consul-k8s-uninstall) - -### consul-k8s install -This command installs Consul on a Kubernetes cluster. It allows `demo` and `secure` installations via preset configurations -using the `-preset` flag. The `demo` installation installs just a single replica server with sidecar injection enabled and -is useful to test out service mesh functionality. The `secure` installation is minimal like `demo` but also enables ACLs and TLS. - -Get started with: -```bash -consul-k8s install -preset=demo -``` - -Note that when configuring an installation, the precedence order is as follows from lowest to highest precedence: -1. `-preset` -2. `-f` -3. `-set` -4. `-set-string` -5. `-set-file` - -For example, `-set-file` will override a value provided via `-set`. Additionally, within each of these groups the -rightmost flag value has the highest precedence, i.e `-set foo=bar -set foo=baz` will result in `foo: baz` being set. - -``` -Usage: consul-k8s install [flags] -Install Consul onto a Kubernetes cluster. - -Command Options: - - -auto-approve - Skip confirmation prompt. The default is false. - - -config-file= - Path to a file to customize the installation, such as Consul Helm chart - values file. Can be specified multiple times. This is aliased as "-f". - - -dry-run - Run pre-install checks and display summary of installation. The default - is false. - - -namespace= - Namespace for the Consul installation. The default is consul. - - -preset= - Use an installation preset, one of demo, secure. Defaults to none - - -set= - Set a value to customize. Can be specified multiple times. Supports - Consul Helm chart values. - - -set-file= - Set a value to customize via a file. The contents of the file will be - set as the value. Can be specified multiple times. Supports Consul Helm - chart values. - - -set-string= - Set a string value to customize. Can be specified multiple times. - Supports Consul Helm chart values. - - -timeout= - Timeout to wait for installation to be ready. The default is 10m. - - -wait - Determines whether to wait for resources in installation to be ready - before exiting command. The default is true. - -Global Options: - - -context= - Kubernetes context to use. - - -kubeconfig= - Path to kubeconfig file. This is aliased as "-c". - -``` - -### consul-k8s uninstall -This command uninstalls Consul on Kubernetes, while prompting whether to uninstall the release and whether to delete all -related resources such as PVCs, Secrets, and ServiceAccounts. - -Get started with: -```bash -consul-k8s uninstall -``` - -``` -Usage: consul-k8s uninstall [flags] -Uninstall Consul with options to delete data and resources associated with Consul installation. - -Command Options: - - -auto-approve - Skip approval prompt for uninstalling Consul. The default is false. - - -name= - Name of the installation. This can be used to uninstall and/or delete - the resources of a specific Helm release. - - -namespace= - Namespace for the Consul installation. - - -timeout= - Timeout to wait for uninstall. The default is 10m. - - -wipe-data - When used in combination with -auto-approve, all persisted data (PVCs - and Secrets) from previous installations will be deleted. Only set this - to true when data from previous installations is no longer necessary. - The default is false. - -Global Options: - - -context= - Kubernetes context to use. - - -kubeconfig= - Path to kubeconfig file. This is aliased as "-c". -```