From c31e6c65dff00d8b7da925af9967e090daeea924 Mon Sep 17 00:00:00 2001 From: Mike Jang <3287976+mjang@users.noreply.github.com> Date: Wed, 30 Jul 2025 10:47:29 -0700 Subject: [PATCH 1/2] fix: clarify data plane keys --- .../nginx-one/data-plane-key-guideline.md | 18 ++++++++++++++++++ content/nginx-one/getting-started.md | 8 +------- 2 files changed, 19 insertions(+), 7 deletions(-) create mode 100644 content/includes/nginx-one/data-plane-key-guideline.md diff --git a/content/includes/nginx-one/data-plane-key-guideline.md b/content/includes/nginx-one/data-plane-key-guideline.md new file mode 100644 index 000000000..20a7a7a5d --- /dev/null +++ b/content/includes/nginx-one/data-plane-key-guideline.md @@ -0,0 +1,18 @@ +--- +files: + - content/nginx-one/nginx-configs/config-sync-group/manage-config-sync-groups.md + - content/nginx-one/getting-started.md +--- + +{{}} +Data plane keys are displayed only once and cannot be retrieved later. Be sure to copy and store this key securely. + +Data plane keys expire after one year. You can change this expiration date by [editing the key]({{< ref "nginx-one/connect-instances/create-manage-data-plane-keys.md#change-expiration-date" >}}). + +Your NGINX instances stay connected as long as the data plane key is active. If: + +- You [revoke a data plane key]({{< ref "nginx-one/connect-instances/create-manage-data-plane-keys.md#revoke-data-plane-key" >}}) +- A data plane key expires + +That disconnects all instances that were registered with that key. +{{}} diff --git a/content/nginx-one/getting-started.md b/content/nginx-one/getting-started.md index 19535d36a..c3bb315f4 100644 --- a/content/nginx-one/getting-started.md +++ b/content/nginx-one/getting-started.md @@ -117,13 +117,7 @@ To generate a data plane key: - **For a new key:** In the **Add Instance** pane, select **Generate Data Plane Key**. - **To reuse an existing key:** If you already have a data plane key and want to use it again, select **Use existing key**. Then, enter the key's value in the **Data Plane Key** box. -{{}} -Data plane keys are displayed only once and cannot be retrieved later. Be sure to copy and store this key securely. - -Data plane keys expire after one year. You can change this expiration date later by [editing the key]({{< ref "nginx-one/connect-instances/create-manage-data-plane-keys.md#change-expiration-date" >}}). - -[Revoking a data plane key]({{< ref "nginx-one/connect-instances/create-manage-data-plane-keys.md#revoke-data-plane-key" >}}) disconnects all instances that were registered with that key. -{{}} +{{< include "/nginx-one/data-plane-key-guideline.md" >}} ### Add an instance From b7e491167359c466ebdc9e56f89bdb76c1e779cf Mon Sep 17 00:00:00 2001 From: Mike Jang <3287976+mjang@users.noreply.github.com> Date: Wed, 30 Jul 2025 11:49:40 -0700 Subject: [PATCH 2/2] More --- content/includes/nginx-one/data-plane-key-guideline.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/includes/nginx-one/data-plane-key-guideline.md b/content/includes/nginx-one/data-plane-key-guideline.md index 20a7a7a5d..17b41b99f 100644 --- a/content/includes/nginx-one/data-plane-key-guideline.md +++ b/content/includes/nginx-one/data-plane-key-guideline.md @@ -5,7 +5,7 @@ files: --- {{}} -Data plane keys are displayed only once and cannot be retrieved later. Be sure to copy and store this key securely. +Data plane keys are displayed only once and cannot be retrieved later. When you create a data plane key,copy and store this key securely. Data plane keys expire after one year. You can change this expiration date by [editing the key]({{< ref "nginx-one/connect-instances/create-manage-data-plane-keys.md#change-expiration-date" >}}).