From 23e57c4992efd03b140e263c7a8c03f4981f4267 Mon Sep 17 00:00:00 2001 From: trujillo-adam Date: Thu, 16 Sep 2021 09:54:55 -0700 Subject: [PATCH] removed flag, added flag, and applied feedback --- website/content/docs/k8s/installation/install.mdx | 5 ++--- website/content/docs/k8s/k8s-cli.mdx | 14 ++++++++++---- 2 files changed, 12 insertions(+), 7 deletions(-) diff --git a/website/content/docs/k8s/installation/install.mdx b/website/content/docs/k8s/installation/install.mdx index e66e95f9a..cccfdcab8 100644 --- a/website/content/docs/k8s/installation/install.mdx +++ b/website/content/docs/k8s/installation/install.mdx @@ -70,8 +70,7 @@ NAME CHART VERSION APP VERSION DESCRIPTION hashicorp/consul 0.32.0 1.10.0 Official HashiCorp Consul Chart ``` -Now you're ready to install Consul! To install Consul with the default -configuration using Helm 3 run: +1. Issue the following command to install Consul with the default configuration using Helm 3: ```shell-session $ helm install consul hashicorp/consul --set global.name=consul @@ -80,7 +79,7 @@ NAME: consul ``` The Helm chart does everything to set up a recommended Consul-on-Kubernetes deployment. -After installation, a Consul cluster will be formed, a will be leader elected, and every node will have a running Consul agent. +After installation, a Consul cluster will be formed, a leader will be elected, and every node will have a running Consul agent. ### Customizing Your Installation diff --git a/website/content/docs/k8s/k8s-cli.mdx b/website/content/docs/k8s/k8s-cli.mdx index 8f0a3c1f7..7c37d2ce6 100644 --- a/website/content/docs/k8s/k8s-cli.mdx +++ b/website/content/docs/k8s/k8s-cli.mdx @@ -14,13 +14,19 @@ This topic describes the commands, subcommands, and available options for using ## Download and Build the Binary -1. Clone the [consul-k8s-cli](https://github.com/hashicorp/consul-k8s-cli) project. -1. Navigate to the `consul-k8s-cli` directory and issue the following command to build the tool: +1. Clone the [consul-k8s](https://github.com/hashicorp/consul-k8s/tree/cli-install/cli) project. +1. Navigate to the `consul-k8s/cli` directory and issue the following command to build the tool: ```shell-session - go build -o bin/consul-k8s + go build . ``` +1. (Optional) Move the binary to you `$PATH` for ease of use, e.g.: + +```shell-session +mv consul-k8s /usr/local/bin/consul-k8s +``` + ## Usage Consul K8s CLI uses the following syntax: @@ -47,7 +53,7 @@ The following options are available. | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | -------- | | `-auto-approve`                                     | Boolean value that enables you to skip the installation confirmation prompt. | `false` | Optional | | `-dry-run` | Boolean value that validates the installation and returns a summary. | `false` | Optional | -| `-name` | String value for the name of the installation. The specified value will be prefixed to resources installed on the cluster. | none | Optional | +| `-config-file` | String value that specifies the path to a file containing custom installation configurations, e.g., Consul Helm chart values file.
You can use the `-config-file` flag multiple times to specify multiple files. | none | Optional | | `-namespace` | String value that specifies the namespace of the Consul installation. | `consul` | Optional | | `-preset` | String value that installs Consul based on a preset configuration. You can specify the following values:
`demo`: Installs a single replica server with sidecar injection enabled; useful for testing service mesh functionality.
`secure`: Installs a single replica server with sidecar injection, ACLs, and TLS enabled; useful for testing service mesh functionality. | Configuration of the Consul Helm chart. | Optional | | `-set` | String value that enables you to set a customizeable value.
You can use the `-set` flag multiple times to set multiple values.
Consul Helm chart values are supported. | none | Optional |