Skip to content
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
1 change: 1 addition & 0 deletions docs/stackit.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ stackit [flags]
* [stackit mongodbflex](./stackit_mongodbflex.md) - Provides functionality for MongoDB Flex
* [stackit opensearch](./stackit_opensearch.md) - Provides functionality for OpenSearch
* [stackit organization](./stackit_organization.md) - Provides functionality regarding organizations
* [stackit postgresflex](./stackit_postgresflex.md) - Provides functionality for PostgreSQL Flex
* [stackit project](./stackit_project.md) - Provides functionality regarding projects
* [stackit rabbitmq](./stackit_rabbitmq.md) - Provides functionality for RabbitMQ
* [stackit redis](./stackit_redis.md) - Provides functionality for Redis
Expand Down
34 changes: 34 additions & 0 deletions docs/stackit_postgresflex.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
## stackit postgresflex

Provides functionality for PostgreSQL Flex

### Synopsis

Provides functionality for PostgreSQL Flex.

```
stackit postgresflex [flags]
```

### Options

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

### 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
```

### SEE ALSO

* [stackit](./stackit.md) - Manage STACKIT resources using the command line
* [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

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

Provides functionality for PostgreSQL Flex instances

### Synopsis

Provides functionality for PostgreSQL Flex instances.

```
stackit postgresflex instance [flags]
```

### Options

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

### 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
```

### SEE ALSO

* [stackit postgresflex](./stackit_postgresflex.md) - Provides functionality for PostgreSQL Flex
* [stackit postgresflex instance create](./stackit_postgresflex_instance_create.md) - Creates a PostgreSQL Flex instance
* [stackit postgresflex instance delete](./stackit_postgresflex_instance_delete.md) - Deletes a PostgreSQL Flex instance
* [stackit postgresflex instance describe](./stackit_postgresflex_instance_describe.md) - Shows details of a PostgreSQL Flex instance
* [stackit postgresflex instance list](./stackit_postgresflex_instance_list.md) - Lists all PostgreSQL Flex instances
* [stackit postgresflex instance update](./stackit_postgresflex_instance_update.md) - Updates a PostgreSQL Flex instance

54 changes: 54 additions & 0 deletions docs/stackit_postgresflex_instance_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
## stackit postgresflex instance create

Creates a PostgreSQL Flex instance

### Synopsis

Creates a PostgreSQL Flex instance.

```
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 1 --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
```

### 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
```

### 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
```

### SEE ALSO

* [stackit postgresflex instance](./stackit_postgresflex_instance.md) - Provides functionality for PostgreSQL Flex instances

38 changes: 38 additions & 0 deletions docs/stackit_postgresflex_instance_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## stackit postgresflex instance delete

Deletes a PostgreSQL Flex instance

### Synopsis

Deletes a PostgreSQL Flex instance.

```
stackit postgresflex instance delete INSTANCE_ID [flags]
```

### Examples

```
Delete a PostgreSQL Flex instance with ID "xxx"
$ stackit postgresflex instance delete xxx
```

### Options

```
-h, --help Help for "stackit postgresflex instance delete"
```

### 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
```

### SEE ALSO

* [stackit postgresflex instance](./stackit_postgresflex_instance.md) - Provides functionality for PostgreSQL Flex instances

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

Shows details of a PostgreSQL Flex instance

### Synopsis

Shows details of a PostgreSQL Flex instance.

```
stackit postgresflex instance describe INSTANCE_ID [flags]
```

### Examples

```
Get details of a PostgreSQL Flex instance with ID "xxx"
$ stackit postgresflex instance describe xxx

Get details of a PostgreSQL Flex instance with ID "xxx" in a table format
$ stackit postgresflex instance describe xxx --output-format pretty
```

### Options

```
-h, --help Help for "stackit postgresflex instance 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"]
-p, --project-id string Project ID
```

### SEE ALSO

* [stackit postgresflex instance](./stackit_postgresflex_instance.md) - Provides functionality for PostgreSQL Flex instances

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

Lists all PostgreSQL Flex instances

### Synopsis

Lists all PostgreSQL Flex instances.

```
stackit postgresflex instance list [flags]
```

### Examples

```
List all PostgreSQL Flex instances
$ stackit postgresflex instance list

List all PostgreSQL Flex instances in JSON format
$ stackit postgresflex instance list --output-format json

List up to 10 PostgreSQL Flex instances
$ stackit postgresflex instance list --limit 10
```

### Options

```
-h, --help Help for "stackit postgresflex instance list"
--limit int Maximum number of entries to 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"]
-p, --project-id string Project ID
```

### SEE ALSO

* [stackit postgresflex instance](./stackit_postgresflex_instance.md) - Provides functionality for PostgreSQL Flex instances

51 changes: 51 additions & 0 deletions docs/stackit_postgresflex_instance_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
## stackit postgresflex instance update

Updates a PostgreSQL Flex instance

### Synopsis

Updates a PostgreSQL Flex instance.

```
stackit postgresflex instance update INSTANCE_ID [flags]
```

### Examples

```
Update the name of a PostgreSQL Flex instance
$ stackit postgresflex instance update xxx --name my-new-name

Update the version of a PostgreSQL Flex instance
$ stackit postgresflex instance update xxx --version 6.0
```

### Options

```
--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
--storage-size int Storage size (in GB)
--type string Instance type, one of ["Replica" "Single"]
--version string 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"]
-p, --project-id string Project ID
```

### SEE ALSO

* [stackit postgresflex instance](./stackit_postgresflex_instance.md) - Provides functionality for PostgreSQL Flex instances

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

Lists PostgreSQL Flex options

### Synopsis

Lists PostgreSQL Flex options (flavors, versions and storages for a given flavor)
Pass one or more flags to filter what categories are shown.

```
stackit postgresflex options [flags]
```

### Examples

```
List PostgreSQL Flex flavors options
$ stackit postgresflex options --flavors

List PostgreSQL Flex available versions
$ stackit postgresflex options --versions

List PostgreSQL Flex storage options for a given flavor. The flavor ID can be retrieved by running "$ stackit postgresflex options --flavors"
$ stackit postgresflex options --storages --flavor-id <FLAVOR_ID>
```

### Options

```
--flavor-id string The flavor ID to show storages for. Only relevant when "--storages" is passed
--flavors Lists supported flavors
-h, --help Help for "stackit postgresflex options"
--storages Lists supported storages for a given flavor
--versions Lists supported versions
```

### 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
```

### SEE ALSO

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

Loading