From 27ee4e778a77259667ff1e7b78621e0aadc32a61 Mon Sep 17 00:00:00 2001 From: Rick Spurgeon Date: Mon, 27 Jun 2022 10:02:24 -0500 Subject: [PATCH 1/4] Tweaks KIC install Moves the NOTE warning up to the proper section related to the instruction Adds code formatting to guidance as well --- app/gateway/2.8.x/install-and-run/kubernetes.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/app/gateway/2.8.x/install-and-run/kubernetes.md b/app/gateway/2.8.x/install-and-run/kubernetes.md index 760c5b26dfdf..ca9ebead2ae1 100644 --- a/app/gateway/2.8.x/install-and-run/kubernetes.md +++ b/app/gateway/2.8.x/install-and-run/kubernetes.md @@ -83,7 +83,10 @@ oc new-project kong oc get pods -n kong ``` -1. To make HTTP requests, you need the IP address of the load balancer. Get the LoadBalancer address and store it in a local PROXY_IP environment variable: +1. To make HTTP requests, you need the IP address of the load balancer. Get the `loadBalancer` address and store it in a local `PROXY_IP` environment variable: + + {:.note} + > **Note:** Some cluster providers provide only a DNS name for load balancers. In this case, specify `.hostname` instead of `.ip`. ```sh export PROXY_IP=$(kubectl get -o jsonpath="{.status.loadBalancer.ingress[0].ip}" service -n kong kong-proxy) @@ -101,9 +104,6 @@ oc new-project kong oc get service kong-proxy -n kong ``` - {:.note} - > **Note:** Some cluster providers provide only a DNS name for load balancers. In this case, specify `.hostname` instead of `.ip`. - ## Next steps See the [Kong Ingress Controller docs](/kubernetes-ingress-controller/) for how-to guides, reference guides, and more. From 92980729edc81f6e061f5536db15837e16c3d761 Mon Sep 17 00:00:00 2001 From: Rick Spurgeon Date: Mon, 27 Jun 2022 10:17:35 -0500 Subject: [PATCH 2/4] Fixes two minor vale errors --- .github/styles/kong/dictionary.txt | 1 + app/gateway/2.8.x/install-and-run/kubernetes.md | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/styles/kong/dictionary.txt b/.github/styles/kong/dictionary.txt index 948fb8d9967d..5cf94829a7c8 100644 --- a/.github/styles/kong/dictionary.txt +++ b/.github/styles/kong/dictionary.txt @@ -27,6 +27,7 @@ declaratively degraphql denylist dev +etcd Fargate Github Goroutine diff --git a/app/gateway/2.8.x/install-and-run/kubernetes.md b/app/gateway/2.8.x/install-and-run/kubernetes.md index ca9ebead2ae1..66a9d809da19 100644 --- a/app/gateway/2.8.x/install-and-run/kubernetes.md +++ b/app/gateway/2.8.x/install-and-run/kubernetes.md @@ -6,7 +6,7 @@ This page explains how to install {{site.base_gateway}} with {{site.kic_product_ This page also includes the equivalent commands for OpenShift. -Note that in DB-less mode on Kubernetes, config is stored in etcd, the Kubernetes native datastore. For more information see [Kubernetes Deployment Options](/gateway/{{page.kong_version}}/plan-and-deploy/kubernetes-deployment-options). +Note that in DB-less mode on Kubernetes, config is stored in etcd, the Kubernetes native data store. For more information see [Kubernetes Deployment Options](/gateway/{{page.kong_version}}/plan-and-deploy/kubernetes-deployment-options). The {{site.base_gateway}} software is governed by the [Kong Software License Agreement](https://konghq.com/kongsoftwarelicense/). From b48dfd9ae14d0f0ca0b2ce43ba95da27b75e7b74 Mon Sep 17 00:00:00 2001 From: Rick Spurgeon Date: Mon, 27 Jun 2022 13:15:37 -0500 Subject: [PATCH 3/4] Adds minor tweaks to KIC install and run instruction --- .../2.8.x/install-and-run/kubernetes.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/app/gateway/2.8.x/install-and-run/kubernetes.md b/app/gateway/2.8.x/install-and-run/kubernetes.md index 66a9d809da19..55978d448da7 100644 --- a/app/gateway/2.8.x/install-and-run/kubernetes.md +++ b/app/gateway/2.8.x/install-and-run/kubernetes.md @@ -92,7 +92,13 @@ oc new-project kong export PROXY_IP=$(kubectl get -o jsonpath="{.status.loadBalancer.ingress[0].ip}" service -n kong kong-proxy) ``` -1. Check that the value of $PROXY_IP is the value of the external host: +1. Verify that the value of `$PROXY_IP` matches the value of the external host: + + ```sh + echo $PROXY_IP + ``` + + This should match the `EXTERNAL_IP` value of the `kong-proxy` service returned by the Kubernetes API: ```sh kubectl get service kong-proxy -n kong @@ -104,6 +110,17 @@ oc new-project kong oc get service kong-proxy -n kong ``` +1. Finally, invoke a test request: + ```sh + curl $PROXY_IP + ``` + + which should return a response from the Kong gateway: + + ```sh + {"message":"no Route matched with those values"} + ``` + ## Next steps See the [Kong Ingress Controller docs](/kubernetes-ingress-controller/) for how-to guides, reference guides, and more. From 9741b6b638858a207c25bdea9456635ee5549191 Mon Sep 17 00:00:00 2001 From: Rick Spurgeon Date: Wed, 29 Jun 2022 13:54:01 -0500 Subject: [PATCH 4/4] Apply suggestions from code review Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com> --- app/gateway/2.8.x/install-and-run/kubernetes.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/app/gateway/2.8.x/install-and-run/kubernetes.md b/app/gateway/2.8.x/install-and-run/kubernetes.md index 55978d448da7..62f592ad0139 100644 --- a/app/gateway/2.8.x/install-and-run/kubernetes.md +++ b/app/gateway/2.8.x/install-and-run/kubernetes.md @@ -6,7 +6,7 @@ This page explains how to install {{site.base_gateway}} with {{site.kic_product_ This page also includes the equivalent commands for OpenShift. -Note that in DB-less mode on Kubernetes, config is stored in etcd, the Kubernetes native data store. For more information see [Kubernetes Deployment Options](/gateway/{{page.kong_version}}/plan-and-deploy/kubernetes-deployment-options). +In DB-less mode on Kubernetes, the config is stored in etcd, the Kubernetes native data store. For more information, see [Kubernetes Deployment Options](/gateway/{{page.kong_version}}/plan-and-deploy/kubernetes-deployment-options). The {{site.base_gateway}} software is governed by the [Kong Software License Agreement](https://konghq.com/kongsoftwarelicense/). @@ -86,7 +86,7 @@ oc new-project kong 1. To make HTTP requests, you need the IP address of the load balancer. Get the `loadBalancer` address and store it in a local `PROXY_IP` environment variable: {:.note} - > **Note:** Some cluster providers provide only a DNS name for load balancers. In this case, specify `.hostname` instead of `.ip`. + > **Note:** Some cluster providers only provide a DNS name for load balancers. In this case, specify `.hostname` instead of `.ip`. ```sh export PROXY_IP=$(kubectl get -o jsonpath="{.status.loadBalancer.ingress[0].ip}" service -n kong kong-proxy) @@ -110,12 +110,12 @@ oc new-project kong oc get service kong-proxy -n kong ``` -1. Finally, invoke a test request: +1. Invoke a test request: ```sh curl $PROXY_IP ``` - which should return a response from the Kong gateway: + This should return the following response from Gateway: ```sh {"message":"no Route matched with those values"}