Skip to content

Commit

Permalink
Updates to cluster profiles (#1721)
Browse files Browse the repository at this point in the history
* Fix caution, revise doc title

* Incorporate feedback from slack thread

* Revise caution statement

* Fix indentation

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* Address review comments

* Clarify sentence in caution.

* Make same change to similar caution statement

---------

Co-authored-by: Karl Cardenas <[email protected]>
  • Loading branch information
ritawatson and karl-cardenas-coding authored Nov 10, 2023
1 parent 8ea4e21 commit 6d1e8f3
Show file tree
Hide file tree
Showing 9 changed files with 28 additions and 15 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The diagram below illustrates the components of these profile types and how you

## Profile Layers

Each cluster profile layer provides a specific functionality. Profile layers can be packs, Helm Charts, or custom manifests, as described in the table.
Each cluster profile layer provides a specific functionality. Profile layers can be packs, Helm Charts, or custom manifests, as described in the table. Adding a pack multiple times to the same cluster profile is possible. To learn more about this scenario, review [Deploy Same Pack to Multiple Layers](../cluster-profiles/create-cluster-profiles/duplicate-pack-in-profile.md).

| **Layer** | **Description** |
|-----------|---------------------------|
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ tags: ["profiles", "cluster profiles", "helm", "add-on"]



You can extend the list of integrations by adding Helm charts from a public or private registries to your cluster profile. Use the following steps to create an add-on cluster profile that adds a Helm chart layer.
You can extend the list of integrations by adding Helm charts from a public or private registry to your cluster profile. Use the following steps to create a cluster profile by adding layers using Helm charts.

## Prerequisites

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ tags: ["profiles", "cluster profiles", "manifest", "add-on"]



You can extend the list of integrations by adding custom manifests to your cluster profile. Use the following steps to create a cluster profile that adds a custom manifest layer.
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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ tags: ["profiles", "cluster profiles", "pack", "add-on"]



Use the following steps to create an add-on cluster profile that adds a pack layer.
Use the following steps to create a cluster profile by adding one or more layers using packs.


## Prerequisites

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ tags: ["profiles", "cluster profiles"]
---


Create an infrastructure profile by adding infrastructure layers composed of an Operating System (OS), Kubernetes, Network, and Storage.
Create an infrastructure profile by adding layers composed of an Operating System (OS), Kubernetes, Network, and Storage packs.

## Prerequisites

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_label: "Duplicate a Pack in a Profile"
title: "Duplicate a Pack in a Profile"
sidebar_label: "Deploy Same Pack to Multiple Layers"
title: "Deploy Same Pack to Multiple Layers"
description: "Learn how to deploy the same pack to multiple layers in a Palette cluster profile."
hide_table_of_contents: false
sidebar_position: 30
Expand All @@ -9,11 +9,11 @@ tags: ["profiles", "cluster profiles"]



Palette allows you to deploy the same pack to multiple layers, which can be required in certain scenarios where an integration needs to be installed more than once with different configurations. For example, you may need to deploy two instances of the same microservice or application but with different configurations. In this case, you will need to launch the Postgres application twice with different configurations.
Palette allows you to add a pack multiple times to the same cluster profile, which can be required in certain scenarios where an integration needs to be installed more than once with different configurations. For example, you may need to deploy two instances of the same microservice or application but with different configurations. In this case, you will need to launch the Postgres application twice with different configurations.

::: caution
:::caution

Depending on the application, you might have to place the duplicate pack in a different namespace, as resource conflicts could arise from the original pack having Kubernetes resources named identical to the one the second pack would create.
Depending on the application, you might have to place the repeated pack in a different namespace, as resource conflicts could arise from the original pack having Kubernetes resources named identical to the one the second pack would create.

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ Instead of rebuilding cluster profiles, you can export them in JSON format and t

- [Macros](../../registries-and-packs/pack-constraints.md#pack-macros) used in the profile you want to export must be available in the target environment *before* you import the profile.

:::caution
:::caution

If custom macros are not available in the target environment, create them there before importing the profile. For instructions on macro creation, review [Macro Support](../../clusters/cluster-management/macros.md#create-your-macro).
If custom macros are not available in the target environment, create them there before importing the profile. For instructions on macro creation, review [Macro Support](../../clusters/cluster-management/macros.md#create-your-macro).

:::
:::


## Export Cluster Profile
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,14 @@ You can modify cluster profiles by updating the following:

- Profile layers or pack versions.

You can also create multiple versions of a cluster profile with different pack configurations. For more information, review the [Version a Cluster Profile](version-cluster-profile.md) guide.
:::caution

In the event that more than one application in the profile needs the same pack, Palette allows you to deploy the same pack to multiple layers. Check out [Duplicate a Pack in a Profile](../create-cluster-profiles/duplicate-pack-in-profile.md) for more information.
If you want to update cluster profiles that have been used to deploy clusters, we recommend creating a *new* profile version, and then upgrade active clusters to the new version. To learn how to version profiles, review [Version a Cluster Profile](version-cluster-profile.md) guide.

:::


In the event that more than one application in the profile needs the same pack, Palette allows you to deploy the same pack to multiple layers. Check out [Deploy Same Pack to Multiple Layers](../create-cluster-profiles/duplicate-pack-in-profile.md) for more information.

The next sections guide you in updating and versioning a profile.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ You can update a cluster profile to change the configuration of one or more laye

Cluster profile changes will generate an update notification on all the clusters that are created from the profile. Update notifications include information about all the changes applied to the profile since the initial creation or since the previous update. You can apply cluster updates individually at any time.

:::caution

We do not recommend updating a currently deployed cluster profile version to push out changes. Instead, we recommend creating a *new* profile version, and then upgrade active clusters to the new version. For information on versioning profiles, check out [Version a Cluster Profile](version-cluster-profile.md).

:::


## Prerequisites

Expand Down

0 comments on commit 6d1e8f3

Please sign in to comment.