-
Notifications
You must be signed in to change notification settings - Fork 37
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add community packs page DOC-1187 (#2910)
* docs: add community packs page DOC-1187 This patch adds the community packs page to the integrations folder. It also revises the verified packs page with a How-To layout. * Optimised images with calibre/image-actions * Optimised images with calibre/image-actions * Update docs/docs-content/integrations/verified_packs.md Co-authored-by: Karl Cardenas <[email protected]> * docs: address requested changes DOC-1187 * docs: address requested changes DOC-1187 * docs: address requested changes DOC-1187 * Optimised images with calibre/image-actions * docs: address review suggestions * docs: replace SaaS with multi-tenant SaaS * docs: change contribution guideline link * docs: clarify supported environments * docs: apply suggestions from review --------- Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com> Co-authored-by: Karl Cardenas <[email protected]> Co-authored-by: Carolina Delwing Rosa <[email protected]>
- Loading branch information
1 parent
9a569ec
commit 8f1874f
Showing
5 changed files
with
137 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
--- | ||
sidebar_label: "Community Packs" | ||
title: "Community Packs" | ||
description: "Learn what are community packs and how to use them in Palette." | ||
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. | ||
|
||
We welcome all contributions to the Spectro Cloud community packs, either by adding new packs or updating existing | ||
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. | ||
|
||
:::warning | ||
|
||
All community packs are reviewed, and if they have followed the | ||
[Contribution Guidelines](https://github.com/spectrocloud/pack-central?tab=readme-ov-file#contributing), they are | ||
accepted by Spectro Cloud. However, unlike [Verified Packs](./verified_packs.md), Spectro Cloud does not actively | ||
maintain and update community packs. Therefore, updates to these packs depend on community contributors. | ||
|
||
::: | ||
|
||
### Supported Environments | ||
|
||
Palette comes with a default community pack registry hosted by Spectro Cloud that is available to all tenants in the | ||
[Multi-tenant SaaS](../architecture/architecture-overview.md) architecture. For different deployment models, the | ||
registry must be added manually. Refer to the table below to check if your environment includes the Palette Community | ||
Registry. If your environment does not include the registry, contact our | ||
[support team](https://www.spectrocloud.com/contact) for assistance. | ||
|
||
| **Environment** | **Palette Community Registry Support** | | ||
| ------------------------- | -------------------------------------- | | ||
| Palette Multi-tenant SaaS | :white_check_mark: | | ||
| Palette Dedicated SaaS | :x: | | ||
| Palette VerteX | :x: | | ||
| Self-Hosted Palette | :x: | | ||
|
||
## 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 community registry is available in your Palette [environment](#supported-environments). | ||
|
||
## 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file added
BIN
+71.6 KB
static/assets/docs/images/integrations_community-packs_add-community-pack.webp
Binary file not shown.
Binary file not shown.