Skip to content

Commit

Permalink
chore(kic) extract common docs to includes (#5256)
Browse files Browse the repository at this point in the history
Co-authored-by: Michael Heap <[email protected]>
  • Loading branch information
pmalek and mheap authored Mar 6, 2023
1 parent 05d933f commit b1db893
Show file tree
Hide file tree
Showing 10 changed files with 88 additions and 187 deletions.
64 changes: 64 additions & 0 deletions app/_includes/md/kic/deploy-kic.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
## Deploy the {{site.kic_product_name}} {#deploy-kic}

Deploy the {{site.kic_product_name}} using `kubectl`:

{% if_version gte:2.8.x %}
```bash
$ kubectl create -f https://raw.githubusercontent.com/Kong/kubernetes-ingress-controller/v{{ include.version }}/deploy/single/all-in-one-dbless.yaml
namespace/kong created
customresourcedefinition.apiextensions.k8s.io/ingressclassparameterses.configuration.konghq.com created
customresourcedefinition.apiextensions.k8s.io/kongclusterplugins.configuration.konghq.com created
customresourcedefinition.apiextensions.k8s.io/kongconsumers.configuration.konghq.com created
customresourcedefinition.apiextensions.k8s.io/kongingresses.configuration.konghq.com created
customresourcedefinition.apiextensions.k8s.io/kongplugins.configuration.konghq.com created
customresourcedefinition.apiextensions.k8s.io/tcpingresses.configuration.konghq.com created
customresourcedefinition.apiextensions.k8s.io/udpingresses.configuration.konghq.com created
serviceaccount/kong-serviceaccount created
role.rbac.authorization.k8s.io/kong-leader-election created
clusterrole.rbac.authorization.k8s.io/kong-ingress 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-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
```
{% endif_version %}
{% if_version lte:2.7.x %}
```bash
$ kubectl create -f https://raw.githubusercontent.com/Kong/kubernetes-ingress-controller/v{{ page.version }}/deploy/single/all-in-one-dbless.yaml
namespace/kong created
customresourcedefinition.apiextensions.k8s.io/kongplugins.configuration.konghq.com created
customresourcedefinition.apiextensions.k8s.io/kongconsumers.configuration.konghq.com created
customresourcedefinition.apiextensions.k8s.io/kongcredentials.configuration.konghq.com created
customresourcedefinition.apiextensions.k8s.io/kongingresses.configuration.konghq.com created
serviceaccount/kong-serviceaccount created
clusterrole.rbac.authorization.k8s.io/kong-ingress-clusterrole created
clusterrolebinding.rbac.authorization.k8s.io/kong-ingress-clusterrole-nisa-binding created
configmap/kong-server-blocks created
service/kong-proxy created
service/kong-validation-webhook created
deployment.extensions/kong created
```
{% endif_version %}

It will take a few minutes for all containers to start and report
healthy status.

Alternatively, you can use our helm chart as well:

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

# Helm 3
$ helm install kong/kong --generate-name --set ingressController.installCRDs=false
```

*Note:* this process could take up to five minutes the first time.
16 changes: 16 additions & 0 deletions app/_includes/md/kic/kong-enterprise-license-secret.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
### Kong Enterprise License secret

Enterprise version requires a valid license to run.
As part of sign up for Kong Enterprise, 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
```

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.
36 changes: 1 addition & 35 deletions app/_src/kubernetes-ingress-controller/deployment/aks.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,41 +12,7 @@ title: Kong Ingress on Azure Kubernetes Service (AKS)
cluster we will work on. The above AKS setup guide will help
you set this up.

## Deploy the {{site.kic_product_name}} {#deploy-kic}

Deploy the {{site.kic_product_name}} using `kubectl`:

```bash
kubectl create -f https://raw.githubusercontent.com/Kong/kubernetes-ingress-controller/v{{ page.version }}/deploy/single/all-in-one-dbless.yaml
namespace/kong created
customresourcedefinition.apiextensions.k8s.io/kongplugins.configuration.konghq.com created
customresourcedefinition.apiextensions.k8s.io/kongconsumers.configuration.konghq.com created
customresourcedefinition.apiextensions.k8s.io/kongcredentials.configuration.konghq.com created
customresourcedefinition.apiextensions.k8s.io/kongingresses.configuration.konghq.com created
serviceaccount/kong-serviceaccount created
clusterrole.rbac.authorization.k8s.io/kong-ingress-clusterrole created
clusterrolebinding.rbac.authorization.k8s.io/kong-ingress-clusterrole-nisa-binding created
configmap/kong-server-blocks created
service/kong-proxy created
service/kong-validation-webhook created
deployment.extensions/kong created
```

It will take a few minutes for all containers to start and report
healthy status.

Alternatively, you can use our helm chart as well.
Please ensure that you've Tiller working and then execute:

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

# Helm 3
$ helm install kong/kong --generate-name --set ingressController.installCRDs=false
```

*Note:* this process could take up to five minutes the first time.
{% include_cached /md/kic/deploy-kic.md version=page.version %}

## Setup environment variables

Expand Down
36 changes: 1 addition & 35 deletions app/_src/kubernetes-ingress-controller/deployment/eks.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,41 +12,7 @@ title: Kong Ingress on Elastic Kubernetes Service (EKS)
cluster we will work on. The above EKS setup guide will help
you set this up.

## Deploy the {{site.kic_product_name}} {#deploy-kic}

Deploy the {{site.kic_product_name}} using `kubectl`:

```bash
kubectl create -f https://raw.githubusercontent.com/Kong/kubernetes-ingress-controller/v{{ page.version }}/deploy/single/all-in-one-dbless.yaml
namespace/kong created
customresourcedefinition.apiextensions.k8s.io/kongplugins.configuration.konghq.com created
customresourcedefinition.apiextensions.k8s.io/kongconsumers.configuration.konghq.com created
customresourcedefinition.apiextensions.k8s.io/kongcredentials.configuration.konghq.com created
customresourcedefinition.apiextensions.k8s.io/kongingresses.configuration.konghq.com created
serviceaccount/kong-serviceaccount created
clusterrole.rbac.authorization.k8s.io/kong-ingress-clusterrole created
clusterrolebinding.rbac.authorization.k8s.io/kong-ingress-clusterrole-nisa-binding created
configmap/kong-server-blocks created
service/kong-proxy created
service/kong-validation-webhook created
deployment.extensions/kong created
```

It may take a few minutes for all containers to start and report
healthy statuses.

Alternatively, you can use our helm chart as well.
Please ensure that you have Tiller working and then execute:

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

# Helm 3
$ helm install kong/kong --generate-name --set ingressController.installCRDs=false
```

*Note:* this process could take up to five minutes the first time.
{% include_cached /md/kic/deploy-kic.md version=page.version %}

## Setup environment variables

Expand Down
33 changes: 1 addition & 32 deletions app/_src/kubernetes-ingress-controller/deployment/gke.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,38 +67,7 @@ subjects:
```

## Deploy the {{site.kic_product_name}} {#deploy-kic}

Deploy the {{site.kic_product_name}} using `kubectl`:

```bash
kubectl create -f https://raw.githubusercontent.com/Kong/kubernetes-ingress-controller/v{{ page.version }}/deploy/single/all-in-one-dbless.yaml
namespace/kong created
customresourcedefinition.apiextensions.k8s.io/kongplugins.configuration.konghq.com created
customresourcedefinition.apiextensions.k8s.io/kongconsumers.configuration.konghq.com created
customresourcedefinition.apiextensions.k8s.io/kongcredentials.configuration.konghq.com created
customresourcedefinition.apiextensions.k8s.io/kongingresses.configuration.konghq.com created
serviceaccount/kong-serviceaccount created
clusterrole.rbac.authorization.k8s.io/kong-ingress-clusterrole created
clusterrolebinding.rbac.authorization.k8s.io/kong-ingress-clusterrole-nisa-binding created
configmap/kong-server-blocks created
service/kong-proxy created
service/kong-validation-webhook created
deployment.extensions/kong created
```

Alternatively, you can use our helm chart as well.
Please ensure that you've Tiller working and then execute:
```bash
$ helm repo add kong https://charts.konghq.com
$ helm repo update
# Helm 3
$ helm install kong/kong --generate-name --set ingressController.installCRDs=false
```
*Note:* this process could take up to five minutes the first time.
{% include_cached /md/kic/deploy-kic.md version=page.version %}

## Setup environment variables

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,22 +20,7 @@ $ kubectl create namespace kong
namespace/kong created
```

### Kong Enterprise License secret

Enterprise version requires a valid license to run.
As part of sign up for Kong Enterprise, 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
```

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.
{% include_cached /md/kic/kong-enterprise-license-secret.md version=page.version %}

## Installers

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,20 +25,7 @@ $ kubectl create namespace kong
namespace/kong created
```

### Kong Enterprise License secret

Kong Enterprise requires a valid license to run.
As part of sign up for Kong Enterprise, you should have received a license file.
Save the license file temporarily to disk and execute the following:

```bash
$ kubectl create secret generic kong-enterprise-license --from-file=license=./license.json -n kong
secret/kong-enterprise-license created
```

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.
{% include_cached /md/kic/kong-enterprise-license-secret.md version=page.version %}

### Kong Enterprise bootstrap password

Expand Down
33 changes: 1 addition & 32 deletions app/_src/kubernetes-ingress-controller/deployment/minikube.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,38 +22,7 @@ title: Kong Ingress on Minikube
kubectl get nodes
```

## Deploy the {{site.kic_product_name}} {#deploy-kic}

Deploy the {{site.kic_product_name}} using `kubectl`:

```bash
kubectl create -f https://raw.githubusercontent.com/Kong/kubernetes-ingress-controller/v{{ page.version }}/deploy/single/all-in-one-dbless.yaml
namespace/kong created
customresourcedefinition.apiextensions.k8s.io/kongplugins.configuration.konghq.com created
customresourcedefinition.apiextensions.k8s.io/kongconsumers.configuration.konghq.com created
customresourcedefinition.apiextensions.k8s.io/kongcredentials.configuration.konghq.com created
customresourcedefinition.apiextensions.k8s.io/kongingresses.configuration.konghq.com created
serviceaccount/kong-serviceaccount created
clusterrole.rbac.authorization.k8s.io/kong-ingress-clusterrole created
clusterrolebinding.rbac.authorization.k8s.io/kong-ingress-clusterrole-nisa-binding created
configmap/kong-server-blocks created
service/kong-proxy created
service/kong-validation-webhook created
deployment.extensions/kong created
```

Alternatively, you can use our helm chart as well.
Please ensure that you've Tiller working and then execute:

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

# Helm 3
$ helm install kong/kong --generate-name --set ingressController.installCRDs=false
```

> Note: this process could take up to five minutes the first time.
{% include_cached /md/kic/deploy-kic.md version=page.version %}

## Setup environment variables

Expand Down
20 changes: 1 addition & 19 deletions app/_src/kubernetes-ingress-controller/guides/cert-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,25 +21,7 @@ You will need the following:

This tutorial was written using Google Kubernetes Engine.

## Set up the {{site.kic_product_name}} {#set-up-kic}

Execute the following to install the Ingress Controller:

```bash
$ kubectl create -f https://raw.githubusercontent.com/Kong/kubernetes-ingress-controller/v{{ page.version }}/deploy/single/all-in-one-dbless.yaml
namespace/kong created
customresourcedefinition.apiextensions.k8s.io/kongplugins.configuration.example.com created
customresourcedefinition.apiextensions.k8s.io/kongconsumers.configuration.example.com created
customresourcedefinition.apiextensions.k8s.io/kongcredentials.configuration.example.com created
customresourcedefinition.apiextensions.k8s.io/kongingresses.configuration.example.com created
serviceaccount/kong-serviceaccount created
clusterrole.rbac.authorization.k8s.io/kong-ingress-clusterrole created
clusterrolebinding.rbac.authorization.k8s.io/kong-ingress-clusterrole-nisa-binding created
configmap/kong-server-blocks created
service/kong-proxy created
service/kong-validation-webhook created
deployment.extensions/kong created
```
{% include_cached /md/kic/deploy-kic.md version=page.version %}

## Set up cert-manager

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,7 @@ $ helm upgrade --install controller kong/kong -n kong --create-namespace \
--set ingressController.gatewayDiscovery.adminApiService.name=${GATEWAY_RELEASE_NAME}-kong-admin \
--set deployment.kong.enabled=false \
--set proxy.nameOverride=${GATEWAY_RELEASE_NAME}-kong-proxy \
--set replicaCount=2 \
--set ingressController.image.repository=kong/nightly-ingress-controller \
--set ingressController.image.tag=nightly \
--set-string ingressController.image.effectiveSemver=2.9.1
--set replicaCount=2
```

At this point you should be able to see both deployments ready:
Expand Down

0 comments on commit b1db893

Please sign in to comment.