Fix: broken command examples for running decK with Docker (#7923)

* fix broken command examples * fix broken command examples
Kong · Sep 13, 2024 · 06a42f0 · 06a42f0
1 parent 1cca572
commit 06a42f0
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 9 deletions.
diff --git a/app/_src/deck/guides/run-with-docker-1.28.md b/app/_src/deck/guides/run-with-docker-1.28.md
@@ -5,6 +5,8 @@ content_type: how-to
 
 If you used the `kong/deck` Docker image to install decK, you can use the Docker image to manage decK. 
 
+Adjust `KONG_ADMIN_HOST` and the port `8001` in the following examples to the host and port of your own {{site.base_gateway}} instance.
+
 ## Prerequisites
 decK must be installed using a [Docker image](/deck/latest/installation/#docker-image).
 
@@ -14,7 +16,7 @@ Run this command to export the `kong.yaml` file:
 ```bash
 docker run -i \
 -v $(pwd):/deck \
-kong/deck --kong-addr http://KONG_ADMIN_HOST:KONG_ADMIN_PORT --headers kong-admin-token:KONG_ADMIN_TOKEN -o /deck/kong.yaml gateway dump
+kong/deck --kong-addr http://KONG_ADMIN_HOST:8001 --headers kong-admin-token:KONG_ADMIN_TOKEN -o /deck/kong.yaml gateway dump
 ```
 Where `$(pwd)/kong.yaml` is the path to a `kong.yaml` file.
 
@@ -25,7 +27,7 @@ Run this command to export objects from all the workspaces:
 docker run -i \
 -v $(pwd):/deck \
 --workdir /deck \
-kong/deck --kong-addr http://KONG_ADMIN_HOST:KONG_ADMIN_PORT:8001 --headers kong-admin-token:KONG_ADMIN_TOKEN -o /deck/kong.yaml gateway dump --all-workspaces
+kong/deck --kong-addr http://KONG_ADMIN_HOST:8001 --headers kong-admin-token:KONG_ADMIN_TOKEN -o /deck/kong.yaml gateway dump --all-workspaces
 ```
 
 ## Reset the configuration
@@ -34,7 +36,7 @@ Run this command to initialize Kong objects:
 ```bash
 docker run -i \
 -v $(pwd):/deck \
-kong/deck --kong-addr http://KONG_ADMIN_HOST:KONG_ADMIN_PORT:8001 --headers kong-admin-token:KONG_ADMIN_TOKEN gateway reset
+kong/deck --kong-addr http://KONG_ADMIN_HOST:8001 --headers kong-admin-token:KONG_ADMIN_TOKEN gateway reset
 ```
 
 ## Import the configuration
@@ -43,7 +45,7 @@ Run this command to import `kong.yaml`:
 ```bash
 docker run -i \
 -v $(pwd):/deck \
-kong/deck --kong-addr http://KONG_ADMIN_HOST:KONG_ADMIN_PORT:8001 --headers kong-admin-token:KONG_ADMIN_TOKEN /deck/kong.yaml gateway sync
+kong/deck --kong-addr http://KONG_ADMIN_HOST:8001 --headers kong-admin-token:KONG_ADMIN_TOKEN gateway sync /deck/kong.yaml
 ```
 In this example, `kong.yaml` is in `$(pwd)/kong.yaml`.
 
@@ -60,4 +62,4 @@ Run the following to check available command flags:
 docker run kong/deck gateway dump --help
 docker run kong/deck gateway sync --help
 docker run kong/deck gateway reset --help
-```
+```
diff --git a/app/_src/deck/guides/run-with-docker.md b/app/_src/deck/guides/run-with-docker.md
@@ -5,6 +5,8 @@ content_type: how-to
 
 If you used the `kong/deck` Docker image to install decK, you can use the Docker image to manage decK. 
 
+Adjust `KONG_ADMIN_HOST` and the port `8001` in the following examples to the host and port of your own {{site.base_gateway}} instance.
+
 ## Prerequisites
 decK must be installed using a [Docker image](/deck/latest/installation/#docker-image).
 
@@ -14,7 +16,7 @@ Run this command to export the `kong.yaml` file:
 ```bash
 docker run -i \
 -v $(pwd):/deck \
-kong/deck --kong-addr http://KONG_ADMIN_HOST:KONG_ADMIN_PORT --headers kong-admin-token:KONG_ADMIN_TOKEN -o /deck/kong.yaml dump
+kong/deck --kong-addr http://KONG_ADMIN_HOST:8001 --headers kong-admin-token:KONG_ADMIN_TOKEN -o /deck/kong.yaml dump
 ```
 Where `$(pwd)/kong.yaml` is the path to a `kong.yaml` file.
 
@@ -25,7 +27,7 @@ Run this command to export objects from all the workspaces:
 docker run -i \
 -v $(pwd):/deck \
 --workdir /deck \
-kong/deck --kong-addr http://KONG_ADMIN_HOST:KONG_ADMIN_PORT:8001 --headers kong-admin-token:KONG_ADMIN_TOKEN dump --all-workspaces
+kong/deck --kong-addr http://KONG_ADMIN_HOST:8001 --headers kong-admin-token:KONG_ADMIN_TOKEN dump --all-workspaces
 ```
 
 ## Reset the configuration
@@ -34,7 +36,7 @@ Run this command to initialize Kong objects:
 ```bash
 docker run -i \
 -v $(pwd):/deck \
-kong/deck --kong-addr http://KONG_ADMIN_HOST:KONG_ADMIN_PORT:8001 --headers kong-admin-token:KONG_ADMIN_TOKEN reset
+kong/deck --kong-addr http://KONG_ADMIN_HOST:8001 --headers kong-admin-token:KONG_ADMIN_TOKEN reset
 ```
 
 ## Import the configuration
@@ -43,7 +45,7 @@ Run this command to import `kong.yaml`:
 ```bash
 docker run -i \
 -v $(pwd):/deck \
-kong/deck --kong-addr http://KONG_ADMIN_HOST:KONG_ADMIN_PORT:8001 --headers kong-admin-token:KONG_ADMIN_TOKEN -s /deck/kong.yaml sync
+kong/deck --kong-addr http://KONG_ADMIN_HOST:8001 --headers kong-admin-token:KONG_ADMIN_TOKEN -s /deck/kong.yaml sync
 ```
 In this example, `kong.yaml` is in `$(pwd)/kong.yaml`.