From 50758236a89227a678a6bf6f13ef8912641e8376 Mon Sep 17 00:00:00 2001 From: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com> Date: Wed, 11 Sep 2024 16:22:25 -0700 Subject: [PATCH] docs: DOC-1369 (#3879) (#3881) * docs: DOC-1369 * docs: fixed typo * docs: Apply suggestions from code review * ci: auto-formatting prettier issues * ci: fix vale --------- Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com> Co-authored-by: karl-cardenas-coding --- .../troubleshooting/automation.md | 36 +++++++++++++++++++ .../troubleshooting/troubleshooting.md | 2 +- plugins/packs-integrations.js | 2 +- vale.ini | 4 +-- 4 files changed, 40 insertions(+), 4 deletions(-) create mode 100644 docs/docs-content/troubleshooting/automation.md diff --git a/docs/docs-content/troubleshooting/automation.md b/docs/docs-content/troubleshooting/automation.md new file mode 100644 index 0000000000..0eb3cb64ff --- /dev/null +++ b/docs/docs-content/troubleshooting/automation.md @@ -0,0 +1,36 @@ +--- +sidebar_label: "Automation" +title: "Automation" +description: "Troubleshooting steps for Palette and VerteX related automation tools such as the SDK, CLI, and API." +icon: "" +hide_table_of_contents: false +sidebar_position: 5 +tags: ["troubleshooting", "automation", "sdk", "cli", "api"] +--- + +The following sections will help you troubleshoot issues with Palette and VerteX related automation tools such as the +API, CLI, Terraform, and SDK. + +## Scenario - Incompatible Stale Palette CLI Binaries + +Palette CLI may encounter issues when attempting to use third-party binaries that are incompatible with the CLI such as +`docker`, `kind`, and `validatorctl`. By default, the Palette CLI will download the third-party binaries from the +internet and store them in the `$HOME/.palette/bin` directory, the first time you issue a command that requires them. +The Palette CLI does not upgrade these binaries, which can lead to compatibility issues with current versions of the +CLI. + +Use the following steps to resolve issues with incompatible stale Palette CLI binaries. + +### Debug Steps + +1. Log in to the machine where the Palette CLI is installed. + +2. Remove the `~/.palette/bin` directory. + + ```shell + rm -rf ~/.palette/bin + ``` + +3. Re-issue the command that requires the binary. The CLI will download the latest version of the binary and store it in + the `$HOME/.palette/bin` directory. If you used the `--workspace` flag then the third-party binaries will be stored + in the specified workspace directory. diff --git a/docs/docs-content/troubleshooting/troubleshooting.md b/docs/docs-content/troubleshooting/troubleshooting.md index ef49edac58..08c7a4a94e 100644 --- a/docs/docs-content/troubleshooting/troubleshooting.md +++ b/docs/docs-content/troubleshooting/troubleshooting.md @@ -11,7 +11,7 @@ tags: ["troubleshooting"] Use the following troubleshooting resources to help you address issues that may arise. You can also reach out to our support team by opening up a ticket through our [support page](http://support.spectrocloud.io/). -- [Kubernetes Debugging](kubernetes-tips.md) +- [Automation](automation.md) - [Cluster Deployment](cluster-deployment.md) diff --git a/plugins/packs-integrations.js b/plugins/packs-integrations.js index ff8b251697..9db8cb795f 100644 --- a/plugins/packs-integrations.js +++ b/plugins/packs-integrations.js @@ -473,7 +473,7 @@ async function pluginPacksAndIntegrationsData(context, options) { logger.error("An error occurred while reading the JSON file:", e); } } - logger.info(`The number of packs identified are ${Object.keys(apiPackResponse.packMDMap).length}`); + logger.info(`The number of packs identified is: ${Object.keys(apiPackResponse.packMDMap).length}`); return { packsPaletteData: apiPackResponse.packMDMap, packsPaletteDetailsData: apiPackResponse.apiPacksData, diff --git a/vale.ini b/vale.ini index 3f85be8868..5d05ce3180 100644 --- a/vale.ini +++ b/vale.ini @@ -5,10 +5,10 @@ Vocab = spectrocloud-vocab MinAlertLevel = suggestion Packages = Google, write-good, alex, https://github.com/spectrocloud/spectro-vale-pkg/releases/latest/download/spectrocloud-docs-internal.zip - +IgnoredScopes = code, tt, img, url, a, [*.md] BasedOnStyles = Vale, Google, write-good, alex, spectrocloud-docs-internal -IgnoredScopes = code, tt, img, url, a, + ; BlockIgnores = ; The following line ignores all import statements in markdown files