Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: Kong for Kubernetes Enterprise #6247

Merged
merged 12 commits into from
Oct 18, 2023
Merged

fix: Kong for Kubernetes Enterprise #6247

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
9267e4d
rewrite of the deployment instructions
Rajakavitha1 Oct 6, 2023
dc804ea
fix a typo
Rajakavitha1 Oct 6, 2023
89a3b19
Merge branch 'main' into k4k8s-enterprise-rajie
Rajakavitha1 Oct 7, 2023
8ed29f9
Merge branch 'main' into k4k8s-enterprise-rajie
Rajakavitha1 Oct 10, 2023
443a8b9
incorporate code review
Rajakavitha1 Oct 11, 2023
a8d568a
Merge branch 'main' into k4k8s-enterprise-rajie
Rajakavitha1 Oct 11, 2023
2c8508a
Update app/_src/kic-v2/deployment/k4k8s-enterprise.md
Rajakavitha1 Oct 16, 2023
f4979ca
Merge branch 'main' into k4k8s-enterprise-rajie
Rajakavitha1 Oct 16, 2023
fe2d8c3
make vale happy
Rajakavitha1 Oct 17, 2023
dc0e74c
make vale happy
Rajakavitha1 Oct 17, 2023
f35d7d3
Merge branch 'main' into k4k8s-enterprise-rajie
Rajakavitha1 Oct 17, 2023
c5245ce
Merge branch 'main' into k4k8s-enterprise-rajie
Rajakavitha1 Oct 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 12 additions & 10 deletions app/_includes/md/kic/kong-enterprise-license-secret.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@

### {{site.ee_product_name}} License secret

Enterprise version requires a valid license to run.
As part of sign up for {{site.ee_product_name}}, you should have received a license file.
If you do not have one, please contact your sales representative.
Save the license file temporarily to disk with filename `license`
and execute the following:

```bash
$ kubectl create secret generic kong-enterprise-license --from-file=license=./license.json -n kong
secret/kong-enterprise-license created
```
1. Save the license file temporarily to disk with filename `license.json`.
1. Deploy {{site.ee_product_name}} in the `kong` namespace.
Ensure that you provide the file path where you have stored `license.json` file when you run the command. To deploy {{site.kic_product_name}} in a different namespace, change the value of `-n kong`.

Please note that `-n kong` specifies the namespace in which you are deploying
the {{site.kic_product_name}}. If you are deploying in a different namespace,
please change this value.
```bash
$ kubectl create secret generic kong-enterprise-license --from-file=license=./license.json -n kong
```
The results should look like this:

```text
secret/kong-enterprise-license created
```
280 changes: 166 additions & 114 deletions app/_src/kic-v2/deployment/k4k8s-enterprise.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,128 +6,180 @@ Kong for Kubernetes Enterprise is an enhanced version of
the Open-Source Ingress Controller. It includes all
Enterprise plugins and comes with 24x7 support for worry-free
production deployment.
This is available to enterprise customers of Kong, Inc. only.
This is available only for enterprise customers of Kong, Inc.

## Prerequisites
## Before you begin

Before we can deploy Kong, we need to satisfy one prerequisite: create a license
secret.
1. Create the `kong` namespace in the cluster to create a secret.

To create this secret, provision the `kong` namespace first:

```bash
$ kubectl create namespace kong
namespace/kong created
```
```bash
$ kubectl create namespace kong
```
The results should look like this:
```text
namespace/kong created
```
1. Create {{site.ee_product_name}} [License secret](#kong-enterprise-license-secret)

{% include_cached /md/kic/kong-enterprise-license-secret.md version=page.version %}

## Installers

Once the secret is in-place, we can proceed with installation.

Kong for Kubernetes can be installed using an installer of
your choice:

### YAML manifests

Execute the following to install Kong for Kubernetes Enterprise using YAML
manifests:

```bash
kubectl apply -f https://raw.githubusercontent.com/Kong/kubernetes-ingress-controller/v{{ page.version }}/deploy/single/all-in-one-dbless-k4k8s-enterprise.yaml
```

It takes a few minutes the first time this setup is done.

```bash
$ kubectl get pods -n kong
NAME READY STATUS RESTARTS AGE
ingress-kong-6ffcf8c447-5qv6z 2/2 Running 1 44m
```

You can also see the `kong-proxy` service:

```bash
$ kubectl get service kong-proxy -n kong
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
kong-proxy LoadBalancer 10.63.254.78 35.233.198.16 80:32697/TCP,443:32365/TCP 22h
```

> Note: Depending on the Kubernetes distribution you are using, you might or might
not see an external IP address assigned to the service. Please see
your provider's guide on obtaining an IP address for a Kubernetes Service of
type `LoadBalancer`.

Let's setup an environment variable to hold the IP address:

```bash
$ export PROXY_IP=$(kubectl get -o jsonpath="{.status.loadBalancer.ingress[0].ip}" service -n kong kong-proxy)
```

{:.note}
> Note: It may take a while for your cloud provider to actually associate the
IP address to the `kong-proxy` Service.

### Kustomize

### Installing {{site.ee_product_name}}

Kong for Kubernetes Enterprise can be installed using an installer of your choice. After the installation is complete, see the [getting started](/kubernetes-ingress-controller/{{page.kong_version}}/guides/getting-started) tutorial to learn more.

{% navtabs %}
{% navtab YAML manifests %}
1. Install Kong for Kubernetes Enterprise using YAML manifests.

```bash
kubectl apply -f https://raw.githubusercontent.com/Kong/kubernetes-ingress-controller/v{{ page.version }}/deploy/single/all-in-one-dbless-k4k8s-enterprise.yaml
```
The results should look like this:
```text
role.rbac.authorization.k8s.io/kong-leader-election created
clusterrole.rbac.authorization.k8s.io/kong-ingress created
clusterrole.rbac.authorization.k8s.io/kong-ingress-crds created
clusterrole.rbac.authorization.k8s.io/kong-ingress-gateway created
clusterrole.rbac.authorization.k8s.io/kong-ingress-knative created
rolebinding.rbac.authorization.k8s.io/kong-leader-election created
clusterrolebinding.rbac.authorization.k8s.io/kong-ingress created
clusterrolebinding.rbac.authorization.k8s.io/kong-ingress-crds created
clusterrolebinding.rbac.authorization.k8s.io/kong-ingress-gateway created
clusterrolebinding.rbac.authorization.k8s.io/kong-ingress-knative created
service/kong-admin created
service/kong-proxy created
service/kong-validation-webhook created
deployment.apps/ingress-kong created
deployment.apps/proxy-kong created
ingressclass.networking.k8s.io/kong created
```
1. Check if the {{site.kic_product_name}} is ready.
```bash
$ kubectl get pods -n kong
```
The results should look like this:
```text
NAME READY STATUS RESTARTS AGE
ingress-kong-6ffcf8c447-5qv6z 2/2 Running 1 44m
```
It takes a few minutes the first time you set this up.
1. Check if the `kong-proxy` service is deployed.

```bash
$ kubectl get service kong-proxy -n kong
```
The results should look like this:
```text
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
kong-proxy LoadBalancer 10.63.254.78 192.168.99.100 80:32697/TCP,443:32365/TCP 22h
```

> Note: Depending on the Kubernetes distribution you are using, you might or might not see an external IP address assigned to the service. To obtain an IP address for a Kubernetes Service of type `LoadBalancer`, see your cloud provider's documentation.

1. Kubernetes exposes the proxy through a Kubernetes service. Run the following commands to store the load balancer IP address in a variable named `PROXY_IP`:

```bash
$ export PROXY_IP=$(kubectl get -o jsonpath="{.status.loadBalancer.ingress[0].ip}" service -n kong kong-proxy)
echo $PROXY_IP
```
The results should look like this:
```text
192.168.99.100
```

{:.note}
> Note: It may take a while for your cloud provider to actually associate the
IP address to the `kong-proxy` Service.

{% endnavtab %}
{% navtab Kustomize %}
{:.important}
> Kustomize manifests are provided for illustration purposes only and are not officially supported by Kong.
There is no guarantee of backwards compatibility or upgrade capabilities for our Kustomize manifests.
For a production setup with Kong support, use the [Helm chart](https://github.com/kong/charts).

Use Kustomize to install Kong for Kubernetes Enterprise:

```
kustomize build github.com/kong/kubernetes-ingress-controller/config/variants/enterprise
```

You can use the above URL as a base kustomization and build on top of it
as well.

Once installed, set an environment variable, $PROXY_IP with the External IP address of
the `kong-proxy` service in `kong` namespace:

```
export PROXY_IP=$(kubectl get -o jsonpath="{.status.loadBalancer.ingress[0].ip}" service -n kong kong-proxy)
```

### Helm

You can use Helm to install Kong via the official Helm chart:

```
$ helm repo add kong https://charts.konghq.com
$ helm repo update

# Helm 3
$ helm install kong/kong --generate-name \
--namespace kong \
-f values.yaml \
--set ingressController.installCRDs=false
```

### Example values.yaml
```
image:
repository: kong/kong-gateway
tag: 2.2.1.0-alpine
env:
LICENSE_DATA:
valueFrom:
secretKeyRef:
name: kong-enterprise-license
key: license
```

Once installed, set an environment variable, $PROXY_IP with the External IP address of
the `demo-kong-proxy` service in `kong` namespace:

```
export PROXY_IP=$(kubectl get -o jsonpath="{.status.loadBalancer.ingress[0].ip}" service -n kong demo-kong-proxy)
```

## Using Kong for Kubernetes Enterprise

Once you've installed Kong for Kubernetes Enterprise, please follow our
[getting started](/kubernetes-ingress-controller/{{page.kong_version}}/guides/getting-started) tutorial to learn more.
1. Install Kong for Kubernetes using Kustomize:

```bash
kubectl apply -k github.com/kong/kubernetes-ingress-controller/config/variants/enterprise
```
You can use this as a base kustomization and build on top of it for your cluster and use-case.

The results should look like this:
```text
role.rbac.authorization.k8s.io/kong-leader-election created
clusterrole.rbac.authorization.k8s.io/kong-ingress created
clusterrole.rbac.authorization.k8s.io/kong-ingress-crds created
clusterrole.rbac.authorization.k8s.io/kong-ingress-gateway created
clusterrole.rbac.authorization.k8s.io/kong-ingress-knative created
rolebinding.rbac.authorization.k8s.io/kong-leader-election created
clusterrolebinding.rbac.authorization.k8s.io/kong-ingress created
clusterrolebinding.rbac.authorization.k8s.io/kong-ingress-crds created
clusterrolebinding.rbac.authorization.k8s.io/kong-ingress-gateway created
clusterrolebinding.rbac.authorization.k8s.io/kong-ingress-knative created
service/kong-admin created
service/kong-proxy created
service/kong-validation-webhook created
deployment.apps/ingress-kong created
deployment.apps/proxy-kong created
ingressclass.networking.k8s.io/kong created
```

1. Kubernetes exposes the proxy through a Kubernetes service. Run the following commands to store the load balancer IP address in a variable named `PROXY_IP`:

```bash
HOST=$(kubectl get svc --namespace kong kong-proxy -o jsonpath='{.status.loadBalancer.ingress[0].ip}')
PORT=$(kubectl get svc --namespace kong kong-proxy -o jsonpath='{.spec.ports[0].port}')
export PROXY_IP=${HOST}:${PORT}
echo $PROXY_IP
```
The results should look like this:
```text
192.168.99.100:80
```
{% endnavtab %}
{% navtab Helm %}
You can use Helm to install Kong using the official Helm chart:
1. Create a `values.yaml` file with these details to deploy using Helm charts.
```
gateway:
image:
repository: kong/kong-gateway
tag: {{ site.data.kong_latest_gateway.ee-version }}
env:
LICENSE_DATA:
valueFrom:
secretKeyRef:
name: kong-enterprise-license
key: license
```
1. Install {{site.kic_product_name}} and {{ site.base_gateway }} with Helm:

```
$ helm repo add kong https://charts.konghq.com
$ helm repo update
$ helm install kong kong/ingress -n kong --create-namespace --values ./values.yaml
```
The results should look like this:
```text
NAME: kong
LAST DEPLOYED: Fri Oct 6 14:41:16 2023
NAMESPACE: kong
STATUS: deployed
REVISION: 1
TEST SUITE: None
```
1. Kubernetes exposes the proxy through a Kubernetes service. Run the following commands to store the load balancer IP address in a variable named `PROXY_IP`:

```
HOST=$(kubectl get svc --namespace kong kong-gateway-proxy -o jsonpath='{.status.loadBalancer.ingress[0].ip}')
PORT=$(kubectl get svc --namespace kong kong-gateway-proxy -o jsonpath='{.spec.ports[0].port}')
export PROXY_IP=${HOST}:${PORT}
echo $PROXY_IP
```
The results should look like this:
```text
192.168.99.100:80
```
{% endnavtab %}
{% endnavtabs %}