Skip to main content
Version: latest

Add a Manifest

You can extend the list of integrations by adding custom manifests to your cluster profile. Use the following steps to create a cluster profile by adding layers using manifests.

Prerequisites​

  • Your Palette account role must have the clusterProfile.create permission to create a profile. Refer to our Cluster Profile Permissions reference guide for more information about roles and permissions.

Create an Add-On Profile with Manifests​

  1. Log in to Palette.

  2. From the left main menu, select Profiles.

  3. In the top-right, select Add Cluster Profile.

  4. Complete the following fields. Ensure you select a cluster profile Type of Add-on. Select Next to continue.

    FieldDescription
    NameEnter a unique name for the cluster profile.
    VersionAssign a version to the profile using semantic versioning. Version 1.0.0 is assigned automatically when creating a new cluster profile unless otherwise specified. You only need to specify a version if you create multiple versions of a profile using the same profile name. Refer to our Version a Cluster Profile guide for more information.
    Description(Optional) Provide context about the profile.
    TypeChoose the type of cluster profile. Select Add-on.
    Tags(Optional) Assign any desired profile tags. Tags propagate to the VMs deployed in the cloud or data center environment when clusters are created from this cluster profile. Example: owner or region.

  1. Select Add Manifest, and provide a Layer name for this layer. This is the display name.

  2. (Optional) If desired, add configurable Layer values and specify the layer install order.

  3. Select New manifest and provide a name for your custom manifest. When finished, select the check mark or press ENTER to open the editor.

  4. Configure parameters as needed. Ensure you specify a namespace; otherwise, the manifest will be deployed to the Default namespace. For examples of Helm-based pack structures, review our Deploy a Pack guide, and select the appropriate tab.

    namespace: "<your-namespace-here>"
    warning

    The namespace parameter in the configuration file identifies the namespace on the target cluster. The namespace must use the regex pattern [a-z0-9]([-a-z0-9]*[a-z0-9])?; only lowercase alphanumeric characters and hyphens are allowed, and the namespace must start and end with an alphanumeric character. For more information about namespace customization, refer to our Profile Customization guide.

  5. Repeat steps 7 - 8 to create additional manifests. When finished, select Confirm & Create to return to the cluster profile overview page. If you need to make changes, select the applicable layer, and update your manifest values; otherwise, select Next to review your cluster profile.

  6. Select Finish Configuration to create your cluster profile.

Add Manifests to an Existing Profile​

Instead of creating a cluster profile from scratch, you can also add manifests to an existing full or add-on cluster profile.

tip

While you cannot add manifests directly to an infrastructure profile, you can add additional functionality to a cluster deployed with an infrastructure profile by attaching an add-on profile to the cluster.

  1. Log in to Palette.

  2. From the left main menu, select Profiles.

  3. Select an existing full or add-on cluster profile. Use the Profile Types drop-down menu to help you locate compatible Full and Add-on profiles.

  4. From the cluster profile menu, select Add Manifest, and provide a Layer name for this layer. This is the display name.

  5. (Optional) If desired, add configurable Layer values and specify the layer install order.

  6. Select New manifest and provide a name for your custom manifest. When finished, select the check mark or press ENTER to open the editor.

  7. Configure parameters as needed. Ensure you specify a namespace; otherwise, the manifest will be deployed to the Default namespace. For examples of Helm-based pack structures, review our Deploy a Pack guide, and select the appropriate tab.

    namespace: "<your-namespace-here>"
    warning

    The namespace parameter in the configuration file identifies the namespace on the target cluster. The namespace must use the regex pattern [a-z0-9]([-a-z0-9]*[a-z0-9])?; only lowercase alphanumeric characters and hyphens are allowed, and the namespace must start and end with an alphanumeric character. For more information about namespace customization, refer to our Profile Customization guide.

  8. Repeat steps 4 - 8 to create additional layers with manifests; repeat steps 6 - 7 to add additional manifests to the same layer of your cluster profile. When finished, select Confirm & Create, then select Next to review your cluster profile.

  9. Select Finish Configuration to save your updated cluster profile.

Validate​

  1. Log in to Palette.

  2. From the left main menu, select Profiles.

  3. Select your cluster profile to review its layers or make changes.

Next Steps​

You now have an add-on cluster profile that contains one or more Helm charts, which you can reuse and apply to multiple clusters in tandem with an infrastructure or full cluster profile.

If you need to make changes to your cluster profile, we recommend creating a new cluster profile version or updating your cluster profile.

For general cluster deployment information, check out our Clusters guide. For an end-to-end walkthrough of deploying a cluster on your desired infrastructure, refer to our Getting Started tutorials.

Resources​