Cluster Profile Variables (#2343)

* docs: Prelim profile variables topic placement + fix alignment in the Profiles section * docs: Profile variables draft * docs: Implement Vale review * Optimised images with calibre/image-actions * docs: Implement SME review and edit the text a bit * docs: Define profile variables in the glossary * docs: Implement peer review * Optimised images with calibre/image-actions * docs: Update the structure --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
spectrocloud · Mar 8, 2024 · 239b96d · 239b96d
1 parent e69ce23
commit 239b96d
Show file tree

Hide file tree

Showing 15 changed files with 370 additions and 173 deletions.
diff --git a/docs/docs-content/glossary-all.md b/docs/docs-content/glossary-all.md
@@ -70,7 +70,7 @@ deploy Kubernetes clusters to public cloud providers, on-prem data centers, and
 
 ## Cluster Definition
 
-A Cluster Definition contain one or more cluster profiles, including profile variables used in those profiles.
+A Cluster Definition contains one or more cluster profiles, including profile variables used in those profiles.
 
 ## Cluster Profile
 
@@ -89,6 +89,12 @@ The diagram below shows an example of a cluster profile:
 
 For more information, check out [Cluster Profiles](profiles/cluster-profiles/cluster-profiles.md).
 
+## Cluster Profile Variable
+
+Cluster Profile Variables enable you to create placeholders for parameters in profile layer configurations, which you
+can then populate for individual clusters during deployment. Meaning you can use a single cluster profile to deploy
+multiple clusters with unique requirements for security, networking, resource allocation, and so on.
+
 ## Edge Appliances
 
 Palette supports several kinds of appliances for the Edge deployment. These appliances can be registered with the

diff --git a/docs/docs-content/profiles/app-profiles/clone-app-profile.md b/docs/docs-content/profiles/app-profiles/clone-app-profile.md
@@ -26,17 +26,17 @@ You can clone an app profile across multiple projects within the same [tenant](.
 
 5. Provide the following information for the app profile you want to clone and click **Confirm**.
 
-| **Parameter**              | **Description**                                                                                                                                                            |
-| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **Name**                   | A custom name for the cloned app profile.                                                                                                                                  |
-| **Profile Version**        | Assign a version number for the cloned app profile. You can create multiple versions of an App Profile using the format `major.minor.patch`. The default value is `1.0.0`. |
-| **Source Profile Version** | The version number of the source profile.                                                                                                                                  |
-| **Target Project**         | The target project to which the profile will be cloned. Select the project name from the **drop-down Menu**.                                                               |
+   | **Parameter**              | **Description**                                                                                                                                                            |
+   | -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+   | **Name**                   | A custom name for the cloned app profile.                                                                                                                                  |
+   | **Profile Version**        | Assign a version number for the cloned app profile. You can create multiple versions of an App Profile using the format `major.minor.patch`. The default value is `1.0.0`. |
+   | **Source Profile Version** | The version number of the source profile.                                                                                                                                  |
+   | **Target Project**         | The target project to which the profile will be cloned. Select the project name from the **drop-down Menu**.                                                               |
 
-To learn how to create multiple profile versions that use the same name, check out
-[Version an App Profile](../app-profiles/modify-app-profiles/version-app-profile.md).
+   To learn how to create multiple profile versions that use the same name, check out
+   [Version an App Profile](../app-profiles/modify-app-profiles/version-app-profile.md).
 
-You can now use the app profile when deploying virtual clusters in the target project or tenant.
+   You can now use the app profile when deploying virtual clusters in the target project or tenant.
 
 ## Validate
 

diff --git a/...cs-content/profiles/app-profiles/create-app-profiles/create-helm-app-profile.md b/...cs-content/profiles/app-profiles/create-app-profiles/create-helm-app-profile.md
@@ -32,15 +32,15 @@ Engine.
 
 4. Provide the following basic information for your app profile and click **Next**.
 
-| **Parameter**        | **Description**                                                                                                                                                                                           |
-| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **App Profile Name** | A custom name for the app profile.                                                                                                                                                                        |
-| **Version**          | An optional version number for the new app profile. You only need to specify a version if you create multiple versions of a profile using the same profile name. Default: `1.0.0`.                        |
-| **Description**      | Use the description to provide context about the profile.                                                                                                                                                 |
-| **Tag**              | Assign any desired profile tags. Tags propagate to the Virtual Machines (VMs) deployed in the cloud or data center environment when apps are created from this app profile. Example: `owner` or `region`. |
+   | **Parameter**        | **Description**                                                                                                                                                                                           |
+   | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+   | **App Profile Name** | A custom name for the app profile.                                                                                                                                                                        |
+   | **Version**          | An optional version number for the new app profile. You only need to specify a version if you create multiple versions of a profile using the same profile name. Default: `1.0.0`.                        |
+   | **Description**      | Use the description to provide context about the profile.                                                                                                                                                 |
+   | **Tag**              | Assign any desired profile tags. Tags propagate to the Virtual Machines (VMs) deployed in the cloud or data center environment when apps are created from this app profile. Example: `owner` or `region`. |
 
-To learn how to create multiple profile versions that use the same name, check out
-[Version an App Profile](../modify-app-profiles/version-app-profile.md).
+   To learn how to create multiple profile versions that use the same name, check out
+   [Version an App Profile](../modify-app-profiles/version-app-profile.md).
 
 5. Select **Helm** to start configuring your app profile.
 
@@ -54,16 +54,16 @@ To learn how to create multiple profile versions that use the same name, check o
 
 7. You can add manifests to the app profile. To do this, click on **Add Manifests** and provide the manifest name.
 
-:::warning
+   :::warning
 
-When adding a manifest-type layer to an app profile, make sure you specify a namespace. Otherwise, the manifest
-deployment will be deployed to the `Default` namespace.
+   When adding a manifest-type layer to an app profile, make sure you specify a namespace. Otherwise, the manifest
+   deployment will be deployed to the `Default` namespace.
 
-```yaml
-namespace: yourNamespaceNameHere
-```
+   ```yaml
+   namespace: yourNamespaceNameHere
+   ```
 
-:::
+   :::
 
 8. You can add services to the app profile as needed. To do this, click `+` next to the **Configure tier** pane. To
    rearrange layers in the profile, select a service and drag it up or down in the pane. Each service becomes a layer in
@@ -86,15 +86,15 @@ Use the following steps to validate that your app profile is available and ready
 4. Hover your cursor over each profile layer to learn more about them, including the service name, version, and
    registry.
 
-![A view of a cursor triggering the info box for a helm layer.](/profiles_app-profiles_create-app-profiles_helm-layer-infobox.png)
+   ![A view of a cursor triggering the info box for a helm layer.](/profiles_app-profiles_create-app-profiles_helm-layer-infobox.png)
 
-:::info
+   :::info
 
-Use the tool-tip that displays when you select a layer to gather information required for creating Terraform templates
-for app profiles. Check out our Terraform registry for
-[Application Profiles](https://registry.terraform.io/providers/spectrocloud/spectrocloud/latest/docs/resources/application_profile).
+   Use the tool-tip that displays when you select a layer to gather information required for creating Terraform
+   templates for app profiles. Check out our Terraform registry for
+   [Application Profiles](https://registry.terraform.io/providers/spectrocloud/spectrocloud/latest/docs/resources/application_profile).
 
-:::
+   :::
 
 5. Deploy your application to a virtual cluster to verify all the required configurations and dependencies are correct.
    Review [Create and Manage Apps](../../../devx/apps/create-app.md) to learn how to deploy an app to a virtual cluster.

diff --git a/...ontent/profiles/app-profiles/create-app-profiles/create-manifest-app-profile.md b/...ontent/profiles/app-profiles/create-app-profiles/create-manifest-app-profile.md
@@ -37,36 +37,36 @@ Engine.
 
 4. Provide the following basic information for your app profile and click **Next**.
 
-| **Parameter**        | **Description**                                                                                                                                                                                           |
-| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **App Profile Name** | A custom name for the app profile.                                                                                                                                                                        |
-| **Version**          | An optional version number for the new app profile. You only need to specify a version if you create multiple versions of a profile using the same profile name. Default: `1.0.0`.                        |
-| **Description**      | Use the description to provide context about the profile.                                                                                                                                                 |
-| **Tag**              | Assign any desired profile tags. Tags propagate to the Virtual Machines (VMs) deployed in the cloud or data center environment when apps are created from this app profile. Example: `owner` or `region`. |
+   | **Parameter**        | **Description**                                                                                                                                                                                           |
+   | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+   | **App Profile Name** | A custom name for the app profile.                                                                                                                                                                        |
+   | **Version**          | An optional version number for the new app profile. You only need to specify a version if you create multiple versions of a profile using the same profile name. Default: `1.0.0`.                        |
+   | **Description**      | Use the description to provide context about the profile.                                                                                                                                                 |
+   | **Tag**              | Assign any desired profile tags. Tags propagate to the Virtual Machines (VMs) deployed in the cloud or data center environment when apps are created from this app profile. Example: `owner` or `region`. |
 
-To learn how to create multiple profile versions that use the same name, check out
-[Version an App Profile](../modify-app-profiles/version-app-profile.md).
+   To learn how to create multiple profile versions that use the same name, check out
+   [Version an App Profile](../modify-app-profiles/version-app-profile.md).
 
 5. Select **Manifest** to start configuring your app profile.
 
-:::warning
+   :::warning
 
-When adding a manifest-type layer to an app profile, make sure you specify a namespace. Otherwise, the manifest
-deployment will be deployed to the `Default` namespace.
+   When adding a manifest-type layer to an app profile, make sure you specify a namespace. Otherwise, the manifest
+   deployment will be deployed to the `Default` namespace.
 
-```yaml
-namespace: yourNamespaceNameHere
-```
+   ```yaml
+   namespace: yourNamespaceNameHere
+   ```
 
-:::
+   :::
 
 6. Provide a custom name for your manifest.
 
 7. Click on **Add Manifests** and provide a name. Click on the blue button to add your manifest. You can add more
    manifests as needed. For an example of how to create a custom add-on pack using a manifest, review
    [Add an Add-on Pack](../../../registries-and-packs/adding-add-on-packs.md#manifests) guide.
 
-![A view showing an arrow that points to the blue-circled checkmark the user clicks to add a manifest.](/profiles_app-profiles_create-app-profiles_add-manifest.png)
+   ![A view showing an arrow that points to the blue-circled checkmark the user clicks to add a manifest.](/profiles_app-profiles_create-app-profiles_add-manifest.png)
 
 8. You can add more services to the app profile as needed. To do this, click `+` next to the **Configure tier** pane. To
    rearrange layers in the profile, select a service and drag it up or down in the pane. Each service becomes a layer in
@@ -89,15 +89,15 @@ Use the following steps to validate that your app profile is available and ready
 4. Hover your cursor over each profile layer to learn more about them, including the service name, version, and
    registry.
 
-![A view of a cursor triggering the info box for a manifest layer.](/profiles_app-profiles_create-app-profiles_manifest-layer-infobox.png)
+   ![A view of a cursor triggering the info box for a manifest layer.](/profiles_app-profiles_create-app-profiles_manifest-layer-infobox.png)
 
-:::info
+   :::info
 
-Use the tool-tip that displays when you select a layer to gather information required for creating Terraform templates
-for app profiles. Check out our Terraform registry for
-[Application Profiles](https://registry.terraform.io/providers/spectrocloud/spectrocloud/latest/docs/resources/application_profile).
+   Use the tool-tip that displays when you select a layer to gather information required for creating Terraform
+   templates for app profiles. Check out our Terraform registry for
+   [Application Profiles](https://registry.terraform.io/providers/spectrocloud/spectrocloud/latest/docs/resources/application_profile).
 
-:::
+   :::
 
 5. Deploy your application to a virtual cluster to verify all the required configurations and dependencies are correct.
    Review [Create and Manage Apps](../../../devx/apps/create-app.md) to learn how to deploy an app to a virtual cluster.

diff --git a/docs/docs-content/profiles/app-profiles/modify-app-profiles/update-app-profile.md b/docs/docs-content/profiles/app-profiles/modify-app-profiles/update-app-profile.md
@@ -30,12 +30,12 @@ previous update. You can apply updates to Apps individually at any time.
 4. Click on **Settings** and choose **Basic Information** in the slide-out panel. You can modify the name, description,
    and tags.
 
-:::info
+   :::info
 
-Updated tags are not propagated to previously created Apps. However, tag changes will apply to new Apps you deploy that
-use the updated profile.
+   Updated tags are not propagated to previously created Apps. However, tag changes will apply to new Apps you deploy
+   that use the updated profile.
 
-:::
+   :::
 
 5. Save your changes.