Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Broken links, continued #4375

Merged
merged 4 commits into from
Sep 6, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions app/_includes/md/admin-listen.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,18 @@
> **Important:** The settings below are intended for non-production use **only**, as they override the default `admin_listen` setting to listen for requests from any source. **Do not** use these settings in environments directly exposed to the internet.
>
> <br>
> If you need to expose the `admin_listen` port to the internet in a production environment, [secure it with authentication](/gateway/{{ include.kong_version }}/production/running-kong/secure-admin-api).
> If you need to expose the `admin_listen` port to the internet in a production environment,
> {% if_version lte:2.8.x
%}[secure it with authentication](/gateway/{{include.kong_version}}/admin-api/secure-admin-api).{% endif_version %}{% if_version gte:3.0.x
%}[secure it with authentication](/gateway/{{include.kong_version}}/production/running-kong/secure-admin-api).{% endif_version %}


{% endif %}
{% if include.desc == "short" %}
{:.important}
> **Important**: If you need to expose the `admin_listen` port to the internet in a production environment, [secure it with authentication](/gateway/{{ include.kong_version }}/production/running-kong/secure-admin-api).
> **Important**: If you need to expose the `admin_listen` port to the internet in a production environment,
> {% if_version lte:2.8.x
%}[secure it with authentication](/gateway/{{include.kong_version}}/admin-api/secure-admin-api).{% endif_version %}{% if_version gte:3.0.x
%}[secure it with authentication](/gateway/{{include.kong_version}}/production/running-kong/secure-admin-api).{% endif_version %}

{% endif %}
20 changes: 19 additions & 1 deletion app/_includes/md/enterprise/deploy-license.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,10 +121,19 @@ substituting your own license key.

1. Include the license as part of the `docker run` command when starting a {{site.base_gateway}} container:

{% if_version lte:2.8.x %}
{:.note}
> **Note:** This is only a snippet. For a full working example, see the instructions to
[Install Kong Gateway on Docker](/gateway/{{page.kong_version}}/install-and-run/docker).

{% endif_version %}
{% if_version gte:3.0.x %}
{:.note}
> **Note:** This is only a snippet. For a full working example, see the instructions to
[Install Kong Gateway on Docker](/gateway/{{page.kong_version}}/install/docker).

{% endif_version %}

```bash
docker run -d --name kong-gateway \
--network=kong-net \
Expand All @@ -142,13 +151,22 @@ on each node manually.

Include the license as part of the `docker run` command when starting a
{{site.base_gateway}} container. Mount the path to the file on your
local filesystem to a directory in the Docker container, making the file visible
local filesystem to a directory in the Docker container, making the file visible
from the container:

{% if_version lte:2.8.x %}
{:.note}
> **Note:** This is only a snippet. For a full working example, see the instructions to
[Install Kong Gateway on Docker](/gateway/{{page.kong_version}}/install-and-run/docker).

{% endif_version %}
{% if_version gte:3.0.x %}
{:.note}
> **Note:** This is only a snippet. For a full working example, see the instructions to
[Install Kong Gateway on Docker](/gateway/{{page.kong_version}}/install/docker).

{% endif_version %}

```bash
docker run -d --name kong-gateway \
--network=kong-net \
Expand Down
2 changes: 1 addition & 1 deletion app/_includes/md/enterprise/turn-on-rbac.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ The cookie is used for all subsequent requests to authenticate the user, until i
{% endnavtabs %}

{% if_version lte:2.8.x %}
Outside of this guide, you will likely want to modify these settings differently, depending on your installation. You can read more about these settings here: [Basic Auth for Kong Manager](/gateway/latest/kong-manager/auth//basic/).
Outside of this guide, you will likely want to modify these settings differently, depending on your installation. You can read more about these settings here: [Basic Auth for Kong Manager](/gateway/latest/kong-manager/auth/basic/).
{% endif_version %}

{% if_version gte:3.0.x %}
Expand Down
5 changes: 5 additions & 0 deletions app/_includes/md/gateway/deployment-options.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
<!-- Deployment Options section; used in all Enterprise installation topics - except k8s -->
The installation instructions explain how to deploy {{site.base_gateway}} in its entirety on a single node -- with or without a database.

{% if_version lte:2.8.x %}
The instructions are the same for setting up a Control Plane instance in Hybrid mode. After you set up the Control Plane, you set up additional Gateway instances for the Data Planes. See [Hybrid Mode Setup](/gateway/{{include.kong_version}}/plan-and-deploy/hybrid-mode/hybrid-mode-setup) for details.
{% endif_version %}
{% if_version gte:3.0.x %}
The instructions are the same for setting up a Control Plane instance in Hybrid mode. After you set up the Control Plane, you set up additional Gateway instances for the Data Planes. See [Hybrid Mode Setup](/gateway/{{include.kong_version}}/production/deployment-topologies/hybrid-mode/setup) for details.
{% endif_version %}
12 changes: 11 additions & 1 deletion app/_includes/md/gateway/root-user-note.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,23 @@
<!-- Shared between all Linux installation topics: Amazon Linux, CentOS, Ubuntu, and RHEL
<!-- Shared between all Linux installation topics: Amazon Linux, CentOS, Ubuntu, and RHEL
located in the app/gateway/{version}/install folder.

Included in the setup.md include located in this folder - in two sections - Using a yaml declarative config file
and Seed Super Admin.
-->

{% if_version lte:2.8.x %}
{:.note}
> **Note:** When you start {{site.base_gateway}}, the NGINX master process runs as `root`, and the worker processes
run as `kong` by default. If this is not the desired behavior, you can switch the NGINX master process
to run on the built-in `kong` user or to a custom non-root user before starting {{site.base_gateway}}.
For more information, see
[Running Kong as a Non-Root User](/gateway/{{include.kong_version}}/plan-and-deploy/kong-user).

{% endif_version %}
{% if_version gte:3.0.x %}
> **Note:** When you start {{site.base_gateway}}, the NGINX master process runs as `root`, and the worker processes
run as `kong` by default. If this is not the desired behavior, you can switch the NGINX master process
to run on the built-in `kong` user or to a custom non-root user before starting {{site.base_gateway}}.
For more information, see
[Running Kong as a Non-Root User](/gateway/{{include.kong_version}}/production/running-kong/kong-user).
{% endif_version %}
24 changes: 23 additions & 1 deletion app/_includes/md/gateway/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ See the [Kong Manager setup guide](/gateway/{{page.kong_version}}/kong-manager/e
2. Update the Admin API setting in the `kong.conf` file to listen on the needed network interfaces on the OS host.
A setting of `0.0.0.0:8001` will listen on port `8001` on all available network interfaces.

{% include_cached /md/admin-listen.md desc='long' %}
{% include_cached /md/admin-listen.md kong_version=page.kong_version desc='long' %}

Example configuration:

Expand Down Expand Up @@ -273,6 +273,8 @@ or hybrid mode), you can enable the [Dev Portal](/gateway/{{page.kong_version}}/
## Troubleshooting and support
{:.badge .enterprise}

{% if_version gte:3.0.x %}

For troubleshooting license issues, see:
* [Deployment options for licenses](/gateway/{{page.kong_version}}/licenses/deploy)
* [`/licenses` API reference](/gateway/{{page.kong_version}}/admin-api/licenses/reference/)
Expand All @@ -287,3 +289,23 @@ your setup, reach out to your Kong Support contact or go to the
Check out {{site.base_gateway}}'s series of
[Getting Started](/gateway/{{include.kong_version}}/get-started/) guides to get the most
out of {{site.base_gateway}}.

{% endif_version %}
{% if_version lte:2.8.x %}

For troubleshooting license issues, see:
* [Deployment options for licenses](/gateway/{{page.kong_version}}/plan-and-deploy/licenses/deploy-license)
* [`/licenses` API reference](/gateway/{{page.kong_version}}/admin-api/licenses/reference/)
* [`/licenses` API examples](/gateway/{{page.kong_version}}/admin-api/licenses/examples)

If you did not receive an `HTTP/1.1 200 OK` message or need assistance completing
your setup, reach out to your Kong Support contact or go to the
[Support Portal](https://support.konghq.com/support/s/).

## Next steps

Check out {{site.base_gateway}}'s series of
[Getting Started](/gateway/{{include.kong_version}}/get-started/comprehensive/) guides to get the most
out of {{site.base_gateway}}.

{% endif_version %}
2 changes: 1 addition & 1 deletion app/enterprise/2.1.x/plugin-development/custom-entities.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ for one that works with Cassandra too.
enforce it for Cassandra, but for Postgres you must set this constraint in
the migrations.

To see a real-life example, give a look at the [Key-Auth plugin migrations](https://github.com/Kong/kong/tree/{{page.kong_version}}/kong/plugins/key-auth/migrations).
To see a real-life example, give a look at the [Key-Auth plugin migrations](https://github.com/Kong/kong/tree/master/kong/plugins/key-auth/migrations).

---

Expand Down
2 changes: 1 addition & 1 deletion app/enterprise/2.1.x/plugin-development/tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ might also want to write integration tests. Again, Kong has your back.
## Write integration tests

The preferred testing framework for Kong is
[busted](http://olivinelabs.com/busted/) running with the
[busted](https://github.com/lunarmodules/busted/) running with the
[resty-cli](https://github.com/openresty/resty-cli) interpreter, though you are
free to use another one if you wish. In the Kong repository, the busted
executable can be found at `bin/busted`.
Expand Down
2 changes: 1 addition & 1 deletion app/enterprise/2.2.x/plugin-development/custom-entities.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ for one that works with Cassandra too.
enforce it for Cassandra, but for Postgres you must set this constraint in
the migrations.

To see a real-life example, give a look at the [Key-Auth plugin migrations](https://github.com/Kong/kong/tree/{{page.kong_version}}/kong/plugins/key-auth/migrations).
To see a real-life example, give a look at the [Key-Auth plugin migrations](https://github.com/Kong/kong/tree/master/kong/plugins/key-auth/migrations).

---

Expand Down
2 changes: 1 addition & 1 deletion app/enterprise/2.2.x/plugin-development/tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ might also want to write integration tests. Again, Kong has your back.
## Write integration tests

The preferred testing framework for Kong is
[busted](http://olivinelabs.com/busted/) running with the
[busted](https://github.com/lunarmodules/busted/) running with the
[resty-cli](https://github.com/openresty/resty-cli) interpreter, though you are
free to use another one if you wish. In the Kong repository, the busted
executable can be found at `bin/busted`.
Expand Down
2 changes: 1 addition & 1 deletion app/enterprise/2.3.x/plugin-development/custom-entities.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ for one that works with Cassandra too.
enforce it for Cassandra, but for Postgres you must set this constraint in
the migrations.

To see a real-life example, give a look at the [Key-Auth plugin migrations](https://github.com/Kong/kong/tree/{{page.kong_version}}/kong/plugins/key-auth/migrations).
To see a real-life example, give a look at the [Key-Auth plugin migrations](https://github.com/Kong/kong/tree/master/kong/plugins/key-auth/migrations).

---

Expand Down
2 changes: 1 addition & 1 deletion app/enterprise/2.3.x/plugin-development/tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ might also want to write integration tests. Again, Kong has your back.
## Write integration tests

The preferred testing framework for Kong is
[busted](http://olivinelabs.com/busted/) running with the
[busted](https://github.com/lunarmodules/busted/) running with the
[resty-cli](https://github.com/openresty/resty-cli) interpreter, though you are
free to use another one if you wish. In the Kong repository, the busted
executable can be found at `bin/busted`.
Expand Down
2 changes: 1 addition & 1 deletion app/enterprise/2.4.x/plugin-development/custom-entities.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ for one that works with Cassandra too.
enforce it for Cassandra, but for Postgres you must set this constraint in
the migrations.

To see a real-life example, give a look at the [Key-Auth plugin migrations](https://github.com/Kong/kong/tree/{{page.kong_version}}/kong/plugins/key-auth/migrations).
To see a real-life example, give a look at the [Key-Auth plugin migrations](https://github.com/Kong/kong/tree/master/kong/plugins/key-auth/migrations).

---

Expand Down
2 changes: 1 addition & 1 deletion app/enterprise/2.4.x/plugin-development/tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ might also want to write integration tests. Again, Kong has your back.
## Write integration tests

The preferred testing framework for Kong is
[busted](http://olivinelabs.com/busted/) running with the
[busted](https://github.com/lunarmodules/busted/) running with the
[resty-cli](https://github.com/openresty/resty-cli) interpreter, though you are
free to use another one if you wish. In the Kong repository, the busted
executable can be found at `bin/busted`.
Expand Down
2 changes: 1 addition & 1 deletion app/enterprise/2.5.x/plugin-development/custom-entities.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ for one that works with Cassandra too.
enforce it for Cassandra, but for Postgres you must set this constraint in
the migrations.

To see a real-life example, give a look at the [Key-Auth plugin migrations](https://github.com/Kong/kong/tree/{{page.kong_version}}/kong/plugins/key-auth/migrations).
To see a real-life example, give a look at the [Key-Auth plugin migrations](https://github.com/Kong/kong/tree/master/kong/plugins/key-auth/migrations).

---

Expand Down
2 changes: 1 addition & 1 deletion app/enterprise/2.5.x/plugin-development/tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ might also want to write integration tests. Again, Kong has your back.
## Write integration tests

The preferred testing framework for Kong is
[busted](http://olivinelabs.com/busted/) running with the
[busted](https://github.com/lunarmodules/busted/) running with the
[resty-cli](https://github.com/openresty/resty-cli) interpreter, though you are
free to use another one if you wish. In the Kong repository, the busted
executable can be found at `bin/busted`.
Expand Down
6 changes: 2 additions & 4 deletions app/gateway-oss/2.0.x/plugin-development/admin-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,10 +95,8 @@ return {
```

This code will create two Admin API endpoints in `/consumers/:consumers/key-auth`, to
obtain (`GET`) and create (`POST`) credentials associated to a given consumer. On this example
the functions are provided by the `kong.api.endpoints` library. If you want to see a more
complete example, with custom code in functions, see
[the `api.lua` file from the key-auth plugin](https://github.com/Kong/kong/blob/master/kong/plugins/key-auth/api.lua).
obtain (`GET`) and create (`POST`) credentials associated to a given consumer. In this example,
the functions are provided by the `kong.api.endpoints` library.

The `endpoints` module currently contains the default implementation for the most usual CRUD
operations used in Kong. This module provides you with helpers for any insert, retrieve,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ for one that works with Cassandra too.
enforce it for Cassandra, but for Postgres you must set this constraint in
the migrations.

To see a real-life example, give a look at the [Key-Auth plugin migrations](https://github.com/Kong/kong/tree/{{page.kong_version}}/kong/plugins/key-auth/migrations).
To see a real-life example, give a look at the [Key-Auth plugin migrations](https://github.com/Kong/kong/tree/master/kong/plugins/key-auth/migrations).

---

Expand Down
2 changes: 1 addition & 1 deletion app/gateway-oss/2.0.x/plugin-development/tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ might also want to write integration tests. Again, Kong has your back.
## Write integration tests

The preferred testing framework for Kong is
[busted](http://olivinelabs.com/busted/) running with the
[busted](https://github.com/lunarmodules/busted/) running with the
[resty-cli](https://github.com/openresty/resty-cli) interpreter, though you are
free to use another one if you wish. In the Kong repository, the busted
executable can be found at `bin/busted`.
Expand Down
6 changes: 2 additions & 4 deletions app/gateway-oss/2.1.x/plugin-development/admin-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,10 +95,8 @@ return {
```

This code will create two Admin API endpoints in `/consumers/:consumers/key-auth`, to
obtain (`GET`) and create (`POST`) credentials associated to a given consumer. On this example
the functions are provided by the `kong.api.endpoints` library. If you want to see a more
complete example, with custom code in functions, see
[the `api.lua` file from the key-auth plugin](https://github.com/Kong/kong/blob/master/kong/plugins/key-auth/api.lua).
obtain (`GET`) and create (`POST`) credentials associated to a given consumer. In this example,
the functions are provided by the `kong.api.endpoints` library.

The `endpoints` module currently contains the default implementation for the most usual CRUD
operations used in Kong. This module provides you with helpers for any insert, retrieve,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ for one that works with Cassandra too.
enforce it for Cassandra, but for Postgres you must set this constraint in
the migrations.

To see a real-life example, give a look at the [Key-Auth plugin migrations](https://github.com/Kong/kong/tree/{{page.kong_version}}/kong/plugins/key-auth/migrations).
To see a real-life example, give a look at the [Key-Auth plugin migrations](https://github.com/Kong/kong/tree/master/kong/plugins/key-auth/migrations).

---

Expand Down
2 changes: 1 addition & 1 deletion app/gateway-oss/2.1.x/plugin-development/tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ might also want to write integration tests. Again, Kong has your back.
## Write integration tests

The preferred testing framework for Kong is
[busted](http://olivinelabs.com/busted/) running with the
[busted](https://github.com/lunarmodules/busted/) running with the
[resty-cli](https://github.com/openresty/resty-cli) interpreter, though you are
free to use another one if you wish. In the Kong repository, the busted
executable can be found at `bin/busted`.
Expand Down
8 changes: 3 additions & 5 deletions app/gateway-oss/2.2.x/plugin-development/admin-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ chapter: 8

<div class="alert alert-warning">
<strong>Note:</strong> The Admin API extensions are available only
for HTTP plugins, not Stream plugins.
for HTTP plugins, not Stream plugins.
</div>

## Introduction
Expand Down Expand Up @@ -100,10 +100,8 @@ return {
```

This code will create two Admin API endpoints in `/consumers/:consumers/key-auth`, to
obtain (`GET`) and create (`POST`) credentials associated to a given consumer. On this example
the functions are provided by the `kong.api.endpoints` library. If you want to see a more
complete example, with custom code in functions, see
[the `api.lua` file from the key-auth plugin](https://github.com/Kong/kong/blob/master/kong/plugins/key-auth/api.lua).
obtain (`GET`) and create (`POST`) credentials associated to a given consumer. In this example,
the functions are provided by the `kong.api.endpoints` library.

The `endpoints` module currently contains the default implementation for the most usual CRUD
operations used in Kong. This module provides you with helpers for any insert, retrieve,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ for one that works with Cassandra too.
enforce it for Cassandra, but for Postgres you must set this constraint in
the migrations.

To see a real-life example, give a look at the [Key-Auth plugin migrations](https://github.com/Kong/kong/tree/{{page.kong_version}}/kong/plugins/key-auth/migrations).
To see a real-life example, give a look at the [Key-Auth plugin migrations](https://github.com/Kong/kong/tree/master/kong/plugins/key-auth/migrations).

---

Expand Down
2 changes: 1 addition & 1 deletion app/gateway-oss/2.2.x/plugin-development/tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ might also want to write integration tests. Again, Kong has your back.
## Write integration tests

The preferred testing framework for Kong is
[busted](http://olivinelabs.com/busted/) running with the
[busted](https://github.com/lunarmodules/busted/) running with the
[resty-cli](https://github.com/openresty/resty-cli) interpreter, though you are
free to use another one if you wish. In the Kong repository, the busted
executable can be found at `bin/busted`.
Expand Down
8 changes: 3 additions & 5 deletions app/gateway-oss/2.3.x/plugin-development/admin-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ chapter: 8

<div class="alert alert-warning">
<strong>Note:</strong> The Admin API extensions are available only
for HTTP plugins, not Stream plugins.
for HTTP plugins, not Stream plugins.
</div>

## Introduction
Expand Down Expand Up @@ -100,10 +100,8 @@ return {
```

This code will create two Admin API endpoints in `/consumers/:consumers/key-auth`, to
obtain (`GET`) and create (`POST`) credentials associated to a given consumer. On this example
the functions are provided by the `kong.api.endpoints` library. If you want to see a more
complete example, with custom code in functions, see
[the `api.lua` file from the key-auth plugin](https://github.com/Kong/kong/blob/master/kong/plugins/key-auth/api.lua).
obtain (`GET`) and create (`POST`) credentials associated to a given consumer. In this example,
the functions are provided by the `kong.api.endpoints` library.

The `endpoints` module currently contains the default implementation for the most usual CRUD
operations used in Kong. This module provides you with helpers for any insert, retrieve,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ for one that works with Cassandra too.
enforce it for Cassandra, but for Postgres you must set this constraint in
the migrations.

To see a real-life example, give a look at the [Key-Auth plugin migrations](https://github.com/Kong/kong/tree/{{page.kong_version}}/kong/plugins/key-auth/migrations).
To see a real-life example, give a look at the [Key-Auth plugin migrations](https://github.com/Kong/kong/tree/master/kong/plugins/key-auth/migrations).

---

Expand Down
Loading