From b0d52c3ab526d4022e62fea84b6f2fbdb305f844 Mon Sep 17 00:00:00 2001 From: Carolina Delwing Rosa Date: Mon, 29 Apr 2024 11:31:26 -0400 Subject: [PATCH] docs: fix more palette cli broken links --- docs/docs-content/clusters/pcg/deploy-app-pcg.md | 6 +++--- docs/docs-content/clusters/pcg/deploy-pcg/maas.md | 8 ++++---- .../clusters/pcg/deploy-pcg/openstack.md | 8 ++++---- docs/docs-content/clusters/pcg/deploy-pcg/vmware.md | 8 ++++---- docs/docs-content/clusters/pcg/pcg.md | 2 +- .../public-cloud/azure/required-permissions.md | 2 +- docs/docs-content/devx/devx.md | 4 ++-- .../install-palette/install-on-vmware/install.md | 6 +++--- .../define-profile-variables.md | 2 +- docs/docs-content/release-notes.md | 12 ++++++------ docs/docs-content/spectro-downloads.md | 2 +- .../install-palette-vertex/airgap/offline-docs.md | 2 +- .../install-on-vmware/install.md | 6 +++--- 13 files changed, 34 insertions(+), 34 deletions(-) diff --git a/docs/docs-content/clusters/pcg/deploy-app-pcg.md b/docs/docs-content/clusters/pcg/deploy-app-pcg.md index db2caed565..b9ac44ace1 100644 --- a/docs/docs-content/clusters/pcg/deploy-app-pcg.md +++ b/docs/docs-content/clusters/pcg/deploy-app-pcg.md @@ -69,7 +69,7 @@ To complete this tutorial, you will need the following prerequisites in place. ::: - Ensure the following software is installed and available on your Linux machine. - - [Palette CLI](../../palette-cli/install-palette-cli.md). + - [Palette CLI](../../automation/palette-cli/install-palette-cli.md). - [Docker](https://docs.docker.com/desktop). - [Kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation). - [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git). @@ -78,7 +78,7 @@ To complete this tutorial, you will need the following prerequisites in place. ## Authenticate with Palette The initial step to deploy a PCG using Palette CLI involves authenticating with your Palette environment using the -[`palette login`](../../palette-cli/commands/login.md) command. +[`palette login`](../../automation/palette-cli/commands/login.md) command. In your terminal, execute the following command. @@ -240,7 +240,7 @@ VMware cloud account with the same name as the PCG. The following recording demonstrates the `pcg install` command with the `--config-only` flag. When using this flag, a reusable configuration file named **pcg.yaml** is created under the path **.palette/pcg**. You can then utilize this file to install a PCG with predefined values using the command `pcg install` with the `--config-file` flag. Refer to the -[Palette CLI PCG Command](../../palette-cli/commands/pcg.md) page for further information about the command. +[Palette CLI PCG Command](../../automation/palette-cli/commands/pcg.md) page for further information about the command. diff --git a/docs/docs-content/clusters/pcg/deploy-pcg/maas.md b/docs/docs-content/clusters/pcg/deploy-pcg/maas.md index 7c6ef739f4..73d04f8307 100644 --- a/docs/docs-content/clusters/pcg/deploy-pcg/maas.md +++ b/docs/docs-content/clusters/pcg/deploy-pcg/maas.md @@ -26,7 +26,7 @@ carefully review the [Prerequisites](#prerequisites) section. ::: - Download and install the Palette CLI from the [Downloads](../../../spectro-downloads.md#palette-cli) page. Refer to - the [Palette CLI Install](../../../palette-cli/install-palette-cli.md) guide to learn more. + the [Palette CLI Install](../../../automation/palette-cli/install-palette-cli.md) guide to learn more. The following system requirements must be met to install a PCG in MAAS: @@ -121,7 +121,7 @@ is not required for the DNS records to be accessible from the internet. The `CloudAccount.apiKey` and `Mgmt.apiKey` values in the **pcg.yaml** file are encrypted and cannot be manually updated. To change these values, use the `palette pcg install --update-passwords` command. Refer to the - [PCG command](../../../palette-cli/commands/pcg.md#update-passwords) reference page for more information. + [PCG command](../../../automation/palette-cli/commands/pcg.md#update-passwords) reference page for more information. ::: @@ -215,8 +215,8 @@ is not required for the DNS records to be accessible from the internet. You cannot modify a deployed PCG cluster. If you need to make changes to the PCG cluster, you must first delete the cluster and redeploy it. We recommend you save your PCG configuration file for future use. Use the `--config-only` flag to save the configuration file without deploying the PCG cluster. Refer to the - [Generate a Configuration File](../../../palette-cli/commands/pcg.md#generate-a-configuration-file) section to learn - more. For additional assistance, visit our + [Generate a Configuration File](../../../automation/palette-cli/commands/pcg.md#generate-a-configuration-file) + section to learn more. For additional assistance, visit our [Customer Support](https://spectrocloud.atlassian.net/servicedesk/customer/portals) portal. ::: diff --git a/docs/docs-content/clusters/pcg/deploy-pcg/openstack.md b/docs/docs-content/clusters/pcg/deploy-pcg/openstack.md index 9876ea8712..c2bbe2b99a 100644 --- a/docs/docs-content/clusters/pcg/deploy-pcg/openstack.md +++ b/docs/docs-content/clusters/pcg/deploy-pcg/openstack.md @@ -26,7 +26,7 @@ installation, carefully review the [Prerequisites](#prerequisites) section. ::: - Download and install the Palette CLI from the [Downloads](../../../spectro-downloads.md#palette-cli) page. Refer to - the [Palette CLI Install](../../../palette-cli/install-palette-cli.md) guide to learn more. + the [Palette CLI Install](../../../automation/palette-cli/install-palette-cli.md) guide to learn more. The following system requirements must be met to install a PCG in OpenStack: @@ -340,7 +340,7 @@ The following permissions are required to deploy a PCG to OpenStack and for Pale The `CloudAccount.apiKey` and `Mgmt.apiKey` values in the **pcg.yaml** file are encrypted and cannot be manually updated. To change these values, use the `palette pcg install --update-passwords` command. Refer to the - [PCG command](../../../palette-cli/commands/pcg.md#update-passwords) reference page for more information. + [PCG command](../../../automation/palette-cli/commands/pcg.md#update-passwords) reference page for more information. ::: @@ -448,8 +448,8 @@ The following permissions are required to deploy a PCG to OpenStack and for Pale You cannot modify a deployed PCG cluster. If you need to make changes to the PCG cluster, you must first delete the cluster and redeploy it. We recommend you save your PCG configuration file for future use. Use the `--config-only` flag to save the configuration file without deploying the PCG cluster. Refer to the - [Generate a Configuration File](../../../palette-cli/commands/pcg.md#generate-a-configuration-file) section to learn - more. For additional assistance, visit our + [Generate a Configuration File](../../../automation/palette-cli/commands/pcg.md#generate-a-configuration-file) + section to learn more. For additional assistance, visit our [Customer Support](https://spectrocloud.atlassian.net/servicedesk/customer/portals) portal. ::: diff --git a/docs/docs-content/clusters/pcg/deploy-pcg/vmware.md b/docs/docs-content/clusters/pcg/deploy-pcg/vmware.md index ec7e1257a7..57881b4746 100644 --- a/docs/docs-content/clusters/pcg/deploy-pcg/vmware.md +++ b/docs/docs-content/clusters/pcg/deploy-pcg/vmware.md @@ -34,7 +34,7 @@ environment, then you already have all the required permissions and roles. Proce ::: - Download and install the Palette CLI from the [Downloads](../../../spectro-downloads.md#palette-cli) page. Refer to - the [Palette CLI Install](../../../palette-cli/install-palette-cli.md) guide to learn more. + the [Palette CLI Install](../../../automation/palette-cli/install-palette-cli.md) guide to learn more. The following system requirements must be met to install a PCG in VMware vSphere: @@ -374,7 +374,7 @@ The following requirements apply to tags: The `CloudAccount.apiKey` and `Mgmt.apiKey` values in the **pcg.yaml** file are encrypted and cannot be manually updated. To change these values, use the `palette pcg install --update-passwords` command. Refer to the - [PCG command](../../../palette-cli/commands/pcg.md#update-passwords) reference page for more information. + [PCG command](../../../automation/palette-cli/commands/pcg.md#update-passwords) reference page for more information. ::: @@ -530,8 +530,8 @@ The following requirements apply to tags: You cannot modify a deployed PCG cluster. If you need to make changes to the PCG cluster, you must first delete the cluster and redeploy it. We recommend you save your PCG configuration file for future use. Use the `--config-only` flag to save the configuration file without deploying the PCG cluster. Refer to the - [Generate a Configuration File](../../../palette-cli/commands/pcg.md#generate-a-configuration-file) section to learn - more. For additional assistance, visit our + [Generate a Configuration File](../../../automation/palette-cli/commands/pcg.md#generate-a-configuration-file) + section to learn more. For additional assistance, visit our [Customer Support](https://spectrocloud.atlassian.net/servicedesk/customer/portals) portal. ::: diff --git a/docs/docs-content/clusters/pcg/pcg.md b/docs/docs-content/clusters/pcg/pcg.md index d4da350293..91aad4ff9c 100644 --- a/docs/docs-content/clusters/pcg/pcg.md +++ b/docs/docs-content/clusters/pcg/pcg.md @@ -10,7 +10,7 @@ tags: ["pcg"] A Private Cloud Gateway (PCG) is a Palette infrastructure support component that enables the communication between Palette and a private cloud or private data center environment. The PCG is typically deployed into the private cloud -environments through the [Palette CLI](../../palette-cli/install-palette-cli.md). +environments through the [Palette CLI](../../automation/palette-cli/install-palette-cli.md). A PCG is necessary in private cloud environments where Palette does not have direct network access to the environment where workload clusters are deployed to. When the PCG is installed, it registers itself with a Palette instance and diff --git a/docs/docs-content/clusters/public-cloud/azure/required-permissions.md b/docs/docs-content/clusters/public-cloud/azure/required-permissions.md index 8aa3ce06e4..b37542e1c1 100644 --- a/docs/docs-content/clusters/public-cloud/azure/required-permissions.md +++ b/docs/docs-content/clusters/public-cloud/azure/required-permissions.md @@ -42,7 +42,7 @@ permissions. The Validator Azure plugin requires the following permissions: - Microsoft.Authorization/roleDefinitions/read You can use the Validator with the Palette CLI. Check out the Palette CLI -[Validator](../../../palette-cli/commands/validator.md) command reference page for more information. +[Validator](../../../automation/palette-cli/commands/validator.md) command reference page for more information. ::: diff --git a/docs/docs-content/devx/devx.md b/docs/docs-content/devx/devx.md index ab9a72fd74..9624381866 100644 --- a/docs/docs-content/devx/devx.md +++ b/docs/docs-content/devx/devx.md @@ -72,8 +72,8 @@ programmatically using PDE. :::tip -Check out the Palette CLI [install guide](../palette-cli/install-palette-cli.md) for more information on how to install -and configure the CLI. +Check out the Palette CLI [install guide](../automation/palette-cli/install-palette-cli.md) for more information on how +to install and configure the CLI. ::: diff --git a/docs/docs-content/enterprise-version/install-palette/install-on-vmware/install.md b/docs/docs-content/enterprise-version/install-palette/install-on-vmware/install.md index 20ad4cb81f..cd35279ffd 100644 --- a/docs/docs-content/enterprise-version/install-palette/install-on-vmware/install.md +++ b/docs/docs-content/enterprise-version/install-palette/install-on-vmware/install.md @@ -29,7 +29,7 @@ proceeding with the installation. Refer to the host. - Palette CLI installed and available. Refer to the Palette CLI - [Install](../../../palette-cli/install-palette-cli.md#download-and-setup) page for guidance. + [Install](../../../automation/palette-cli/install-palette-cli.md#download-and-setup) page for guidance. - Review the required VMware vSphere [permissions](vmware-system-requirements.md). Ensure you have created the proper custom roles and zone tags. @@ -134,7 +134,7 @@ Use the following steps to install Palette. 5. 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/commands.md). + about the `ec` subcommand, refer to [Palette Commands](../../../automation/palette-cli/commands/commands.md). ```bash palette ec install @@ -428,7 +428,7 @@ teams. ## Resources -- [Palette CLI](../../../palette-cli/install-palette-cli.md#download-and-setup) +- [Palette CLI](../../../automation/palette-cli/install-palette-cli.md#download-and-setup) - [VMware System Requirements](vmware-system-requirements.md) diff --git a/docs/docs-content/profiles/cluster-profiles/create-cluster-profiles/define-profile-variables.md b/docs/docs-content/profiles/cluster-profiles/create-cluster-profiles/define-profile-variables.md index 7cebca6390..8acda409d4 100644 --- a/docs/docs-content/profiles/cluster-profiles/create-cluster-profiles/define-profile-variables.md +++ b/docs/docs-content/profiles/cluster-profiles/create-cluster-profiles/define-profile-variables.md @@ -44,7 +44,7 @@ This guide explains how you can define and manage cluster profile variables. - Palette does not support nesting profile variables within macros or other profile variables. - You cannot define profile variables for the `pack.content` and `system.uri` parameters because the - [Palette CLI](../../../palette-cli/palette-cli.md) populates them automatically. + [Palette CLI](../../../automation/palette-cli/palette-cli.md) populates them automatically. - Once you deploy a cluster from a profile with variables, you can neither edit nor delete the profile variables. To edit or delete them, [version the cluster profile](../modify-cluster-profiles/version-cluster-profile.md) and update diff --git a/docs/docs-content/release-notes.md b/docs/docs-content/release-notes.md index 80b4de99fd..8fc54abd12 100644 --- a/docs/docs-content/release-notes.md +++ b/docs/docs-content/release-notes.md @@ -74,16 +74,16 @@ the following sections for a complete list of features, improvements, and known - The [Validator AWS](https://github.com/spectrocloud-labs/validator-plugin-aws) plugin now reports IAM permissions issues that are caused by [Service control policies](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_scps.html). - Refer to the Palette CLI [Validator](./palette-cli/commands/validator.md) page to learn how to use Validator with the - Palette CLI. + Refer to the Palette CLI [Validator](./automation/palette-cli/commands/validator.md) page to learn how to use + Validator with the Palette CLI. - Packs that are marked as _Disabled_ are no longer displayed in the cluster profile creation wizard. Existing cluster profiles containing disabled packs are not affected and continue to work as expected. Refer to the [maintenance policy](./integrations/maintenance-policy.md#pack-deprecations) page to learn more. -- Several enhancements have been added to the Palette CLI [Validator](./palette-cli/commands/validator.md) command that - improves the user experience. The enhancements include a Validator upgrade feature, a describe subcommand that - displays results more clearly, an interactive re-configure option, the ability to restart the wizard, and more. +- Several enhancements have been added to the Palette CLI [Validator](./automation/palette-cli/commands/validator.md) + command that improves the user experience. The enhancements include a Validator upgrade feature, a describe subcommand + that displays results more clearly, an interactive re-configure option, the ability to restart the wizard, and more. - Cox Edge has been removed as a supported platform for Edge clusters. Cox stopped supporting the platform and is no longer available for new deployments. All Cox Edge-related resources and API endpoints have been removed. @@ -227,7 +227,7 @@ the following sections for a complete list of features, improvements, and known `fips-validate` command. The command scans the cluster and reports the FIPS compliance status of images. The command also supports checking exposed service endpoints for approved ciphers and TLS versions. Images and service endpoints that are not compliant are reported with either a failed or unknown status. Refer to the - [FIPS Validate](./palette-cli/commands/fips-validate.md) guide to learn more about the command. + [FIPS Validate](./automation/palette-cli/commands/fips-validate.md) guide to learn more about the command. - VerteX instances now use Kubernetes version 1.27.11. This new version of Kubernetes will cause node repave events during the upgrade process. If you have multiple self-hosted Palette instances in a VMware environment, take a moment diff --git a/docs/docs-content/spectro-downloads.md b/docs/docs-content/spectro-downloads.md index 5d245bc095..895d6e4fcc 100644 --- a/docs/docs-content/spectro-downloads.md +++ b/docs/docs-content/spectro-downloads.md @@ -21,7 +21,7 @@ on how to install Palette. Palette VerteX installation guide can be found in the ## Palette CLI The Palette Command Line Interface (CLI) is a tool that you can use to interact with Palette programmatically. Check out -the [Palette CLI](./palette-cli/palette-cli.md) document for installation guidance. +the [Palette CLI](./automation/palette-cli/palette-cli.md) document for installation guidance. | Version | Operating System | Checksum (SHA256) | | ------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | diff --git a/docs/docs-content/vertex/install-palette-vertex/airgap/offline-docs.md b/docs/docs-content/vertex/install-palette-vertex/airgap/offline-docs.md index e8a3a34164..a558e0d425 100644 --- a/docs/docs-content/vertex/install-palette-vertex/airgap/offline-docs.md +++ b/docs/docs-content/vertex/install-palette-vertex/airgap/offline-docs.md @@ -17,7 +17,7 @@ you can access it using your browser. :::tip You can use the Palette CLI to download and start the offline documentation container with a single command. Check out -the Palette CLI `docs` command [page](../../../palette-cli/commands/docs.md) for more information. +the Palette CLI `docs` command [page](../../../automation/palette-cli/commands/docs.md) for more information. ::: 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 51b96e6f37..edc8e43a37 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 @@ -30,7 +30,7 @@ before proceeding with the installation. Refer to the host. - Palette CLI installed and available. Refer to the Palette CLI - [Install](../../../palette-cli/install-palette-cli.md#download-and-setup) page for guidance. + [Install](../../../automation/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. @@ -144,7 +144,7 @@ Use the following steps to install Palette VerteX. 5. 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.md). + about the `ec` subcommand, refer to [Palette Commands](../../../automation/palette-cli/commands/ec.md). ```bash palette ec install @@ -441,7 +441,7 @@ teams. - [Enterprise Install Troubleshooting](../../../troubleshooting/enterprise-install.md) -- [Palette CLI](../../../palette-cli/install-palette-cli.md#download-and-setup) +- [Palette CLI](../../../automation/palette-cli/install-palette-cli.md#download-and-setup) - [System Management](../../system-management/system-management.md)