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.

Sign up for GitHub

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

Feat: Add reserved entity names to References section #8150

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Feat: Add reserved entity names to References section #8150

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
55 changes: 55 additions & 0 deletions app/_src/gateway/reference/reserved-entity-names.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
title: Reserved Entity Names
content_type: reference
badge: enterprise
---

The {{site.base_gateway}} maintains a list of reserved entity names which cannot be used when naming workspaces or other entities.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should all of these entities be singular or plural? Is the plural name reserved but the singular isn't?

* `admins`
* `applications`
* `application_instances`
* `audit_objects`
* `audit_requests`
* `ca_certificates`
* `certificates`
* `clustering_data_planes`
* `consumer_group_consumers`
* `consumer_group_plugins`
* `consumer_groups`
* `consumer_reset_secrets`
* `consumers`
* `credentials`
* `developers`
* `document_objects`
* `event_hooks`
* `filter_chains`
* `files`
* `group_rbac_roles`
* `groups`
* `key_sets`
* `keyring_keys`
* `keyring_meta`
* `keys`
* `licenses`
* `legacy_files`
* `login_attempts`
* `parameters`
* `plugins`
* `rbac_role_endpoints`
* `rbac_role_entities`
* `rbac_roles`
* `rbac_user_groups`
* `rbac_user_roles`
* `rbac_users`
* `routes`
* `services`
* `snis`
* `tags`
* `targets`
* `upstreams`
* `vaults`
* `workspaces`
* `workspace_entity_counters`

For example, a workspace cannot be named `consumers` or `vaults`. Doing so will yield a `schema violation` error response.
Loading