Skip to content

Merge main into multi-config feature branch #343

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 9 commits into from
May 24, 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
8 changes: 4 additions & 4 deletions docs/stackit.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,19 +27,19 @@ stackit [flags]
### SEE ALSO

* [stackit argus](./stackit_argus.md) - Provides functionality for Argus
* [stackit auth](./stackit_auth.md) - Provides authentication functionality
* [stackit auth](./stackit_auth.md) - Authenticates the STACKIT CLI
* [stackit config](./stackit_config.md) - Provides functionality for CLI configuration options
* [stackit curl](./stackit_curl.md) - Executes an authenticated HTTP request to an endpoint
* [stackit dns](./stackit_dns.md) - Provides functionality for DNS
* [stackit load-balancer](./stackit_load-balancer.md) - Provides functionality for Load Balancer
* [stackit logme](./stackit_logme.md) - Provides functionality for LogMe
* [stackit mariadb](./stackit_mariadb.md) - Provides functionality for MariaDB
* [stackit mongodbflex](./stackit_mongodbflex.md) - Provides functionality for MongoDB Flex
* [stackit object-storage](./stackit_object-storage.md) - Provides functionality regarding Object Storage
* [stackit object-storage](./stackit_object-storage.md) - Provides functionality for Object Storage
* [stackit opensearch](./stackit_opensearch.md) - Provides functionality for OpenSearch
* [stackit organization](./stackit_organization.md) - Provides functionality regarding organizations
* [stackit organization](./stackit_organization.md) - Manages organizations
* [stackit postgresflex](./stackit_postgresflex.md) - Provides functionality for PostgreSQL Flex
* [stackit project](./stackit_project.md) - Provides functionality regarding projects
* [stackit project](./stackit_project.md) - Manages projects
* [stackit rabbitmq](./stackit_rabbitmq.md) - Provides functionality for RabbitMQ
* [stackit redis](./stackit_redis.md) - Provides functionality for Redis
* [stackit secrets-manager](./stackit_secrets-manager.md) - Provides functionality for Secrets Manager
Expand Down
8 changes: 6 additions & 2 deletions docs/stackit_argus_scrape-config_generate-payload.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,23 @@ stackit argus scrape-config generate-payload [flags]

```
Generate a Create payload with default values, and adapt it with custom values for the different configuration options
$ stackit argus scrape-config generate-payload > ./payload.json
$ stackit argus scrape-config generate-payload --file-path ./payload.json
<Modify payload in file, if needed>
$ stackit argus scrape-config create my-config --payload @./payload.json

Generate an Update payload with the values of an existing configuration named "my-config" for Argus instance xxx, and adapt it with custom values for the different configuration options
$ stackit argus scrape-config generate-payload --job-name my-config --instance-id xxx > ./payload.json
$ stackit argus scrape-config generate-payload --job-name my-config --instance-id xxx --file-path ./payload.json
<Modify payload in file>
$ stackit argus scrape-config update my-config --payload @./payload.json

Generate an Update payload with the values of an existing configuration named "my-config" for Argus instance xxx, and preview it in the terminal
$ stackit argus scrape-config generate-payload --job-name my-config --instance-id xxx
```

### Options

```
-f, --file-path string If set, writes the payload to the given file. If unset, writes the payload to the standard output
-h, --help Help for "stackit argus scrape-config generate-payload"
--instance-id string Instance ID
-n, --job-name string If set, generates an update payload with the current state of the given scrape config. If unset, generates a create payload with default values
Expand Down
4 changes: 2 additions & 2 deletions docs/stackit_auth.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## stackit auth

Provides authentication functionality
Authenticates the STACKIT CLI

### Synopsis

Provides authentication functionality.
Authenticates in the STACKIT CLI.

```
stackit auth [flags]
Expand Down
2 changes: 1 addition & 1 deletion docs/stackit_auth_activate-service-account.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,5 +48,5 @@ stackit auth activate-service-account [flags]

### SEE ALSO

* [stackit auth](./stackit_auth.md) - Provides authentication functionality
* [stackit auth](./stackit_auth.md) - Authenticates the STACKIT CLI

2 changes: 1 addition & 1 deletion docs/stackit_auth_login.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,5 @@ stackit auth login [flags]

### SEE ALSO

* [stackit auth](./stackit_auth.md) - Provides authentication functionality
* [stackit auth](./stackit_auth.md) - Authenticates the STACKIT CLI

2 changes: 1 addition & 1 deletion docs/stackit_dns_record-set.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,6 @@ stackit dns record-set [flags]
* [stackit dns record-set create](./stackit_dns_record-set_create.md) - Creates a DNS record set
* [stackit dns record-set delete](./stackit_dns_record-set_delete.md) - Deletes a DNS record set
* [stackit dns record-set describe](./stackit_dns_record-set_describe.md) - Shows details of a DNS record set
* [stackit dns record-set list](./stackit_dns_record-set_list.md) - List DNS record sets
* [stackit dns record-set list](./stackit_dns_record-set_list.md) - Lists DNS record sets
* [stackit dns record-set update](./stackit_dns_record-set_update.md) - Updates a DNS record set

4 changes: 2 additions & 2 deletions docs/stackit_dns_record-set_list.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## stackit dns record-set list

List DNS record sets
Lists DNS record sets

### Synopsis

List DNS record sets. Successfully deleted record sets are not listed by default.
Lists DNS record sets. Successfully deleted record sets are not listed by default.

```
stackit dns record-set list [flags]
Expand Down
2 changes: 1 addition & 1 deletion docs/stackit_dns_zone.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,6 @@ stackit dns zone [flags]
* [stackit dns zone create](./stackit_dns_zone_create.md) - Creates a DNS zone
* [stackit dns zone delete](./stackit_dns_zone_delete.md) - Deletes a DNS zone
* [stackit dns zone describe](./stackit_dns_zone_describe.md) - Shows details of a DNS zone
* [stackit dns zone list](./stackit_dns_zone_list.md) - List DNS zones
* [stackit dns zone list](./stackit_dns_zone_list.md) - Lists DNS zones
* [stackit dns zone update](./stackit_dns_zone_update.md) - Updates a DNS zone

4 changes: 2 additions & 2 deletions docs/stackit_dns_zone_list.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## stackit dns zone list

List DNS zones
Lists DNS zones

### Synopsis

List DNS zones. Successfully deleted zones are not listed by default.
Lists DNS zones. Successfully deleted zones are not listed by default.

```
stackit dns zone list [flags]
Expand Down
12 changes: 8 additions & 4 deletions docs/stackit_load-balancer_generate-payload.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,25 @@ stackit load-balancer generate-payload [flags]

```
Generate a payload, and adapt it with custom values for the different configuration options
$ stackit load-balancer generate-payload > ./payload.json
$ stackit load-balancer generate-payload --file-path ./payload.json
<Modify payload in file, if needed>
$ stackit load-balancer create --payload @./payload.json

Generate a payload with values of an existing load balancer, and adapt it with custom values for the different configuration options
$ stackit load-balancer generate-payload --lb-name xxx > ./payload.json
$ stackit load-balancer generate-payload --lb-name xxx --file-path ./payload.json
<Modify payload in file>
$ stackit load-balancer update xxx --payload @./payload.json

Generate a payload with values of an existing load balancer, and preview it in the terminal
$ stackit load-balancer generate-payload --lb-name xxx
```

### Options

```
-h, --help Help for "stackit load-balancer generate-payload"
-n, --lb-name string If set, generates the payload with the current values of the given load balancer. If unset, generates the payload with empty values
-f, --file-path string If set, writes the payload to the given file. If unset, writes the payload to the standard output
-h, --help Help for "stackit load-balancer generate-payload"
-n, --lb-name string If set, generates the payload with the current values of the given load balancer. If unset, generates the payload with empty values
```

### Options inherited from parent commands
Expand Down
6 changes: 3 additions & 3 deletions docs/stackit_mongodbflex_backup_restore.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ Restores a MongoDB Flex instance from a backup

### Synopsis

Restores a MongoDB Flex instance from a backup of an instance or clones a MongoDB Flex instance from a point-in-time snapshot.
The backup is specified by a backup ID and the point-in-time snapshot is specified by a timestamp.
Restores a MongoDB Flex instance from a backup of an instance or clones a MongoDB Flex instance from a point-in-time backup.
The backup can be specified by a backup ID or a timestamp.
You can specify the instance to which the backup will be applied. If not specified, the backup will be applied to the same instance from which it was taken.

```
Expand All @@ -32,7 +32,7 @@ stackit mongodbflex backup restore [flags]
--backup-instance-id string Instance ID of the target instance to restore the backup to
-h, --help Help for "stackit mongodbflex backup restore"
--instance-id string Instance ID
--timestamp string Timestamp of the snapshot to use as a source for cloning the instance in a date-time with the RFC3339 layout format, e.g. 2024-01-01T00:00:00Z
--timestamp string Timestamp to restore the instance to, in a date-time with the RFC3339 layout format, e.g. 2024-01-01T00:00:00Z
```

### Options inherited from parent commands
Expand Down
12 changes: 6 additions & 6 deletions docs/stackit_mongodbflex_backup_update-schedule.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,20 +19,20 @@ stackit mongodbflex backup update-schedule [flags]
Update the backup schedule of a MongoDB Flex instance with ID "xxx"
$ stackit mongodbflex backup update-schedule --instance-id xxx --schedule '6 6 * * *'

Update the retention days for snapshots of a MongoDB Flex instance with ID "xxx" to 5 days
$ stackit mongodbflex backup update-schedule --instance-id xxx --save-snapshot-days 5
Update the retention days for backups of a MongoDB Flex instance with ID "xxx" to 5 days
$ stackit mongodbflex backup update-schedule --instance-id xxx --store-for-days 5
```

### Options

```
-h, --help Help for "stackit mongodbflex backup update-schedule"
--instance-id string Instance ID
--save-daily-snapshot-days int Number of days to retain daily snapshots. Should be less than or equal to the number of days of the selected weekly or monthly value.
--save-monthly-snapshot-months int Number of months to retain monthly snapshots
--save-snapshot-days int Number of days to retain snapshots. Should be less than or equal to the value of the daily backup.
--save-weekly-snapshot-weeks int Number of weeks to retain weekly snapshots. Should be less than or equal to the number of weeks of the selected monthly value.
--schedule string Backup schedule, in the cron scheduling system format e.g. '0 0 * * *'
--store-daily-backup-days int Number of days to retain daily backups. Should be less than or equal to the number of days of the selected weekly or monthly value.
--store-for-days int Number of days to retain backups. Should be less than or equal to the value of the daily backup.
--store-monthly-backups-months int Number of months to retain monthly backups
--store-weekly-backup-weeks int Number of weeks to retain weekly backups. Should be less than or equal to the number of weeks of the selected monthly value.
```

### Options inherited from parent commands
Expand Down
4 changes: 2 additions & 2 deletions docs/stackit_object-storage.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## stackit object-storage

Provides functionality regarding Object Storage
Provides functionality for Object Storage

### Synopsis

Provides functionality regarding Object Storage.
Provides functionality for Object Storage.

```
stackit object-storage [flags]
Expand Down
2 changes: 1 addition & 1 deletion docs/stackit_object-storage_bucket.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ stackit object-storage bucket [flags]

### SEE ALSO

* [stackit object-storage](./stackit_object-storage.md) - Provides functionality regarding Object Storage
* [stackit object-storage](./stackit_object-storage.md) - Provides functionality for Object Storage
* [stackit object-storage bucket create](./stackit_object-storage_bucket_create.md) - Creates an Object Storage bucket
* [stackit object-storage bucket delete](./stackit_object-storage_bucket_delete.md) - Deletes an Object Storage bucket
* [stackit object-storage bucket describe](./stackit_object-storage_bucket_describe.md) - Shows details of an Object Storage bucket
Expand Down
2 changes: 1 addition & 1 deletion docs/stackit_object-storage_credentials-group.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ stackit object-storage credentials-group [flags]

### SEE ALSO

* [stackit object-storage](./stackit_object-storage.md) - Provides functionality regarding Object Storage
* [stackit object-storage](./stackit_object-storage.md) - Provides functionality for Object Storage
* [stackit object-storage credentials-group create](./stackit_object-storage_credentials-group_create.md) - Creates a credentials group to hold Object Storage access credentials
* [stackit object-storage credentials-group delete](./stackit_object-storage_credentials-group_delete.md) - Deletes a credentials group that holds Object Storage access credentials
* [stackit object-storage credentials-group list](./stackit_object-storage_credentials-group_list.md) - Lists all credentials groups that hold Object Storage access credentials
Expand Down
2 changes: 1 addition & 1 deletion docs/stackit_object-storage_credentials.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ stackit object-storage credentials [flags]

### SEE ALSO

* [stackit object-storage](./stackit_object-storage.md) - Provides functionality regarding Object Storage
* [stackit object-storage](./stackit_object-storage.md) - Provides functionality for Object Storage
* [stackit object-storage credentials create](./stackit_object-storage_credentials_create.md) - Creates credentials for an Object Storage credentials group
* [stackit object-storage credentials delete](./stackit_object-storage_credentials_delete.md) - Deletes credentials of an Object Storage credentials group
* [stackit object-storage credentials list](./stackit_object-storage_credentials_list.md) - Lists all credentials for an Object Storage credentials group
Expand Down
2 changes: 1 addition & 1 deletion docs/stackit_object-storage_disable.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,5 @@ stackit object-storage disable [flags]

### SEE ALSO

* [stackit object-storage](./stackit_object-storage.md) - Provides functionality regarding Object Storage
* [stackit object-storage](./stackit_object-storage.md) - Provides functionality for Object Storage

2 changes: 1 addition & 1 deletion docs/stackit_object-storage_enable.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,5 @@ stackit object-storage enable [flags]

### SEE ALSO

* [stackit object-storage](./stackit_object-storage.md) - Provides functionality regarding Object Storage
* [stackit object-storage](./stackit_object-storage.md) - Provides functionality for Object Storage

8 changes: 4 additions & 4 deletions docs/stackit_organization.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## stackit organization

Provides functionality regarding organizations
Manages organizations

### Synopsis

Provides functionality regarding organizations.
Manages organizations.
An active STACKIT organization is the root element of the resource hierarchy and a prerequisite to use any STACKIT Cloud Resource / Service.

```
Expand All @@ -30,6 +30,6 @@ stackit organization [flags]
### SEE ALSO

* [stackit](./stackit.md) - Manage STACKIT resources using the command line
* [stackit organization member](./stackit_organization_member.md) - Provides functionality regarding organization members
* [stackit organization role](./stackit_organization_role.md) - Provides functionality regarding organization roles
* [stackit organization member](./stackit_organization_member.md) - Manages organization members
* [stackit organization role](./stackit_organization_role.md) - Manages organization roles

6 changes: 3 additions & 3 deletions docs/stackit_organization_member.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## stackit organization member

Provides functionality regarding organization members
Manages organization members

### Synopsis

Provides functionality regarding organization members.
Manages organization members.

```
stackit organization member [flags]
Expand All @@ -28,7 +28,7 @@ stackit organization member [flags]

### SEE ALSO

* [stackit organization](./stackit_organization.md) - Provides functionality regarding organizations
* [stackit organization](./stackit_organization.md) - Manages organizations
* [stackit organization member add](./stackit_organization_member_add.md) - Adds a member to an organization
* [stackit organization member list](./stackit_organization_member_list.md) - Lists members of an organization
* [stackit organization member remove](./stackit_organization_member_remove.md) - Removes a member from an organization
Expand Down
2 changes: 1 addition & 1 deletion docs/stackit_organization_member_add.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,5 +41,5 @@ stackit organization member add SUBJECT [flags]

### SEE ALSO

* [stackit organization member](./stackit_organization_member.md) - Provides functionality regarding organization members
* [stackit organization member](./stackit_organization_member.md) - Manages organization members

2 changes: 1 addition & 1 deletion docs/stackit_organization_member_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,5 @@ stackit organization member list [flags]

### SEE ALSO

* [stackit organization member](./stackit_organization_member.md) - Provides functionality regarding organization members
* [stackit organization member](./stackit_organization_member.md) - Manages organization members

2 changes: 1 addition & 1 deletion docs/stackit_organization_member_remove.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,5 +43,5 @@ stackit organization member remove SUBJECT [flags]

### SEE ALSO

* [stackit organization member](./stackit_organization_member.md) - Provides functionality regarding organization members
* [stackit organization member](./stackit_organization_member.md) - Manages organization members

6 changes: 3 additions & 3 deletions docs/stackit_organization_role.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## stackit organization role

Provides functionality regarding organization roles
Manages organization roles

### Synopsis

Provides functionality regarding organization roles.
Manages organization roles.

```
stackit organization role [flags]
Expand All @@ -28,6 +28,6 @@ stackit organization role [flags]

### SEE ALSO

* [stackit organization](./stackit_organization.md) - Provides functionality regarding organizations
* [stackit organization](./stackit_organization.md) - Manages organizations
* [stackit organization role list](./stackit_organization_role_list.md) - Lists roles and permissions of an organization

2 changes: 1 addition & 1 deletion docs/stackit_organization_role_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,5 +43,5 @@ stackit organization role list [flags]

### SEE ALSO

* [stackit organization role](./stackit_organization_role.md) - Provides functionality regarding organization roles
* [stackit organization role](./stackit_organization_role.md) - Manages organization roles

8 changes: 4 additions & 4 deletions docs/stackit_project.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## stackit project

Provides functionality regarding projects
Manages projects

### Synopsis

Provides functionality regarding projects.
Provides functionality for projects.
A project is a container for resources which is the service that you can purchase from STACKIT.

```
Expand Down Expand Up @@ -34,7 +34,7 @@ stackit project [flags]
* [stackit project delete](./stackit_project_delete.md) - Deletes a STACKIT project
* [stackit project describe](./stackit_project_describe.md) - Shows details of a STACKIT project
* [stackit project list](./stackit_project_list.md) - Lists STACKIT projects
* [stackit project member](./stackit_project_member.md) - Provides functionality regarding project members
* [stackit project role](./stackit_project_role.md) - Provides functionality regarding project roles
* [stackit project member](./stackit_project_member.md) - Manages project members
* [stackit project role](./stackit_project_role.md) - Manages project roles
* [stackit project update](./stackit_project_update.md) - Updates a STACKIT project

2 changes: 1 addition & 1 deletion docs/stackit_project_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,5 +41,5 @@ stackit project create [flags]

### SEE ALSO

* [stackit project](./stackit_project.md) - Provides functionality regarding projects
* [stackit project](./stackit_project.md) - Manages projects

2 changes: 1 addition & 1 deletion docs/stackit_project_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,5 +38,5 @@ stackit project delete [flags]

### SEE ALSO

* [stackit project](./stackit_project.md) - Provides functionality regarding projects
* [stackit project](./stackit_project.md) - Manages projects

2 changes: 1 addition & 1 deletion docs/stackit_project_describe.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,5 +42,5 @@ stackit project describe [flags]

### SEE ALSO

* [stackit project](./stackit_project.md) - Provides functionality regarding projects
* [stackit project](./stackit_project.md) - Manages projects

2 changes: 1 addition & 1 deletion docs/stackit_project_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,5 +50,5 @@ stackit project list [flags]

### SEE ALSO

* [stackit project](./stackit_project.md) - Provides functionality regarding projects
* [stackit project](./stackit_project.md) - Manages projects

Loading