diff --git a/.github/workflows/packs-data.yaml b/.github/workflows/packs-data.yaml index fdc5da8b04..b646f895a7 100644 --- a/.github/workflows/packs-data.yaml +++ b/.github/workflows/packs-data.yaml @@ -18,7 +18,7 @@ jobs: steps: - name: Retrieve Credentials id: import-secrets - uses: hashicorp/vault-action@v2 + uses: hashicorp/vault-action@v2.7.3 with: url: https://vault.prism.spectrocloud.com method: approle diff --git a/Makefile b/Makefile index 3a5ac1936c..07dbbd1099 100644 --- a/Makefile +++ b/Makefile @@ -9,13 +9,14 @@ help: ## Display this help clean: ## Clean build artifacts rm -rf node_modules build public .cache .docusaurus - docker image rm $(IMAGE) + docker image rm $(IMAGE) || echo "No image exists." ##@ npm Targets -initialize: ## Initialize npm dependencies +init: ## Initialize npm dependencies @echo "initializing npm dependencies" npm ci + npx husky install start: ## Start a local development server npm run start diff --git a/README.md b/README.md index fc92841507..91a8bf74d5 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,7 @@ Clone the repository and run the initialization script cd Work git clone https://github.com/spectrocloud/librarium.git cd librarium -make initialize +make init ``` # Documentation Content diff --git a/docs/docs-content/architecture/architecture-overview.md b/docs/docs-content/architecture/architecture-overview.md index fb9beb5fa4..0349a720a5 100644 --- a/docs/docs-content/architecture/architecture-overview.md +++ b/docs/docs-content/architecture/architecture-overview.md @@ -25,7 +25,7 @@ Palette is available in three flexible deployment models: ## Product Security -At Spectro Cloud, we recognize the importance of robust security measures in today's rapidly evolving digital landscape. As the provider of our cutting-edge SaaS and self-hosted Palette product, our commitment to safeguarding your data and ensuring the integrity of our services is paramount. Learn more about Palette security by reviewing the [Security](/security) section. +At Spectro Cloud, we recognize the importance of robust security measures in today's rapidly evolving digital landscape. As the provider of our cutting-edge SaaS and self-hosted Palette product, our commitment to safeguarding your data and ensuring the integrity of our services is paramount. Learn more about Palette security by reviewing the [Security](../security/security.md) section.
diff --git a/docs/docs-content/architecture/architecture.md b/docs/docs-content/architecture/architecture.md index 500f6abe7e..6dc6d9e0fb 100644 --- a/docs/docs-content/architecture/architecture.md +++ b/docs/docs-content/architecture/architecture.md @@ -20,17 +20,17 @@ Palette supports three different architecture models; multi-tenant SaaS, dedicat ## Resources -- [Architecture Overview](/architecture/architecture-overview/) +- [Architecture Overview](architecture-overview.md) -- [Provisioning Order of Operations](/architecture/orchestration-spectrocloud) +- [Provisioning Order of Operations](orchestration-spectrocloud.md) -- [Namespaces and Pods](/architecture/palette-namespaces-podes) +- [Namespaces and Pods](palette-namespaces-podes.md) -- [Network Ports](/architecture/networking-ports) +- [Network Ports](networking-ports.md) -- [IP Addresses](/architecture/palette-public-ips) +- [IP Addresses](palette-public-ips.md) diff --git a/docs/docs-content/architecture/grps-proxy.md b/docs/docs-content/architecture/grps-proxy.md index 162be3dd91..3b27e782fc 100644 --- a/docs/docs-content/architecture/grps-proxy.md +++ b/docs/docs-content/architecture/grps-proxy.md @@ -15,7 +15,7 @@ Palette uses [gRPC](https://grpc.io) to communicate between the management platf :::info -Refer to the [Network Ports](/architecture/networking-ports) documentation for a detailed network architecture diagram with gRPC and to learn more about the ports used for communication. +Refer to the [Network Ports](networking-ports.md) documentation for a detailed network architecture diagram with gRPC and to learn more about the ports used for communication. ::: diff --git a/docs/docs-content/cluster-profiles/byoos/byoos.md b/docs/docs-content/cluster-profiles/byoos/byoos.md index b0f3289a68..26dee6e42e 100644 --- a/docs/docs-content/cluster-profiles/byoos/byoos.md +++ b/docs/docs-content/cluster-profiles/byoos/byoos.md @@ -8,7 +8,7 @@ hide_table_of_contents: false --- -With Palette, you can bring your own operating system and use it with your Kubernetes clusters using the [Bring Your Own Operating System (BYOOS)](/glossary-all#bringyourownoperatingsystem(byoos)) feature. The BYOOS pack allows you to upload your own OS images, configure the necessary drivers, and customize the OS to meet your specific requirements. +With Palette, you can bring your own operating system and use it with your Kubernetes clusters using the [Bring Your Own Operating System (BYOOS)](../../glossary-all.md#bringyourownoperatingsystem(byoos)) feature. The BYOOS pack allows you to upload your own OS images, configure the necessary drivers, and customize the OS to meet your specific requirements. @@ -28,9 +28,9 @@ To learn more about BYOOS, use the following resources to learn more. ## Resources -- [Create Images with Image Builder](/cluster-profiles/byoos/image-builder) +- [Create Images with Image Builder](image-builder.md) -- [BYOOS Pack](/integrations/byoos) +- [BYOOS Pack](../../integrations/byoos.md)
\ No newline at end of file diff --git a/docs/docs-content/cluster-profiles/byoos/image-builder.md b/docs/docs-content/cluster-profiles/byoos/image-builder.md index 32e5765b80..c4914bd3f3 100644 --- a/docs/docs-content/cluster-profiles/byoos/image-builder.md +++ b/docs/docs-content/cluster-profiles/byoos/image-builder.md @@ -309,4 +309,4 @@ Use the following steps to validate your custom image. 1. You can validate that the custom image is working correctly by deploying a compute instance in the respective infrastructure provider you created the image in using the custom image. Review the compute instance logs to learn more about the problems if you encounter any issues. -2. Next, deploy a host cluster that uses the cluster profile you created containing the custom image. Verify the cluster is deployed correctly and without any issues. If you encounter any problems, review the event logs of the cluster to gain more details about the issue. Check out the [Deploy a Cluster](/clusters/public-cloud/deploy-k8s-cluster/) tutorial for additional guidance on deploying a host cluster. \ No newline at end of file +2. Next, deploy a host cluster that uses the cluster profile you created containing the custom image. Verify the cluster is deployed correctly and without any issues. If you encounter any problems, review the event logs of the cluster to gain more details about the issue. Check out the [Deploy a Cluster](../../clusters/public-cloud/deploy-k8s-cluster.md) tutorial for additional guidance on deploying a host cluster. \ No newline at end of file diff --git a/docs/docs-content/cluster-profiles/cluster-profile-import-export.md b/docs/docs-content/cluster-profiles/cluster-profile-import-export.md index 75748f347d..524c6f42d9 100644 --- a/docs/docs-content/cluster-profiles/cluster-profile-import-export.md +++ b/docs/docs-content/cluster-profiles/cluster-profile-import-export.md @@ -12,13 +12,13 @@ Palette enables cluster profiles to be exported and then imported across multipl ## Prerequisites -* [Export](/cluster-profiles/cluster-profile-import-export#exportclusterprofile) the cluster profile file in JSON format from Palette. +* [Export](#export-cluster-profile) the cluster profile file in JSON format from Palette. * The packs in the exported profile should be available in the target environment during import. -* The `macros` used in the exported profile should be available in the target environment during import. If not [create the macros](/clusters/cluster-management/macros#createyourmacro) at the target environment. +* The `macros` used in the exported profile should be available in the target environment during import. If not [create the macros](../clusters/cluster-management/macros.md#create-your-macro) at the target environment. ## Use Cases @@ -90,5 +90,3 @@ If there is only a single repository where the imported packs are present within ::: -
-
diff --git a/docs/docs-content/cluster-profiles/cluster-profiles.md b/docs/docs-content/cluster-profiles/cluster-profiles.md index b238e8c4bf..8acc8882b6 100644 --- a/docs/docs-content/cluster-profiles/cluster-profiles.md +++ b/docs/docs-content/cluster-profiles/cluster-profiles.md @@ -12,7 +12,7 @@ sidebar_custom_props: # Overview -[Cluster Profiles](/glossary-all#cluster-profile) are like templates that are created with preconfigured layers/components that are required for +[Cluster Profiles](../glossary-all.md#cluster-profile) are like templates that are created with preconfigured layers/components that are required for workload cluster deployments. Cluster Profiles provide a way for driving consistency across workload cluster deployments. You can create as many profiles as required. diff --git a/docs/docs-content/cluster-profiles/create-add-on-profile.md b/docs/docs-content/cluster-profiles/create-add-on-profile.md index ee8a1bd5a1..39e7c76083 100644 --- a/docs/docs-content/cluster-profiles/create-add-on-profile.md +++ b/docs/docs-content/cluster-profiles/create-add-on-profile.md @@ -59,7 +59,7 @@ Use the following steps to learn how to create an add-on cluster profile. ### Prerequisites -* Your Palette account role must have the `clusterProfile.create` permission to create an Add-on cluster profile. Refer to the [Cluster Profile](/user-management/palette-rbac/project-scope-roles-permissions#clusterprofile) permissions documentation for more information about roles and permissions. +* Your Palette account role must have the `clusterProfile.create` permission to create an Add-on cluster profile. Refer to the [Cluster Profile](../user-management/palette-rbac/project-scope-roles-permissions.md#clusterprofile) permissions documentation for more information about roles and permissions. ### Create Steps @@ -116,7 +116,7 @@ Use the following steps to learn how to create an add-on cluster profile. -You now have an add-on cluster profile. You can reuse the profile and apply it to several clusters. You can also update a cluster profile and decide what clusters to apply the new version to. Refer to the [Update Cluster Profile](/cluster-profiles/task-update-profile) guide for more information about update operations. +You now have an add-on cluster profile. You can reuse the profile and apply it to several clusters. You can also update a cluster profile and decide what clusters to apply the new version to. Refer to the [Update Cluster Profile](../cluster-profiles/task-update-profile.md) guide for more information about update operations. ### Validate diff --git a/docs/docs-content/cluster-profiles/task-define-profile.md b/docs/docs-content/cluster-profiles/task-define-profile.md index be7c377e01..a90818f451 100644 --- a/docs/docs-content/cluster-profiles/task-define-profile.md +++ b/docs/docs-content/cluster-profiles/task-define-profile.md @@ -19,9 +19,9 @@ Cluster profiles are created by configuring various layers of the Kubernetes inf |**Parameter** |**Description** | |---------|---------| |**Name** | Give a name for the new cluster. | - |**Version** | Include the [Cluster Profile Version](/cluster-profiles/task-define-profile#clusterprofileversioning) number for the cluster under which the cluster profile needs to be created. See below for more information. | + |**Version** | Include the [Cluster Profile Version](#clusterprofileversioning) number for the cluster under which the cluster profile needs to be created. See below for more information. | |**Description** | Provide quick description of your cluster. This is optional. | - |**Profile Type (Full, Infrastructure, Add-on)**| Dictates the layers that can be configured in the cluster profile. If the cluster profile type is Infrastructure or Full, you are able to select a Cloud Type or Data Center environments. For more information on [Add-on](/cluster-profiles/task-define-profile#Addon) types go to step four. | + |**Profile Type (Full, Infrastructure, Add-on)**| Dictates the layers that can be configured in the cluster profile. If the cluster profile type is Infrastructure or Full, you are able to select a Cloud Type or Data Center environments. For more information on Add-on types go to step four. | |**Tags** | Tags on a cluster profile are propagated to the VMs deployed on the cloud/data center environments when clusters are created from the cluster profile. This is optional. | diff --git a/docs/docs-content/clusters/cluster-groups/cluster-group-backups.md b/docs/docs-content/clusters/cluster-groups/cluster-group-backups.md index e5c4e00060..9b808aea5c 100644 --- a/docs/docs-content/clusters/cluster-groups/cluster-group-backups.md +++ b/docs/docs-content/clusters/cluster-groups/cluster-group-backups.md @@ -7,15 +7,15 @@ sidebar_position: 10 tags: ["clusters", "cluster groups"] --- -Palette [Virtual Clusters](/clusters/palette-virtual-clusters) are a capability that cluster groups support and that you can enable when creating a cluster group. By default, the virtual cluster settings in a cluster group disable disk backups. You can back up all the volumes within a virtual cluster using the following steps. +Palette [Virtual Clusters](../palette-virtual-clusters/palette-virtual-clusters.md) are a capability that cluster groups support and that you can enable when creating a cluster group. By default, the virtual cluster settings in a cluster group disable disk backups. You can back up all the volumes within a virtual cluster using the following steps. ## Prerequisites -* A project or tenant backup location. Refer to the [cluster backup and restore](/clusters/cluster-management/backup-restore#clusterbackupandrestore) document to learn how to configure a backup location. +* A project or tenant backup location. Refer to the [cluster backup and restore](../cluster-management/backup-restore/backup-restore.md#clusterbackupandrestore) document to learn how to configure a backup location. -* Cluster group modification [permissions](/user-management/palette-rbac). +* Cluster group modification [permissions](../../user-management/palette-rbac/palette-rbac.md). -* A cluster group. Review the [create a cluster group](/clusters/cluster-groups/create-cluster-group) for additional guidance. +* A cluster group. Review the [create a cluster group](create-cluster-group.md) for additional guidance. :::info @@ -77,10 +77,10 @@ You can validate that the disk backups are occurring by deploying a virtual clus 1. Log in to [Palette](https://console.spectrocloud.com). -2. Deploy a virtual cluster in your cluster group that has the disk backup settings enabled. Refer to the [Deploy a Virtual Cluster to a Cluster Group](/clusters/palette-virtual-clusters/deploy-virtual-cluster) guide to learn how to deploy Palette Virtual clusters. +2. Deploy a virtual cluster in your cluster group that has the disk backup settings enabled. Refer to the [Deploy a Virtual Cluster to a Cluster Group](../palette-virtual-clusters/deploy-virtual-cluster.md) guide to learn how to deploy Palette Virtual clusters. -3. Create a backup of your virtual cluster and include all disks. Use the [Create a Cluster Backup](/clusters/cluster-management/backup-restore#createaclusterbackup) guide for additional guidance. +3. Create a backup of your virtual cluster and include all disks. Use the [Create a Cluster Backup](../cluster-management/backup-restore/backup-restore.md#get-started) guide for additional guidance. 4. Access the backup location's blob storage and review the backup files. diff --git a/docs/docs-content/clusters/cluster-groups/cluster-groups.md b/docs/docs-content/clusters/cluster-groups/cluster-groups.md index 017b7d9a62..22232433a6 100644 --- a/docs/docs-content/clusters/cluster-groups/cluster-groups.md +++ b/docs/docs-content/clusters/cluster-groups/cluster-groups.md @@ -8,9 +8,9 @@ sidebar_custom_props: tags: ["clusters", "cluster groups"] --- -A *Cluster Group* is a collection of one or more host clusters that together form a computing platform for you and your users to deploy Palette virtual clusters. Downstream consumers can use the cluster group when using Palette in [*App Mode*](/introduction/palette-modes#whatisappmode?). +A *Cluster Group* is a collection of one or more host clusters that together form a computing platform for you and your users to deploy Palette virtual clusters. Downstream consumers can use the cluster group when using Palette in [*App Mode*](../../introduction/palette-modes.md#what-is-app-mode). -You can create a cluster group under the Palette [tenant](/glossary-all#tenant) scope. Alternatively, you can create a cluster group at the [project](/projects) scope. +You can create a cluster group under the Palette [tenant](../../glossary-all.md#tenant) scope. Alternatively, you can create a cluster group at the [project](../../projects.md) scope. By default, Palette exposes a managed cluster group called *beehive* that is available for users in app mode. This cluster group is managed by Palette and falls under the free tier. The beehive cluster group is located in the eastern side of the U.S. @@ -28,14 +28,14 @@ Cluster groups support two network endpoints: load balancer and ingress. All hos ## Get Started -Learn how to create a cluster group by reviewing the [Create and Manage Cluster Groups](/clusters/cluster-groups/create-cluster-group) guide. +Learn how to create a cluster group by reviewing the [Create and Manage Cluster Groups](create-cluster-group.md) guide.
## Resources -- [Create and Manage Cluster Groups](/clusters/cluster-groups/create-cluster-group) +- [Create and Manage Cluster Groups](create-cluster-group.md) -- [Enable Disk Backup on Virtual Clusters](/clusters/cluster-groups/cluster-group-backups) +- [Enable Disk Backup on Virtual Clusters](cluster-group-backups.md) -- [Set up Ingress for a Cluster Group](/clusters/cluster-groups/ingress-cluster-group) +- [Set up Ingress for a Cluster Group](ingress-cluster-group.md) diff --git a/docs/docs-content/clusters/cluster-groups/create-cluster-group.md b/docs/docs-content/clusters/cluster-groups/create-cluster-group.md index 239a286d0e..7f3b77ae8c 100644 --- a/docs/docs-content/clusters/cluster-groups/create-cluster-group.md +++ b/docs/docs-content/clusters/cluster-groups/create-cluster-group.md @@ -14,7 +14,7 @@ Use the instructions below to create a cluster group. ## Prerequisites -* To create a Palette Host Cluster Group, you need to deploy a healthy running [Palette host cluster](/clusters). +* To create a Palette Host Cluster Group, you need to deploy a healthy running [Palette host cluster](../clusters.md). * The host clusters must match the network endpoint type of the cluster group. @@ -66,7 +66,7 @@ s |--------------------------------------|-------------------------------------------| |Oversubscription (%): | The allowed oversubscription for cluster in terms of resources. Default is 120%.| |Cluster endpoint type: | Load balancer or Ingress.| -|Host DNS: | If the selected cluster endpoint is **Ingress**, then for each selected host cluster provide the host DNS pattern. Ensure that a wildcard DNS record exists that maps the provided host pattern to the ingress controller load balancer for this cluster. Check out the [Setup Ingress](/clusters/cluster-groups/ingress-cluster-group) for additional guidance.| +|Host DNS: | If the selected cluster endpoint is **Ingress**, then for each selected host cluster provide the host DNS pattern. Ensure that a wildcard DNS record exists that maps the provided host pattern to the ingress controller load balancer for this cluster. Check out the [Setup Ingress](ingress-cluster-group.md) for additional guidance.| #### Palette Virtual Cluster Configuration diff --git a/docs/docs-content/clusters/cluster-groups/ingress-cluster-group.md b/docs/docs-content/clusters/cluster-groups/ingress-cluster-group.md index 1615dfedf6..220f176062 100644 --- a/docs/docs-content/clusters/cluster-groups/ingress-cluster-group.md +++ b/docs/docs-content/clusters/cluster-groups/ingress-cluster-group.md @@ -59,7 +59,7 @@ The following steps describe how to enable an Ingress Controller for a Cluster G - Existing host clusters that you will add to a new Cluster Group.

-3. Either add the `nginx-ingress` add-on profile to each host cluster, or manually configure your own ingress controller add-on profile with the customizations described in the [Prerequisites](/clusters/cluster-groups/ingress-cluster-group/#prerequisites) section. +3. Either add the `nginx-ingress` add-on profile to each host cluster, or manually configure your own ingress controller add-on profile with the customizations described in the [Prerequisites](ingress-cluster-group.md/#prerequisites) section. a. From the **Main Menu**, choose **Clusters** and select a cluster. @@ -115,7 +115,7 @@ The following steps describe how to enable an Ingress Controller for a Cluster G To validate that ingress is functioning as expected, do the following: 1. From the **User Menu**, switch to App Mode and deploy a new virtual cluster.
- To learn how to deploy a virtual cluster, check out the [Add Virtual Clusters to a Cluster Group](/clusters/palette-virtual-clusters/deploy-virtual-cluster) guide. + To learn how to deploy a virtual cluster, check out the [Add Virtual Clusters to a Cluster Group](../palette-virtual-clusters/deploy-virtual-cluster.md) guide. 2. Use a web shell and type the following command to verify you can connect to the newly deployed virtual cluster: diff --git a/docs/docs-content/clusters/cluster-management/backup-restore/add-backup-location-dynamic.md b/docs/docs-content/clusters/cluster-management/backup-restore/add-backup-location-dynamic.md index 3634cb8537..5218257d46 100644 --- a/docs/docs-content/clusters/cluster-management/backup-restore/add-backup-location-dynamic.md +++ b/docs/docs-content/clusters/cluster-management/backup-restore/add-backup-location-dynamic.md @@ -8,7 +8,7 @@ tags: ["clusters", "cluster management", "backup"] --- -This guide provides instructions for how to add a backup location in Palette using dynamic access credentials. You use the dynamic access credentials to authenticate Palette with the backup location service provider. Refer to the [Backup Location](/clusters/cluster-management/backup-restore#backuplocation) section to learn more about the supported service providers. +This guide provides instructions for how to add a backup location in Palette using dynamic access credentials. You use the dynamic access credentials to authenticate Palette with the backup location service provider. Refer to the [Backup Location](backup-restore.md#backuplocation) section to learn more about the supported service providers. Depending on the infrastructure provider, there may be limitations or different prerequisites. @@ -46,7 +46,7 @@ Use the following steps to add an S3 bucket as the backup location using the STS * Both your Palette environment instance and the S3 bucket are hosted on AWS. This prerequisite is more applicable to self-hosted Palette and Palette VerteX customers. Palette SaaS in hosted in an AWS environment. -* An AWS account. This account is assumed to be the same account where you deploy Kubernetes clusters. Refer to the [Multiple Cloud Accounts with AWS STS](/clusters/cluster-management/backup-restore/add-backup-location-dynamic#multiple-cloud-accounts-with-aws-sts) section to learn how to add a backup location when the cluster deployment cloud account differs from the backup cloud account. +* An AWS account. This account is assumed to be the same account where you deploy Kubernetes clusters. Refer to the [Multiple Cloud Accounts with AWS STS](add-backup-location-dynamic.md#multiple-cloud-accounts-with-aws-sts) section to learn how to add a backup location when the cluster deployment cloud account differs from the backup cloud account. @@ -207,7 +207,7 @@ Suppose your Kubernetes cluster is deployed in *AWS Account A*, and you want to A multi-cloud account scenario requires you to perform the following authentication steps. -1. Grant Palette access to the cluster in AWS Account A. When you register a primary cloud account in Palette, you authenticate and authorize Palette to deploy clusters in the cloud account. Check out the [Add AWS Account](/clusters/public-cloud/aws/add-aws-accounts) to guidance on how to add an AWS account in Palette. +1. Grant Palette access to the cluster in AWS Account A. When you register a primary cloud account in Palette, you authenticate and authorize Palette to deploy clusters in the cloud account. Check out the [Add AWS Account](../../public-cloud/aws/add-aws-accounts.md) to guidance on how to add an AWS account in Palette. 2. Give Palette permission to use the S3 buckets in AWS Account B. Set the bucket permissions and link them to an IAM role. Then, update the IAM role to let Palette assume it. @@ -434,6 +434,6 @@ Use the following steps to validate adding the new backup location. ## Next Steps -You can now use the newly added backup location to create a backup of your clusters or workspaces. Refer to the [Create a Backup](/clusters/cluster-management/backup-restore/create-cluster-backup) guide to learn how to create a backup of your clusters or workspaces. +You can now use the newly added backup location to create a backup of your clusters or workspaces. Refer to the [Create a Backup](create-cluster-backup.md) guide to learn how to create a backup of your clusters or workspaces. diff --git a/docs/docs-content/clusters/cluster-management/backup-restore/add-backup-location-static.md b/docs/docs-content/clusters/cluster-management/backup-restore/add-backup-location-static.md index e7edc204bb..3004ab08bf 100644 --- a/docs/docs-content/clusters/cluster-management/backup-restore/add-backup-location-static.md +++ b/docs/docs-content/clusters/cluster-management/backup-restore/add-backup-location-static.md @@ -130,7 +130,7 @@ The following sections provide detailed instructions. Select the environment whe |**S3 URL**|Optional bucket URL. If you choose to provide a value, refer to the [Methods for accessing a bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-bucket-intro.html#virtual-host-style-url-ex) guide to determine the bucket URL. If you provided an S3 URL, enable the **Force S3 path style** checkbox.| -5. Next, choose the *Credentials* validation method. If you want to use dynamic credentials through the AWS STS service, refer to the [Add a Backup Location using Dynamic Credentials](/clusters/cluster-management/backup-restore/add-backup-location-dynamic) for guided instructions. +5. Next, choose the *Credentials* validation method. If you want to use dynamic credentials through the AWS STS service, refer to the [Add a Backup Location using Dynamic Credentials](add-backup-location-dynamic.md) for guided instructions. 6. Provide the IAM user's access key if you chose the **Credentials** method. The IAM user must have the necessary IAM policy attached, which you defined in the prerequisites section above. The specified policy allows Palette to create a backup in the S3 bucket. @@ -217,7 +217,7 @@ You have completed configuring and adding a backup location to Palette with stat Use the following steps to validate adding the new backup location. -1. Log in to [Palette](https://console.spectrocloud.com/). +1. Log in to [Palette](https://console.spectrocloud.com). 2. Navigate to **Project Settings** and click on **Backup Locations**. @@ -298,7 +298,7 @@ You have completed configuring and adding a backup location to Palette with stat Use the following steps to validate adding the new backup location. -1. Log in to [Palette](https://console.spectrocloud.com/). +1. Log in to [Palette](https://console.spectrocloud.com). 2. Navigate to **Project Settings** and click on **Backup Locations**. @@ -343,7 +343,7 @@ Check out the [Work with Azure service principal using the Azure CLI](https://le ### Add an Azure Blob Container -1. Log in to [Palette](https://console.spectrocloud.com/). +1. Log in to [Palette](https://console.spectrocloud.com). 2. Navigate to **Project Settings** and click on **Backup Locations**. @@ -384,7 +384,7 @@ You have completed configuring and adding a backup location to Palette with stat Use the following steps to validate adding the new backup location. -1. Log in to [Palette](https://console.spectrocloud.com/). +1. Log in to [Palette](https://console.spectrocloud.com). 2. Navigate to **Project Settings** and click on **Backup Locations**. @@ -400,4 +400,4 @@ Use the following steps to validate adding the new backup location. ## Next Steps -You can now use the newly added backup location to create a backup of your clusters or workspaces. Refer to the [Create a Backup](/clusters/cluster-management/backup-restore/create-cluster-backup) guide to learn how to create a backup of your clusters or workspaces. \ No newline at end of file +You can now use the newly added backup location to create a backup of your clusters or workspaces. Refer to the [Create a Backup](create-cluster-backup.md) guide to learn how to create a backup of your clusters or workspaces. \ No newline at end of file diff --git a/docs/docs-content/clusters/cluster-management/backup-restore/backup-restore.md b/docs/docs-content/clusters/cluster-management/backup-restore/backup-restore.md index 67d26f86ab..d1a3617924 100644 --- a/docs/docs-content/clusters/cluster-management/backup-restore/backup-restore.md +++ b/docs/docs-content/clusters/cluster-management/backup-restore/backup-restore.md @@ -12,13 +12,13 @@ Palette supports backup and restore capabilities for Kubernetes clusters. A backup is a persistent state of Kubernetes resources, ranging from objects such as Pods, DaemonSets, and Services to persistent volumes. A backup allows you to save the current state of a cluster and restore it at a later point in time if needed. You can restore a backup to the same or a different cluster. -You can schedule a backup of a specific cluster or an entire [workspace](/workspace). You can also maintain multiple backups of a cluster or workspace. +You can schedule a backup of a specific cluster or an entire [workspace](../../../workspace/workspace.md). You can also maintain multiple backups of a cluster or workspace. ## Get Started -To get started with creating a backup, check out the [Add a Backup Location using Static Credentials](/clusters/cluster-management/backup-restore/add-backup-location-static) or [Add a Backup Location using Dynamic Credentials](/clusters/cluster-management/backup-restore/add-backup-location-dynamic) guide. +To get started with creating a backup, check out the [Add a Backup Location using Static Credentials](add-backup-location-static.md) or [Add a Backup Location using Dynamic Credentials](add-backup-location-dynamic.md) guide. :::info @@ -82,13 +82,13 @@ To learn more about adding a backup location, check out the [Add a Backup Locati ## Resources -- [Add a Backup Location using Static Credentials](/clusters/cluster-management/backup-restore/add-backup-location-static) +- [Add a Backup Location using Static Credentials](add-backup-location-static.md) -- [Add a Backup Location using Dynamic Credentials](/clusters/cluster-management/backup-restore/add-backup-location-dynamic) +- [Add a Backup Location using Dynamic Credentials](add-backup-location-dynamic.md) -- [Create a Cluster Backup](/clusters/cluster-management/backup-restore/create-cluster-backup) +- [Create a Cluster Backup](create-cluster-backup.md) -- [Restore a Cluster Backup](/clusters/cluster-management/backup-restore/restore-cluster-backup) +- [Restore a Cluster Backup](restore-cluster-backup.md) diff --git a/docs/docs-content/clusters/cluster-management/backup-restore/create-cluster-backup.md b/docs/docs-content/clusters/cluster-management/backup-restore/create-cluster-backup.md index f2977d3b59..41204b242d 100644 --- a/docs/docs-content/clusters/cluster-management/backup-restore/create-cluster-backup.md +++ b/docs/docs-content/clusters/cluster-management/backup-restore/create-cluster-backup.md @@ -42,7 +42,7 @@ Use the following instructions to schedule a backup for an existing cluster. ### Prerequisites -- An available backup location in Palette. Refer to the [Add a Backup Location using Static Credentials](/clusters/cluster-management/backup-restore/add-backup-location-static) or [Add a Backup Location using Dynamic Credentials](/clusters/cluster-management/backup-restore/add-backup-location-dynamic). +- An available backup location in Palette. Refer to the [Add a Backup Location using Static Credentials](add-backup-location-static.md) or [Add a Backup Location using Dynamic Credentials](add-backup-location-dynamic.md). - An active cluster in Palette. @@ -137,7 +137,7 @@ Use the following instructions to create an on-demand backup for an existing clu ### Prerequisites -- An available backup location in Palette. Refer to the [Add a Backup Location using Static Credentials](/clusters/cluster-management/backup-restore/add-backup-location-static) or [Add a Backup Location using Dynamic Credentials](/clusters/cluster-management/backup-restore/add-backup-location-dynamic). +- An available backup location in Palette. Refer to the [Add a Backup Location using Static Credentials](add-backup-location-static.md) or [Add a Backup Location using Dynamic Credentials](add-backup-location-dynamic.md). ### Instructions @@ -145,7 +145,7 @@ Use the following instructions to create an on-demand backup for an existing clu - An active cluster in Palette. -1. Log in to [Palette](https://console.spectrocloud.com/). +1. Log in to [Palette](https://console.spectrocloud.com). 2. Navigate to the left **Main Menu** and select **Clusters**. @@ -167,7 +167,7 @@ Use the following instructions to create an on-demand backup for an existing clu |**Field**|**Description**| |---|---| |**Backup name**|Provide a name for the backup. | - |**Select backup location**|Choose a backup location. You must configure a backup location before creating a backup. Refer to the [Add a Backup Location using Static Credentials](/clusters/cluster-management/backup-restore/add-backup-location-static) or [Add a Backup Location using Dynamic Credentials](/clusters/cluster-management/backup-restore/add-backup-location-dynamic) guides to learn about adding a backup location using static or dynamic credentials. | + |**Select backup location**|Choose a backup location. You must configure a backup location before creating a backup. Refer to the [Add a Backup Location using Static Credentials](add-backup-location-static.md) or [Add a Backup Location using Dynamic Credentials](add-backup-location-dynamic.md) guides to learn about adding a backup location using static or dynamic credentials. | |**Select period until expiry**|Select an expiry duration for the backup. The backup will be automatically removed after the expiry duration.| |**Include all disks**|Select this checkbox if you want to include PVs and volume snapshots in the backup.| |**Include cluster resources**|Select the checkbox if you want to include cluster-scoped resources in the backup. If you do not select the checkbox, Palette will back up only the namespace-scoped resources.| @@ -220,4 +220,4 @@ Use the following steps to validate creating a backup in Palette. ## Next Steps -When the backup is available, you can restore it to the same or to a different cluster. Refer to the [Restore a Cluster Backup](/clusters/cluster-management/backup-restore/restore-cluster-backup) guide to learn more about restoring a backup. +When the backup is available, you can restore it to the same or to a different cluster. Refer to the [Restore a Cluster Backup](restore-cluster-backup.md) guide to learn more about restoring a backup. diff --git a/docs/docs-content/clusters/cluster-management/backup-restore/restore-cluster-backup.md b/docs/docs-content/clusters/cluster-management/backup-restore/restore-cluster-backup.md index cea7d37553..f3b5e0ee4d 100644 --- a/docs/docs-content/clusters/cluster-management/backup-restore/restore-cluster-backup.md +++ b/docs/docs-content/clusters/cluster-management/backup-restore/restore-cluster-backup.md @@ -93,13 +93,13 @@ A restore operation only restores the specified namespaces, cluster-scoped resou - The destination cluster must belong to the same project as the source cluster. -- A backup is created for the source cluster. Check out the [Create Cluster Backup](/clusters/cluster-management/backup-restore/create-cluster-backup) for guidance on how to create a backup. +- A backup is created for the source cluster. Check out the [Create Cluster Backup](create-cluster-backup.md) for guidance on how to create a backup. - Ensure the storage classes in the destination cluster match the storage classes in the source cluster. -- If the backup location is configured using dynamic credentials, such as the AWS Security Token Service (STS) authentication method, ensure you define a trust relationship with the destination cluster. The trust relationship enables the destination cluster to assume the necessary IAM role to access the backup files. Refer to the [Add a Backup Location using Dynamic Credentials](/clusters/cluster-management/backup-restore/add-backup-location-dynamic) guide. +- If the backup location is configured using dynamic credentials, such as the AWS Security Token Service (STS) authentication method, ensure you define a trust relationship with the destination cluster. The trust relationship enables the destination cluster to assume the necessary IAM role to access the backup files. Refer to the [Add a Backup Location using Dynamic Credentials](add-backup-location-dynamic.md) guide. ### Instructions @@ -107,7 +107,7 @@ A restore operation only restores the specified namespaces, cluster-scoped resou Use the following instructions in Palette to restore a backup to a destination cluster. -1. Log in to [Palette](https://console.spectrocloud.com/). +1. Log in to [Palette](https://console.spectrocloud.com). 2. Navigate to the left **Main Menu** and click on **Clusters**. diff --git a/docs/docs-content/clusters/cluster-management/certificate-management.md b/docs/docs-content/clusters/cluster-management/certificate-management.md index 6b59c1a455..a8bec905ec 100644 --- a/docs/docs-content/clusters/cluster-management/certificate-management.md +++ b/docs/docs-content/clusters/cluster-management/certificate-management.md @@ -40,7 +40,7 @@ When you upgrade the control plane on a cluster, the PKI certificates are automa :::info -You can upgrade the Kubernetes version of a cluster by updating the Kubernetes layer of the [cluster profile](/cluster-profiles) and applying the cluster profile update to the cluster. For guidelines on updating pack versions, review [Update the Pack Version](/cluster-profiles/task-update-profile#updatethepackversion). +You can upgrade the Kubernetes version of a cluster by updating the Kubernetes layer of the [cluster profile](/cluster-profiles) and applying the cluster profile update to the cluster. For guidelines on updating pack versions, review [Update the Pack Version](../../cluster-profiles/task-update-profile.md#updatethepackversion). ::: @@ -129,7 +129,7 @@ Use the following steps to update the cluster PKI certificates through the Palet ### Prerequisites -- A Palette API key. You can learn how to create a Palette API key by reviewing the [API Key](/user-management/user-authentication/) documentation. +- A Palette API key. You can learn how to create a Palette API key by reviewing the [API Key](../../user-management/user-authentication.md) documentation. - A deployed host cluster. @@ -246,7 +246,7 @@ Using the following steps, you can validate that the cluster's PKI certificates
- ```json + ```json hideClipboard { "machineCertificates": [ { @@ -305,10 +305,6 @@ Using the following steps, you can validate that the cluster's PKI certificates ``` - -
## Advanced - Only Renew Control Plane Nodes @@ -326,7 +322,7 @@ Use the following steps to configure Palette only to renew the certificates for - A host cluster deployed. -- Access to the host cluster's kubeconfig file. Refer to the [Access Cluster with CLI](/clusters/cluster-management/palette-webctl) guide to learn how to use your cluster's kubeconfig file. +- Access to the host cluster's kubeconfig file. Refer to the [Access Cluster with CLI](palette-webctl.md) guide to learn how to use your cluster's kubeconfig file. ### Configure Cluster @@ -371,7 +367,7 @@ Use the following steps to configure Palette only to renew the certificates for ``` -4. Next, trigger a certificate renewal using either [Automatic Certificate Renewal](/clusters/cluster-management/certificate-management#automaticcertificaterenewal) or [Manual Certificate Renewal](/clusters/cluster-management/certificate-management#manualcertificaterenewal). +4. Next, trigger a certificate renewal using either [Automatic Certificate Renewal](#automatic-certificate-renewal) or [Manual Certificate Renewal](#manual-certificate-renewal). diff --git a/docs/docs-content/clusters/cluster-management/cluster-management.md b/docs/docs-content/clusters/cluster-management/cluster-management.md index 0263a65a84..3b39bc3f28 100644 --- a/docs/docs-content/clusters/cluster-management/cluster-management.md +++ b/docs/docs-content/clusters/cluster-management/cluster-management.md @@ -13,65 +13,65 @@ Palette supports several Day-2 operations to manage the end-to-end lifecycle of The following sections describe these capabilities in detail: -* [Reconfigure](/clusters/cluster-management/reconfigure) - Scale your clusters up/down by adding/reducing the number of nodes in a node pool and adding additional worker pools. Resize nodes in a node pool by modifying the node specs (CPU, Memory, or Instance Type for public clouds). Add additional fault domains such as availability zones to a node pool. +* [Reconfigure](reconfigure.md) - Scale your clusters up/down by adding/reducing the number of nodes in a node pool and adding additional worker pools. Resize nodes in a node pool by modifying the node specs (CPU, Memory, or Instance Type for public clouds). Add additional fault domains such as availability zones to a node pool. -* [Updates](/clusters/cluster-management/cluster-updates) - Upgrade core packs (OS, Kubernetes, CSI, CNI) and add-on layers, such as Monitoring and Security. +* [Updates](cluster-updates.md) - Upgrade core packs (OS, Kubernetes, CSI, CNI) and add-on layers, such as Monitoring and Security. -* [Cluster Health Alerts](/clusters/cluster-management/health-alerts) - Palette monitors the health of all workload clusters and raises an alert when the cluster goes to an unhealthy state. Besides displaying the alert on the UI console, Palette provides the ability to have these alerts pushed out to a variety of channels. Users can set up email alerts to receive an email when the health status of their cluster changes. +* [Cluster Health Alerts](health-alerts.md) - Palette monitors the health of all workload clusters and raises an alert when the cluster goes to an unhealthy state. Besides displaying the alert on the UI console, Palette provides the ability to have these alerts pushed out to a variety of channels. Users can set up email alerts to receive an email when the health status of their cluster changes. -* [Certificate Management](/clusters/cluster-management/certificate-management) - You can renew cluster certificates on-demand or leverage the automatic cluster update process to handle certificate renewal operations. +* [Certificate Management](certificate-management.md) - You can renew cluster certificates on-demand or leverage the automatic cluster update process to handle certificate renewal operations. -* [Cluster Monitoring](/clusters/cluster-management/monitoring/deploy-monitor-stack) - Monitor your cluster resources by collecting and reviewing metrics. +* [Cluster Monitoring](monitoring/deploy-monitor-stack.md) - Monitor your cluster resources by collecting and reviewing metrics. -* [Compliance Scans](/clusters/cluster-management/compliance-scan) - Perform continuous compliance checks to ensure your clusters are secure and compliant. +* [Compliance Scans](compliance-scan.md) - Perform continuous compliance checks to ensure your clusters are secure and compliant. -* [OS Patching](/clusters/cluster-management/os-patching) - Automatically apply the most recent security patches to cluster nodes to stay up to date with the latest OS patches. +* [OS Patching](os-patching.md) - Automatically apply the most recent security patches to cluster nodes to stay up to date with the latest OS patches. -* [Backup and Restore](/clusters/cluster-management/backup-restore) - Regularly back up your cluster configurations and any persistent volumes that your applications use. Choose critical namespaces you would like to back up. Restore as required to new or existing clusters. +* [Backup and Restore](backup-restore/backup-restore.md) - Regularly back up your cluster configurations and any persistent volumes that your applications use. Choose critical namespaces you would like to back up. Restore as required to new or existing clusters. -* [Cost Visibility](/clusters/cluster-management/cloud-cost) - Get visibility into the estimated cloud cost for the cluster based on cluster node configuration. Get additional insights into per namespace cost (Usage Cost) calculated based on the number of resources consumed within the namespace. +* [Cost Visibility](cloud-cost.md) - Get visibility into the estimated cloud cost for the cluster based on cluster node configuration. Get additional insights into per namespace cost (Usage Cost) calculated based on the number of resources consumed within the namespace. -* [Workload Visibility](/clusters/cluster-management/workloads) - Palette provides visibility into the resources running inside workload clusters. These resources are displayed on the cluster details page. +* [Workload Visibility](workloads.md) - Palette provides visibility into the resources running inside workload clusters. These resources are displayed on the cluster details page. -* [Node Labels and Taints](/clusters/cluster-management/taints) - You can constrain a pod to run only on a particular set of nodes. There are several ways to do this. Common approaches, such as nodeSelector and node affinity, use labels to facilitate the selection. Taints allow a node to repel a set of pods for appropriate pod allocation to node pools. +* [Node Labels and Taints](taints.md) - You can constrain a pod to run only on a particular set of nodes. There are several ways to do this. Common approaches, such as nodeSelector and node affinity, use labels to facilitate the selection. Taints allow a node to repel a set of pods for appropriate pod allocation to node pools. -* [RBAC and NS Support](/clusters/cluster-management/cluster-rbac) - RoleBindings and ClusterRoleBindings are Role-Based Access Control (RBAC) concepts that allow granular control over cluster-wide resources as well as namespace resources. Palette provides the ability to specify these bindings to configure granular RBAC rules. Palette can also define new namespaces for the cluster and manage the namespaces, such as removing them and assigning quotas and role bindings to them. +* [RBAC and NS Support](cluster-rbac.md) - RoleBindings and ClusterRoleBindings are Role-Based Access Control (RBAC) concepts that allow granular control over cluster-wide resources as well as namespace resources. Palette provides the ability to specify these bindings to configure granular RBAC rules. Palette can also define new namespaces for the cluster and manage the namespaces, such as removing them and assigning quotas and role bindings to them. -* [Namespace Management](/clusters/cluster-management/namespace-management) - use Kubernetes namespaces to partition resources among multiple users without having to set up multiple physical clusters, configure Role-Based Access Control (RBAC) based on namespaces, and more. +* [Namespace Management](namespace-management.md) - use Kubernetes namespaces to partition resources among multiple users without having to set up multiple physical clusters, configure Role-Based Access Control (RBAC) based on namespaces, and more. -* [Add-on Pack Status and Monitoring](/clusters/cluster-management/pack-monitoring) - Palette displays the status and installation progress of add-on packs associated with the cluster you are monitoring. Pack status appears gray during initial onboarding and before deployment, blue when the pack is in the process of being installed, and green to indicate successful installation. Red indicates a failed installation and requires attention. +* [Add-on Pack Status and Monitoring](pack-monitoring.md) - Palette displays the status and installation progress of add-on packs associated with the cluster you are monitoring. Pack status appears gray during initial onboarding and before deployment, blue when the pack is in the process of being installed, and green to indicate successful installation. Red indicates a failed installation and requires attention. -* [Kubectl](/clusters/cluster-management/palette-webctl#overview) - Learn how to use `kubectl` to interact with your host clusters. +* [Kubectl](palette-webctl.md) - Learn how to use `kubectl` to interact with your host clusters. -* [Platform Management](/clusters/cluster-management/palette-lock-cluster) - Palette supports the Cluster(s) Management feature to exclude a cluster or a group of clusters from getting upgraded when Palette is upgraded. +* [Platform Management](palette-lock-cluster.md) - Palette supports the Cluster(s) Management feature to exclude a cluster or a group of clusters from getting upgraded when Palette is upgraded. -* [NOC UI](/clusters/cluster-management/palette-lock-cluster) - Palette provides Intuitive UI-based location monitoring for the clusters running at multiple locations. For public cloud clusters Palette displays the `Region` set during the cluster creation process and displays the location on the UI Map. For private cloud clusters the user can set the location through the Palette UI. The user can monitor the location details of all the clusters running under a specific scope. +* [NOC UI](palette-lock-cluster.md) - Palette provides Intuitive UI-based location monitoring for the clusters running at multiple locations. For public cloud clusters Palette displays the `Region` set during the cluster creation process and displays the location on the UI Map. For private cloud clusters the user can set the location through the Palette UI. The user can monitor the location details of all the clusters running under a specific scope. -* [Palette Access Control](/clusters/cluster-management/cluster-tag-filter) - Palette provides the ability to manage user and role access privileges through tags. This feature helps you reduce the overhead in managing user and role access to clusters by assigning tags. Tags can be used to group clusters, allowing you to apply access controls to the tag rather than to each cluster, user, or role. This reduces the overhead of managing access controls for individual users and clusters. +* [Palette Access Control](cluster-tag-filter/cluster-tag-filter.md) - Palette provides the ability to manage user and role access privileges through tags. This feature helps you reduce the overhead in managing user and role access to clusters by assigning tags. Tags can be used to group clusters, allowing you to apply access controls to the tag rather than to each cluster, user, or role. This reduces the overhead of managing access controls for individual users and clusters. -* [Image Swap](/clusters/cluster-management/image-swap) - Learn how to use image swap capabilities with Palette. +* [Image Swap](image-swap.md) - Learn how to use image swap capabilities with Palette. diff --git a/docs/docs-content/clusters/cluster-management/cluster-rbac.md b/docs/docs-content/clusters/cluster-management/cluster-rbac.md index 7163c46f9d..7e0b911f1c 100644 --- a/docs/docs-content/clusters/cluster-management/cluster-rbac.md +++ b/docs/docs-content/clusters/cluster-management/cluster-rbac.md @@ -10,7 +10,7 @@ tags: ["clusters", "cluster management"] [*RoleBindings*](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#rolebinding-and-clusterrolebinding) and *ClusterRoleBindings* are Role-Based Access Control (RBAC) concepts that allow granular control over cluster-wide resources. Palette provides you the ability to specify bindings to configure granular RBAC rules. -You can configure namespaces and RBAC from within a cluster or from a [Palette Workspace](/workspace) that contains a collection of like clusters that need to be managed as a group. If a host cluster is part of a Palette workspace, then all roleBindings must occur at the namespace level. +You can configure namespaces and RBAC from within a cluster or from a [Palette Workspace](../../workspace/workspace.md) that contains a collection of like clusters that need to be managed as a group. If a host cluster is part of a Palette workspace, then all roleBindings must occur at the namespace level. As you review RBAC support, use the following definitions: @@ -92,7 +92,7 @@ Use the steps below to create a RoleBinding or ClusterRoleBinding for your host ## Palette Roles and Kubernetes Roles -Palette offers a set of [default roles](/user-management/palette-rbac#palettespecific(default)roles:) you can assign to your users. The Palette roles are only in scope at the platform level. This means you can manage the permissions for users' actions in Palette, such as creating or deleting clusters, creating projects, creating users, and more. +Palette offers a set of [default roles](../../user-management/palette-rbac/palette-rbac.md#assign-palette-specific-roles-to-users) you can assign to your users. The Palette roles are only in scope at the platform level. This means you can manage the permissions for users' actions in Palette, such as creating or deleting clusters, creating projects, creating users, and more. The Kubernetes roles are used to control the actions users are allowed to do inside the cluster. For example, a user in Palette could have the *Cluster Profile Viewer* role, which grants them the ability to view cluster profiles for a specific project. In all the clusters in this project, the user could be assigned a role binding to a custom role that grants them administrative access in all the clusters. @@ -112,7 +112,7 @@ Palette roles do not automatically map to a Kubernetes role. You must create a r To create a role binding the role must exist inside the host cluster. You can use any of the [default cluster roles](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#user-facing-roles) provided by Kubernetes. The alternative to default cluster roles is to create a role by using a manifest in the cluster profile. -If you have OpenID Connect (OIDC) configured at the Kubernetes layer of your cluster profile, you can create a role binding that maps individual users or groups assigned within the OIDC provider's configuration to a role. To learn more, review [Use RBAC with OIDC](/integrations/kubernetes#userbacwithoidc). +If you have OpenID Connect (OIDC) configured at the Kubernetes layer of your cluster profile, you can create a role binding that maps individual users or groups assigned within the OIDC provider's configuration to a role. To learn more, review [Use RBAC with OIDC](../../integrations/kubernetes-generic.md#configure-custom-oidc). ### Enablement diff --git a/docs/docs-content/clusters/cluster-management/cluster-tag-filter/cluster-tag-filter.md b/docs/docs-content/clusters/cluster-management/cluster-tag-filter/cluster-tag-filter.md index 70a3a630fa..0e852e21f5 100644 --- a/docs/docs-content/clusters/cluster-management/cluster-tag-filter/cluster-tag-filter.md +++ b/docs/docs-content/clusters/cluster-management/cluster-tag-filter/cluster-tag-filter.md @@ -8,27 +8,27 @@ tags: ["clusters", "cluster management", "filter"] Palette provides the ability to manage user and role access privileges through tags. This feature helps you reduce the overhead in managing users' and roles' access to clusters by assigning tags. Tags can be used to group clusters, allowing you to apply access controls to the tag rather than to each cluster, user, or role, reducing the overhead of managing access controls for individual users and clusters. -To get started with an attribute access control through tags, check out the [Create Resource Filter](/clusters/cluster-management/cluster-tag-filter/create-add-filter) guide. +To get started with an attribute access control through tags, check out the [Create Resource Filter](create-add-filter.md) guide. ## Resources -- [Cluster Resource Filter](/clusters/cluster-management/cluster-tag-filter/create-add-filter) +- [Cluster Resource Filter](create-add-filter.md) -- [Create Resource Filter](/clusters/cluster-management/cluster-tag-filter/create-add-filter#createresourcefilter) +- [Create Resource Filter](create-add-filter.md#createresourcefilter) -- [Add Resource Role](/clusters/cluster-management/cluster-tag-filter/create-add-filter#addresourcerole) +- [Add Resource Role](create-add-filter.md#addresourcerole) -- [Palette Resource Roles](/user-management/palette-rbac/resource-scope-roles-permissions) +- [Palette Resource Roles](../../../user-management/palette-rbac/resource-scope-roles-permissions.md) -- [Palette Global Resource Roles](/user-management/palette-rbac/resource-scope-roles-permissions#paletteglobalresourceroles) +- [Palette Global Resource Roles](../../../user-management/palette-rbac/resource-scope-roles-permissions.md#paletteglobalresourceroles) -- [Palette Custom Resource Roles](/user-management/palette-rbac/resource-scope-roles-permissions#palettecustomresourceroles) +- [Palette Custom Resource Roles](../../../user-management/palette-rbac/resource-scope-roles-permissions.md#palettecustomresourceroles) -- [Create Custom Role](/user-management/new-user#createcustomrole) +- [Create Custom Role](../../../user-management/new-user.md#createcustomrole) -- [Create New User in Palette](/user-management/new-user#createanewuser) +- [Create New User in Palette](../../../user-management/new-user.md#createanewuser) diff --git a/docs/docs-content/clusters/cluster-management/cluster-tag-filter/create-add-filter.md b/docs/docs-content/clusters/cluster-management/cluster-tag-filter/create-add-filter.md index 3e8a6c4dd0..2fcc4f7dec 100644 --- a/docs/docs-content/clusters/cluster-management/cluster-tag-filter/create-add-filter.md +++ b/docs/docs-content/clusters/cluster-management/cluster-tag-filter/create-add-filter.md @@ -47,17 +47,17 @@ Upon creating a filter, a display message will pop up to confirm the successful ## Add Resource Role -You can assign the resource filter created, in combination with roles, to a [user](/user-management/new-user#createanewuser) to enforce access restriction. Palette provisions two types of roles: +You can assign the resource filter created, in combination with roles, to a [user](../../../user-management/new-user.md#createanewuser) to enforce access restriction. Palette provisions two types of roles: -* [Palette Global Roles](/user-management/palette-rbac/resource-scope-roles-permissions#paletteglobalresourceroles), the set of roles that are available in Palette console +* [Palette Global Roles](../../..//user-management/palette-rbac/resource-scope-roles-permissions.md#paletteglobalresourceroles), the set of roles that are available in Palette console -* [Custom Resource Roles](/user-management/palette-rbac/resource-scope-roles-permissions#palettecustomresourceroles), can be generated according to your requirements from the available set of permissions and operations. +* [Custom Resource Roles](../../..//user-management/palette-rbac/resource-scope-roles-permissions.md#palettecustomresourceroles), can be generated according to your requirements from the available set of permissions and operations. ### Prerequisites -* A [Palette account](https://www.spectrocloud.com/get-started/) with Tenant scope privileges. +* A [Palette account](https://console.spectrocloud.com) with Tenant scope privileges. -* A [user created](/user-management/new-user#createanewuser) to assign the resource privileges. +* A [user created](../../../user-management/new-user.md#createanewuser) to assign the resource privileges. To assign the resource roles and filter to the user follow the below steps:
@@ -104,5 +104,5 @@ Upon creating a filter, a display message will pop up to confirm the successful ## Resource -* [Create a New User](/user-management/new-user#createanewuser) +* [Create a New User](../../..//user-management/new-user.md#createanewuser) diff --git a/docs/docs-content/clusters/cluster-management/compliance-scan.md b/docs/docs-content/clusters/cluster-management/compliance-scan.md index 8000a788b6..5c3134e125 100644 --- a/docs/docs-content/clusters/cluster-management/compliance-scan.md +++ b/docs/docs-content/clusters/cluster-management/compliance-scan.md @@ -54,7 +54,7 @@ To initiate an SBOM scan, navigate to **Clusters** and select the cluster to sca Palette will identify every unique container image within your chosen scope and generate an SBOM for that image. Palette also runs the SBOM through a vulnerability scanner to flag any Common Vulnerabilities and Exposures (CVEs). Palette leverages two open-source tools from Anchore: [Syft](https://github.com/anchore/syft) for SBOM generation and [Grype](https://github.com/anchore/grype) for vulnerability detection. -Suppose you specify a [backup location](/clusters/cluster-management/backup-restore). In that case, the SBOM for each image will be uploaded to your backup location, and you can subsequently download the SBOMs with the click of a button or using the Palette API. +Suppose you specify a [backup location](backup-restore/backup-restore.md). In that case, the SBOM for each image will be uploaded to your backup location, and you can subsequently download the SBOMs with the click of a button or using the Palette API. If a backup location is not provided, Palette will preserve all of the identified dependencies and vulnerabilities, but the raw SBOMs will not be available for download. The report results are available for review regardless of their backup location setting. diff --git a/docs/docs-content/clusters/cluster-management/image-swap.md b/docs/docs-content/clusters/cluster-management/image-swap.md index 94be42db7b..f924af898a 100644 --- a/docs/docs-content/clusters/cluster-management/image-swap.md +++ b/docs/docs-content/clusters/cluster-management/image-swap.md @@ -154,7 +154,7 @@ Use the following steps to learn how to use Palette's image swap functionality. -10. Deploy a host cluster and use the cluster profile containing the image swap functionality. Check out the [Deploy a Cluster](/clusters/public-cloud/deploy-k8s-cluster) tutorial for additional guidance in deploying a host cluster. +10. Deploy a host cluster and use the cluster profile containing the image swap functionality. Check out the [Deploy a Cluster](../public-cloud/deploy-k8s-cluster.md) tutorial for additional guidance in deploying a host cluster. ### Validate @@ -171,7 +171,7 @@ You can validate that the image swap is functioning correctly by using the follo 3. Select the host cluster you deployed with the image swap functionality. -4. Download the kubeconfig file to access the cluster. Refer to the [Access Cluster with CLI](/clusters/cluster-management/palette-webctl) guide for detailed steps. +4. Download the kubeconfig file to access the cluster. Refer to the [Access Cluster with CLI](palette-webctl.md) guide for detailed steps. 5. Review the deployment configuration of a workload using a registry or image impacted by the image swap configuration. Verify the image or registry is swapped to the expected configuration value you provided in the image swap configuration block. diff --git a/docs/docs-content/clusters/cluster-management/kubeconfig.md b/docs/docs-content/clusters/cluster-management/kubeconfig.md index aba409e5ac..abbbc48d51 100644 --- a/docs/docs-content/clusters/cluster-management/kubeconfig.md +++ b/docs/docs-content/clusters/cluster-management/kubeconfig.md @@ -16,17 +16,17 @@ The kubeconfig file is crucial in enabling you and other users to issue kubectl Overall, the kubeconfig file serves as a key component in connecting and interacting with a Kubernetes cluster, providing you with the necessary configuration and credentials to access the cluster's API server. -You can download the kubeconfig file from the cluster details page in Palette. Check out the [Access Cluster with CLI](/clusters/cluster-management/palette-webctl) guide for steps on how to download your cluster's kubeconfig file and connect to your host cluster with the kubectl CLI. +You can download the kubeconfig file from the cluster details page in Palette. Check out the [Access Cluster with CLI](palette-webctl.md) guide for steps on how to download your cluster's kubeconfig file and connect to your host cluster with the kubectl CLI. ## Kubeconfig Files Palette exposes two kubeconfig files for each cluster deployed through Palette. -* Kubeconfig - This kubeconfig contains OIDC and Spectro Proxy configurations. The kubeconfig file is available for all users with proper access to the cluster. The kubeconfig file can be used to access the cluster's resources and perform operations on the cluster. Refer to the [Kubeconfig Access Permissions](#kubeconfigaccesspermissions) section to learn more about access permissions for the kubeconfig file. +* Kubeconfig - This kubeconfig contains OIDC and Spectro Proxy configurations. The kubeconfig file is available for all users with proper access to the cluster. The kubeconfig file can be used to access the cluster's resources and perform operations on the cluster. Refer to the [Kubeconfig Access Permissions](#kubeconfig-access-permissions) section to learn more about access permissions for the kubeconfig file. -* Admin Kubeconfig - The admin kubeconfig is created without OIDC configurations. This file is ideal for those that need to access an intermediate host to access the cluster, such as a jump host. Refer to the [Kubeconfig Access Permissions](#kubeconfigaccesspermissions) section to learn more about access permissions for the admin kubeconfig file. +* Admin Kubeconfig - The admin kubeconfig is created without OIDC configurations. This file is ideal for those that need to access an intermediate host to access the cluster, such as a jump host. Refer to the [Kubeconfig Access Permissions](#kubeconfig-access-permissions) section to learn more about access permissions for the admin kubeconfig file. ![The cluster details page with the two Kubeconfig files elements highlighted](/clusters_cluster--management_kubeconfig_cluster-details-kubeconfig-files.png) @@ -34,15 +34,15 @@ Palette exposes two kubeconfig files for each cluster deployed through Palette. Palette exposes kubeconfig files for each cluster deployed through the paltform. Depending on the cluster's configuration, the kubeconfig file may contain different configurations, such as the cluster's API server address and authentication credentials. -Your assigned [Palette permissions](/user-management/palette-rbac/project-scope-roles-permissions) determine which clusters you can access and what operations you can perform on the cluster. The permissions assigned to you in Palette determine if you can download and access the kubeconfig files for a cluster. +Your assigned [Palette permissions](../../user-management/palette-rbac/project-scope-roles-permissions.md) determine which clusters you can access and what operations you can perform on the cluster. The permissions assigned to you in Palette determine if you can download and access the kubeconfig files for a cluster. -As a rule of thumb, users with the Palette role [*Cluster Admin*](/user-management/palette-rbac/project-scope-roles-permissions#cluster) can access both kubeconfig files for all clusters in the project. Users with lower-level project roles such as the *Cluster Editor* or the *Cluster Viewer* may not be able to access the kubeconfig file of the cluster. +As a rule of thumb, users with the Palette role [*Cluster Admin*](../../user-management/palette-rbac/project-scope-roles-permissions#cluster) can access both kubeconfig files for all clusters in the project. Users with lower-level project roles such as the *Cluster Editor* or the *Cluster Viewer* may not be able to access the kubeconfig file of the cluster. :::info -Palette has its own RBAC system that is separate from the [Kubernetes RBAC](https://kubernetes.io/docs/reference/access-authn-authz/rbac/) system in the host cluster. The permissions assigned to you in Palette determine what operations you can perform on the cluster. The permissions assigned to you in the host cluster through the Kubernetes RBAC system determine what operations you can perform inside the cluster and on its resources. Refer to the [Palette Roles and Kubernetes Roles](/clusters/cluster-management/cluster-rbac#paletterolesandkubernetesroles) for additional information. +Palette has its own RBAC system that is separate from the [Kubernetes RBAC](https://kubernetes.io/docs/reference/access-authn-authz/rbac/) system in the host cluster. The permissions assigned to you in Palette determine what operations you can perform on the cluster. The permissions assigned to you in the host cluster through the Kubernetes RBAC system determine what operations you can perform inside the cluster and on its resources. Refer to the [Palette Roles and Kubernetes Roles](cluster-rbac#palette-roles-and-kubernetes-roles) for additional information. ::: @@ -51,7 +51,7 @@ The access you have as a user to the kubeconfig files for a cluster depends on t -* Is OIDC configured for the cluster? OIDC is configured in the Kubernetes pack YAML file of the cluster profile. Refer to the respective Kubernetes distribution on the [Packs List](/integrations) page to learn more about OIDC configuration. +* Is OIDC configured for the cluster? OIDC is configured in the Kubernetes pack YAML file of the cluster profile. Refer to the respective Kubernetes distribution on the [Packs List](../../integrations/integrations.mdx) page to learn more about OIDC configuration. :::caution @@ -60,7 +60,7 @@ The access you have as a user to the kubeconfig files for a cluster depends on t ::: -* Is the [Spectro Proxy](/integrations/frp) enabled for the cluster? +* Is the [Spectro Proxy](../../integrations/frp.md) enabled for the cluster? @@ -98,7 +98,7 @@ Palette exposes two API endpoints that you can use to access the kubeconfig file * `GET https://api.spectrocloud.com/v1/spectroclusters/{clusterId}/assets/kubeconfig` - Returns the kubeconfig file for the cluster. The kubeconfig file is returned as a text string. Access to the kubeconfig file is determined by the permissions assigned to you in Palette. For additional information, refer to the [Kubeconfig Access Permissions](#kubeconfigaccesspermissions) section. + Returns the kubeconfig file for the cluster. The kubeconfig file is returned as a text string. Access to the kubeconfig file is determined by the permissions assigned to you in Palette. For additional information, refer to the [Kubeconfig Access Permissions](#kubeconfig-access-permissions) section. * `GET https://api.spectrocloud.com/v1/spectroclusters/{clusterId}/assets/adminkubeconfig` diff --git a/docs/docs-content/clusters/cluster-management/kubernetes-dashboard.md b/docs/docs-content/clusters/cluster-management/kubernetes-dashboard.md index 643021ccb4..8179d3072a 100644 --- a/docs/docs-content/clusters/cluster-management/kubernetes-dashboard.md +++ b/docs/docs-content/clusters/cluster-management/kubernetes-dashboard.md @@ -10,4 +10,4 @@ tags: ["clusters", "cluster management", "k"] The [Kubernetes Dashboard](https://github.com/kubernetes/dashboard) is a general-purpose, web-based UI for Kubernetes clusters. You can use the dashboard to manage the cluster, deploy and manage applications, and troubleshoot issues. -Use the [Spectro Kubernetes Dashboard](/integrations/spectro-k8s-dashboard) pack to add the Kubernetes dashboard to your cluster. The pack documentation page has instructions on how to use the pack. +Use the [Spectro Kubernetes Dashboard](../../integrations/spectro-k8s-dashboard.md) pack to add the Kubernetes dashboard to your cluster. The pack documentation page has instructions on how to use the pack. diff --git a/docs/docs-content/clusters/cluster-management/monitoring/deploy-agent.md b/docs/docs-content/clusters/cluster-management/monitoring/deploy-agent.md index 4bd2daea82..1b597fe63d 100644 --- a/docs/docs-content/clusters/cluster-management/monitoring/deploy-agent.md +++ b/docs/docs-content/clusters/cluster-management/monitoring/deploy-agent.md @@ -26,10 +26,10 @@ Use the following steps to create an add-on profile and deploy a host cluster wi ### Prerequisites -- A monitoring stack. Check out the [Deploy Monitoring Stack](/clusters/cluster-management/monitoring/deploy-monitor-stack) guide to learn how to deploy a monitoring stack in your Palette environment. +- A monitoring stack. Check out the [Deploy Monitoring Stack](deploy-monitor-stack.md) guide to learn how to deploy a monitoring stack in your Palette environment. -- An infrastructure provider environment registered in Palette. Refer to the [Clusters](/clusters) documentation for guidance on how to register your infrastructure provider environment in Palette. +- An infrastructure provider environment registered in Palette. Refer to the [Clusters](../../clusters.md) documentation for guidance on how to register your infrastructure provider environment in Palette. +You can use authorization tokens to authenticate requests. + +To obtain an authorization token, use the `v1/auth/authenticate` endpoint with a POST request to authenticate and obtain the authorization token. Provide your API key as a header value or query parameter. The authorization token is valid for 15 minutes. You can refresh the token using the refresh token API. + +API requests using the authroization token must use the HTTP header `Authorization` with token as the value. For example: + +```bash +TOKEN=abcd1234 +``` + +```bash +curl --location --request GET 'https://api.spectrocloud.com/v1/projects/alert' \ +--header 'Authorization: $TOKEN' \ +--header 'Content-Type: application/json' +``` + +To refresh the authorization token, use the `v1/auth/refresh` endpoint with a GET request to refresh the authorization token. diff --git a/docs/docs-content/user-management/user-management.md b/docs/docs-content/user-management/user-management.md index c9c7d4ff17..61070ee354 100644 --- a/docs/docs-content/user-management/user-management.md +++ b/docs/docs-content/user-management/user-management.md @@ -31,14 +31,14 @@ For a Tenant admin, the password shall be set upon the initial login. The Tenant ## RBAC -Palette allows the users that have been added to be allowed or restricted access to resources based on the roles set by the tenant admin. This Role-Based Access Control is explained in detail in the RBAC}>Palette's RBAC design allows granting granular access to resources and its operations [page](/user-management/palette-rbac#rbac). +Palette allows the users that have been added to be allowed or restricted access to resources based on the roles set by the tenant admin. This Role-Based Access Control is explained in detail in the RBAC}>Palette's RBAC design allows granting granular access to resources and its operations [page](palette-rbac/palette-rbac.md#permissions). ## Roles and Permissions -The Tenant admin can allow or restrict access of resources to users which can differ as per the scenario. A user can have complete access to a specific project but can be restricted access to other projects in which there is no involvement. An intermediate stage is also possible where read-only access can be provided in some projects. The Roles}>A Role is a collection of permissions. and Permissions}>Permissions are associated with specific actions within the platform. sections in the [RBAC](/user-management/palette-rbac#rbac) page provide more details on this. +The Tenant admin can allow or restrict access of resources to users which can differ as per the scenario. A user can have complete access to a specific project but can be restricted access to other projects in which there is no involvement. An intermediate stage is also possible where read-only access can be provided in some projects. The Roles}>A Role is a collection of permissions. and Permissions}>Permissions are associated with specific actions within the platform. sections in the [RBAC](./palette-rbac/palette-rbac.md) page provide more details on this. To add a user to a project: - 1. Sign in as a Tenant admin and go to the **Users and Teams** section of the [Tenant Admin Dashboard](/getting-started#admindashboard). + 1. Sign in as a Tenant admin and navigate to the **Users and Teams** section of the Tenant settings Menu. 1. Click on the user that you want to enable access to. diff --git a/docs/docs-content/vertex/fips/fips-compliant-components.md b/docs/docs-content/vertex/fips/fips-compliant-components.md index beeb334ee4..89f7fda249 100644 --- a/docs/docs-content/vertex/fips/fips-compliant-components.md +++ b/docs/docs-content/vertex/fips/fips-compliant-components.md @@ -44,14 +44,14 @@ All services in the management plane are FIPS compiled with Go using [BoringCryp ## FIPS-Compliant Kubernetes -Our customized version of Kubernetes is FIPS-compliant. Both [Palette eXtended Kubernetes (PXK)](/integrations/kubernetes) and [Palette eXtended Kubernetes-Edge (PXK-E)](/integrations/kubernetes-edge) are compiled with FIPS-compliant compiler and libraries. +Our customized version of Kubernetes is FIPS-compliant. Both [Palette eXtended Kubernetes (PXK)](../../integrations/kubernetes.md) and [Palette eXtended Kubernetes-Edge (PXK-E)](../../integrations/kubernetes-edge.md) are compiled with FIPS-compliant compiler and libraries.
:::info -Refer to the [Palette eXtended Kubernetes (PXK)](/integrations/kubernetes) and [Palette eXtended Kubernetes-Edge (PXK-E)](/integrations/kubernetes-edge) documentation to learn more about the each Kubernetes distribution. +Refer to the [Palette eXtended Kubernetes (PXK)](../../integrations/kubernetes.md) and [Palette eXtended Kubernetes-Edge (PXK-E)](../../integrations/kubernetes-edge.md) documentation to learn more about the each Kubernetes distribution. ::: @@ -162,5 +162,3 @@ The Longhorn Manager component is partially FIPS-compliant. This component uses ::: -
- diff --git a/docs/docs-content/vertex/fips/fips-status-icons.md b/docs/docs-content/vertex/fips/fips-status-icons.md index 95858948cf..a3f55f01e7 100644 --- a/docs/docs-content/vertex/fips/fips-status-icons.md +++ b/docs/docs-content/vertex/fips/fips-status-icons.md @@ -11,7 +11,7 @@ tags: ["vertex", "fips"] While Palette VerteX brings FIPS 140-2 cryptographic modules to the Palette management platform and deployed clusters, it also provides the capability to consume features that are not FIPS compliant. For example, when the cluster import option is enabled, it allows users to import any type of Kubernetes cluster, including some that are not fully FIPS compliant. -Similarly, when the option to add non-FIPS add-on packs is enabled, users can add packs in cluster profiles that are not FIPS compliant. For more information about these tenant-level settings, refer to [Enable non-FIPS Settings](/vertex/system-management/enable-non-fips-settings). +Similarly, when the option to add non-FIPS add-on packs is enabled, users can add packs in cluster profiles that are not FIPS compliant. For more information about these tenant-level settings, refer to [Enable non-FIPS Settings](../system-management/enable-non-fips-settings/enable-non-fips-settings.md). To avoid confusion and compliance issues, Palette VerteX displays icons to indicate the FIPS compliance status of clusters, profiles, and packs. @@ -44,9 +44,4 @@ Icons appear next to each profile layer to indicate FIPS compliance. In this screenshot, Palette VerteX shows FIPS status for the cluster is partially compliant because one pack in the profile is not FIPS-compliant. -![Diagram showing FIPS status icons on Cluster Overview page.](/vertex_fips-status-icons_icons-in-cluster-overview.png) - - -
- -
\ No newline at end of file +![Diagram showing FIPS status icons on Cluster Overview page.](/vertex_fips-status-icons_icons-in-cluster-overview.png) \ No newline at end of file diff --git a/docs/docs-content/vertex/fips/fips.md b/docs/docs-content/vertex/fips/fips.md index c942bf267e..5d6c6e22e1 100644 --- a/docs/docs-content/vertex/fips/fips.md +++ b/docs/docs-content/vertex/fips/fips.md @@ -12,15 +12,13 @@ Palette VerteX is FIPS 140-2 compliant. This means that Palette VerteX uses FIPS ## Non-FIPS Enablement -You can deploy non-FIPS-compliant components in your Palette VerteX environment by enabling non-FIPS settings. Refer to the [Enable non-FIPS Settings](/vertex/system-management/enable-non-fips-settings) guide for more information. +You can deploy non-FIPS-compliant components in your Palette VerteX environment by enabling non-FIPS settings. Refer to the [Enable non-FIPS Settings](../system-management/enable-non-fips-settings/enable-non-fips-settings.md) guide for more information. - Something to note when using RKE2 and K3s:
- - When we scan the binaries, which we consume directly from Rancher's RKE2 repository, issues are reported for the following components. These components were compiled with a Go compiler that is not FIPS-compliant. @@ -34,15 +32,11 @@ Something to note when using RKE2 and K3s: RKE2 is designated as FIPS-compliant per official Rancher [FIPS 140-2 Enablement](https://docs.rke2.io/security/fips_support) security documentation. Therefore, Palette VerteX designates RKE2 as FIPS-compliant. - - - - - Although K3s is not available as a FIPS-certified distribution, Palette VerteX supports K3s as a Kubernetes distribution for Edge clusters. -Palette VerteX uses icons to show FIPS compliance status. For information about Palette VerteX status icons, review [FIPS Status Icons](/vertex/fips/fips-status-icons). +Palette VerteX uses icons to show FIPS compliance status. For information about Palette VerteX status icons, review [FIPS Status Icons](fips-status-icons.md). ## Legal Notice @@ -52,10 +46,10 @@ Spectro Cloud has performed a categorization under FIPS 199 with (client/tenant) ## Resources -- [FIPS Status Icons](/vertex/fips/fips-status-icons) +- [FIPS Status Icons](fips-status-icons.md) -- [FIPS-Compliant Components](/vertex/fips/fips-compliant-components) +- [FIPS-Compliant Components](fips-compliant-components.md) - [RKE2 FIPS 140-2 Enablement](https://docs.rke2.io/security/fips_support) \ No newline at end of file diff --git a/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/install-on-kubernetes.md b/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/install-on-kubernetes.md index bc48432b97..fedbb6de89 100644 --- a/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/install-on-kubernetes.md +++ b/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/install-on-kubernetes.md @@ -8,17 +8,17 @@ tags: ["vertex", "kubernetes"] --- -Palette VerteX can be installed on Kubernetes with internet connectivity or an airgap environment. When you install Palette VerteX, a three-node cluster is created. You use a Helm chart our support team provides to install Palette VerteX on Kubernetes. Refer to [Access Palette VerteX](/vertex#accesspalettevertex) for instructions on requesting access to the Helm Chart. +Palette VerteX can be installed on Kubernetes with internet connectivity or an airgap environment. When you install Palette VerteX, a three-node cluster is created. You use a Helm chart our support team provides to install Palette VerteX on Kubernetes. Refer to [Access Palette VerteX](../../vertex.md#access-palette-vertex) for instructions on requesting access to the Helm Chart. -To get started with Palette VerteX on Kubernetes, refer to the [Install Instructions](/vertex/install-palette-vertex/install-on-kubernetes/install) guide. +To get started with Palette VerteX on Kubernetes, refer to the [Install Instructions](install.md) guide. ## Resources -- [Install Instructions](/vertex/install-palette-vertex/install-on-kubernetes/install) +- [Install Instructions](install.md) -- [Helm Configuration Reference](/vertex/install-palette-vertex/install-on-kubernetes/vertex-helm-ref) +- [Helm Configuration Reference](vertex-helm-ref.md) diff --git a/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/install.md b/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/install.md index 703b3f536a..16a20bca20 100644 --- a/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/install.md +++ b/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/install.md @@ -12,7 +12,7 @@ tags: ["vertex", "kubernetes"] Use the Palette VerteX Helm Chart to install Palette VerteX in a multi-node Kubernetes cluster in your production environment. Palette VerteX is a FIPS-compliant product that must be installed in a FIPS-compliant environment. This means that Operating System (OS) the Kubernetes cluster you are installing Palette VerteX into must be FIPS-compliant. -Review our [architecture diagrams](/architecture/networking-ports) to ensure your Kubernetes cluster has the necessary network connectivity for Palette to operate successfully. +Review our [architecture diagrams](../../../architecture/networking-ports.md) to ensure your Kubernetes cluster has the necessary network connectivity for Palette to operate successfully. ## Prerequisites @@ -36,7 +36,7 @@ Review our [architecture diagrams](/architecture/networking-ports) to ensure you -- We recommend the following resources for Palette VerteX. Refer to the [Palette VerteX size guidelines](/vertex/install-palette-vertex#sizeguidelines) for additional sizing information. +- We recommend the following resources for Palette VerteX. Refer to the [Palette VerteX size guidelines](../install-palette-vertex.md#size-guidelines) for additional sizing information. - 8 CPUs per node. @@ -52,7 +52,7 @@ Review our [architecture diagrams](/architecture/networking-ports) to ensure you :::info - Refer to the Palette VerteX [size guidelines](/vertex/install-palette-vertex#sizeguidelines) resource for additional sizing information. + Refer to the Palette VerteX [size guidelines](../install-palette-vertex.md#size-guidelines) resource for additional sizing information. ::: @@ -79,7 +79,7 @@ Review our [architecture diagrams](/architecture/networking-ports) to ensure you - A custom domain and the ability to update Domain Name System (DNS) records. You will need this to enable HTTPS encryption for Palette VerteX. -- Access to the Palette Helm Charts. Refer to the [Access Palette VerteX](/vertex#accesspalettevertex) for instructions on how to request access to the Helm Chart. +- Access to the Palette Helm Charts. Refer to the [Access Palette VerteX](../../vertex.md#access-palette-vertex) for instructions on how to request access to the Helm Chart. @@ -166,7 +166,7 @@ The following instructions are written agnostic to the Kubernetes distribution y :::info - You can learn more about the parameters in the **values.yaml** file in the [Helm Configuration Reference](/vertex/install-palette-vertex/install-on-kubernetes/vertex-helm-ref) page. + You can learn more about the parameters in the **values.yaml** file in the [Helm Configuration Reference](vertex-helm-ref.md) page. ::: @@ -237,13 +237,13 @@ The following instructions are written agnostic to the Kubernetes distribution y
-10. After login, a summary page is displayed. Palette VerteX is installed with a self-signed SSL certificate. To assign a different SSL certificate you must upload the SSL certificate, SSL certificate key, and SSL certificate authority files to Palette VerteX. You can upload the files using the Palette VerteX system console. Refer to the [Configure HTTPS Encryption](/vertex/system-management/ssl-certificate-management) page for instructions on how to upload the SSL certificate files to Palette VerteX. +10. After login, a summary page is displayed. Palette VerteX is installed with a self-signed SSL certificate. To assign a different SSL certificate you must upload the SSL certificate, SSL certificate key, and SSL certificate authority files to Palette VerteX. You can upload the files using the Palette VerteX system console. Refer to the [Configure HTTPS Encryption](../../system-management/ssl-certificate-management.md) page for instructions on how to upload the SSL certificate files to Palette VerteX.
:::caution -If you are planning to deploy host clusters into different networks, you may require a reverse proxy. Check out the [Configure Reverse Proxy](/vertex/system-management/reverse-proxy) guide for instructions on configuring a reverse proxy for Palette VerteX. +If you are planning to deploy host clusters into different networks, you may require a reverse proxy. Check out the [Configure Reverse Proxy](../../system-management/reverse-proxy.md) guide for instructions on configuring a reverse proxy for Palette VerteX. ::: @@ -317,4 +317,4 @@ Use the following steps to validate the Palette VerteX installation. ## Next Steps -You have successfully installed Palette VerteX in a Kubernetes cluster. Your next steps are to configure Palette VerteX for your organization. Start by creating the first tenant to host your users. Use the [Create a Tenant](/vertex/system-management/tenant-management#createatenant) page for instructions on how to create a tenant. +You have successfully installed Palette VerteX in a Kubernetes cluster. Your next steps are to configure Palette VerteX for your organization. Start by creating the first tenant to host your users. Use the [Create a Tenant](../../system-management/tenant-management.md) page for instructions on how to create a tenant. diff --git a/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/vertex-helm-ref.md b/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/vertex-helm-ref.md index 0288896f00..b2480549a0 100644 --- a/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/vertex-helm-ref.md +++ b/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/vertex-helm-ref.md @@ -11,7 +11,7 @@ tags: ["vertex", "helm"] You can use the Palette VerteX Helm Chart to install Palette VerteX in a multi-node Kubernetes cluster in your production environment. The Helm chart allows you to customize values in the **values.yaml** file. This reference page lists and describes parameters available in the **values.yaml** file from the Helm Chart for your installation. -To learn how to install Palette VerteX using the Helm Chart, refer to the Kubernetes [Instructions](/vertex/install-palette-vertex/install-on-kubernetes/install). +To learn how to install Palette VerteX using the Helm Chart, refer to the Kubernetes [Instructions](install.md). ## Required Parameters @@ -20,14 +20,14 @@ The following parameters are required for a successful installation of Palette V | **Parameters** | **Description** | **Type** | | --- | --- | --- | -| `config.env.rootDomain` | Used to configure the domain for the Palette installation. We recommend you create a CNAME DNS record that supports multiple subdomains. You can achieve this using a wild card prefix, `*.vertex.abc.com`. Review the [Environment parameters](/vertex/install-palette-vertex/install-on-kubernetes/vertex-helm-ref#environment) to learn more. | String | +| `config.env.rootDomain` | Used to configure the domain for the Palette installation. We recommend you create a CNAME DNS record that supports multiple subdomains. You can achieve this using a wild card prefix, `*.vertex.abc.com`. Review the [Environment parameters](#environment) to learn more. | String | | `config.env.ociPackRegistry` or `config.env.ociPackEcrRegistry`| Specifies the FIPS image registry for Palette VerteX. You can use an a self-hosted OCI registry or a public OCI registry we maintain and support. For more information, refer to the [Registry](#registries) section. | Object | | `scar`| The Spectro Cloud Artifact Repository (SCAR) credentials for Palette VerteX FIPS images. Our support team provides these credentials. For more information, refer to the [Registry](#registries) section. | Object | :::caution -If you are installing an air-gapped version of Palette VerteX, you must provide the image swap configuration. For more information, refer to the [Image Swap Configuration](#imageswapconfiguration) section. +If you are installing an air-gapped version of Palette VerteX, you must provide the image swap configuration. For more information, refer to the [Image Swap Configuration](#image-swap-configuration) section. ::: @@ -88,7 +88,7 @@ config: ### SSO -You can configure Palette VerteX to use Single Sign-On (SSO) for user authentication. Configure the SSO parameters to enable SSO for Palette VerteX. You can also configure different SSO providers for each tenant post-install, check out the [SAML & SSO Setup](/user-management/saml-sso) documentation for additional guidance. +You can configure Palette VerteX to use Single Sign-On (SSO) for user authentication. Configure the SSO parameters to enable SSO for Palette VerteX. You can also configure different SSO providers for each tenant post-install, check out the [SAML & SSO Setup](../../../user-management/saml-sso/saml-sso.md) documentation for additional guidance. To configure SSO, you must provide the following parameters. @@ -115,7 +115,7 @@ config: ### Email -Palette VerteX uses email to send notifications to users. The email notification is used when inviting new users to the platform, password resets, and when [webhook alerts](/clusters/cluster-management/health-alerts#overview) are triggered. Use the following parameters to configure email settings for Palette VerteX. +Palette VerteX uses email to send notifications to users. The email notification is used when inviting new users to the platform, password resets, and when [webhook alerts](../../../clusters/cluster-management/health-alerts.md) are triggered. Use the following parameters to configure email settings for Palette VerteX. | **Parameters** | **Description** | **Type** | **Default value** | | --- | --- | --- | --- | @@ -186,7 +186,7 @@ Palette VerteX requires credentials to access the required Palette VerteX images ### OCI Registry -Palette VerteX requires access to an OCI registry that contains all the required FIPS packs. You can host your own OCI registry and configure Palette VerteX to reference the registry. Alternatively, you can use the public OCI registry provided by us, refer to the [`ociPackRegistry`](#ociecrregistry) section to learn more about the publicly available OCI registry. +Palette VerteX requires access to an OCI registry that contains all the required FIPS packs. You can host your own OCI registry and configure Palette VerteX to reference the registry. Alternatively, you can use the public OCI registry provided by us, refer to the [`ociPackEcrRegistry`](#oci-ecr-registry) section to learn more about the publicly available OCI registry.
@@ -355,7 +355,7 @@ ingress: ## Spectro Proxy -You can specify a reverse proxy server that clusters deployed through Palette VerteX can use to facilitate network connectivity to the cluster's Kubernetes API server. Host clusters deployed in private networks can use the [Spectro Proxy pack](/integrations/frp) to expose the cluster's Kubernetes API to downstream clients that are not in the same network. Check out the [Reverse Proxy](/vertex/system-management/reverse-proxy) documentation to learn more about setting up a reverse proxy server for Palette VerteX. +You can specify a reverse proxy server that clusters deployed through Palette VerteX can use to facilitate network connectivity to the cluster's Kubernetes API server. Host clusters deployed in private networks can use the [Spectro Proxy pack](../../../integrations/frp.md) to expose the cluster's Kubernetes API to downstream clients that are not in the same network. Check out the [Reverse Proxy](../../system-management/reverse-proxy.md) documentation to learn more about setting up a reverse proxy server for Palette VerteX. | **Parameters** | **Description** | **Type** | **Default value** | diff --git a/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/install-on-vmware.md b/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/install-on-vmware.md index 9e00bb997d..29f56e1b42 100644 --- a/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/install-on-vmware.md +++ b/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/install-on-vmware.md @@ -10,19 +10,15 @@ tags: ["vertex", "vmware"] -Palette VerteX can be installed on VMware vSphere with internet connectivity or an airgap environment. When you install Palette VerteX, a three-node cluster is created. You use the interactive Palette CLI to install Palette VerteX on VMware vSphere. Refer to [Access Palette VerteX](/vertex#accesspalettevertex) for instructions on requesting repository access. +Palette VerteX can be installed on VMware vSphere with internet connectivity or an airgap environment. When you install Palette VerteX, a three-node cluster is created. You use the interactive Palette CLI to install Palette VerteX on VMware vSphere. Refer to [Access Palette VerteX](../../vertex.md#access-palette-vertex) for instructions on requesting repository access. ## Resources -- [Install on VMware](/vertex/install-palette-vertex/install-on-vmware/install) +- [Install on VMware](install.md) -- [VMware System Requirements](/vertex/install-palette-vertex/install-on-vmware/vmware-system-requirements) - -
- -
+- [VMware System Requirements](vmware-system-requirements.md) \ No newline at end of file diff --git a/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/install.md b/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/install.md index ee7cfe6f88..4460a78a0f 100644 --- a/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/install.md +++ b/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/install.md @@ -28,17 +28,17 @@ You install Palette VerteX using the Palette Command Line Interface (CLI) that g -- Palette CLI installed and available. Refer to the Palette CLI [Install](/palette-cli/install-palette-cli#downloadandsetup) page for guidance. +- Palette CLI installed and available. Refer to the Palette CLI [Install](../../../palette-cli/install-palette-cli.md#download-and-setup) page for guidance. - An Ubuntu Pro Subscription and token. Ubuntu Pro provides access to FIPS 140-2 certified cryptographic packages. -- Review required VMware vSphere environment [permissions](/vertex/install-palette-vertex/install-on-vmware/vmware-system-requirements). +- Review required VMware vSphere environment [permissions](vmware-system-requirements.md). -- We recommended the following resources for Palette VerteX. Refer to the [Palette VerteX size guidelines](/vertex/install-palette-vertex#sizeguidelines) for additional sizing information. +- We recommended the following resources for Palette VerteX. Refer to the [Palette VerteX size guidelines](../install-palette-vertex.md#instance-sizing) for additional sizing information. - 8 CPUs per VM. @@ -63,7 +63,7 @@ You install Palette VerteX using the Palette Command Line Interface (CLI) that g - x509 SSL certificate authority file in base64 format. This file is optional. -- Zone tagging is required for dynamic storage allocation across fault domains when provisioning workloads that require persistent storage. Refer to [Zone Tagging](/vertex/install-palette-vertex/install-on-vmware/vmware-system-requirements#zonetagging) for information. +- Zone tagging is required for dynamic storage allocation across fault domains when provisioning workloads that require persistent storage. Refer to [Zone Tagging](vmware-system-requirements.md#zone-tagging) for information. - Assigned IP addresses for application workload services, such as Load Balancer services. @@ -77,7 +77,7 @@ You install Palette VerteX using the Palette Command Line Interface (CLI) that g :::info -Self-hosted Palette VerteX installations provide a system Private Cloud Gateway (PCG) out-of-the-box and typically do not require a separate, user-installed PCG. However, you can create additional PCGs as needed to support provisioning into remote data centers that do not have a direct incoming connection from the Palette console. To learn how to install a PCG on VMware, check out the [VMware](/clusters/data-center/vmware) guide. +Self-hosted Palette VerteX installations provide a system Private Cloud Gateway (PCG) out-of-the-box and typically do not require a separate, user-installed PCG. However, you can create additional PCGs as needed to support provisioning into remote data centers that do not have a direct incoming connection from the Palette console. To learn how to install a PCG on VMware, check out the [VMware](../../../clusters/data-center/vmware.md) guide. ::: @@ -96,7 +96,7 @@ Use the following steps to install Palette VerteX.
-1. Open a terminal window and invoke the Palette CLI by using the `ec` command to install the enterprise cluster. The interactive CLI prompts you for configuration details and then initiates the installation. For more information about the `ec` subcommand, refer to [Palette Commands](/palette-cli/commands#ec). +1. Open a terminal window and invoke the Palette CLI by using the `ec` command to install the enterprise cluster. The interactive CLI prompts you for configuration details and then initiates the installation. For more information about the `ec` subcommand, refer to [Palette Commands](../../../palette-cli/commands.md#ec).
@@ -172,7 +172,7 @@ Use the following steps to install Palette VerteX.
-10. Next, specify the database storage size to allocate for Palette VerteX. The default is 20 GB. Refer to the [size guidelines](/vertex/install-palette-vertex#sizeguidelines) for additional information. +10. Next, specify the database storage size to allocate for Palette VerteX. The default is 20 GB. Refer to the [size guidelines](../install-palette-vertex.md#instance-sizing) for additional information. @@ -296,7 +296,7 @@ Use the following steps to install Palette VerteX. 16. After login, a Summary page is displayed. Palette VerteX is installed with a self-signed SSL certificate. To assign a different SSL certificate you must upload the SSL certificate, SSL certificate key, and SSL certificate authority files to Palette VerteX. You can upload the files using the Palette VerteX system console. Refer to the [Configure HTTPS Encryption](/vertex/system-management/ssl-certificate-management) page for instructions on how to upload the SSL certificate files to Palette VerteX. -17. The last step is to start setting up a tenant. To learn how to create a tenant, check out the [Tenant Management](/vertex/system-management/tenant-management) guide. +17. The last step is to start setting up a tenant. To learn how to create a tenant, check out the [Tenant Management](../../system-management/tenant-management.md) guide.
@@ -331,13 +331,11 @@ You can also validate that a three-node Kubernetes cluster is launched and Palet ## Next Steps -You have successfully installed Palette VerteX in vSphere. Your next steps are to configure Palette VerteX for your organization. Start by creating the first tenant to host your users. Refer to [Create a Tenant](/vertex/system-management/tenant-management) for instructions. +You have successfully installed Palette VerteX in vSphere. Your next steps are to configure Palette VerteX for your organization. Start by creating the first tenant to host your users. Refer to [Create a Tenant](../../system-management/tenant-management.md) for instructions. After you create the tenant, you are ready to configure authentication types in tenant settings and create users and teams. ## Resources -- [Create a Tenant](/vertex/system-management/tenant-management) - -
+- [Create a Tenant](../../system-management/tenant-management.md) \ No newline at end of file diff --git a/docs/docs-content/vertex/install-palette-vertex/install-palette-vertex.md b/docs/docs-content/vertex/install-palette-vertex/install-palette-vertex.md index c3e97331dd..117178bb0e 100644 --- a/docs/docs-content/vertex/install-palette-vertex/install-palette-vertex.md +++ b/docs/docs-content/vertex/install-palette-vertex/install-palette-vertex.md @@ -79,15 +79,7 @@ The recommended maximum number of deployed nodes and clusters in the environment ## Resources -- [Install on VMware vSphere](/vertex/install-palette-vertex/install-on-vmware) +- [Install on VMware vSphere](install-on-vmware/install-on-vmware.md) -- [Install Using Helm Chart](/vertex/install-palette-vertex/install-on-kubernetes/install) - - - - - -
- -
\ No newline at end of file +- [Install Using Helm Chart](install-on-kubernetes/install-on-kubernetes.md) \ No newline at end of file diff --git a/docs/docs-content/vertex/system-management/enable-non-fips-settings/allow-cluster-import.md b/docs/docs-content/vertex/system-management/enable-non-fips-settings/allow-cluster-import.md index ae7b12093b..1168916f40 100644 --- a/docs/docs-content/vertex/system-management/enable-non-fips-settings/allow-cluster-import.md +++ b/docs/docs-content/vertex/system-management/enable-non-fips-settings/allow-cluster-import.md @@ -13,7 +13,7 @@ tags: ["vertex", "non-fips"] You can allow tenant users to import Kubernetes clusters that were not deployed through Palette, including some that *are not* FIPS compliant or are only *partially* compliant. Prior to enabling cluster import, the **Import Cluster** option is not available. -Palette VerteX displays icons next to clusters to indicate their FIPS compliance status or when FIPS compliance cannot be confirmed. To learn about icons that Palette VerteX applies, refer to [FIPS Status Icons](/vertex/fips/fips-status-icons). +Palette VerteX displays icons next to clusters to indicate their FIPS compliance status or when FIPS compliance cannot be confirmed. To learn about icons that Palette VerteX applies, refer to [FIPS Status Icons](../../fips/fips-status-icons.md). @@ -22,7 +22,7 @@ Palette VerteX displays icons next to clusters to indicate their FIPS compliance - You need tenant admin permission to enable this feature. -- Refer to [Cluster Import Prerequisites](/clusters/imported-clusters/cluster-import#prerequisites). +- Refer to [Cluster Import Prerequisites](../../../clusters/imported-clusters/cluster-import.md#prerequisites). ## Allow non-FIPS Cluster Import @@ -40,7 +40,7 @@ Palette VerteX displays icons next to clusters to indicate their FIPS compliance To disable the setting, toggle this option off and confirm you want to disable it. -Refer to [Import a Cluster](/clusters/imported-clusters/cluster-import) for guidance. Check out [Import Modes](/clusters/imported-clusters#importmodes) to learn about various import modes and limitations to be aware of. +Refer to [Import a Cluster](../../../clusters/imported-clusters/cluster-import.md) for guidance. Check out [Import Modes](../../../clusters/imported-clusters/imported-clusters.md#import-modes) to learn about various import modes and limitations to be aware of. ## Validate @@ -56,10 +56,10 @@ Refer to [Import a Cluster](/clusters/imported-clusters/cluster-import) for guid ## Resources -- [Import a Cluster](/clusters/imported-clusters/cluster-import) +- [Import a Cluster](../../../clusters/imported-clusters/cluster-import.md) -- [Import Modes](/clusters/imported-clusters#importmodes) +- [Import Modes](../../../clusters/imported-clusters/imported-clusters.md#import-modes) -- [Cluster Import Limitations](/clusters/imported-clusters#limitations) \ No newline at end of file +- [Cluster Import Limitations](../../../clusters/imported-clusters/imported-clusters.md#limitations) \ No newline at end of file diff --git a/docs/docs-content/vertex/system-management/enable-non-fips-settings/enable-non-fips-settings.md b/docs/docs-content/vertex/system-management/enable-non-fips-settings/enable-non-fips-settings.md index 5726fec797..f3bc781139 100644 --- a/docs/docs-content/vertex/system-management/enable-non-fips-settings/enable-non-fips-settings.md +++ b/docs/docs-content/vertex/system-management/enable-non-fips-settings/enable-non-fips-settings.md @@ -10,23 +10,22 @@ tags: ["vertex", "non-fips"] -Palette VerteX is FIPS-enforced by default, incorporating the Spectro Cloud Cryptographic Module into the Kubernetes Management Platform and the infrastructure components of target clusters. To learn more about our cryptographic library, check out [FIPS 140-2 Certification](/compliance#fips140-2). +Palette VerteX is FIPS-enforced by default, incorporating the Spectro Cloud Cryptographic Module into the Kubernetes Management Platform and the infrastructure components of target clusters. To learn more about our cryptographic library, check out [FIPS 140-2 Certification](../../../compliance.md#fips-140-2). If desired, you can allow the consumption of certain non-FIPS functionality in Palette VerteX at the tenant level. **Platform Settings** at the tenant level provide toggles to allow non-FIPS-compliant add-on packs and non-FIPS features such as scans, backup, and restore. You can also allow importing clusters created external to Palette. ## Resources -- [Use non-FIPS Add-On Packs](/vertex/system-management/enable-non-fips-settings/use-non-fips-addon-packs) +- [Use non-FIPS Add-On Packs](../../system-management/enable-non-fips-settings/use-non-fips-addon-packs.md) -- [Use non-FIPS Features](/vertex/system-management/enable-non-fips-settings/use-non-fips-features) +- [Use non-FIPS Features](../../system-management/enable-non-fips-settings/use-non-fips-features.md) -- [Allow Cluster Import](/vertex/system-management/enable-non-fips-settings/allow-cluster-import) +- [Allow Cluster Import](../../system-management/enable-non-fips-settings/allow-cluster-import.md) -- [Spectro Cloud FIPS 140-2 Certification](/compliance#fips140-2) +- [Spectro Cloud FIPS 140-2 Certification](../../../compliance.md#fips-140-2) -
diff --git a/docs/docs-content/vertex/system-management/enable-non-fips-settings/use-non-fips-addon-packs.md b/docs/docs-content/vertex/system-management/enable-non-fips-settings/use-non-fips-addon-packs.md index 9a10366629..5878f1ff58 100644 --- a/docs/docs-content/vertex/system-management/enable-non-fips-settings/use-non-fips-addon-packs.md +++ b/docs/docs-content/vertex/system-management/enable-non-fips-settings/use-non-fips-addon-packs.md @@ -11,7 +11,7 @@ tags: ["vertex", "non-fips"] -Palette VerteX provides the following FIPS-compliant infrastructure components in Kubernetes clusters it deploys. Review [FIPS-Compliant Components](/vertex/fips/fips-compliant-components) to learn more. +Palette VerteX provides the following FIPS-compliant infrastructure components in Kubernetes clusters it deploys. Review [FIPS-Compliant Components](../../fips/fips-compliant-components.md) to learn more.
@@ -24,7 +24,7 @@ Palette VerteX provides the following FIPS-compliant infrastructure components i - Container Storage Interface (CSI) -As shown in the screenshot below, the FIPS-compliant icon used to indicate full FIPS compliance is displayed next to Palette VerteX infrastructure components in the cluster profile stack. To learn about other icons Palette VerteX applies, refer to [FIPS Status Icons](/vertex/fips/fips-status-icons). +As shown in the screenshot below, the FIPS-compliant icon used to indicate full FIPS compliance is displayed next to Palette VerteX infrastructure components in the cluster profile stack. To learn about other icons Palette VerteX applies, refer to [FIPS Status Icons](../../fips/fips-status-icons.md). ![Diagram showing FIPS-compliant icons in profile stack.](/vertex_fips-status-icons_icons-in-profile-stack.png) @@ -80,13 +80,13 @@ Palette VerteX will display the appropriate FIPS status icon next to the pack la ## Resources -- [Packs List](/integrations) +- [Packs List](../../../integrations/integrations.mdx) -- [Create an Add-on Profile](/cluster-profiles/create-add-on-profile) +- [Create an Add-on Profile](../../../cluster-profiles/create-add-on-profile.md) -- [FIPS Status Icons](/vertex/fips/fips-status-icons) +- [FIPS Status Icons](../../fips/fips-status-icons.md) diff --git a/docs/docs-content/vertex/system-management/enable-non-fips-settings/use-non-fips-features.md b/docs/docs-content/vertex/system-management/enable-non-fips-settings/use-non-fips-features.md index 0ec257e23d..e2db8ea908 100644 --- a/docs/docs-content/vertex/system-management/enable-non-fips-settings/use-non-fips-features.md +++ b/docs/docs-content/vertex/system-management/enable-non-fips-settings/use-non-fips-features.md @@ -17,7 +17,7 @@ You can allow tenant users access to Palette features that are *not* FIPS-compli - You need tenant admin permission to enable this feature. -- Palette can back up clusters to several locations. To learn about backup requirements, review [Backup-Restore](/clusters/cluster-management/backup-restore). +- Palette can back up clusters to several locations. To learn about backup requirements, review [Backup-Restore](../../../clusters/cluster-management/backup-restore/backup-restore.md). - There are no prerequisites for restoring clusters or performing scans. @@ -48,7 +48,7 @@ To disable the setting, toggle this option off and confirm you want to disable i 1. Log in to [Palette VerteX](https://console.spectrocloud.com/). -2. Navigate to the left **Main Me[Title](http://localhost:9000/vertex/system-management/enable-non-fips-settings/use-non-fips-features)nu** and click on **Clusters**. +2. Navigate to the left **Main Menu** and click on **Clusters**. 3. Select your cluster in the list. The **Scan** and **Backups** tabs are now displayed on the **Cluster Overview** page. @@ -56,8 +56,8 @@ To disable the setting, toggle this option off and confirm you want to disable i ## Resources -- [Cluster Backup and Restore](/clusters/cluster-management/backup-restore) +- [Cluster Backup and Restore](../../../clusters/cluster-management/backup-restore/backup-restore.md) -- [Scans](/clusters/cluster-management/compliance-scan) +- [Scans](../../../clusters/cluster-management/compliance-scan.md) diff --git a/docs/docs-content/vertex/system-management/reverse-proxy.md b/docs/docs-content/vertex/system-management/reverse-proxy.md index 1e4ffa3fa0..df8b318097 100644 --- a/docs/docs-content/vertex/system-management/reverse-proxy.md +++ b/docs/docs-content/vertex/system-management/reverse-proxy.md @@ -12,7 +12,7 @@ tags: ["vertex", "management"] You can configure a reverse proxy for Palette VerteX. The reverse proxy can be used by host clusters deployed in a private network. Host clusters deployed in a private network are not accessible from the public internet or by users in different networks. You can use a reverse proxy to access the cluster's Kubernetes API server from a different network. -When you configure reverse proxy server for Palette VerteX, clusters that use the [Spectro Proxy pack](/integrations/frp) will use the reverse proxy server address in the kubeconfig file. Clusters not using the Spectro Proxy pack will use the default cluster address in the kubeconfig file. +When you configure reverse proxy server for Palette VerteX, clusters that use the [Spectro Proxy pack](../../integrations/frp.md) will use the reverse proxy server address in the kubeconfig file. Clusters not using the Spectro Proxy pack will use the default cluster address in the kubeconfig file. Use the following steps to configure a reverse proxy server for Palette VerteX. @@ -48,7 +48,7 @@ Use the following steps to configure a reverse proxy server for Palette VerteX. 1. Open a terminal session and navigate to the directory where you stored the **values.yaml** for the Palette VerteX installation. -2. Use a text editor and open the **values.yaml** file. Locate the `frps` section and update the following values in the **values.yaml** file. Refer to the [Spectro Proxy Helm Configuration](/enterprise-version/helm-chart-install-reference/#spectroproxy) to learn more about the configuration options. +2. Use a text editor and open the **values.yaml** file. Locate the `frps` section and update the following values in the **values.yaml** file. Refer to the [Spectro Proxy Helm Configuration](../install-palette-vertex/install-on-kubernetes/vertex-helm-ref.md#spectro-proxy) to learn more about the configuration options.
@@ -188,7 +188,7 @@ Use the following steps to configure a reverse proxy server for Palette VerteX. 204 ``` -You now have a Spectro Proxy server that you can use to access Palette VerteX clusters deployed in a different network. Make sure you add the [Spectro Proxy pack](/integrations/frp) to the clusters you want to access using the Spectro Proxy server. +You now have a Spectro Proxy server that you can use to access Palette VerteX clusters deployed in a different network. Make sure you add the [Spectro Proxy pack](../../integrations/frp.md) to the clusters you want to access using the Spectro Proxy server. ## Validate diff --git a/docs/docs-content/vertex/system-management/system-management.md b/docs/docs-content/vertex/system-management/system-management.md index 95c2698202..dc24511fbc 100644 --- a/docs/docs-content/vertex/system-management/system-management.md +++ b/docs/docs-content/vertex/system-management/system-management.md @@ -8,7 +8,7 @@ sidebar_position: 20 tags: ["vertex", "management"] --- -Palette VerteX contains many system settings you can configure to meet your organization's needs. These settings are available at the system level and are applied to all [tenants](/glossary-all#tenant) in the system. +Palette VerteX contains many system settings you can configure to meet your organization's needs. These settings are available at the system level and are applied to all [tenants](../../glossary-all.md#tenant) in the system. You can access the system setting by visiting the IP address or the custom domain name assigned to your Palette VerteX cluster and appending the `/system` path to the URL. For example, if your Palette VerteX cluster is hosted at `https://vertex.abc.com`, you can access the system settings at `https://vertex.abc.com/system`. @@ -28,14 +28,10 @@ Exercise caution when changing system settings as the changes will be applied to ## Resources -* [Enable non-FIPS Settings](/vertex/system-management/enable-non-fips-settings) +* [Enable non-FIPS Settings](enable-non-fips-settings/enable-non-fips-settings.md) -* [Tenant Management](/vertex/system-management/tenant-management) +* [Tenant Management](../system-management/tenant-management.md) -* [SSL Certificate Management](/vertex/system-management/ssl-certificate-management) - -
- -
\ No newline at end of file +* [SSL Certificate Management](../system-management/ssl-certificate-management.md) diff --git a/docs/docs-content/vertex/vertex.md b/docs/docs-content/vertex/vertex.md index 19a3c79bb2..b8a4f40028 100644 --- a/docs/docs-content/vertex/vertex.md +++ b/docs/docs-content/vertex/vertex.md @@ -16,7 +16,7 @@ Palette VerteX offers regulated industries, such as government and public sector Palette VerteX integrates validated Federal Information Processing Standards (FIPS) 140-2 cryptographic modules in Kubernetes clusters it deploys to ensure robust data protection for your organization’s infrastructure and applications. To learn more about our FIPS 140-2 certification, review [Spectro Cloud Cryptographic Module](https://csrc.nist.gov/projects/cryptographic-module-validation-program/certificate/4349). FIPS modules, which are accessible in our private artifact repository, extend Palette’s existing security features that include security scans, powerful RBAC, and tamper-proof edge device images. Palette VerteX protects sensitive data in clusters across edge, bare metal, on-prem data centers, air-gapped environments, and cloud. -To learn more about FIPS in Palette VerteX, check out the [FIPS](/vertex/fips) section. +To learn more about FIPS in Palette VerteX, check out the [FIPS](fips/fips.md) section. ## Access Palette VerteX @@ -34,19 +34,13 @@ Our dedicated support team will promptly get in touch with you to provide the ne ## Resources -- [FIPS](/vertex/fips) +- [FIPS](fips/fips.md) -- [Installation](/vertex/install-palette-vertex) +- [Installation](install-palette-vertex/install-palette-vertex.md) -- [System Management](/vertex/system-management) +- [System Management](system-management/system-management.md) - -
- -
- - diff --git a/docs/docs-content/vm-management/create-manage-vm/create-manage-vm.md b/docs/docs-content/vm-management/create-manage-vm/create-manage-vm.md index 042a7818eb..5607fd57f8 100644 --- a/docs/docs-content/vm-management/create-manage-vm/create-manage-vm.md +++ b/docs/docs-content/vm-management/create-manage-vm/create-manage-vm.md @@ -15,10 +15,10 @@ Palette Virtual Machine Orchestrator (VMO) allows you to deploy and manage Virtu - Outbound internet connectivity for port 443 is allowed so that you and your applications can connect with the Spectro Cloud reverse proxy. -- Users or groups must be mapped to a Virtual Machine RBAC role. You can create a custom role through a manifest and use Palette's RoleBinding feature to associate users and groups with the role. Refer to the [Create Role Bindings](/clusters/cluster-management/cluster-rbac#createrolebindings) guide to learn more. +- Users or groups must be mapped to a Virtual Machine RBAC role. You can create a custom role through a manifest and use Palette's RoleBinding feature to associate users and groups with the role. Refer to the [Create Role Bindings](../../clusters/cluster-management/cluster-rbac.md#create-role-bindings) guide to learn more. -- A namespace for VMs. Although you can deploy VMs from the default namespace, we recommend creating at least one namespace dedicated to VMs as a way to organize and manage them. To learn how to create a namespace, check out [Create a Namespace](/clusters/cluster-management/namespace-management#createanamespace). +- A namespace for VMs. Although you can deploy VMs from the default namespace, we recommend creating at least one namespace dedicated to VMs as a way to organize and manage them. To learn how to create a namespace, check out [Create a Namespace](../../clusters/cluster-management/namespace-management.md#create-a-namespace). ## VM Creation @@ -27,7 +27,7 @@ You can create a VM three ways:
-- Deploy a VM from a template. Palette provides out-of-the-box templates, or your organization may provide templates. For the latter, refer to the [Create a VM Template](/vm-management/create-manage-vm/create-vm-template) guide. +- Deploy a VM from a template. Palette provides out-of-the-box templates, or your organization may provide templates. For the latter, refer to the [Create a VM Template](create-vm-template.md) guide. - Create an empty VM and install the Operating System (OS) using a standard method, such as a Preboot Execution Environment (PXE) or optical disk image (ISO). @@ -51,15 +51,10 @@ We recommend installing the QEMU guest agent to display additional details in Pa ## Resources -- [Standard VM Operations](/vm-management/create-manage-vm/standard-vm-operations) +- [Standard VM Operations](standard-vm-operations/standard-vm-operations.md) -- [Deploy VM from a Template](/vm-management/create-manage-vm/standard-vm-operations/deploy-vm-from-template) +- [Deploy VM from a Template](standard-vm-operations/deploy-vm-from-template.md) -- [Create a VM Template](/vm-management/create-manage-vm/create-vm-template) - - -
- -
+- [Create a VM Template](create-vm-template.md) diff --git a/docs/docs-content/vm-management/create-manage-vm/standard-vm-operations/deploy-vm-from-template.md b/docs/docs-content/vm-management/create-manage-vm/standard-vm-operations/deploy-vm-from-template.md index f97f927abc..e56cac2e6f 100644 --- a/docs/docs-content/vm-management/create-manage-vm/standard-vm-operations/deploy-vm-from-template.md +++ b/docs/docs-content/vm-management/create-manage-vm/standard-vm-operations/deploy-vm-from-template.md @@ -13,7 +13,7 @@ You can deploy a Virtual Machine (VM) using Palette's out-of-the-box templates o ## Prerequisites -- Configured Virtual Machine Orchestrator profile applied to your cluster. Review [Create a VMO Profile](/vm-management/vm-packs-profiles/create-vmo-profile) to configure the dashboard. +- Configured Virtual Machine Orchestrator profile applied to your cluster. Review [Create a VMO Profile](../../vm-packs-profiles/create-vmo-profile.md) to configure the dashboard. ## Deploy VM from a Template @@ -98,8 +98,4 @@ VMs do not self-heal. If a VM is running on a node that fails, the VM is re-sche Try installing your applications. If you did not install the QEMU guest agent as part of the VM deployment, you can install it now. The guest agent displays additional details in the **Virtual Machines** > **Details** tab. -You can update the VM configuration from the VM console or from tabs when you click on the VM. Learn about updates you can make in the [Update VM Configuration](/vm-management/create-manage-vm/standard-vm-operations/update-vm-configuration) guide. - -
- -
\ No newline at end of file +You can update the VM configuration from the VM console or from tabs when you click on the VM. Learn about updates you can make in the [Update VM Configuration](update-vm-configuration.md) guide. \ No newline at end of file diff --git a/docs/docs-content/vm-management/create-manage-vm/standard-vm-operations/migrate-vm-to-different-node.md b/docs/docs-content/vm-management/create-manage-vm/standard-vm-operations/migrate-vm-to-different-node.md index 61e31db1f7..1cfcb32b0f 100644 --- a/docs/docs-content/vm-management/create-manage-vm/standard-vm-operations/migrate-vm-to-different-node.md +++ b/docs/docs-content/vm-management/create-manage-vm/standard-vm-operations/migrate-vm-to-different-node.md @@ -12,7 +12,7 @@ tags: ["vmo"] Palette supports virtual machine (VM) migration to another physical host in the cluster. This is known as *live migration*. During live migration, the VM and its memory, storage, and CPU resources are moved from one cluster compute node to another without any noticeable downtime. -Successful live migrations rely on appropriately configured storage and networking, and live migration must be enabled as a feature gate. Live migration is enabled by default in the ``feature-gates`` section of the KubeVirt configuration file that is part of the **Virtual Machine Orchestrator** pack. Refer to [Feature Gates](/vm-management#featuregates) for more information. +Successful live migrations rely on appropriately configured storage and networking, and live migration must be enabled as a feature gate. Live migration is enabled by default in the ``feature-gates`` section of the KubeVirt configuration file that is part of the **Virtual Machine Orchestrator** pack. Refer to [Feature Gates](../../vm-management.md#feature-gates) for more information. Live migration is used with rolling Kubernetes upgrades and workload balancing. To avoid interrupting a VM when a node is placed into maintenance or upgraded, all VM instances require a ``LiveMigrate`` eviction strategy. @@ -113,7 +113,7 @@ You can validate evacuation completed by following the steps below.
-1. Obtain the kubeconfig file from Palette, and set the KUBECONFIG environment variable to access it so you can issue kubectl commands to the cluster. To learn how, refer to [Set up Kubectl](https://docs.spectrocloud.com/clusters/cluster-management/palette-webctl/#setupkubectl). +1. Obtain the kubeconfig file from Palette, and set the KUBECONFIG environment variable to access it so you can issue kubectl commands to the cluster. To learn how, refer to [Set up Kubectl](../../../clusters/cluster-management/palette-webctl.md#set-up-kubectl). 2. Issue the following command to mark the node as *un-schedulable*. This alerts the Kubernetes scheduler not to schedule any new pods on that node but allows existing pods on the node to continue to operate. @@ -168,8 +168,3 @@ You can validate evacuation completed by following the steps below. - [Safely Drain a Node](https://kubernetes.io/docs/tasks/administer-cluster/safely-drain-node/#use-kubectl-drain-to-remove-a-node-from-service) - - -
- -
diff --git a/docs/docs-content/vm-management/create-manage-vm/standard-vm-operations/standard-vm-operations.md b/docs/docs-content/vm-management/create-manage-vm/standard-vm-operations/standard-vm-operations.md index 60c80ade45..c608e6cdc2 100644 --- a/docs/docs-content/vm-management/create-manage-vm/standard-vm-operations/standard-vm-operations.md +++ b/docs/docs-content/vm-management/create-manage-vm/standard-vm-operations/standard-vm-operations.md @@ -59,23 +59,16 @@ When you select a VM from the **Clusters** > **Virtual Machines** tab, the follo ## Resources -- [Deploy VM From a Template](/vm-management/create-manage-vm/standard-vm-operations/deploy-vm-from-template) +- [Deploy VM From a Template](deploy-vm-from-template.md) -- [Update VM Configuration](/vm-management/create-manage-vm/standard-vm-operations/update-vm-configuration) +- [Update VM Configuration](update-vm-configuration.md) -- [Migrate VM to a Different Node](/vm-management/create-manage-vm/standard-vm-operations/migrate-vm-to-different-node) +- [Migrate VM to a Different Node](migrate-vm-to-different-node.md) -- [Take a VM Snapshot](/vm-management/create-manage-vm/standard-vm-operations/take-snapshot-of-vm) +- [Take a VM Snapshot](take-snapshot-of-vm.md) -- [Clone a VM](/vm-management/create-manage-vm/standard-vm-operations/clone-vm) - - - - -
- -
\ No newline at end of file +- [Clone a VM](clone-vm.md) \ No newline at end of file diff --git a/docs/docs-content/vm-management/create-manage-vm/standard-vm-operations/update-vm-configuration.md b/docs/docs-content/vm-management/create-manage-vm/standard-vm-operations/update-vm-configuration.md index 6328dd9b38..6ca957136b 100644 --- a/docs/docs-content/vm-management/create-manage-vm/standard-vm-operations/update-vm-configuration.md +++ b/docs/docs-content/vm-management/create-manage-vm/standard-vm-operations/update-vm-configuration.md @@ -102,4 +102,4 @@ The **Network Interfaces** tab lists the newly added interface. # Resources -- [Multus CNI](/integrations/multus-cni) +- [Multus CNI](../../../integrations/multus-cni.md) diff --git a/docs/docs-content/vm-management/vm-management.md b/docs/docs-content/vm-management/vm-management.md index 20b0d03acc..947ece390a 100644 --- a/docs/docs-content/vm-management/vm-management.md +++ b/docs/docs-content/vm-management/vm-management.md @@ -35,7 +35,7 @@ Palette Virtual Machine Orchestrator requires the following: - Palette version 3.3.0 or higher. -- For data centers, production VMs are supported on bare metal Kubernetes clusters deployed on Canonical MAAS. To learn how to configure MAAS and create MAAS clusters in Palette, refer to the [Install and Manage MAAS Gateway](/clusters/data-center/maas/install-manage-maas-pcg) guide. +- For data centers, production VMs are supported on bare metal Kubernetes clusters deployed on Canonical MAAS. To learn how to configure MAAS and create MAAS clusters in Palette, refer to the [Install and Manage MAAS Gateway](../clusters/data-center/maas/install-manage-maas-pcg.md) guide. - To use VMO on Edge, contact our support team by sending an email to [support@spectrocloud.com](mailto:support@spectrocloud.com) @@ -52,11 +52,11 @@ Palette Virtual Machine Orchestrator requires the following: ## Get Started With VM Orchestrator -To get started, review [Virtual Machine Orchestrator Pack](/vm-management/vm-packs-profiles) to learn about its components. +To get started, review [Virtual Machine Orchestrator Pack](vm-packs-profiles/vm-packs-profiles.md) to learn about its components. -Review [Create a VMO Profile](/vm-management/vm-packs-profiles/create-vmo-profile) and [Add Roles and Role Bindings](/vm-management/vm-packs-profiles/add-roles-and-role-bindings) to learn how to create the cluster profile and add roles and permissions that allow users to create and manage Virtual Machines (VMs). +Review [Create a VMO Profile](vm-packs-profiles/create-vmo-profile.md) and [Add Roles and Role Bindings](vm-packs-profiles/add-roles-and-role-bindings.md) to learn how to create the cluster profile and add roles and permissions that allow users to create and manage Virtual Machines (VMs). -Palette VM Orchestrator provides various methods to quickly deploy VMs from out-of-the-box templates or from your organization's templates. To learn more about using and creating templates, review [Deploy VM From a Template](/vm-management/create-manage-vm/standard-vm-operations/deploy-vm-from-template) and [Create a VM Template](/vm-management/create-manage-vm/create-vm-template). +Palette VM Orchestrator provides various methods to quickly deploy VMs from out-of-the-box templates or from your organization's templates. To learn more about using and creating templates, review [Deploy VM From a Template](create-manage-vm/standard-vm-operations/deploy-vm-from-template.md) and [Create a VM Template](create-manage-vm/create-vm-template.md). ## Feature Gates @@ -79,32 +79,28 @@ For more information on KubeVirt feature gates, refer to the [KubeVirt user guid ## Resources -- [Virtual Machine Orchestrator Pack](/vm-management/vm-packs-profiles) +- [Virtual Machine Orchestrator Pack](vm-packs-profiles/vm-packs-profiles.md) -- [Create a VMO Profile](/vm-management/vm-packs-profiles/create-vmo-profile) +- [Create a VMO Profile](vm-packs-profiles/create-vmo-profile.md) -- [Add Roles and Role Bindings](/vm-management/vm-packs-profiles/add-roles-and-role-bindings) +- [Add Roles and Role Bindings](vm-packs-profiles/add-roles-and-role-bindings.md) -- [Create and Manage VMs](/vm-management/create-manage-vm) +- [Create and Manage VMs](create-manage-vm/create-manage-vm.md) -- [Standard VM Operations](/vm-management/create-manage-vm/standard-vm-operations) +- [Standard VM Operations](create-manage-vm/standard-vm-operations/standard-vm-operations.md) -- [Deploy VM from a Template](/vm-management/create-manage-vm/standard-vm-operations/deploy-vm-from-template) +- [Deploy VM from a Template](create-manage-vm/standard-vm-operations/deploy-vm-from-template.md) -- [Create a VM Template](/vm-management/create-manage-vm/create-vm-template) +- [Create a VM Template](create-manage-vm/create-vm-template.md) -- [VM Roles and Permissions](/vm-management/vm-roles-permissions) +- [VM Roles and Permissions](vm-roles-permissions.md) -- [KubeVirt user guide](https://kubevirt.io/user-guide/operations/activating_feature_gates/) - -
- -
\ No newline at end of file +- [KubeVirt user guide](https://kubevirt.io/user-guide/operations/activating_feature_gates/) \ No newline at end of file diff --git a/docs/docs-content/vm-management/vm-packs-profiles/add-roles-and-role-bindings.md b/docs/docs-content/vm-management/vm-packs-profiles/add-roles-and-role-bindings.md index a6a056bd3a..62288c2cd7 100644 --- a/docs/docs-content/vm-management/vm-packs-profiles/add-roles-and-role-bindings.md +++ b/docs/docs-content/vm-management/vm-packs-profiles/add-roles-and-role-bindings.md @@ -9,12 +9,12 @@ tags: ["vmo"] --- -You must configure permissions for actions that users can perform on Virtual Machines (VMs) deployed using Palette Virtual Machine Orchestrator (VMO), such as cloning, updating, and migrating VMs. You can do this by creating roles and cluster role bindings to determine access permissions. Refer to [VM User Roles and Permissions](/vm-management/vm-roles-permissions) for a list of Cluster Roles and equivalent Palette Roles. To learn more about Cluster RBAC in Palette, review the [RBAC and NS Support](/clusters/cluster-management/cluster-rbac) guide. +You must configure permissions for actions that users can perform on Virtual Machines (VMs) deployed using Palette Virtual Machine Orchestrator (VMO), such as cloning, updating, and migrating VMs. You can do this by creating roles and cluster role bindings to determine access permissions. Refer to [VM User Roles and Permissions](../vm-roles-permissions.md) for a list of Cluster Roles and equivalent Palette Roles. To learn more about Cluster RBAC in Palette, review the [RBAC and NS Support](../../clusters/cluster-management/cluster-rbac.md) guide. ## Prerequisites -- A cluster profile with the **Virtual Machine Orchestrator** add-on pack configured. Check out the [Create a VMO Profile](/vm-management/vm-packs-profiles/create-vmo-profile) guide to learn more. +- A cluster profile with the **Virtual Machine Orchestrator** add-on pack configured. Check out the [Create a VMO Profile](../vm-packs-profiles/create-vmo-profile.md) guide to learn more. - Additional cluster roles, based on the user's persona, must be associated with the user by specifying a cluster role binding or a namespace-restricted role binding: @@ -36,7 +36,7 @@ You must configure permissions for actions that users can perform on Virtual Mac 2. From the left **Main Menu**, click **Clusters** and select your cluster. -3. Click on **Settings** and choose **RBAC** to add role bindings. Refer to [Create a Role Binding](/clusters/cluster-management/cluster-rbac#createrolebindings) for guidance. Refer to [VM User Roles and Permissions](/vm-management/vm-roles-permissions) for a list of Cluster Roles and equivalent Palette Roles. +3. Click on **Settings** and choose **RBAC** to add role bindings. Refer to [Create a Role Binding](../../clusters/cluster-management/cluster-rbac.md#create-role-bindings) for guidance. Refer to [VM User Roles and Permissions](../vm-roles-permissions.md) for a list of Cluster Roles and equivalent Palette Roles. 4. Click **Confirm** to update the cluster. @@ -71,8 +71,8 @@ kubectl get role --namespace --show-kind --export ## Next Steps -Now you are ready to deploy a VM. Review the [Deploy VM From a Template](/vm-management/create-manage-vm/standard-vm-operations/deploy-vm-from-template) guide to get started with the deployment process. +Now you are ready to deploy a VM. Review the [Deploy VM From a Template](../create-manage-vm/standard-vm-operations/deploy-vm-from-template.md) guide to get started with the deployment process. ## Resources -- [VM User Roles and Permissions](/vm-management/vm-roles-permissions) +- [VM User Roles and Permissions](../vm-roles-permissions.md) diff --git a/docs/docs-content/vm-management/vm-packs-profiles/create-vmo-profile.md b/docs/docs-content/vm-management/vm-packs-profiles/create-vmo-profile.md index e1bbd3abeb..4996a4d075 100644 --- a/docs/docs-content/vm-management/vm-packs-profiles/create-vmo-profile.md +++ b/docs/docs-content/vm-management/vm-packs-profiles/create-vmo-profile.md @@ -9,7 +9,7 @@ tags: ["vmo"] --- -The **Virtual Machine Orchestrator** pack that you use to create a cluster profile conveniently includes several components and automatically installs the [Spectro Proxy](/integrations/frp) pack when you use the default profile configuration. To learn about pack components, refer to [Virtual Machine Orchestrator Pack](/vm-management/vm-packs-profiles). +The **Virtual Machine Orchestrator** pack that you use to create a cluster profile conveniently includes several components and automatically installs the [Spectro Proxy](../../integrations/frp.md) pack when you use the default profile configuration. To learn about pack components, refer to [Virtual Machine Orchestrator Pack](../vm-packs-profiles/vm-packs-profiles.md). ## Prerequisites @@ -44,7 +44,7 @@ The **Virtual Machine Orchestrator** pack that you use to create a cluster profi - **Pack Version**: 1.0 or higher -7. Review the **Access** configuration panel at right. The default setting is **Proxied**, which automatically adds the **Spectro Proxy** pack when you create the cluster. Check out the [Spectro Proxy](/integrations/frp) guide to learn more. Changing the default may require some additional configuration. +7. Review the **Access** configuration panel at right. The default setting is **Proxied**, which automatically adds the **Spectro Proxy** pack when you create the cluster. Check out the [Spectro Proxy](../../integrations/frp.md) guide to learn more. Changing the default may require some additional configuration. The **Direct** option is intended for a private configuration where a proxy is not implemented or not desired. @@ -68,18 +68,6 @@ The **Virtual Machine Orchestrator** pack that you use to create a cluster profi 11. Apply the profile to your cluster. - - ## Validate You can validate the profile is created. @@ -103,9 +91,9 @@ You can validate the profile is created. ## Next Steps -You will need to configure roles and role bindings to give users access virtual clusters. You can use VM user roles and permissions or standard Kubernetes roles. For configuration guidance, refer to [Add Roles and Role Bindings](/vm-management/vm-packs-profiles/add-roles-and-role-bindings). The [VM User Roles and Permissions](/vm-management/vm-roles-permissions) reference lists Cluster Roles and equivalent Palette Roles. +You will need to configure roles and role bindings to give users access virtual clusters. You can use VM user roles and permissions or standard Kubernetes roles. For configuration guidance, refer to [Add Roles and Role Bindings](add-roles-and-role-bindings.md). The [VM User Roles and Permissions](../vm-roles-permissions.md) reference lists Cluster Roles and equivalent Palette Roles. ## Resources -- [Add Roles and Role Bindings](/vm-management/vm-packs-profiles/add-roles-and-role-bindings) +- [Add Roles and Role Bindings](add-roles-and-role-bindings.md) diff --git a/docs/docs-content/vm-management/vm-packs-profiles/vm-packs-profiles.md b/docs/docs-content/vm-management/vm-packs-profiles/vm-packs-profiles.md index df3ff8e136..102dfb32e9 100644 --- a/docs/docs-content/vm-management/vm-packs-profiles/vm-packs-profiles.md +++ b/docs/docs-content/vm-management/vm-packs-profiles/vm-packs-profiles.md @@ -14,7 +14,7 @@ The **Virtual Machine Orchestrator** pack provides a single-pack experience that - **Spectro VM Dashboard**: Enables access to a web console so you can manage and monitor your VMs. The console is accessible from the **Virtual Machines** tab that appears on the cluster overview page when using Palette Virtual Machine Orchestrator (VMO). The dashboard provides a web interface to create and manage VMs in your Kubernetes cluster. -- **KubeVirt**: Allows you to create VMs within a Kubernetes cluster using open-source [KubeVirt](https://kubevirt.io). KubeVirt provides feature gates you can enable in the Virtual Machine Orchestrator pack YAML file. To learn which feature gates Palette enables by default and how you can enable additional feature gates, check out the [Feature Gates](/vm-management#featuregates) section. +- **KubeVirt**: Allows you to create VMs within a Kubernetes cluster using open-source [KubeVirt](https://kubevirt.io). KubeVirt provides feature gates you can enable in the Virtual Machine Orchestrator pack YAML file. To learn which feature gates Palette enables by default and how you can enable additional feature gates, check out the [Feature Gates](../vm-management.md#feature-gates) section. KubeVirt extends Kubernetes with additional virtualization resource types using Kubernetes Custom Resource Definitions (CRD) API. KubeVirt also includes controllers and agents that provide VM management capabilities on the cluster. Through KubeVirt you can use the Kubernetes API to manage VM resources similar to the way you manage Kubernetes resources. @@ -30,7 +30,7 @@ The **Virtual Machine Orchestrator** pack provides a single-pack experience that :::info -The **Spectro Proxy** pack enables the use of a reverse proxy with a Kubernetes cluster and is automatically installed when you create the cluster with the default **Proxied** setting for **Access** during cluster profile creation. Check out the [Spectro Proxy](/integrations/frp) pack documentation to learn more. +The **Spectro Proxy** pack enables the use of a reverse proxy with a Kubernetes cluster and is automatically installed when you create the cluster with the default **Proxied** setting for **Access** during cluster profile creation. Check out the [Spectro Proxy](../../integrations/frp.md) pack documentation to learn more. ::: @@ -41,11 +41,7 @@ Administrators can configure the out-of-the-box add-on packs, cluster profiles, # Resources -- [Spectro Proxy](/integrations/frp) +- [Spectro Proxy](../../integrations/frp.md) -- [Feature Gates](/vm-management#featuregates) - -
- -
\ No newline at end of file +- [Feature Gates](../vm-management.md#feature-gates) \ No newline at end of file diff --git a/docs/docs-content/vm-management/vm-roles-permissions.md b/docs/docs-content/vm-management/vm-roles-permissions.md index 4c372082e4..d25d475f6a 100644 --- a/docs/docs-content/vm-management/vm-roles-permissions.md +++ b/docs/docs-content/vm-management/vm-roles-permissions.md @@ -38,10 +38,6 @@ You can create additional roles based on the permissions granularity that Palett
-You can configure namespaces and RBAC from within a cluster or from a Palette workspace that contains a cluster group. In a cluster group, all RoleBindings must occur at the namespace level. For details, review the [Cluster RBAC](/clusters/cluster-management/cluster-rbac/) and [workspace RBAC](/workspace/#rolebasedaccesscontrol(rbac)) guides. +You can configure namespaces and RBAC from within a cluster or from a Palette workspace that contains a cluster group. In a cluster group, all RoleBindings must occur at the namespace level. For details, review the [Cluster RBAC](../clusters/cluster-management/cluster-rbac.md) and [workspace RBAC](../workspace/workspace.md#role-based-access-controlrbac) guides. -Palette leverages Regex Pattern matching so you can select multiple namespaces to apply role bindings. Check out [Regex for Namespaces](/workspace/workload-features) to learn more. - -
- -
\ No newline at end of file +Palette leverages Regex Pattern matching so you can select multiple namespaces to apply role bindings. Check out [Regex for Namespaces](../workspace/workload-features.md#regex-for-namespaces) to learn more. diff --git a/docs/docs-content/workspace/adding-a-new-workspace.md b/docs/docs-content/workspace/adding-a-new-workspace.md index 36a0635db9..d50b761265 100644 --- a/docs/docs-content/workspace/adding-a-new-workspace.md +++ b/docs/docs-content/workspace/adding-a-new-workspace.md @@ -20,16 +20,17 @@ Palette enables multi-cluster management and governance capabilities by introduc ## Create Your Workspace -#### 1. Add the Basic Information +1. Add the Basic Information Provide the basic information for the workspace such as: * Unique Name * Optional Description * Optional Tag -#### 2. Associate Clusters - * Select the cluster(s) to be added to the workspace. (See [New Clusters](/clusters) to learn how to add a new Cluster.) Palette clusters, as well as brownfield clusters, can be added to your workspace. +2.Associate Clusters + + * Select the cluster(s) to be added to the workspace. (See [New Clusters](../clusters/clusters.md) to learn how to add a new Cluster.) Palette clusters, as well as brownfield clusters, can be added to your workspace. * Configure the Cluster Role Binding (optional). Role bindings can be created on all workspace clusters. @@ -44,7 +45,7 @@ Provide the basic information for the workspace such as: | **Service Account** | a valid path segment name | Granting super-user access to all service accounts
cluster-wide is strongly discouraged. Hence, grant a
role to all service accounts in a namespace. | -#### 3. Associate Namespaces +3. Associate Namespaces * Enter one or more namespaces that need to be part of the workspace. The combination of workspace and cluster is unique across workspaces in a project. Palette ensures that all the namespaces are created for all the clusters in the workspaces, in case they are not pre-existing. @@ -58,13 +59,15 @@ Provide the basic information for the workspace such as: * Make the selection of Subjects from the dropdown list (User, Group, or ServiceAccount). For the subject selected, provide a valid path segment name. For the subject, ServiceAccount select namespace name as granting super-user access to all service accounts cluster-wide is strongly discouraged due to security concerns. * Confirm the information provided to complete the configuration of role binding. -#### 4. Settings +4. Settings -* [Schedule Backups](/clusters/cluster-management/backup-restore#createaworkspacebackup) - set the backup and restore policies. +* [Schedule Backups](../clusters/cluster-management/backup-restore/backup-restore.md) - set the backup and restore policies. -* [Container Image](/workspace/workload-features#restrictedcontainerimages) - list out the container images to be restricted within a Workspace namespace. +* [Container Image](workload-features.md#restrict-container-images-to-a-workspace) - list out the container images to be restricted within a Workspace namespace. + + -#### 5. Review and finish the configuration and complete the deployment. +Review and finish the configuration and complete the deployment. diff --git a/docs/docs-content/workspace/workload-features.md b/docs/docs-content/workspace/workload-features.md index 4441604ed4..df934a66d0 100644 --- a/docs/docs-content/workspace/workload-features.md +++ b/docs/docs-content/workspace/workload-features.md @@ -20,7 +20,7 @@ The following sections describe these capabilities in detail: ------------------------ - + @@ -66,7 +66,7 @@ To create your **Workspace Role**, follow the steps below: 2. Go to the **Users and Teams** option. -3. From the listed users, select the user to be assigned with Workspace Roles. See here for [User Creation](/projects/#projects). +3. From the listed users, select the user to be assigned with Workspace Roles. See here for [User Creation](../user-management/new-user.md). 4. Select the **Workspace Roles** tab and click **+ New Workspace Role** to create a new role. @@ -89,13 +89,13 @@ Palette leverages the BackUps to the following locations:
-#### Amazon Web Services (AWS) S3 Buckets: [Prerequisites](/workspace/workload-features#foranamazonwebservices(aws)bucketasbackuplocation), [Configure your Backup](/workspace/workload-features#configureyourbackupinawss3) +#### Amazon Web Services (AWS) S3 Buckets: [Prerequisites](#amazon-web-services-aws-s3-buckets-prerequisitesbucketasbackuplocation-configure-your-backup)bucketasbackuplocation), [Configure your Backup](#configure-your-backup-in-aws-s3) -#### Google Cloud Platform (GCP) Buckets: [Prerequisites](/workspace/workload-features#foragooglecloudplatform(gcp)backuplocation), [Configure your Backup](/workspace/workload-features#configureyourbackupingcpbucket) +#### Google Cloud Platform (GCP) Buckets: [Prerequisites](#google-cloud-platform-gcp-buckets-prerequisites-configure-your-backup), [Configure your Backup](#configure-your-backup-in-gcp-bucket) -#### MinIO S3 Buckets: [Prerequisites](/workspace/workload-features#forminios3backup), [Configure your Backup](/workspace/workload-features#configureyourbackupinminio) +#### MinIO S3 Buckets: [Prerequisites](#minio-s3-buckets-prerequisites-configure-your-backup), [Configure your Backup](#configure-your-backup-in-minio) -#### Azure Blob: [Prerequisites](/workspace/workload-features#forazureblobbackup), [Configure your Backup](/workspace/workload-features#configureyourbackupinazure:azureblob) +#### Azure Blob: [Prerequisites](#azure-blob-prerequisites-configure-your-backup), [Configure your Backup](#configure-your-backup-in-azure-azure-blob) ## Prerequisites @@ -416,7 +416,7 @@ Palette enables the users to limit resource usage within the workspace optionall ## To set your Resource Quota: -1. During [Step: 3 Associate Namespaces](/workspace/adding-a-new-workspace#3.associatenamespaces) of Namespace creation, **Workspace Quota** can be set by giving the **Maximum CPU** and **Maximum Memory**. Then, all the clusters launched within the Namespace can use the set Quota. +1. During [Step: 3 Associate Namespaces](adding-a-new-workspace#3-associate-namespaces) of Namespace creation, **Workspace Quota** can be set by giving the **Maximum CPU** and **Maximum Memory**. Then, all the clusters launched within the Namespace can use the set Quota. 2. Namespace Quota can be set for an already deployed workspace as: @@ -501,7 +501,7 @@ A single RoleBinding can have multiple subjects. ## Configure role bindings: Namespace Scope -Users can now allocate CPU and Memory [quotas](/workspace/workload-features#workspacequota) for each **namespace** at the cluster level. +Users can now allocate CPU and Memory [quotas](#workspace-quota) for each **namespace** at the cluster level. * Login to Palette as Project admin and select the Workspace to which the Role Binding need to be configured. @@ -512,11 +512,11 @@ Users can now allocate CPU and Memory [quotas](/workspace/workload-features#work * Create a namespace with a custom name and add it to the list of the namespace by clicking on “add to the list”. -* [Allocate resources](/workspace/workload-features#workspacequota) to the created namespace (CPU and Memory). +* [Allocate resources](workload-features.md#workspace-quota) to the created namespace (CPU and Memory). * Click on “Add new binding” to open the “Add ClusterRoleBinding” wizard. Fill in the following details: - * Namespace: Select the namespace from the drop-down (the list will display the namespaces created during the previous step. + * Namespace: Select the namespace from the drop-down Menu. The list will display the namespaces created during the previous step. * Role Type: Select the role type from the drop-down. Either Role or Cluster Role. :::info @@ -552,7 +552,7 @@ Palette users can restrict a few container images from getting deployed into a s To restrict a container image for a particular namespace within the workspace: -1. During [Step: 4 Settings](/workspace/adding-a-new-workspace#4.settings) of workspace creation, select the **Container Images** tab from the left ribbon. +1. During [Step: 4 Settings](adding-a-new-workspace.md#4-settings) of workspace creation, select the **Container Images** tab from the left ribbon. 2. Click on **+ Add New Container Image** and provide the **Namespace** and **Restricted Images**. Multiple images can be restricted within a namespace by separating them with commas. @@ -567,17 +567,9 @@ The user can add a list of restricted images to an already deployed workspace as 2. Click on **Add New Container Image** and provide the **Namespace** and **Restricted Images**. Multiple images can be restricted within a Namespace by separating them with commas. - - - - -
-
-
- diff --git a/docs/docs-content/workspace/workspace.md b/docs/docs-content/workspace/workspace.md index 78ffcbddef..7b2b7518a4 100644 --- a/docs/docs-content/workspace/workspace.md +++ b/docs/docs-content/workspace/workspace.md @@ -37,13 +37,9 @@ Workspaces provide a workload browser to view all the workloads such as pods, de ## Backup and Restore -A workspace-based backup is similar to a cluster backup, with the additional coverage of multiple clusters, should the workspace include more than one. The prerequisites and detailed instructions to backup and restore clusters are specified on the [Clusters page](/clusters/#manage_clusters). +A workspace-based backup is similar to a cluster backup, with the additional coverage of multiple clusters, should the workspace include more than one. The prerequisites and detailed instructions to backup and restore clusters are specified on the [Backup and Restore](../clusters/cluster-management/backup-restore/backup-restore.md) page. ## Regex for Namespaces -Palette leverages [Regex Pattern matching](/workspace/workload-features#regexfornamespaces) to select multiple namespaces to apply Role binding concurrently. When we have many namespaces to be configured for role binding, the user can provide a Regex pattern matching multiple namespaces instead of giving a single namespace. This will help select all the namespaces matching the given Regex pattern to be selected together for role binding. - - -
-
+Palette leverages [Regex Pattern matching](workload-features.md#regex-for-namespaces) to select multiple namespaces to apply Role binding concurrently. When we have many namespaces to be configured for role binding, the user can provide a Regex pattern matching multiple namespaces instead of giving a single namespace. This will help select all the namespaces matching the given Regex pattern to be selected together for role binding. >