From e54327a08f8372a7b967d53cf6f3036f894dbe64 Mon Sep 17 00:00:00 2001 From: Rita Watson Date: Thu, 19 Oct 2023 18:39:56 -0700 Subject: [PATCH] Add sys-level regstry docs, vertex/palette --- .../system-management/add-registry.md | 57 ++++++++++++++++++ .../vertex/system-management/add-registry.md | 59 +++++++++++++++++++ .../use-non-fips-addon-packs.md | 11 +++- 3 files changed, 125 insertions(+), 2 deletions(-) create mode 100644 docs/docs-content/enterprise-version/system-management/add-registry.md create mode 100644 docs/docs-content/vertex/system-management/add-registry.md diff --git a/docs/docs-content/enterprise-version/system-management/add-registry.md b/docs/docs-content/enterprise-version/system-management/add-registry.md new file mode 100644 index 0000000000..14c29e9e19 --- /dev/null +++ b/docs/docs-content/enterprise-version/system-management/add-registry.md @@ -0,0 +1,57 @@ +--- +sidebar_label: "Add System-Level Registry" +title: "Add System-Level Registry" +description: "Learn how to add a system-level registry in Palette." +icon: "" +hide_table_of_contents: false +sidebar_position: 60 +tags: ["enterprise", "management", "registry"] +--- + +You can add a registry at the system level or tenant level. Registries added at the system level are available to all the tenants. Registries added at the tenant level are available only to that tenant. This section describes how to add a system-level registry. For steps to add a tenant-level registry, refer to [Add a Tenant-Level Registry]... + +## Prerequisites + +- You need tenant admin privileges to add a system-level registry. + +## Add an OCI Registry + +Use the following steps to add a system-level OCI registry. + +1. Log in to [Palette](https://console.spectrocloud.com) as a tenant admin. + +2. From the left **Main Menu** select **Administration**. + +3. Select the **Pack Registries** tab and click on the **Add New Pack Registry** button. + +4. Fill out the following input values to add an OCI registry. Contact our support team to obtain the registry endpoint, base path, and credentials. + + | **Field** | **Description** | + |----------------------|-----------------------------------| + | Name | A custom name for the registry. | + | Registry Type | Select **OCI**. | + | Authentication Type | Select **ECR**. Our OCI packs are hosted in the Amazon Elastic Container Registry (ECR). | + | Endpoint | Provide the registry endpoint, and prefix the endpoint with `https://`. | + | Base Content Path | Provide the registry base path. | + +5. Enable the **Protected** toggle. Palette displays the **Access key** and **Secret access key** fields. Provide the credentials you received from our support team. + +6. Click the **Validate** button. If the credentials you provided are correct, VerteX displays a *Credentials validated* success message with a green check. + +7. Click **Confirm**. + +You have successfully added a system-level registry. Registries added at the system level can only be removed at that level. + + +## Validate + +You can verify the registry has been added if Palette displayed a *Credentials validated* success message with a green check when you added the registry. Use these steps to further verify the registry is added. + +1. Log in to the [Palette](https://console.spectrocloud.com) as a tenant admin. + +2. From the left **Main Menu** select **Administration**. + +3. Select the **Pack Registries** tab and verify the registry you added is listed. + + + diff --git a/docs/docs-content/vertex/system-management/add-registry.md b/docs/docs-content/vertex/system-management/add-registry.md new file mode 100644 index 0000000000..09052c1e42 --- /dev/null +++ b/docs/docs-content/vertex/system-management/add-registry.md @@ -0,0 +1,59 @@ +--- +sidebar_label: "Add a Registry" +title: "Add a Registry" +description: "Learn how to add a registry in Palette VerteX." +icon: "" +hide_table_of_contents: false +sidebar_position: 50 +tags: ["vertex", "management", "registry"] +--- + +You can add a registry at the system level or tenant level. Registries added at the system level are available to all the tenants. Registries added at the tenant level are available only to that tenant. This section describes how to add a system-level registry. For steps to add a tenant-level registry, refer to [Add a Tenant-Level Registry]... + +## Prerequisites + +- You need tenant admin privileges to add a system-level registry. + +## Add an OCI Registry + +Use the following steps to add a system-level OCI registry. + +1. Log in to the Palette VerteX system console. + +2. From the left **Main Menu** select **Administration**. + +3. Select the **Pack Registries** tab and click on the **Add New Pack Registry** button. + +4. Fill out the following input values to add an OCI registry. + + | **Field** | **Description** | + |----------------------|-----------------------------------| + | Name | A custom name for the registry. | + | Registry Type | Select **OCI**. | + | Authentication Type | Select **ECR**. Our OCI packs are hosted in the Amazon Elastic Container Registry (ECR). | + | Endpoint | Provide the endpoint `415789037893.dkr.ecr.us-east-1.amazonaws.com`, and prefix the endpoint with `https://`. | + | Base Content Path | Provide the registry base path: `production` or `community`. | + +5. Enable the **Protected** toggle. Palette displays the **Access key** and **Secret access key** fields. Provide the credentials you received from our support team. + +6. Click the **Validate** button. If the credentials you provided are correct, VerteX displays a *Credentials validated* success message with a green check. + +7. Click **Confirm**. + +8. To add both of the non-FIPS registries listed in the [Use non-FIPS Packs](../system-management/enable-non-fips-settings/enable-non-fips-settings.md) guide, repeat steps 4 through 7 and specify the other base path. + +You have successfully added a system-level registry. Registries added at the system level can only be removed at that level. + + +## Validate + +You can verify the registry has been added if VerteX displayed a *Credentials validated* success message with a green check when you added the registry. Use these steps to further verify the registry is added. + +1. Log in to the Palette VerteX system console. + +2. From the left **Main Menu** select **Administration**. + +3. Select the **Pack Registries** tab and verify the registry you added is listed. + + + diff --git a/docs/docs-content/vertex/system-management/enable-non-fips-settings/use-non-fips-addon-packs.md b/docs/docs-content/vertex/system-management/enable-non-fips-settings/use-non-fips-addon-packs.md index 2c28901948..07310f3582 100644 --- a/docs/docs-content/vertex/system-management/enable-non-fips-settings/use-non-fips-addon-packs.md +++ b/docs/docs-content/vertex/system-management/enable-non-fips-settings/use-non-fips-addon-packs.md @@ -18,7 +18,14 @@ Palette VerteX provides the following FIPS-compliant infrastructure components i - Container Network Interface (CNI) - Container Storage Interface (CSI) -VerteX provides the flexibility to utilize non-FIPS packs. To do this, you must add the **Non-fips pack registry** to the tenant. Our support team will provide you with the registry URL. +VerteX provides the flexibility to utilize non-FIPS packs. To do this, you must add a non-FIPS compliant pack registry. Refer to [Add a Registry] for guidance. + +We provide an Open Container Initiative (OCI) registry and a community registry. You can add both non-FIPS registries to utilize the entire suite of packs. The table below lists these registries and their endpoints. Our support team will provide you with the required credentials. + +| **Production** | **Type** | **Endpoint** | **Base Path** | +| -------------------| ---------- | -------------------------- | ----------------------- | +| **OCI Pack Registry** | non-FIPS | 415789037893.dkr.ecr.us-east-1.amazonaws.com | `production` | +| **Spectro Cloud Community Registry** | non-FIPS | 415789037893.dkr.ecr.us-east-1.amazonaws.com | `community` | The ability to use non-FIPS packs allows tenant users to tailor deployments to their specific needs by customizing cluster profiles with infrastructure or add-on functionality that meets their requirements. For more information about cluster profiles, check out the [Cluster Profiles](../../../profiles/cluster-profiles/cluster-profiles.md) documentation. @@ -42,7 +49,7 @@ Use the following steps to enable non-FIPS packs. 2. Navigate to the left **Main Menu** and click on **Tenant Settings**. -3. On the **Tenant Settings Menu**, select **Platform Settings**. +3. From the **Tenant Settings Menu**, select **Platform Settings**. 4. Enable the **Allow non-FIPS packs** option. When you enable this option, you are prompted to confirm the use of non-FIPS packs for the tenant.