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 5 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
79 changes: 79 additions & 0 deletions docs/docs-content/integrations/community_packs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
---
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

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. Check out the [Deploy a Custom Pack](../registries-and-packs/deploy-pack.md) tutorial to learn more about how to build and deploy your own
custom pack.

Palette comes with a default community pack registry hosted by Spectro Cloud that is available to all SaaS tenants, and
caroldelwing marked this conversation as resolved.
Show resolved Hide resolved
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.

:::warning

All community packs are reviewed and accepted by Spectro Cloud. However, unlike [Verified Packs](./verified_packs.md),
caroldelwing marked this conversation as resolved.
Show resolved Hide resolved
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.
- Ensure that the Palette Community Registry is available. Depending on the configuration of your Palette environment,
you may need to add it yourself. Refer to the
[Use non-FIPS Packs](../vertex/system-management/enable-non-fips-settings/use-non-fips-addon-packs.md) guide for
guidance.

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

Use the following steps to create a cluster profile by adding one or more layers using community packs.

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.
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
47 changes: 46 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,48 @@ 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

Use the following steps to create a cluster profile by adding one or more layers using verified packs.

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 with
the verified badge to add 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