Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
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_alpha.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,5 +41,6 @@ stackit alpha [flags]
### SEE ALSO

* [stackit](./stackit.md) - Manage STACKIT resources using the command line
* [stackit alpha sca](./stackit_alpha_sca.md) - Provides functionality for SCA
* [stackit alpha vpc](./stackit_alpha_vpc.md) - Manages vpcs

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

Provides functionality for SCA

### Synopsis

Provides functionality for STACKIT Container Applications (SCA).

```
stackit alpha sca [flags]
```

### Options

```
-h, --help Help for "stackit alpha sca"
```

### 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 alpha](./stackit_alpha.md) - Contains alpha STACKIT CLI commands
* [stackit alpha sca application](./stackit_alpha_sca_application.md) - Provides functionality for SCA applications

41 changes: 41 additions & 0 deletions docs/stackit_alpha_sca_application.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
## stackit alpha sca application

Provides functionality for SCA applications

### Synopsis

Provides functionality for STACKIT Container Applications (SCA) cluster.

```
stackit alpha sca application [flags]
```

### Options

```
-h, --help Help for "stackit alpha sca application"
```

### 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 alpha sca](./stackit_alpha_sca.md) - Provides functionality for SCA
* [stackit alpha sca application create](./stackit_alpha_sca_application_create.md) - Create a SCA application
* [stackit alpha sca application create-from-payload](./stackit_alpha_sca_application_create-from-payload.md) - Create a SCA application from payload
* [stackit alpha sca application delete](./stackit_alpha_sca_application_delete.md) - Delete a SCA application
* [stackit alpha sca application describe](./stackit_alpha_sca_application_describe.md) - Show details of a SCA application
* [stackit alpha sca application generate-payload](./stackit_alpha_sca_application_generate-payload.md) - Generates a payload to create/update SCA applications
* [stackit alpha sca application list](./stackit_alpha_sca_application_list.md) - Lists all SCA applications
* [stackit alpha sca application update](./stackit_alpha_sca_application_update.md) - Update a SCA application
* [stackit alpha sca application update-from-payload](./stackit_alpha_sca_application_update-from-payload.md) - Update a SCA application from payload

53 changes: 53 additions & 0 deletions docs/stackit_alpha_sca_application_create-from-payload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
## stackit alpha sca application create-from-payload

Create a SCA application from payload

### Synopsis

Create a STACKIT Container Applications (SCA) application from payload.
The payload can be provided as a JSON string or a file path prefixed with "@".
See https://docs.api.stackit.cloud/documentation/sca/version/v1alpha#tag/Applications/operation/Applications_CreateApplication for information regarding the payload structure.

```
stackit alpha sca application create-from-payload [flags]
```

### Examples

```
Create a SCA application using an API payload sourced from the file "./payload.json"
$ stackit alpha sca cluster create-from-payload --name application-name --payload @./payload.json

Create a SCA application using an API payload provided as a JSON string
$ stackit alpha sca cluster create-from-payload --name application-name --payload "{...}"

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

### Options

```
--environment-id string Environment ID (uses default environment if not set)
-h, --help Help for "stackit alpha sca application create-from-payload"
--name string Application display name
--payload string Request payload (JSON). Can be a string or a file path, if prefixed with "@" (example: @./payload.json).
```

### 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 alpha sca application](./stackit_alpha_sca_application.md) - Provides functionality for SCA applications

70 changes: 70 additions & 0 deletions docs/stackit_alpha_sca_application_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
## stackit alpha sca application create

Create a SCA application

### Synopsis

Create a STACKIT Container Applications (SCA) application.

```
stackit alpha sca application create [flags]
```

### Examples

```
Create a SCA application with name "application-name" and image "my-image" for an environment with ID "yyy"
$ stackit alpha sca application create --name application-name --image my-image --environment-id yyy

Create a SCA application with name "application-name" and image "my-image" with 2 instances
$ stackit alpha sca application create --name application-name --image my-image --instances 2

Create a SCA application with name "application-name" and image "my-image" exposing port 8888 of the container
$ stackit alpha sca application create --name application-name --image my-image --external-port 8888

Create a SCA application with name "application-name" and image "my-image" disabling public networking
$ stackit alpha sca application create --name application-name --image my-image --public=false

Create a SCA application with name "application-name" and image "my-image" and environment variables ENV1=value1 and ENV2=value2
$ stackit alpha sca application create --name application-name --image my-image --environment-vars ENV1=value1,ENV2=value2
```

### Options

```
--args strings Arguments to pass to the application container command
--commands strings Commands to execute in the application container
--container-name string Container name (default "container-1")
--cpu int32 The dedicated virtual CPU processing power allocated per container instance (default 1000)
--environment-id string Environment ID (uses default environment if not set)
--environment-vars stringToString Environment variables to inject into the application (default [])
--external-port int32 Container external exposed port (default 8080)
-h, --help Help for "stackit alpha sca application create"
--http-rule-concurrency int32 Target number of in-flight requests to trigger autoscaling (if autoscaling is enabled)
--http-rule-rps int32 Target number of requests per second to trigger autoscaling (if autoscaling is enabled)
--image string Container image
--instances int32 The number of application instances (if manually scaled) (default 1)
--max-instances int32 The maximum number of application instances (if autoscaling is enabled)
--memory int32 The total amount of memory (RAM) allocated per container instance (default 1024)
--min-instances int32 The minimum number of application instances (if autoscaling is enabled) (default 1)
--name string Application display name
--public Exposes your application securely to the public internet via HTTPS endpoint (default true)
--scale-to-zero Enable scale to zero (if autoscaling is enabled)
--scaling-type string Scaling type, (one of: [manual, auto]) (default "manual")
```

### 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 alpha sca application](./stackit_alpha_sca_application.md) - Provides functionality for SCA applications

41 changes: 41 additions & 0 deletions docs/stackit_alpha_sca_application_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
## stackit alpha sca application delete

Delete a SCA application

### Synopsis

Delete a STACKIT Container Applications (SCA) application.

```
stackit alpha sca application delete [flags]
```

### Examples

```
Delete a SCA application with ID "xxx" from an environment with ID "yyy"
$ stackit alpha sca application delete xxx --environment-id yyy
```

### Options

```
--environment-id string Environment ID (uses default environment if not set)
-h, --help Help for "stackit alpha sca application 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, 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 alpha sca application](./stackit_alpha_sca_application.md) - Provides functionality for SCA applications

44 changes: 44 additions & 0 deletions docs/stackit_alpha_sca_application_describe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
## stackit alpha sca application describe

Show details of a SCA application

### Synopsis

Show details of a STACKIT Container Applications (SCA) application.

```
stackit alpha sca application describe [flags]
```

### Examples

```
Get details of a SCA application with ID "xxx" from an environment with ID "yyy"
$ stackit alpha sca application describe xxx --environment-id yyy

Get details of all SCA application with ID "xxx" from an environment with ID "yyy" in JSON format
$ stackit alpha sca application describe xxx --environment-id yyy --output-format json
```

### Options

```
--environment-id string Environment ID (if not set uses default environment)
-h, --help Help for "stackit alpha sca application 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 alpha sca application](./stackit_alpha_sca_application.md) - Provides functionality for SCA applications

54 changes: 54 additions & 0 deletions docs/stackit_alpha_sca_application_generate-payload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
## stackit alpha sca application generate-payload

Generates a payload to create/update SCA applications

### Synopsis

Generates a JSON payload with values to be used as --payload input for application creation or update.
See https://docs.api.stackit.cloud/documentation/sca/version/v1alpha#tag/Applications/operation/Applications_CreateApplication for information regarding the payload structure.

```
stackit alpha sca application generate-payload [flags]
```

### Examples

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

Generate a payload with values of an application, and adapt it with custom values for the different configuration options
$ stackit alpha sca application generate-payload --application-id xxx --file-path ./payload.json
<Modify payload in file>
$ stackit alpha sca application update-from-payload --payload @./payload.json

Generate a payload with values of an application, and preview it in the terminal
$ stackit alpha sca application generate-payload --application-id xxx
```

### Options

```
--application-id string
--environment-id string
-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 alpha sca application generate-payload"
```

### 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 alpha sca application](./stackit_alpha_sca_application.md) - Provides functionality for SCA applications

Loading