Skip to content
Open
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
3 changes: 2 additions & 1 deletion docs/stackit_postgresflex.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ stackit postgresflex [flags]

* [stackit](./stackit.md) - Manage STACKIT resources using the command line
* [stackit postgresflex backup](./stackit_postgresflex_backup.md) - Provides functionality for PostgreSQL Flex instance backups
* [stackit postgresflex flavor](./stackit_postgresflex_flavor.md) - Provides functionality for PostgreSQL Flex flavors
* [stackit postgresflex instance](./stackit_postgresflex_instance.md) - Provides functionality for PostgreSQL Flex instances
* [stackit postgresflex options](./stackit_postgresflex_options.md) - Lists PostgreSQL Flex options
* [stackit postgresflex user](./stackit_postgresflex_user.md) - Provides functionality for PostgreSQL Flex users
* [stackit postgresflex version](./stackit_postgresflex_version.md) - Provides functionality for PostgreSQL Flex versions

1 change: 0 additions & 1 deletion docs/stackit_postgresflex_backup.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,5 +32,4 @@ stackit postgresflex backup [flags]
* [stackit postgresflex](./stackit_postgresflex.md) - Provides functionality for PostgreSQL Flex
* [stackit postgresflex backup describe](./stackit_postgresflex_backup_describe.md) - Shows details of a backup for a PostgreSQL Flex instance
* [stackit postgresflex backup list](./stackit_postgresflex_backup_list.md) - Lists all backups which are available for a PostgreSQL Flex instance
* [stackit postgresflex backup update-schedule](./stackit_postgresflex_backup_update-schedule.md) - Updates backup schedule for a PostgreSQL Flex instance

42 changes: 0 additions & 42 deletions docs/stackit_postgresflex_backup_update-schedule.md

This file was deleted.

35 changes: 35 additions & 0 deletions docs/stackit_postgresflex_flavor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
## stackit postgresflex flavor

Provides functionality for PostgreSQL Flex flavors

### Synopsis

Provides functionality for PostgreSQL Flex flavors.

```
stackit postgresflex flavor [flags]
```

### Options

```
-h, --help Help for "stackit postgresflex flavor"
```

### 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, none, yaml])
-p, --project-id string Project ID
--region string Target region for region-specific requests
--verbosity string Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info")
```

### SEE ALSO

* [stackit postgresflex](./stackit_postgresflex.md) - Provides functionality for PostgreSQL Flex
* [stackit postgresflex flavor describe](./stackit_postgresflex_flavor_describe.md) - Show details of a PostgreSQL Flex flavor
* [stackit postgresflex flavor list](./stackit_postgresflex_flavor_list.md) - Lists PostgreSQL Flex flavors

40 changes: 40 additions & 0 deletions docs/stackit_postgresflex_flavor_describe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
## stackit postgresflex flavor describe

Show details of a PostgreSQL Flex flavor

### Synopsis

Show details of a PostgreSQL Flex flavor.

```
stackit postgresflex flavor describe [flags]
```

### Examples

```
Show PostgreSQL Flex flavor details
$ stackit postgresflex flavor describe <FLAVOR_ID>
```

### Options

```
-h, --help Help for "stackit postgresflex flavor describe"
```

### 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, none, yaml])
-p, --project-id string Project ID
--region string Target region for region-specific requests
--verbosity string Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info")
```

### SEE ALSO

* [stackit postgresflex flavor](./stackit_postgresflex_flavor.md) - Provides functionality for PostgreSQL Flex flavors

40 changes: 40 additions & 0 deletions docs/stackit_postgresflex_flavor_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
## stackit postgresflex flavor list

Lists PostgreSQL Flex flavors

### Synopsis

Lists PostgreSQL Flex flavors.

```
stackit postgresflex flavor list [flags]
```

### Examples

```
List PostgreSQL Flex flavor
$ stackit postgresflex flavor list
```

### Options

```
-h, --help Help for "stackit postgresflex flavor list"
```

### 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, none, yaml])
-p, --project-id string Project ID
--region string Target region for region-specific requests
--verbosity string Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info")
```

### SEE ALSO

* [stackit postgresflex flavor](./stackit_postgresflex_flavor.md) - Provides functionality for PostgreSQL Flex flavors

12 changes: 3 additions & 9 deletions docs/stackit_postgresflex_instance_clone.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,16 @@ stackit postgresflex instance clone INSTANCE_ID [flags]

```
Clone a PostgreSQL Flex instance with ID "xxx" from a selected recovery timestamp.
$ stackit postgresflex instance clone xxx --recovery-timestamp 2023-04-17T09:28:00+00:00

Clone a PostgreSQL Flex instance with ID "xxx" from a selected recovery timestamp and specify storage class.
$ stackit postgresflex instance clone xxx --recovery-timestamp 2023-04-17T09:28:00+00:00 --storage-class premium-perf6-stackit

Clone a PostgreSQL Flex instance with ID "xxx" from a selected recovery timestamp and specify storage size.
$ stackit postgresflex instance clone xxx --recovery-timestamp 2023-04-17T09:28:00+00:00 --storage-size 10
$ stackit postgresflex instance clone xxx --recovery-timestamp 2023-04-17T09:28:00+00:00 --storage-size 10 --storage-class premium-perf6-stackit
```

### Options

```
-h, --help Help for "stackit postgresflex instance clone"
--recovery-timestamp string Recovery timestamp for the instance, in a date-time with the layout format YYYY-MM-DDTHH:mm:ss±HH:mm, e.g. 2006-01-02T15:04:05-07:00
--storage-class string Storage class. If not specified, storage class from the existing instance will be used.
--storage-size int Storage size (in GB). If not specified, storage size from the existing instance will be used.
--storage-class string Storage class. If not specified, storage class from the existing instance will be used. This flag will be required after 2027-01-31.
--storage-size int Storage size (in GB). If not specified, storage size from the existing instance will be used. This flag will be required after 2027-01-31.
```

### Options inherited from parent commands
Expand Down
35 changes: 17 additions & 18 deletions docs/stackit_postgresflex_instance_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,30 +13,29 @@ stackit postgresflex instance create [flags]
### Examples

```
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 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).
$ stackit postgresflex instance create --name my-instance --flavor-id xxx --acl 0.0.0.0/0 --storage-size 20 --retention-days 32 --version 17 --backup-schedule "6 6 * * *" --storage-size 10 --storage-class premium-perf2-stackit

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 2 --ram 4 --acl 1.2.3.0/24 --storage-size 20
Create a PostgreSQL Flex instance with name "my-instance", allow access to a specific range of IP addresses.
$ stackit postgresflex instance create --name my-instance --flavor-id xxx --acl 1.2.3.0/24 --storage-size 20 --retention-days 32 --version 17 --backup-schedule "6 6 * * *" --storage-size 10 --storage-class premium-perf2-stackit
```

### Options

```
--acl strings The access control list (ACL). Must contain at least one valid subnet, for instance '0.0.0.0/0' for open access (discouraged), '1.2.3.0/24 for a public IP range of an organization, '1.2.3.4/32' for a single IP range, etc. (default [])
--backup-schedule string Backup schedule (default "0 0 * * *")
--cpu int Number of CPUs
--flavor-id string ID of the flavor
-h, --help Help for "stackit postgresflex instance create"
-n, --name string Instance name
--ram int Amount of RAM (in GB)
--storage-class string Storage class (default "premium-perf2-stackit")
--storage-size int Storage size (in GB) (default 10)
--type string Instance type, (one of: [Replica, Single]) (default "Replica")
--version string PostgreSQL version. Defaults to the latest version available
--acl strings The access control list (ACL). Must contain at least one valid subnet, for instance '0.0.0.0/0' for open access (discouraged), '1.2.3.0/24 for a public IP range of an organization, '1.2.3.4/32' for a single IP range, etc. (default [])
--backup-schedule string Backup schedule. This flag will be required after 2027-01-31.
--encryption-kek-key-id string The key identifier
--encryption-kek-key-version string The key version
--encryption-kek-keyring-id string The keyring identifier
--encryption-service-account string The service account
--flavor-id string ID of the flavor. This flag will be required after 2027-01-31.
-h, --help Help for "stackit postgresflex instance create"
-n, --name string Instance name
--retention-days int32 The days for how long the backup files should be stored before cleaned up (32 to 90). This flag will be required after 2027-01-31.
--storage-class string Storage class. This flag will be required after 2027-01-31.
--storage-size int Storage size (in GB). This flag will be required after 2027-01-31.
--version string PostgreSQL version. Defaults to the latest version available. This flag will be required after 2027-01-31.
```

### Options inherited from parent commands
Expand Down
3 changes: 1 addition & 2 deletions docs/stackit_postgresflex_instance_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,7 @@ stackit postgresflex instance delete INSTANCE_ID [flags]
### Options

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

### Options inherited from parent commands
Expand Down
5 changes: 1 addition & 4 deletions docs/stackit_postgresflex_instance_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,11 @@ stackit postgresflex instance update INSTANCE_ID [flags]
```
--acl strings List of IP networks in CIDR notation which are allowed to access this instance (default [])
--backup-schedule string Backup schedule
--cpu int Number of CPUs
--flavor-id string ID of the flavor
-h, --help Help for "stackit postgresflex instance update"
-n, --name string Instance name
--ram int Amount of RAM (in GB)
--storage-class string Storage class
--retention-days string The days for how long the backup files should be stored before cleaned up (32 to 90).
--storage-size int Storage size (in GB)
--type string Instance type, (one of: [Replica, Single])
--version string Version
```

Expand Down
51 changes: 0 additions & 51 deletions docs/stackit_postgresflex_options.md

This file was deleted.

34 changes: 34 additions & 0 deletions docs/stackit_postgresflex_version.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
## stackit postgresflex version

Provides functionality for PostgreSQL Flex versions

### Synopsis

Provides functionality for PostgreSQL Flex versions.

```
stackit postgresflex version [flags]
```

### Options

```
-h, --help Help for "stackit postgresflex version"
```

### 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, none, yaml])
-p, --project-id string Project ID
--region string Target region for region-specific requests
--verbosity string Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info")
```

### SEE ALSO

* [stackit postgresflex](./stackit_postgresflex.md) - Provides functionality for PostgreSQL Flex
* [stackit postgresflex version list](./stackit_postgresflex_version_list.md) - Lists PostgreSQL Flex versions

Loading
Loading