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

docs(secret-management) update secret management docs for GA #4379

Merged
merged 7 commits into from
Sep 8, 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
1 change: 1 addition & 0 deletions .github/styles/kong/dictionary.txt
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ JsonPath
jwk
jwks
jwt
kafka
Keycloak
keyspace
kiali
Expand Down
12 changes: 6 additions & 6 deletions app/_hub/kong-inc/acme/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ params:
The account identifier. Can be reused in a different plugin instance.

This field is _referenceable_, which means it can be securely stored as a
[secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).
[secret](/gateway/latest/kong-enterprise/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/kong-enterprise/security/secrets-management/reference-format).
- name: api_uri
required: false
default: '` https://acme-v02.api.letsencrypt.org/directory`'
Expand Down Expand Up @@ -114,8 +114,8 @@ params:
External account binding (EAB) key id. You usually don't need to set this unless it is explicitly required by the CA.

This field is _referenceable_, which means it can be securely stored as a
[secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).
[secret](/gateway/latest/kong-enterprise/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/kong-enterprise/security/secrets-management/reference-format).
- name: eab_hmac_key
minimum_version: "2.4.x"
required: false
Expand All @@ -125,8 +125,8 @@ params:
External account binding (EAB) base64-encoded URL string of the HMAC key. You usually don't need to set this unless it is explicitly required by the CA.

This field is _referenceable_, which means it can be securely stored as a
[secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).
[secret](/gateway/latest/kong-enterprise/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/kong-enterprise/security/secrets-management/reference-format).
- name: rsa_key_size
minimum_version: "2.8.x"
required: false
Expand Down
12 changes: 6 additions & 6 deletions app/_hub/kong-inc/aws-lambda/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ params:
is configured.

This field is _referenceable_, which means it can be securely stored as a
[secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).
[secret](/gateway/latest/kong-enterprise/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/kong-enterprise/security/secrets-management/reference-format).
- name: aws_secret
required: semi
value_in_examples: <AWS_SECRET>
Expand All @@ -56,8 +56,8 @@ params:
is configured.

This field is _referenceable_, which means it can be securely stored as a
[secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).
[secret](/gateway/latest/kong-enterprise/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/kong-enterprise/security/secrets-management/reference-format).
- name: aws_region # old version, do not update
maximum_version: "2.5.x"
required: true
Expand Down Expand Up @@ -128,8 +128,8 @@ params:
used for a cross-account Lambda function invocation.

This field is _referenceable_, which means it can be securely stored as a
[secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).
[secret](/gateway/latest/kong-enterprise/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/kong-enterprise/security/secrets-management/reference-format).
- name: aws_role_session_name
minimum_version: "2.8.x"
required: false
Expand Down
9 changes: 4 additions & 5 deletions app/_hub/kong-inc/azure-functions/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
name: Azure Functions
publisher: Kong Inc.
source_url: 'https://github.com/Kong/kong-plugin-azure-functions'
desc: Invoke and manage Azure functions from Kong
description: |
This plugin invokes
Expand Down Expand Up @@ -60,8 +59,8 @@ params:
The apikey to access the Azure resources. If provided, it is injected as the `x-functions-key` header.

This field is _referenceable_, which means it can be securely stored as a
[secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).
[secret](/gateway/latest/kong-enterprise/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/kong-enterprise/security/secrets-management/reference-format).
- name: clientid
required: false
default: null
Expand All @@ -72,8 +71,8 @@ params:
The `clientid` to access the Azure resources. If provided, it is injected as the `x-functions-clientid` header.

This field is _referenceable_, which means it can be securely stored as a
[secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).
[secret](/gateway/latest/kong-enterprise/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/kong-enterprise/security/secrets-management/reference-format).
- name: https_verify
required: false
default: false
Expand Down
10 changes: 5 additions & 5 deletions app/_hub/kong-inc/forward-proxy/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,8 +132,8 @@ params:
by basic authentication.

This field is _referenceable_, which means it can be securely stored as a
[secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).
[secret](/gateway/latest/kong-enterprise/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/kong-enterprise/security/secrets-management/reference-format).
- name: auth_password
required: false
default: null
Expand All @@ -144,8 +144,8 @@ params:
by basic authentication.

This field is _referenceable_, which means it can be securely stored as a
[secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).
[secret](/gateway/latest/kong-enterprise/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/kong-enterprise/security/secrets-management/reference-format).
- name: https_verify
required: true
default: false
Expand Down Expand Up @@ -178,7 +178,7 @@ params:
* The `auth_password` and `auth_username` configuration fields are now marked as
referenceable, which means they can be securely stored as
[secrets](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).
in a vault. References must follow a [specific format](/gateway/latest/kong-enterprise/security/secrets-management/reference-format).

* Fixed a plugin version in the documentation. Previously, there was a plugin
version labelled as `1.0.x`. It is now updated to align with the
Expand Down
18 changes: 9 additions & 9 deletions app/_hub/kong-inc/graphql-rate-limiting-advanced/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,8 +179,8 @@ params:
If undefined, ACL authentication will not be performed. This requires Redis v6.0.0+.

This field is _referenceable_, which means it can be securely stored as a
[secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).
[secret](/gateway/latest/kong-enterprise/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/kong-enterprise/security/secrets-management/reference-format).
minimum_version: "2.8.x"
- name: redis.password
required: semi
Expand All @@ -192,8 +192,8 @@ params:
If undefined, no AUTH commands are sent to Redis.

This field is _referenceable_, which means it can be securely stored as a
[secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).
[secret](/gateway/latest/kong-enterprise/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/kong-enterprise/security/secrets-management/reference-format).
- name: redis.database
required: semi
default: 0
Expand All @@ -218,8 +218,8 @@ params:
If undefined, ACL authentication will not be performed. This requires Redis v6.2.0+.

This field is _referenceable_, which means it can be securely stored as a
[secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).
[secret](/gateway/latest/kong-enterprise/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/kong-enterprise/security/secrets-management/reference-format).
minimum_version: "2.8.x"
- name: redis.sentinel_password
required: semi
Expand All @@ -231,8 +231,8 @@ params:
If undefined, no AUTH commands are sent to Redis Sentinels.

This field is _referenceable_, which means it can be securely stored as a
[secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).
[secret](/gateway/latest/kong-enterprise/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/kong-enterprise/security/secrets-management/reference-format).
- name: redis.sentinel_role
required: semi
default: null
Expand Down Expand Up @@ -689,7 +689,7 @@ curl -i -X PATCH http://kong:8001/plugins/{plugin_id} \
* The `redis.username`, `redis.password`, `redis.sentinel_username`, and `redis.sentinel_password`
configuration fields are now marked as referenceable, which means they can be securely stored as
[secrets](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).
in a vault. References must follow a [specific format](/gateway/latest/kong-enterprise/security/secrets-management/reference-format).

* Fixed plugin versions in the documentation. Previously, the plugin versions
were labelled as `1.3-x` and `2.3.x`. They are now updated to align with the
Expand Down
14 changes: 7 additions & 7 deletions app/_hub/kong-inc/kafka-log/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,8 @@ params:
Username for SASL authentication.

This field is _referenceable_, which means it can be securely stored as a
[secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).
[secret](/gateway/latest/kong-enterprise/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/kong-enterprise/security/secrets-management/reference-format).
- name: authentication.password
required: false
value_in_examples: admin-secret
Expand All @@ -83,8 +83,8 @@ params:
Password for SASL authentication.

This field is _referenceable_, which means it can be securely stored as a
[secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).
[secret](/gateway/latest/kong-enterprise/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/kong-enterprise/security/secrets-management/reference-format).
- name: authentication.tokenauth
required: false
value_in_examples: false
Expand Down Expand Up @@ -313,7 +313,7 @@ Known limitations:

## Changelog

### Kong Gateway 2.8.x (plugin version 0.4.0)
**{{site.base_gateway}} 2.8.x**

* Added support for the `SCRAM-SHA-512` authentication mechanism.

Expand All @@ -322,9 +322,9 @@ Known limitations:
* The `authentication.user` and `authentication.password` configuration fields are now marked as
referenceable, which means they can be securely stored as
[secrets](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).
in a vault. References must follow a [specific format](/gateway/latest/kong-enterprise/security/secrets-management/reference-format).

### Kong Gateway 2.7.x (plugin version 0.3.0)
**{{site.base_gateway}} 2.7.x**

* Starting with {{site.base_gateway}} 2.7.0.0, if keyring encryption is enabled,
the `config.authentication.user` and `config.authentication.password` parameter
Expand Down
14 changes: 7 additions & 7 deletions app/_hub/kong-inc/kafka-upstream/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,8 @@ params:
Username for SASL authentication.

This field is _referenceable_, which means it can be securely stored as a
[secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).
[secret](/gateway/latest/kong-enterprise/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/kong-enterprise/security/secrets-management/reference-format).
- name: authentication.password
required: false
value_in_examples: admin-secret
Expand All @@ -85,8 +85,8 @@ params:
Password for SASL authentication.

This field is _referenceable_, which means it can be securely stored as a
[secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).
[secret](/gateway/latest/kong-enterprise/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/kong-enterprise/security/secrets-management/reference-format).
- name: authentication.tokenauth
required: false
value_in_examples: false
Expand Down Expand Up @@ -376,7 +376,7 @@ The following steps assume that {{site.base_gateway}} is installed and the Kafka

## Changelog

### Kong Gateway 2.8.x (plugin version 0.4.0)
**{{site.base_gateway}} 2.8.x**

* Added support for the `SCRAM-SHA-512` authentication mechanism.

Expand All @@ -385,9 +385,9 @@ The following steps assume that {{site.base_gateway}} is installed and the Kafka
* The `authentication.user` and `authentication.password` configuration fields are now marked as
referenceable, which means they can be securely stored as
[secrets](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).
in a vault. References must follow a [specific format](/gateway/latest/kong-enterprise/security/secrets-management/reference-format).

### Kong Gateway 2.7.x (plugin version 0.3.0)
**{{site.base_gateway}} 2.7.x**

* Starting with {{site.base_gateway}} 2.7.0.0, if keyring encryption is enabled,
the `config.authentication.user` and `config.authentication.password` parameter
Expand Down
2 changes: 1 addition & 1 deletion app/_hub/kong-inc/ldap-auth-advanced/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -318,7 +318,7 @@ mapping.
* The `ldap_password` and `bind_dn` configuration fields are now marked as
referenceable, which means they can be securely stored as
[secrets](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).
in a vault. References must follow a [specific format](/gateway/latest/kong-enterprise/security/secrets-management/reference-format).

**{{site.base_gateway}} 2.7.x**

Expand Down
4 changes: 2 additions & 2 deletions app/_hub/kong-inc/loggly/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ params:
Loggly [customer token](https://www.loggly.com/docs/customer-token-authentication-token/).

This field is _referenceable_, which means it can be securely stored as a
[secret](/gateway/latest/plan-and-deploy/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/plan-and-deploy/security/secrets-management/reference-format).
[secret](/gateway/latest/kong-enterprise/security/secrets-management/getting-started)
in a vault. References must follow a [specific format](/gateway/latest/kong-enterprise/security/secrets-management/reference-format).
- name: tags
required: false
default: '`kong`'
Expand Down
Loading