mirror of https://github.com/status-im/consul.git
docs: GKE Autopilot section (#20697)
* Update install.mdx * Update install-k8s.mdx * Update website/content/docs/k8s/installation/install.mdx Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>
This commit is contained in:
David Yu
GitHub
parent
dd833d9a36
commit
b45314f8e9
|
|
@ -9,10 +9,13 @@ 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.
|
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">
|
<CodeBlockConfig filename="values.yaml">
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
global:
|
global:
|
||||||
name: consul
|
name: consul
|
||||||
|
|
@ -21,24 +24,60 @@ The Consul API gateway ships with Consul and is automatically installed when you
|
||||||
apiGateway:
|
apiGateway:
|
||||||
manageExternalCRDs: true
|
manageExternalCRDs: true
|
||||||
```
|
```
|
||||||
|
|
||||||
</CodeBlockConfig>
|
</CodeBlockConfig>
|
||||||
|
</Tab>
|
||||||
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.
|
|
||||||
|
<Tab heading="OpenShift">
|
||||||
1. If you are installing Consul on an OpenShift Kubernetes cluster, you must include the `global.openShift.enabled` parameter and set it to `true`:
|
|
||||||
|
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.
|
||||||
<CodeBlockConfig filename="values.yaml">
|
|
||||||
|
<CodeBlockConfig filename="values.yaml">
|
||||||
```yaml
|
|
||||||
global:
|
```yaml
|
||||||
openshift:
|
global:
|
||||||
|
openshift:
|
||||||
|
enabled: true
|
||||||
|
connectInject:
|
||||||
enabled: true
|
enabled: true
|
||||||
```
|
apiGateway:
|
||||||
|
manageExternalCRDs: true
|
||||||
</CodeBlockConfig>
|
cni:
|
||||||
|
enabled: true
|
||||||
Refer to [OpenShift requirements](/consul/docs/connect/gateways/api-gateway/tech-specs#openshift-requirements) for additional information.
|
logLevel: info
|
||||||
|
multus: true
|
||||||
|
cniBinDir: "/var/lib/cni/bin"
|
||||||
|
cniNetDir: "/etc/kubernetes/cni/net.d"
|
||||||
|
```
|
||||||
|
</CodeBlockConfig>
|
||||||
|
</Tab>
|
||||||
|
|
||||||
|
<Tab heading="GKE Autopilot">
|
||||||
|
|
||||||
|
By default, GKE Autopilot installs [Gateway API resources](https://gateway-api.sigs.k8s.io), so we recommend customizing the `connectInject.apiGateway` stanza to accommodate the pre-installed Gateway API CRDs.
|
||||||
|
|
||||||
|
The following working example enables both Consul Service Mesh and Consul API Gateway on GKE Autopilot. Refer to [`connectInject.agiGateway` in the Helm chart reference](https://developer.hashicorp.com/consul/docs/k8s/helm#v-connectinject-apigateway) for additional information.
|
||||||
|
|
||||||
|
<CodeBlockConfig filename="values.yaml">
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
global:
|
||||||
|
name: consul
|
||||||
|
connectInject:
|
||||||
|
enabled: true
|
||||||
|
apiGateway:
|
||||||
|
manageExternalCRDs: false
|
||||||
|
manageNonStandardCRDs: true
|
||||||
|
cni:
|
||||||
|
enabled: true
|
||||||
|
logLevel: info
|
||||||
|
cniBinDir: "/home/kubernetes/bin"
|
||||||
|
cniNetDir: "/etc/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.
|
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.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -114,7 +114,33 @@ global:
|
||||||
enabled: true
|
enabled: true
|
||||||
```
|
```
|
||||||
|
|
||||||
Refer to [`openshift` in the Helm chart reference](/consul/docs/k8s/helm#v-global-openshift) for additional information.
|
Refer to [`openshift` in the Helm chart reference](/consul/docs/k8s/helm#v-global-openshift) for additional information regarding the OpenShift stanza. In addition, refer to the [Deploy Consul on RedHat OpenShift tutorial](/consul/tutorials/kubernetes/kubernetes-openshift-red-hat) for a complete working example that deploys Consul Service Mesh using Red Hat Certified UBI images.
|
||||||
|
|
||||||
|
### Install Consul on GKE Autopilot
|
||||||
|
|
||||||
|
GKE Autopilot provides a fully managed environment for containerized workloads and requires the Consul CNI plugin to be installed. Refer to [Enable the Consul CNI plugin](#enable-the-consul-cni-plugin) for a full reference on how to enable the CNI plugin.
|
||||||
|
|
||||||
|
By default, GKE Autopilot also installs [Gateway API resources](https://gateway-api.sigs.k8s.io), so we recommend customizing the `connectInject.apiGateway` stanza to accommodate for the pre-installed Gateway API CRDs.
|
||||||
|
|
||||||
|
The following working example enables both Consul Service Mesh and Consul API Gateway on GKE Autopilot. Refer to [`connectInject.agiGateway` in the Helm chart reference](https://developer.hashicorp.com/consul/docs/k8s/helm#v-connectinject-apigateway) for additional information.
|
||||||
|
|
||||||
|
<CodeBlockConfig filename="values.yaml">
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
global:
|
||||||
|
name: consul
|
||||||
|
connectInject:
|
||||||
|
enabled: true
|
||||||
|
apiGateway:
|
||||||
|
manageExternalCRDs: false
|
||||||
|
manageNonStandardCRDs: true
|
||||||
|
cni:
|
||||||
|
enabled: true
|
||||||
|
logLevel: info
|
||||||
|
cniBinDir: "/home/kubernetes/bin"
|
||||||
|
cniNetDir: "/etc/cni/net.d"
|
||||||
|
```
|
||||||
|
</CodeBlockConfig>
|
||||||
|
|
||||||
### Enable the Consul CNI plugin
|
### Enable the Consul CNI plugin
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue