luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

removed flag, added flag, and applied feedback

This commit is contained in:
trujillo-adam 2021-09-16 09:54:55 -07:00
parent 84d0763302
commit 23e57c4992
2 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
website/content/docs/k8s/installation/install.mdx
View File

@ -70,8 +70,7 @@ NAME CHART VERSION APP VERSION DESCRIPTION
hashicorp/consul 0.32.0 1.10.0 Official HashiCorp Consul Chart 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 1. Issue the following command to install Consul with the default configuration using Helm 3:
configuration using Helm 3 run:
```shell-session ```shell-session
$ helm install consul hashicorp/consul --set global.name=consul $ 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. 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 ### Customizing Your Installation

14
website/content/docs/k8s/k8s-cli.mdx
View File

@ -14,11 +14,17 @@ This topic describes the commands, subcommands, and available options for using
## Download and Build the Binary ## Download and Build the Binary
1. Clone the [consul-k8s-cli](https://github.com/hashicorp/consul-k8s-cli) project. 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: 1. Navigate to the `consul-k8s/cli` directory and issue the following command to build the tool:
```shell-session ```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 ## Usage
@ -47,7 +53,7 @@ The following options are available.
| --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | -------- | | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | -------- |
| `-auto-approve`                                     | Boolean value that enables you to skip the installation confirmation prompt. | `false` | Optional | | `-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 | | `-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. <br/> 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 | | `-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: <br/> `demo`: Installs a single replica server with sidecar injection enabled; useful for testing service mesh functionality. <br/> `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 | | `-preset` | String value that installs Consul based on a preset configuration. You can specify the following values: <br/> `demo`: Installs a single replica server with sidecar injection enabled; useful for testing service mesh functionality. <br/> `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. <br/> You can use the `-set` flag multiple times to set multiple values. <br/> Consul Helm chart values are supported. | none | Optional | | `-set` | String value that enables you to set a customizeable value. <br/> You can use the `-set` flag multiple times to set multiple values. <br/> Consul Helm chart values are supported. | none | Optional |