Skip to content

SKE Credentials Rotation: deprecate old commands #191

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 3, 2024
Merged

SKE Credentials Rotation: deprecate old commands #191

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2bfd134
deprecate describe and rotate commands
DiogoFerrao Apr 2, 2024
917805f
improve deprecation messages, add docs
DiogoFerrao Apr 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions docs/stackit_ske_credentials.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,5 @@ stackit ske credentials [flags]

* [stackit ske](./stackit_ske.md) - Provides functionality for SKE
* [stackit ske credentials complete-rotation](./stackit_ske_credentials_complete-rotation.md) - Completes the rotation of the credentials associated to a SKE cluster
* [stackit ske credentials describe](./stackit_ske_credentials_describe.md) - Shows details of the credentials associated to a SKE cluster
* [stackit ske credentials rotate](./stackit_ske_credentials_rotate.md) - Rotates credentials associated to a SKE cluster
* [stackit ske credentials start-rotation](./stackit_ske_credentials_start-rotation.md) - Starts the rotation of the credentials associated to a SKE cluster

41 changes: 0 additions & 41 deletions docs/stackit_ske_credentials_describe.md
View file
Open in desktop

This file was deleted.

38 changes: 0 additions & 38 deletions docs/stackit_ske_credentials_rotate.md
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion docs/stackit_ske_kubeconfig_create.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ stackit ske kubeconfig create CLUSTER_NAME [flags]

```
-e, --expiration string Expiration time for the kubeconfig in seconds(s), minutes(m), hours(h), days(d) or months(M). Example: 30d. By default, expiration time is 1h
--filepath string Path to create the kubeconfig file. By default, the kubeconfig is created in the .kube folder, in the user's home directory.
--filepath string Path to create the kubeconfig file. By default, the kubeconfig is created as 'config' in the .kube folder, in the user's home directory.
-h, --help Help for "stackit ske kubeconfig create"
```

Expand Down
6 changes: 6 additions & 0 deletions internal/cmd/ske/credentials/describe/describe.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,12 @@ func NewCmd() *cobra.Command {
Short: "Shows details of the credentials associated to a SKE cluster",
Long: "Shows details of the credentials associated to a STACKIT Kubernetes Engine (SKE) cluster",
Args: args.SingleArg(clusterNameArg, nil),
Deprecated: fmt.Sprintf("%s\n%s\n%s\n%s\n",
"and will be removed in a future release.",
"Please use the following command to obtain a kubeconfig file instead:",
" $ stackit ske kubeconfig create my-cluster",
"For more information, visit: https://docs.stackit.cloud/stackit/en/how-to-rotate-ske-credentials-200016334.html",
),
Example: examples.Build(
examples.NewExample(
`Get details of the credentials associated to the SKE cluster with name "my-cluster"`,
Expand Down
7 changes: 7 additions & 0 deletions internal/cmd/ske/credentials/rotate/rotate.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,13 @@ func NewCmd() *cobra.Command {
Short: "Rotates credentials associated to a SKE cluster",
Long: "Rotates credentials associated to a STACKIT Kubernetes Engine (SKE) cluster. The old credentials will be invalid after the operation.",
Args: args.SingleArg(clusterNameArg, nil),
Deprecated: fmt.Sprintf("%s\n%s\n%s\n%s\n%s\n",
"and will be removed in a future release.",
"Please use the 2-step credential rotation flow instead, by running the commands:",
" $ stackit ske credentials start-rotation my-cluster",
" $ stackit ske credentials complete-rotation my-cluster",
"For more information, visit: https://docs.stackit.cloud/stackit/en/how-to-rotate-ske-credentials-200016334.html",
),
Example: examples.Build(
examples.NewExample(
`Rotate credentials associated to the SKE cluster with name "my-cluster"`,
Expand Down