Skip to content

Commit

Permalink
Update install-k8s.mdx
Browse files Browse the repository at this point in the history
  • Loading branch information
David Yu authored Feb 22, 2024
1 parent 6dd8c72 commit 5aaace4
Showing 1 changed file with 29 additions and 16 deletions.
45 changes: 29 additions & 16 deletions website/content/docs/connect/gateways/api-gateway/install-k8s.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,12 @@ description: >-

The Consul API gateway ships with Consul and is automatically installed when you install Consul on Kubernetes. Before you begin the installation process, verify that the environment you are deploying Consul and the API gateway in meets the requirements listed in the [Technical Specifications](/consul/docs/connect/gateways/api-gateway/tech-specs). Refer to the [Release Notes](/consul/docs/release-notes) for any additional information about the version you are deploying.

1. Create a `values.yaml` file for configuring your Consul API gateway deployment and include the following settings:
1. The Consul Helm chart deploys the API gateway using the configuration specified in the `values.yaml` file. Refer to [Helm Chart Configuration - `connectInject.apiGateway`](/consul/docs/k8s/helm#apigateway) for information about the Helm chart configuration options. Create a `values.yaml` file for configuring your Consul API gateway deployment and include the following settings:


<Tabs>

<Tab heading="Reference configuration">
<CodeBlockConfig filename="values.yaml">

```yaml
Expand All @@ -23,22 +27,31 @@ The Consul API gateway ships with Consul and is automatically installed when you
```
</CodeBlockConfig>
</Tab>
If you are installing Consul on an OpenShift Kubernetes cluster, you must include the `global.openShift.enabled` parameter and set it to `true`. Refer to [OpenShift requirements](/consul/docs/connect/gateways/api-gateway/tech-specs#openshift-requirements) for additional information.
<Tab heading="OpenShift">
<CodeBlockConfig filename="values.yaml">

The Consul Helm chart deploys the API gateway using the configuration specified in the `values.yaml` file. Refer to [Helm Chart Configuration - `connectInject.apiGateway`](/consul/docs/k8s/helm#apigateway) for information about the Helm chart configuration options.

1. If you are installing Consul on an OpenShift Kubernetes cluster, you must include the `global.openShift.enabled` parameter and set it to `true`:

<CodeBlockConfig filename="values.yaml">

```yaml
global:
openshift:
enabled: true
```

</CodeBlockConfig>

Refer to [OpenShift requirements](/consul/docs/connect/gateways/api-gateway/tech-specs#openshift-requirements) for additional information.
```yaml
global:
openshift:
enabled: true
connectInject:
enabled: true
apiGateway:
manageExternalCRDs: true
cni:
enabled: true
logLevel: info
multus: true
cniBinDir: "/var/lib/cni/bin"
cniNetDir: "/etc/kubernetes/cni/net.d"
```
</CodeBlockConfig>

</Tab>

</Tabs>

1. Install Consul API Gateway using the standard Consul Helm chart or Consul K8s CLI specify the custom values file. Refer to the [Consul Helm chart](https://github.com/hashicorp/consul-k8s/releases) in GitHub releases for the available versions.

Expand Down

0 comments on commit 5aaace4

Please sign in to comment.