Skip to content

Logging: merge changes from main #204

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.

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 12 commits into from
Apr 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions docs/stackit_postgresflex_instance_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ stackit postgresflex instance create [flags]

```
Create a PostgreSQL Flex instance with name "my-instance", ACL 0.0.0.0/0 (open access) and specify flavor by CPU and RAM. Other parameters are set to default values
$ stackit postgresflex instance create --name my-instance --cpu 1 --ram 4 --acl 0.0.0.0/0
$ stackit postgresflex instance create --name my-instance --cpu 2 --ram 4 --acl 0.0.0.0/0

Create a PostgreSQL Flex instance with name "my-instance", ACL 0.0.0.0/0 (open access) and specify flavor by ID. Other parameters are set to default values
$ stackit postgresflex instance create --name my-instance --flavor-id xxx --acl 0.0.0.0/0

Create a PostgreSQL Flex instance with name "my-instance", allow access to a specific range of IP addresses, specify flavor by CPU and RAM and set storage size to 20 GB. Other parameters are set to default values
$ stackit postgresflex instance create --name my-instance --cpu 1 --ram 4 --acl 1.2.3.0/24 --storage-size 20
$ stackit postgresflex instance create --name my-instance --cpu 2 --ram 4 --acl 1.2.3.0/24 --storage-size 20
```

### Options
Expand Down
8 changes: 7 additions & 1 deletion docs/stackit_postgresflex_instance_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ Deletes a PostgreSQL Flex instance
### Synopsis

Deletes a PostgreSQL Flex instance.
By default, instances will be kept in a delayed deleted state for 7 days before being permanently deleted.
Use the --force flag to force the immediate deletion of a delayed deleted instance.

```
stackit postgresflex instance delete INSTANCE_ID [flags]
Expand All @@ -15,12 +17,16 @@ stackit postgresflex instance delete INSTANCE_ID [flags]
```
Delete a PostgreSQL Flex instance with ID "xxx"
$ stackit postgresflex instance delete xxx

Force the deletion of a delayed deleted PostgreSQL Flex instance with ID "xxx"
$ stackit postgresflex instance delete xxx --force
```

### Options

```
-h, --help Help for "stackit postgresflex instance delete"
-f, --force Force deletion of a delayed deleted instance
-h, --help Help for "stackit postgresflex instance delete"
```

### Options inherited from parent commands
Expand Down
2 changes: 1 addition & 1 deletion docs/stackit_project_describe.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ stackit project describe [flags]
$ stackit project describe

Get the details of a STACKIT project by explicitly providing the project ID
$ stackit project describe --project-id xxx
$ stackit project describe xxx

Get the details of the configured STACKIT project, including details of the parent resources
$ stackit project describe --include-parents
Expand Down
3 changes: 3 additions & 0 deletions docs/stackit_project_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ stackit project list [flags]
### Examples

```
List all STACKIT projects that the authenticated user or service account is a member of
$ stackit project list

List all STACKIT projects that are children of a specific parent
$ stackit project list --parent-id xxx

Expand Down
6 changes: 3 additions & 3 deletions docs/stackit_project_member_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ stackit project member list [flags]

```
List all members of a project
$ stackit project role list --project-id xxx
$ stackit project member list --project-id xxx

List all members of a project, sorted by role
$ stackit project role list --project-id xxx --sort-by role
$ stackit project member list --project-id xxx --sort-by role

List up to 10 members of a project
$ stackit project role list --project-id xxx --limit 10
$ stackit project member list --project-id xxx --limit 10
```

### Options
Expand Down
1 change: 1 addition & 0 deletions docs/stackit_ske.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,6 @@ stackit ske [flags]
* [stackit ske describe](./stackit_ske_describe.md) - Shows overall details regarding SKE
* [stackit ske disable](./stackit_ske_disable.md) - Disables SKE for a project
* [stackit ske enable](./stackit_ske_enable.md) - Enables SKE for a project
* [stackit ske kubeconfig](./stackit_ske_kubeconfig.md) - Provides functionality for SKE kubeconfig
* [stackit ske options](./stackit_ske_options.md) - Lists SKE provider options

4 changes: 2 additions & 2 deletions docs/stackit_ske_credentials.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,6 @@ stackit ske credentials [flags]
### SEE ALSO

* [stackit ske](./stackit_ske.md) - Provides functionality for SKE
* [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 complete-rotation](./stackit_ske_credentials_complete-rotation.md) - Completes the rotation of the 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

54 changes: 54 additions & 0 deletions docs/stackit_ske_credentials_complete-rotation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
## stackit ske credentials complete-rotation

Completes the rotation of the credentials associated to a SKE cluster

### Synopsis

Completes the rotation of the credentials associated to a STACKIT Kubernetes Engine (SKE) cluster.

This is step 2 of a 2-step process to rotate all SKE cluster credentials. Tasks accomplished in this phase include:
- The old certification authority will be dropped from the package.
- The old signing key for the service account will be dropped from the bundle.
To ensure continued access to the Kubernetes cluster, please update your kubeconfig with the new credentials:
$ stackit ske kubeconfig create my-cluster

If you haven't, please start the process by running:
$ stackit ske credentials start-rotation my-cluster
For more information, visit: https://docs.stackit.cloud/stackit/en/how-to-rotate-ske-credentials-200016334.html

```
stackit ske credentials complete-rotation CLUSTER_NAME [flags]
```

### Examples

```
Complete the rotation of the credentials associated to the SKE cluster with name "my-cluster"
$ stackit ske credentials complete-rotation my-cluster

Flow of the 2-step process to rotate all SKE cluster credentials, including generating a new kubeconfig file
$ stackit ske credentials start-rotation my-cluster
$ stackit ske kubeconfig create my-cluster
$ stackit ske credentials complete-rotation my-cluster
```

### Options

```
-h, --help Help for "stackit ske credentials complete-rotation"
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, one of ["json" "pretty"]
-p, --project-id string Project ID
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit ske credentials](./stackit_ske_credentials.md) - Provides functionality for SKE credentials

42 changes: 0 additions & 42 deletions docs/stackit_ske_credentials_describe.md

This file was deleted.

39 changes: 0 additions & 39 deletions docs/stackit_ske_credentials_rotate.md

This file was deleted.

58 changes: 58 additions & 0 deletions docs/stackit_ske_credentials_start-rotation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
## stackit ske credentials start-rotation

Starts the rotation of the credentials associated to a SKE cluster

### Synopsis

Starts the rotation of the credentials associated to a STACKIT Kubernetes Engine (SKE) cluster.

This is step 1 of a 2-step process to rotate all SKE cluster credentials. Tasks accomplished in this phase include:
- Rolling recreation of all worker nodes
- A new Certificate Authority (CA) will be established and incorporated into the existing CA bundle.
- A new etcd encryption key is generated and added to the Certificate Authority (CA) bundle.
- A new signing key will be generated for the service account and added to the Certificate Authority (CA) bundle.
- The kube-apiserver will rewrite all secrets in the cluster, encrypting them with the new encryption key.
The old CA, encryption key and signing key will be retained until the rotation is completed.

After completing the rotation of credentials, you can generate a new kubeconfig file by running:
$ stackit ske kubeconfig create my-cluster
Complete the rotation by running:
$ stackit ske credentials complete-rotation my-cluster
For more information, visit: https://docs.stackit.cloud/stackit/en/how-to-rotate-ske-credentials-200016334.html

```
stackit ske credentials start-rotation CLUSTER_NAME [flags]
```

### Examples

```
Start the rotation of the credentials associated to the SKE cluster with name "my-cluster"
$ stackit ske credentials start-rotation my-cluster

Flow of the 2-step process to rotate all SKE cluster credentials, including generating a new kubeconfig file
$ stackit ske credentials start-rotation my-cluster
$ stackit ske kubeconfig create my-cluster
$ stackit ske credentials complete-rotation my-cluster
```

### Options

```
-h, --help Help for "stackit ske credentials start-rotation"
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, one of ["json" "pretty"]
-p, --project-id string Project ID
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit ske credentials](./stackit_ske_credentials.md) - Provides functionality for SKE credentials

33 changes: 33 additions & 0 deletions docs/stackit_ske_kubeconfig.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
## stackit ske kubeconfig

Provides functionality for SKE kubeconfig

### Synopsis

Provides functionality for STACKIT Kubernetes Engine (SKE) kubeconfig.

```
stackit ske kubeconfig [flags]
```

### Options

```
-h, --help Help for "stackit ske kubeconfig"
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, one of ["json" "pretty"]
-p, --project-id string Project ID
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit ske](./stackit_ske.md) - Provides functionality for SKE
* [stackit ske kubeconfig create](./stackit_ske_kubeconfig_create.md) - Creates a kubeconfig for an SKE cluster

55 changes: 55 additions & 0 deletions docs/stackit_ske_kubeconfig_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
## stackit ske kubeconfig create

Creates a kubeconfig for an SKE cluster

### Synopsis

Creates a kubeconfig for a STACKIT Kubernetes Engine (SKE) cluster.

By default the kubeconfig is created in the .kube folder, in the user's home directory. The kubeconfig file will be overwritten if it already exists.
You can override this behavior by specifying a custom filepath with the --filepath flag.
An expiration time can be set for the kubeconfig. The expiration time is set in seconds(s), minutes(m), hours(h), days(d) or months(M). Default is 1h.
Note that the format is <value><unit>, e.g. 30d for 30 days and you can't combine units.

```
stackit ske kubeconfig create CLUSTER_NAME [flags]
```

### Examples

```
Create a kubeconfig for the SKE cluster with name "my-cluster"
$ stackit ske kubeconfig create my-cluster

Create a kubeconfig for the SKE cluster with name "my-cluster" and set the expiration time to 30 days
$ stackit ske kubeconfig create my-cluster --expiration 30d

Create a kubeconfig for the SKE cluster with name "my-cluster" and set the expiration time to 2 months
$ stackit ske kubeconfig create my-cluster --expiration 2M

Create a kubeconfig for the SKE cluster with name "my-cluster" in a custom filepath
$ stackit ske kubeconfig create my-cluster --filepath /path/to/config
```

### Options

```
-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 as 'config' in the .kube folder, in the user's home directory.
-h, --help Help for "stackit ske kubeconfig create"
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, one of ["json" "pretty"]
-p, --project-id string Project ID
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit ske kubeconfig](./stackit_ske_kubeconfig.md) - Provides functionality for SKE kubeconfig

Loading