From 03e6d607967c4bdf91de96775e2bf90c3e77b9ee Mon Sep 17 00:00:00 2001 From: Michael Heap Date: Tue, 4 Feb 2025 09:52:45 -0800 Subject: [PATCH] Simplify Konnect decK steps (#384) * Simplify Konnect decK steps * Remove mention of a prereqs.yaml file --------- Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com> --- app/_includes/components/entity_examples.html | 11 ----------- app/_includes/how-tos/steps/apply_config.md | 17 +---------------- app/_includes/how-tos/steps/ping-gateway.md | 7 ------- app/_includes/prereqs/entities.md | 13 +------------ app/_includes/prereqs/products/konnect.md | 4 ++-- 5 files changed, 4 insertions(+), 48 deletions(-) diff --git a/app/_includes/components/entity_examples.html b/app/_includes/components/entity_examples.html index 7b55cfa48..c7dcc8eeb 100644 --- a/app/_includes/components/entity_examples.html +++ b/app/_includes/components/entity_examples.html @@ -1,17 +1,6 @@ -```yaml -echo ' -_format_version: "3.0" -{{ entity_examples.data }} -' | deck gateway apply - \ - --konnect-token $KONNECT_TOKEN \ - --konnect-control-plane-name $KONNECT_CP_NAME -``` -{: data-file="kong.yaml" data-deployment-topology="konnect" data-test-step="block" } - ```yaml echo ' _format_version: "3.0" {{ entity_examples.data }} ' | deck gateway apply - ``` -{: data-file="kong.yaml" data-deployment-topology="on-prem" data-test-step="block" } diff --git a/app/_includes/how-tos/steps/apply_config.md b/app/_includes/how-tos/steps/apply_config.md index 76e392778..d4546093b 100644 --- a/app/_includes/how-tos/steps/apply_config.md +++ b/app/_includes/how-tos/steps/apply_config.md @@ -7,14 +7,6 @@ First, compare the decK file or files to the state of the {{site.base_gateway}}: ```bash deck gateway diff deck_files ``` -{: data-deployment-topology="on-prem" data-test-step="block" } - -```bash -deck gateway diff deck_files \ - --konnect-token ${{konnect_token}} \ - --konnect-control-plane-name $KONNECT_CP_NAME -``` -{: data-deployment-topology="konnect" data-test-step="block" } The output shows you which entities will change if you sync the state files. @@ -22,11 +14,4 @@ If everything looks right, synchronize them to update your Gateway configuration ```bash deck gateway sync deck_files -``` -{: data-deployment-topology="on-prem" data-test-step="block" } -```bash -deck gateway sync deck_files \ - --konnect-token ${{konnect_token}} \ - --konnect-control-plane-name $KONNECT_CP_NAME -``` -{: data-deployment-topology="konnect" data-test-step="block" } +``` \ No newline at end of file diff --git a/app/_includes/how-tos/steps/ping-gateway.md b/app/_includes/how-tos/steps/ping-gateway.md index 4a75c5232..418881b33 100644 --- a/app/_includes/how-tos/steps/ping-gateway.md +++ b/app/_includes/how-tos/steps/ping-gateway.md @@ -5,13 +5,6 @@ We'll be using decK for this tutorial, so let's check that {{site.base_gateway}} ```sh deck gateway ping ``` -{: data-deployment-topology="on-prem" } -```bash -deck gateway ping \ - --konnect-token ${{konnect_token}} \ - --konnect-control-plane-name $KONNECT_CP_NAME -``` -{: data-deployment-topology="konnect" } If everything is running, then you should get the following response: diff --git a/app/_includes/prereqs/entities.md b/app/_includes/prereqs/entities.md index cf8d5590b..41168989b 100644 --- a/app/_includes/prereqs/entities.md +++ b/app/_includes/prereqs/entities.md @@ -5,25 +5,14 @@ {% capture details_content %} For this tutorial, you'll need {{site.base_gateway}} entities, like Gateway Services and Routes, pre-configured. These entities are essential for {{site.base_gateway}} to function but installing them isn't the focus of this guide. Follow these steps to pre-configure them: -1. Create a `prereqs.yaml` file within your `deck_files` directory, and add the following content to it: +1. Run the following command: {% capture entities %} -```yaml -echo ' -{{ include.data }} -' | deck gateway apply - \ - --konnect-token $KONNECT_TOKEN \ - --konnect-control-plane-name $KONNECT_CP_NAME -``` -{: data-file="prereqs.yaml" data-deployment-topology="konnect" data-test-prereqs="block"} - ```yaml echo ' {{ include.data }} ' | deck gateway apply - ``` -{: data-file="prereqs.yaml" data-deployment-topology="on-prem" data-test-prereqs="block"} - {% endcapture %} {{ entities | indent: 3 }} diff --git a/app/_includes/prereqs/products/konnect.md b/app/_includes/prereqs/products/konnect.md index 8f9c94dda..4d26ea09a 100644 --- a/app/_includes/prereqs/products/konnect.md +++ b/app/_includes/prereqs/products/konnect.md @@ -14,8 +14,8 @@ If you don't have a Konnect account, you can get started quickly with our [onboa 2. Set the personal access token, the Control Plane Name and the Konnect proxy URL as environment variables: ```sh - export KONNECT_TOKEN=your-token - export KONNECT_CP_NAME=your-control-plane-name + export DECK_KONNECT_TOKEN=your-token + export DECK_KONNECT_CONTROL_PLANE_NAME=your-control-plane-name export KONNECT_PROXY_URL=konnect-proxy-url ```