Skip to content

Commit

Permalink
Simplify Konnect decK steps (#384)
Browse files Browse the repository at this point in the history
* Simplify Konnect decK steps

* Remove mention of a prereqs.yaml file

---------

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
  • Loading branch information
mheap and lena-larionova authored Feb 4, 2025
1 parent a7ba22e commit 03e6d60
Show file tree
Hide file tree
Showing 5 changed files with 4 additions and 48 deletions.
11 changes: 0 additions & 11 deletions app/_includes/components/entity_examples.html
Original file line number Diff line number Diff line change
@@ -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" }
17 changes: 1 addition & 16 deletions app/_includes/how-tos/steps/apply_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,11 @@ 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.

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" }
```
7 changes: 0 additions & 7 deletions app/_includes/how-tos/steps/ping-gateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
13 changes: 1 addition & 12 deletions app/_includes/prereqs/entities.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 }}
Expand Down
4 changes: 2 additions & 2 deletions app/_includes/prereqs/products/konnect.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand Down

0 comments on commit 03e6d60

Please sign in to comment.