Skip to content

Commit

Permalink
docs: DOC-1369 (#3879) (#3881)
Browse files Browse the repository at this point in the history
* 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 <karl-cardenas-coding@users.noreply.github.com>
  • Loading branch information
3 people authored Sep 11, 2024
1 parent 25f349b commit 5075823
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 4 deletions.
36 changes: 36 additions & 0 deletions docs/docs-content/troubleshooting/automation.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion docs/docs-content/troubleshooting/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
2 changes: 1 addition & 1 deletion plugins/packs-integrations.js
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
4 changes: 2 additions & 2 deletions vale.ini
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 5075823

Please sign in to comment.