mirror of https://github.com/status-im/consul.git
docs: slight formatting update and provide example with service mesh enabled (#12227)
* docs: slight formatting update and provide example with service mesh install * add status * Update website/content/docs/k8s/installation/install.mdx Co-authored-by: mrspanishviking <kcardenas@hashicorp.com> * Update install.mdx * Update install.mdx * Update install.mdx * Update install.mdx * Update install.mdx Co-authored-by: mrspanishviking <kcardenas@hashicorp.com>
This commit is contained in:
David Yu
GitHub
parent
9d80c1886a
commit
2893275e33
|
|
@ -27,7 +27,7 @@ mesh](https://learn.hashicorp.com/tutorials/consul/service-mesh-deploy?utm_sourc
|
|||
|
||||
## Consul K8s CLI Installation
|
||||
|
||||
We recommend using the [Consul K8S CLI](/docs/k8s/k8s-cli) to install Consul on Kubernetes for single-cluster deployments. You can install Consul on Kubernetes using the Consul K8s CLI tool after installing the CLI.
|
||||
We recommend using the [Consul K8s CLI](/docs/k8s/k8s-cli) to install Consul on Kubernetes for single-cluster deployments. You can install Consul on Kubernetes using the Consul K8s CLI tool after installing the CLI.
|
||||
|
||||
Before beginning the installation process, verify that `kubectl` is already configured to authenticate to the Kubernetes cluster using a valid `kubeconfig` file.
|
||||
|
||||
|
|
@ -45,38 +45,58 @@ The [Homebrew](https://brew.sh) package manager is required to complete the foll
|
|||
$ brew install hashicorp/tap/consul-k8s
|
||||
```
|
||||
|
||||
1. Issue the `install` subcommand to install Consul on Kubernetes:
|
||||
1. Issue the `install` subcommand to install Consul on Kubernetes. Refer to the [Consul K8s CLI reference](/docs/k8s/k8s-cli) for details about all commands and available options. Without any additional options passed, the `consul-k8s` CLI will install Consul on Kubernetes by using the Consul Helm chart's default values. Below is an example that installs Consul on Kubernetes with Service Mesh and CRDs enabled. If you did not set the `-auto-approve` option to `true`, you will be prompted to proceed with the installation if the pre-install checks pass.
|
||||
|
||||
```shell-session
|
||||
consul-k8s install <OPTIONS>
|
||||
```
|
||||
-> The pre-install checks may fail if existing `PersistentVolumeClaims` (PVC) are detected. Refer to the [uninstall instructions](/docs/k8s/operations/uninstall#uninstall-consul) for information about removing PVCs.
|
||||
|
||||
```shell-session
|
||||
$ consul-k8s install -set connectInject.enabled=true -set controller.enabled=true
|
||||
|
||||
Refer to the [Consul K8s CLI reference](/docs/k8s/k8s-cli) for details about all commands and available options.
|
||||
|
||||
If you did not set the `-auto-approve` option to `true`, you will be prompted to proceed with the installation if the pre-install checks pass.
|
||||
|
||||
```shell-session
|
||||
==> Pre-Install Checks
|
||||
✓ No existing installations found
|
||||
==> Pre-Install Checks
|
||||
No existing installations found.
|
||||
✓ No previous persistent volume claims found
|
||||
✓ No previous secrets found
|
||||
|
||||
==> Consul Installation Summary
|
||||
Installation name: consul
|
||||
Namespace: myns
|
||||
Overrides:
|
||||
connectInject:
|
||||
enabled: true
|
||||
global:
|
||||
name: consul
|
||||
server:
|
||||
bootstrapExpect: 1
|
||||
replicas: 1
|
||||
==> Consul Installation Summary
|
||||
Installation name: consul
|
||||
Namespace: consul
|
||||
Overrides:
|
||||
connectInject:
|
||||
enabled: true
|
||||
controller:
|
||||
enabled: true
|
||||
|
||||
Proceed with installation? (y/n)
|
||||
```
|
||||
Proceed with installation? (y/N) y
|
||||
|
||||
==> Running Installation
|
||||
✓ Downloaded charts
|
||||
--> creating 1 resource(s)
|
||||
--> creating 45 resource(s)
|
||||
--> beginning wait for 45 resources with timeout of 10m0s
|
||||
✓ Consul installed into namespace "consul"
|
||||
```
|
||||
|
||||
1. Enter `y` to proceed. The pre-install checks may fail if existing `PersistentVolumeClaims` (PVC) are detected. Refer to the [uninstall instructions](/docs/k8s/operations/uninstall#uninstall-consul) for information about removing PVCs.
|
||||
1. (Optional) Run `consul-k8s status` command to quickly glance at the status of the installed Consul cluster.
|
||||
|
||||
```shell-session
|
||||
$ consul-k8s status
|
||||
|
||||
==> Consul-K8s Status Summary
|
||||
NAME | NAMESPACE | STATUS | CHARTVERSION | APPVERSION | REVISION | LAST UPDATED
|
||||
---------+-----------+----------+--------------+------------+----------+--------------------------
|
||||
consul | consul | deployed | 0.40.0 | 1.11.2 | 1 | 2022/01/31 16:58:51 PST
|
||||
|
||||
==> Config:
|
||||
connectInject:
|
||||
enabled: true
|
||||
controller:
|
||||
enabled: true
|
||||
global:
|
||||
name: consul
|
||||
|
||||
✓ Consul servers healthy (3/3)
|
||||
✓ Consul clients healthy (3/3)
|
||||
```
|
||||
|
||||
## Helm Chart Installation
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue