Skip to content

DRAFT: Fix data plane keys #912

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

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft
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
18 changes: 18 additions & 0 deletions content/includes/nginx-one/data-plane-key-guideline.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
files:
- content/nginx-one/nginx-configs/config-sync-group/manage-config-sync-groups.md
- content/nginx-one/getting-started.md
---

{{<call-out "caution" "Data plane key guidelines" "fas fa-key" >}}
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" >}}).

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.
{{</call-out>}}
8 changes: 1 addition & 7 deletions content/nginx-one/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

{{<call-out "caution" "Data plane key guidelines" "fas fa-key" >}}
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.
{{</call-out>}}
{{< include "/nginx-one/data-plane-key-guideline.md" >}}

### Add an instance

Expand Down