spectrocloud · karl-cardenas-coding · Sep 16, 2023 · Sep 15, 2023 · Sep 16, 2023 · Sep 16, 2023
@@ -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

@@ -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

@@ -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

@@ -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.
 
 <br />
 

@@ -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)
 
@@ -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.
 
 :::
 

@@ -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)
 
 <br />
@@ -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.
+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.
@@ -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
 
 :::
 
-<br />
-<br />
@@ -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. 
 

@@ -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

@@ -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.      |
 
 

@@ -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.

@@ -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.
 
 <br />
 
 ## 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)
@@ -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

@@ -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. <br /><br />
 
-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. <br />
-    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: