Skip to content

Commit b47789c

Browse files
authored
docs: PLT-1948: Palette CLI Breaking Change (#8076)
* Adding breaking change to Palette CLI limitations section * Adding breaking change to release notes * Minor changes * Empty commit to trigger Netlify preview * removing hardcoded path
1 parent 0ebdd04 commit b47789c

File tree

4 files changed

+32
-0
lines changed

4 files changed

+32
-0
lines changed

docs/docs-content/automation/palette-cli/commands/ec.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,14 @@ The `ec` command exposes the following subcommand.
2222
- `install` - Install a Palette Enterprise Cluster through an interactive wizard. A container runtime is required to
2323
install an EC cluster.
2424

25+
## Limitations
26+
27+
- Passwords set using Palette CLI version 4.7.1 or earlier are not compatible with Palette CLI version 4.7.2 or later.
28+
As a result, users cannot use configuration files created using version 4.7.1 or earlier to perform Palette CLI
29+
operations after upgrading to version 4.7.2 or later. Users must update their password by either running the command
30+
`palette ec install --config-file <ec-yaml-location> --update-passwords` and completing the subsequent prompts or
31+
deleting the existing `ec.yaml` file.
32+
2533
## Prerequisites
2634

2735
- Docker is required to install a PCG cluster. Refer to the [Docker](https://docs.docker.com/get-docker/) documentation

docs/docs-content/automation/palette-cli/commands/pcg.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,14 @@ The `pcg` command exposes the following subcommand.
2020

2121
- `install` - Install a PCG through an interactive wizard. A container runtime is required to install a PCG cluster.
2222

23+
## Limitations
24+
25+
- Passwords set using Palette CLI version 4.7.1 or earlier are not compatible with Palette CLI version 4.7.2 or later.
26+
As a result, users cannot use configuration files created using version 4.7.1 or earlier to perform Palette CLI
27+
operations after upgrading to version 4.7.2 or later. Users must update their password by either running the command
28+
`palette pcg install --config-file <pcg-yaml-location> --update-passwords` and completing the subsequent prompts or
29+
deleting the existing `pcg.yaml` file.
30+
2331
## Prerequisites
2432

2533
- Docker is required to install a PCG cluster. Refer to the [Docker](https://docs.docker.com/get-docker/) documentation

docs/docs-content/automation/palette-cli/install-palette-cli.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,13 @@ The Palette CLI is available for the following operating systems and architectur
1919
| -------------------- | ---------------- |
2020
| Linux | amd64 |
2121

22+
## Limitations
23+
24+
- Passwords set using Palette CLI version 4.7.1 or earlier are not compatible with Palette CLI version 4.7.2 or later.
25+
As a result, users cannot use configuration files created using version 4.7.1 or earlier to perform Palette CLI
26+
operations after upgrading to version 4.7.2 or later. Users must update their password by either running the command
27+
`palette login --api-key <key>` and completing the subsequent prompts or deleting the existing `palette.yaml` file.
28+
2229
## Prerequisites
2330

2431
- A Palette account. Click [here](https://console.spectrocloud.com/) to create a Palette account.

docs/docs-content/release-notes/release-notes.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,15 @@ tags: ["release-notes"]
2424
- The `spec.jsonCredentialsFileUid` field in API requests is no longer available. Users who create GCP cloud accounts
2525
using the API should use the `spec.jsonCredentials` field to supply their credentials in JSON format. Refer to the
2626
[API documentation](/api/introduction) for further details.
27+
- The previous encryption library used in the [Palette CLI](../automation/palette-cli/palette-cli.md) has been
28+
deprecated. As a result, users cannot use their existing configuration files to perform operations after upgrading to
29+
Palette CLI version 4.7.2 or later. Users must update their passwords by either running the applicable commands and
30+
following the subsequent prompts or deleting the respective configuration files:
31+
- [Palette CLI](../automation/palette-cli/install-palette-cli.md) (`palette.yaml`) - `palette login --api-key <key>`
32+
- [Enterprise Cluster (EC)](../automation/palette-cli/commands/ec.md) (`ec.yaml`) -
33+
`palette ec install --config-file <ec-yaml-location> --update-passwords`
34+
- [Private Cloud Gateway (PGC)](../automation/palette-cli/commands/pcg.md) (`pcg.yaml`) -
35+
`palette pcg install --config-file <pcg-yaml-location> --update-passwords`
2736

2837
#### Features
2938

0 commit comments

Comments
 (0)