Skip to content

Commit 11090ee

Browse files
authored
docs: PLT-1948: Palette CLI Breaking Change Updates (Ubuntu Pro) (#8103)
* Updating breaking change re: ubuntu-pro * Empty commit to trigger Netlify preview * Splitting ubuntu-pro-token flag into separate PR for backporting * Update _partials/palette-cli/credentials-breaking-change.mdx
1 parent 98f611a commit 11090ee

File tree

6 files changed

+26
-47
lines changed

6 files changed

+26
-47
lines changed
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
partial_category: palette-cli
3+
partial_name: credentials-breaking-change
4+
---
5+
6+
Credentials such as Palette API keys, passwords, and Ubuntu Pro tokens set using Palette CLI version 4.7.1 or
7+
earlier are not compatible with Palette CLI version 4.7.2 or later. As a result, users cannot use configuration files
8+
created using version 4.7.1 or earlier to perform Palette CLI operations after upgrading to version 4.7.2 or later.
9+
Refer to our <VersionedLink text="Troubleshooting" url="/troubleshooting/automation#scenario---update-cli-configuration-files-credentials" />
10+
guide for more information.

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,7 @@ The `ec` command exposes the following subcommand.
2424

2525
## Limitations
2626

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.
27+
- <PartialsComponent category="palette-cli" name="credentials-breaking-change" />
3228

3329
## Prerequisites
3430

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,7 @@ The `pcg` command exposes the following subcommand.
2222

2323
## Limitations
2424

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.
25+
- <PartialsComponent category="palette-cli" name="credentials-breaking-change" />
3026

3127
## Prerequisites
3228

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

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,7 @@ The Palette CLI is available for the following operating systems and architectur
2121

2222
## Limitations
2323

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.
24+
- <PartialsComponent category="palette-cli" name="credentials-breaking-change" />
2825

2926
## Prerequisites
3027

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

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,12 @@ tags: ["release-notes"]
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.
2727
- 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`
28+
deprecated. As a result, users cannot use their existing credentials, such as Palette API keys, passwords, and Ubuntu
29+
Pro tokens, to perform operations after upgrading to Palette CLI version 4.7.2 or later. Users must update their
30+
credentials by either running the applicable commands and following the subsequent prompts or deleting the respective
31+
configuration files. Refer to our
32+
[Troubleshooting](../troubleshooting/automation.md#scenario---update-cli-configuration-files-credentials) guide for
33+
more information.
3634

3735
#### Features
3836

docs/docs-content/troubleshooting/automation.md

Lines changed: 7 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,13 @@ Palette API key, passwords, and other credentials in the CLI configuration files
4242
due to a changed encryption passphrase or other reasons, you can update the CLI configuration files by using the
4343
following steps.
4444

45+
:::tip
46+
47+
Alternatively, you can delete the respective `palette.yaml`, `ec.yaml`, or `pcg.yaml` file, and the next time you need
48+
to perform related Palette CLI operations, you will be prompted to re-enter your credentials.
49+
50+
:::
51+
4552
### Debug Steps
4653

4754
1. Log in to the machine where the Palette CLI is installed.
@@ -124,28 +131,3 @@ following steps.
124131
</TabItem>
125132
126133
</Tabs>
127-
128-
6. (Optional) Update any previous Palette TC install configuration file that was created using the previous encryption
129-
passphrase. You can use the `tc install` command with the `--update-passwords` flag to update the passwords in the
130-
configuration. Replace `/path/to/tc.yaml` with the path to the desired TC configuration file. If you are using
131-
Ubuntu Pro, pass in the token using the `--ubuntu-pro-token` flag.
132-
133-
<!-- prettier-ignore -->
134-
<Tabs>
135-
<TabItem label="Ubuntu Pro Token" value="token">
136-
137-
```shell
138-
palette tc install --config-file /path/to/tc.yaml --update-passwords --ubuntu-pro-token *************
139-
```
140-
141-
</TabItem>
142-
<!-- prettier-ignore -->
143-
<TabItem label="No Ubuntu Pro Token" value="no-token">
144-
145-
```shell
146-
palette tc install --config-file /path/to/tc.yaml --update-passwords
147-
```
148-
149-
</TabItem>
150-
151-
</Tabs>

0 commit comments

Comments
 (0)