Skip to content

Commit

Permalink
document install order (#1928)
Browse files Browse the repository at this point in the history
* DRAFT: document install order

* move install order to pack add doc; link from manifest, helm docs

* clarify 'configurable layer values'

* replace removed heading

* Update docs/docs-content/profiles/cluster-profiles/create-cluster-profiles/create-addon-profile/create-pack-addon.md

Co-authored-by: Karl Cardenas <karl@spectrocloud.com>

* Update docs/docs-content/profiles/cluster-profiles/create-cluster-profiles/create-addon-profile/create-pack-addon.md

Co-authored-by: Karl Cardenas <karl@spectrocloud.com>

* docs: new content and moved the info the index page as it applies to all layers

---------

Co-authored-by: Karl Cardenas <karl@spectrocloud.com>
(cherry picked from commit dd5f891)
  • Loading branch information
stenwt committed Dec 21, 2023
1 parent 1674c9d commit d7ff992
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,24 @@ This capability allows you to customize and configure clusters based on specific
The next sections provide guidance in creating each type of these add-on profiles.



## Install Order

You can specify the install order of each add-on pack layer in a cluster profile. The install order value accepts negative and positive numbers and 0. The default install order value is 0.
The install order determines the order in which manifests in the profile are applied. The lowest-numbered packs will be installed first. Palette will wait a few moments when installing layers to ensure the readiness checks pass.


If a readiness check for an add-on pack layer fails, Palette will keep checking the status every two minutes until the check passes. Once the readiness check passes for a pack with a lower priority, add-on layer packs with higher install priority will be installed.

A cluster profile containing several different install order values will take a few minutes longer to install versus a cluster profile with the same install order for all add-on packs.

:::info

Palette will deploy together all packs that have the same install order. Palette will wait for all pack readiness checks to pass before moving to the next install order.

:::


## Resources

- [Add a Pack](create-pack-addon.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ You can extend the list of integrations by adding Helm charts from a public or p

5. Select **Add Helm Chart** and use the **drop-down Menu** to choose public or private packs.

<!-- For a description of the layers, review [Profile Layers](../../cluster-profiles.md#profile-layers). -->

6. To add a chart from a public registry, choose a Helm chart from the list displayed on the next page. You can search charts by name. Pack details and the configuration file are displayed on the next page.

Expand All @@ -49,6 +48,7 @@ You can extend the list of integrations by adding Helm charts from a public or p
pack:
namespace: your_namespace_here
```
Optionally, you can add configurable layer values and specify the layer [install order](./create-addon-profile.md#install-order).
:::caution
Expand Down Expand Up @@ -86,4 +86,4 @@ Now you can use the add-on profile you created with other profiles.

- [Version a Cluster Profile](../../modify-cluster-profiles/version-cluster-profile.md)

- [Profile Customization](../../../profile-customization.md)
- [Profile Customization](../../../profile-customization.md)
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ You can extend the list of integrations by adding custom manifests to your clust

To learn how to create multiple profile versions, check out [Version a Cluster Profile](../../modify-cluster-profiles/version-cluster-profile.md).

5. Select **Add Manifest** and provide a display name for this layer. Optionally, you can add configurable layer values and specify the layer install order. When multiple manifests are added to the layer, the install order determines the order in which manifests in the profile are consumed. You can change the order as needed.
5. Select **Add Manifest** and provide a display name for this layer. Optionally, you can specify the layer [install order](./create-addon-profile.md#install-order).

6. Click on **New manifest** and provide a name for your custom manifest. Click on the check or press Enter to open the editor.

Expand Down Expand Up @@ -69,8 +69,7 @@ You now have an add-on cluster profile that contains one or more manifests. You

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


## Next Steps
## Next Steps

Now you can use the add-on profile you created with other profiles.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Use the following steps to create a cluster profile by adding one or more layers

<!-- Select the type of layer to add to the cluster profile. For more information about the layers, applying pack versions, configuration parameters, and presets, review [Profile Layers](../../cluster-profiles.md#profile-layers). -->

6. Fill out the required input fields and click on **Confirm & Create**.
6. Fill out the required input fields and click on **Confirm & Create**. Optionally, you can configure values specific to the layer in Helm values.yaml form, and specify the layer [install order](./create-addon-profile.md#install-order).

<!-- ![A view of the manifest create process and the YAML code in the text editior](/clusters_imported-clusters_attach-add-on-profile_manfest-view.png) -->

Expand Down Expand Up @@ -72,4 +72,4 @@ Now you can use the add-on profile with other profiles and across multiple envir

- [Profile Customization](../../../profile-customization.md)

- [Duplicate a Pack in a Profile](../duplicate-pack-in-profile.md)
- [Duplicate a Pack in a Profile](../duplicate-pack-in-profile.md)

0 comments on commit d7ff992

Please sign in to comment.