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

merge back in mike's environment doc in install

Browse source
This commit is contained in:
Sarah Alsmiller 2022-07-21 14:53:55 -05:00
parent 8c8dee189f
commit 1b32cba878
1 changed files with 28 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

50
website/content/docs/api-gateway/install.mdx
View file

@ -15,39 +15,43 @@ Ensure that the environment you are deploying Consul API Gateway in meets the re
## Installation ## Installation
-> **Version reference convention:** Replace `VERSION` in command and configuration examples with the Consul API Gateway version you are installing, such as `0.3.0`. In some instances, `VERSION` is prepended with a lowercase _v_. This indicates that you must include the `v` as is part of the version, for example `v0.3.0`. 1. Set the version of Consul API Gateway you are installing as an environment variable. The following steps use this environment variable in commands and configurations.
```shell-session
$ export VERSION=0.3.0
```
1. Issue the following command to install the CRDs: 1. Issue the following command to install the CRDs:
```shell-session ```shell-session
$ kubectl apply --kustomize="github.com/hashicorp/consul-api-gateway/config/crd?ref=vVERSION" $ kubectl apply --kustomize="github.com/hashicorp/consul-api-gateway/config/crd?ref=v$VERSION"
``` ```
1. Create a `values.yaml` file for your Consul API Gateway deployment. 1. Create a `values.yaml` file for your Consul API Gateway deployment by copying the following content and running it in the environment where you set the `VERSION` environment variable. The Consul Helm chart uses this `values.yaml` file to deploy the API Gateway. Available versions of the [Consul](https://hub.docker.com/r/hashicorp/consul/tags) and [Consul API Gateway](https://hub.docker.com/r/hashicorp/consul-api-gateway/tags) Docker images can be found on DockerHub, with additional context on version compatibility published in [GitHub releases](https://github.com/hashicorp/consul-api-gateway/releases). For more options to configure your Consul API Gateway deployment through the Helm chart, refer to [Helm Chart Configuration - apiGateway](https://www.consul.io/docs/k8s/helm#apigateway).
1. Copy the following example configuration into the `values.yaml` file. The Consul Helm chart uses the `values.yaml` file to install Consul.
<CodeBlockConfig hideClipboard filename="values.yaml"> <CodeBlockConfig filename="values.yaml">
```yaml ```shell
global: cat <<EOF > values.yaml
name: consul global:
connectInject: name: consul
enabled: true connectInject:
controller: enabled: true
enabled: true controller:
apiGateway: enabled: true
enabled: true apiGateway:
image: hashicorp/consul-api-gateway:VERSION enabled: true
``` image: hashicorp/consul-api-gateway:$VERSION
EOF
```
</CodeBlockConfig> </CodeBlockConfig>
Refer to the [Consul](https://hub.docker.com/r/hashicorp/consul/tags) and [Consul API Gateway] (https://hub.docker.com/r/hashicorp/consul-api-gateway/tags) DockerHub pages for information about all available versions, as well as additional context about version compatibility published in [GitHub releases](https://github.com/hashicorp/consul-api-gateway/releases). See [Helm Chart Configuration - apiGateway](https://www.consul.io/docs/k8s/helm#apigateway) for more available options on how to configure your Consul API Gateway deployment via the Helm chart.
1. Install Consul API Gateway using the standard Consul Helm chart and specify the custom values file. Available versions of the [Consul Helm chart](https://github.com/hashicorp/consul-k8s/releases) can be found in GitHub releases. 1. Install Consul API Gateway using the standard Consul Helm chart and specify the custom values file. Available versions of the [Consul Helm chart](https://github.com/hashicorp/consul-k8s/releases) can be found in GitHub releases.
```shell-session ```shell-session
$ helm install consul hashicorp/consul --version 0.45.0 --values values.yaml --create-namespace --namespace consul $ helm install consul hashicorp/consul --version 0.45.0 --values values.yaml --create-namespace --namespace consul
``` ```
<!-- <!--
****** KEEP ALL PAGE CONTENT ABOVE THIS LINE ******* ****** KEEP ALL PAGE CONTENT ABOVE THIS LINE *******