From cff8bc0e886b5cd29bee03072072be4cc7f434a3 Mon Sep 17 00:00:00 2001 From: Boobalan Rathinam <57693963+brathina-spectro@users.noreply.github.com> Date: Wed, 15 May 2024 14:20:32 -0700 Subject: [PATCH] docs: cluster profile resource usage computation (#2802) * Cluster profile resource usage computation Every version of the profile has a unique identifier and gets counted towards the profile resource usage. * chore: style update * chore: fixed page location --------- Co-authored-by: Karl Cardenas (cherry picked from commit a9e481d939e8b836c4c4cfa5e5deac51c21d1c86) --- .../tenant-settings/add-registry.md | 2 +- .../tenant-settings/api-key-management.md | 2 +- .../tenant-settings/login-banner.md | 2 +- .../palette-resource-limits.md | 62 ++++++++++++++++++ .../tenant-settings/tenant-settings.md | 2 + .../palette-resource-limits.md | 64 ------------------- redirects.js | 4 ++ 7 files changed, 71 insertions(+), 67 deletions(-) create mode 100644 docs/docs-content/tenant-settings/palette-resource-limits.md delete mode 100644 docs/docs-content/user-management/palette-resource-limits.md diff --git a/docs/docs-content/tenant-settings/add-registry.md b/docs/docs-content/tenant-settings/add-registry.md index 0619eb8592..0c049162b5 100644 --- a/docs/docs-content/tenant-settings/add-registry.md +++ b/docs/docs-content/tenant-settings/add-registry.md @@ -4,7 +4,7 @@ title: "Add Tenant-Level Registry" description: "Learn how to add a tenant-level registry in Palette." icon: "" hide_table_of_contents: false -sidebar_position: 60 +sidebar_position: 10 tags: ["enterprise", "management", "registry"] --- diff --git a/docs/docs-content/tenant-settings/api-key-management.md b/docs/docs-content/tenant-settings/api-key-management.md index 0a3b7565dd..7dd8908afa 100644 --- a/docs/docs-content/tenant-settings/api-key-management.md +++ b/docs/docs-content/tenant-settings/api-key-management.md @@ -4,7 +4,7 @@ title: "API Key Management" description: "Learn how to set a login banner for your Palette tenant." icon: "" hide_table_of_contents: false -sidebar_position: 0 +sidebar_position: 20 tags: ["tenant-administration", "authentication", "api-key"] --- diff --git a/docs/docs-content/tenant-settings/login-banner.md b/docs/docs-content/tenant-settings/login-banner.md index fb7396fc6e..781c17a93f 100644 --- a/docs/docs-content/tenant-settings/login-banner.md +++ b/docs/docs-content/tenant-settings/login-banner.md @@ -4,7 +4,7 @@ title: "Login Banner" description: "Learn how to set a login banner for your Palette tenant." icon: "" hide_table_of_contents: false -sidebar_position: 0 +sidebar_position: 30 tags: ["tenant-administration"] --- diff --git a/docs/docs-content/tenant-settings/palette-resource-limits.md b/docs/docs-content/tenant-settings/palette-resource-limits.md new file mode 100644 index 0000000000..07ed7cc445 --- /dev/null +++ b/docs/docs-content/tenant-settings/palette-resource-limits.md @@ -0,0 +1,62 @@ +--- +sidebar_label: "Default Resource Limits" +title: "Default Resource Limits" +description: + "Understand the default resource limits for Palette and learn how to set resource limits for your Palette tenant." +icon: "" +hide_table_of_contents: false +sidebar_position: 25 +tags: ["tenant-administration"] +--- + +Tenant administrators can set and update resource limits for Palette. The resource limits determine the maximum number +of resources that can be created in Palette. The resource limits are set at the tenant level and apply to all projects +in the tenant. + +The following table lists the default resource limits for Palette: + +| **Resources** | **Max Limit** | **Scope** | +| --------------------------------------------------- | ------------- | --------- | +| Users | 300 | Tenant | +| Teams | 100 | Tenant | +| Projects | 50 | Tenant | +| Workspaces | 50 | Tenant | +| Roles | 100 | Tenant | +| Cloud Accounts | 200 | Tenant | +| Cluster Profiles including Cluster Profile versions | 200 | Tenant | +| Registries | 50 | Tenant | +| Private Gateway | 50 | Tenant | +| API Keys | 20 | User | +| Backup Locations | 100 | Tenant | +| Certificates | 20 | Tenant | +| Macros | 200 | Project | +| SSH Keys | 300 | Tenant | +| Alerts or Webhook | 100 | Project | +| Clusters | 10,000 | Tenant | +| Edge Hosts | 200 | Tenant | + +## Set Resource Limit + +Use the following steps to set or update resource limits for your Palette tenant. + +## Prerequisites + +- You must have access to the _tenant admin_ role. + +## Update Limits + +1. Log in to [Palette](https://console.spectrocloud.com) as a tenant admin. + +2. Navigate to the left **Main Menu** and select **Tenant Settings**. + +3. Select **Resource Limits** from the **Tenant Settings Menu**. + +4. Set the values for the different Palette resources. + +5. Save your changes. + +## Validate + +You can validate the updated resource limits by creating a resource of the same type you updated. For example, you can +create five API keys if you updated the **API Key** to five. If you attempt to create a sixth API key, you will receive +an error message. diff --git a/docs/docs-content/tenant-settings/tenant-settings.md b/docs/docs-content/tenant-settings/tenant-settings.md index d8c097d821..a895c0e285 100644 --- a/docs/docs-content/tenant-settings/tenant-settings.md +++ b/docs/docs-content/tenant-settings/tenant-settings.md @@ -36,6 +36,8 @@ Use the following resources to become familiar with the available tenant setting - [API Key Management](api-key-management.md) +- [Default Resource Limits](./palette-resource-limits.md) + - [Login Banner](login-banner.md) - [Projects](./projects/projects.md) diff --git a/docs/docs-content/user-management/palette-resource-limits.md b/docs/docs-content/user-management/palette-resource-limits.md deleted file mode 100644 index b797ff8f45..0000000000 --- a/docs/docs-content/user-management/palette-resource-limits.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -sidebar_label: "Palette Resource Limits" -title: "Default Palette Resource Limits" -description: - "Understand the default resource limits for Palette and learn how to set resource limits for your Palette tenant." -icon: "" -hide_table_of_contents: false -sidebar_position: 40 -tags: ["user-management"] ---- - -## Default Palette Resource Limits - -Tenant admins can set and update resource limits for Palette. The resource limits determine the maximum number of -resources that can be created in Palette. The resource limits are set at the tenant level and apply to all projects in -the tenant. - -The following table lists the default resource limits for Palette: - -| **Resources** | **Max Limit** | **Scope** | -| ----------------- | ------------- | --------- | -| Users | 300 | Tenant | -| Teams | 100 | Tenant | -| Projects | 50 | Tenant | -| Workspaces | 50 | Tenant | -| Roles | 100 | Tenant | -| Cloud Accounts | 200 | Tenant | -| Cluster Profiles | 200 | Tenant | -| Registries | 50 | Tenant | -| Private Gateway | 50 | Tenant | -| API Keys | 20 | User | -| Backup Locations | 100 | Tenant | -| Certificates | 20 | Tenant | -| Macros | 200 | Project | -| SSH Keys | 300 | Tenant | -| Alerts or Webhook | 100 | Project | -| Clusters | 10,000 | Tenant | -| Edge Hosts | 200 | Tenant | - -## Set Resource Limit - -Use the following steps to set or update resource limits for your Palette tenant. - -## Prerequisites - -- You must have access to the _tenant admin_ role. - -## Update Limits - -1. Log in to [Palette](https://console.spectrocloud.com) as a tenant admin. - -2. Navigate to the left **Main Menu** and select **Tenant Settings**. - -3. Select **Resource Limits** from the **Tenant Settings Menu**. - -4. Set the values for the different Palette resources. - -5. Save your changes. - -## Validate - -You can validate the updated resource limits by creating a resource of the same type you updated. For example, you can -create five API keys if you updated the **API Key** to five. If you attempt to create a sixth API key, you will receive -an error message. diff --git a/redirects.js b/redirects.js index 30487b3a68..a931161b43 100644 --- a/redirects.js +++ b/redirects.js @@ -479,6 +479,10 @@ const redirects = [ from: "/palette-cli/commands/validator/", to: "/automation/palette-cli/commands/validator/", }, + { + from: "/user-management/palette-resource-limits/", + to: "/tenant-settings/palette-resource-limits/", + }, ]; module.exports = redirects;