nginx / nginx/documentation

Set up warning for data plane keys

Open
#904 1 comment 0 reactions 1 assignee View on GitHub

@mjang is already working on this.

Since Jul 29, 2025.

bug documentation P4 - Low (TTR: 90 days) product/nginx-one
Dominant language
HTML
Stars
94
Forks
174
Avg merge
1d 10h
Merged PRs (30d)
66

Description

Overview

Users need clear understanding of data plane keys

I'm calling this a bug, as the consequences of an expiring data plane key is a loss of connection to NGINX One Console. However, IMO it's a p4, as the default lifetime is one year.

Description

  • Definition (in glossary). Is that good enough? Check against F5 definition, if any
  • Use. While we list data plane key labels in the UI, it's up to the user to save those keys when they create them
  • Whenever a data plane key is revoked, or expires, all instances which used that data plane key also loses their connection
  • If a user has a data plane key (and remembered to record it), they can use it to create any kind of instance
    • They can create data plane keys when creating an instance, connecting NIC, connecting NGF (and probably other options). They can also create them with the API
    • We're setting up notifications for when:
      • Data plane keys are within 30 days of expiring
      • Data plane keys expire

Acceptance criteria

see Description

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.