Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add community packs page DOC-1187 #2910

Merged
merged 17 commits into from
May 31, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 73 additions & 0 deletions docs/docs-content/integrations/community_packs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
---
sidebar_label: "Community Packs"
title: "Community Packs"
description: "Identify Community Packs in Palette, which are not actively maintenance."
caroldelwing marked this conversation as resolved.
Show resolved Hide resolved
icon: ""
hide_table_of_contents: false
sidebar_position: 30
tags: ["packs", "community"]
---

Palette Community Packs are packs that are created and maintained by the Spectro Cloud community. They provide important
integrations with Spectro Cloud Palette.
caroldelwing marked this conversation as resolved.
Show resolved Hide resolved

:::warning

We provide community packs to facilitate collaborations and contributions from the wider community. All community packs
addetz marked this conversation as resolved.
Show resolved Hide resolved
are reviewed and accepted by Spectro Cloud. However, unlike [Verified Packs](./verified_packs.md), community packs are
not maintained and updated regularly.

:::

## Prerequisites

- Your Palette account role must have the `clusterProfile.create` permission to create a profile. Refer to the
[Roles and Permissions](../user-management/palette-rbac/project-scope-roles-permissions.md#cluster-profile-admin)
documentation for more information.

addetz marked this conversation as resolved.
Show resolved Hide resolved
## Use Community Packs

Palette comes with a default community pack registry that is available to all SaaS tenants, and non-airgap self-hosted
Palette environments. The [Default Registries](../registries-and-packs/registries/registries.md#default-registries)
table has the details of the community registry. You can use community packs in your cluster profiles without any
special configuration.

1. Log in to [Palette](https://console.spectrocloud.com/).

2. From the left **Main Menu** click **Profiles**.

3. Click on the **Add Cluster Profile** button.

4. Fill out the cluster profile name and description.

5. Select **Add-on** for the cluster profile type. Click on **Next** to continue.

6. Select **Add New Pack**. In the next window that displays, choose the **Palette Community Registry** and select the
community pack to add to your profile. You can search packs by name.

![A screenshot of selecting Palette Community Registry](/integrations_community-packs_add-community-pack.webp)

7. Fill out the required input fields and click on **Confirm & Create**.

8. If you want to add additional layers, repeat steps 6 and 7. Otherwise, click on **Next** to review the profile.

9. Click on **Finish Configuration** to create the cluster profile.

You now have an add-on cluster profile that contains one or more community packs.

## Validate

1. Log in to [Palette](https://console.spectrocloud.com).

2. Navigate to left **Main Menu** and select **Profiles**.

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

## Next Steps

Now you can use the add-on profile with other profiles and across multiple environments, projects, and tenants.

We welcome all contributions to the Spectro Cloud community packs, either by adding new packs or updating existing
addetz marked this conversation as resolved.
Show resolved Hide resolved
packs. You can read our
[Contribution Guidelines](https://github.com/spectrocloud/pack-central?tab=readme-ov-file#contributing) in the community
packs repository.
1 change: 1 addition & 0 deletions docs/docs-content/integrations/deprecated-packs.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: "Deprecated Packs"
description: "Deprecated Packs"
icon: ""
hide_table_of_contents: false
sidebar_position: 40
tags: ["packs", "deprecation"]
---

Expand Down
50 changes: 49 additions & 1 deletion docs/docs-content/integrations/verified_packs.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: "Verified Packs"
description: "Identify Verified Packs in Palette, which undergo active maintenance."
icon: ""
hide_table_of_contents: false
sidebar_position: 10
sidebar_position: 20
tags: ["packs", "verified"]
---

Expand All @@ -31,3 +31,51 @@ To learn about our general pack maintenance policy, review the [Maintenance Poli
Palette paid subscriptions cover access to our Support team and product updates.

:::

addetz marked this conversation as resolved.
Show resolved Hide resolved
## Prerequisites

- Your Palette account role must have the `clusterProfile.create` permission to create a profile. Refer to the
[Roles and Permissions](../user-management/palette-rbac/project-scope-roles-permissions.md#cluster-profile-admin)
documentation for more information.

## Use Verified Packs

Palette comes with a default pack registry that is available to all SaaS tenants, and non-airgap self-hosted Palette
addetz marked this conversation as resolved.
Show resolved Hide resolved
environments. The [Default Registries](../registries-and-packs/registries/registries.md#default-registries) table has
the details of the Palette registry. You can use verified packs in your cluster profiles without any special
addetz marked this conversation as resolved.
Show resolved Hide resolved
configuration.

1. Log in to [Palette](https://console.spectrocloud.com/).

2. From the left **Main Menu** click **Profiles**.

3. Click on the **Add Cluster Profile** button.

4. Fill out the cluster profile name and description.

5. Select **Add-on** for the cluster profile type. Click on **Next** to continue.
addetz marked this conversation as resolved.
Show resolved Hide resolved

6. Select **Add New Pack**. In the next window that displays, choose the **Palette Registry** and select the pack to add
addetz marked this conversation as resolved.
Show resolved Hide resolved
addetz marked this conversation as resolved.
Show resolved Hide resolved
to your profile. You can search packs by name.

![A screenshot of selecting Palette Registry](/integrations_verified-packs_add-pack.webp)

7. Fill out the required input fields and click on **Confirm & Create**.

8. If you want to add additional layers, repeat steps 6 and 7. Otherwise, click on **Next** to review the profile.

9. Click on **Finish Configuration** to create the cluster profile.

You now have an add-on cluster profile that contains one or more verified packs.

## Validate

1. Log in to [Palette](https://console.spectrocloud.com).

2. Navigate to left **Main Menu** and select **Profiles**.

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

## Next Steps

Now you can use the add-on profile with other profiles and across multiple environments, projects, and tenants.
Binary file not shown.
Binary file not shown.
Loading