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
6 changes: 6 additions & 0 deletions docs/stackit_beta_volume_automation.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,12 @@ stackit beta volume automation [flags]
### SEE ALSO

* [stackit beta volume](./stackit_beta_volume.md) - Provides functionality for Volume
* [stackit beta volume automation create](./stackit_beta_volume_automation_create.md) - Creates a Volume Automation
* [stackit beta volume automation delete](./stackit_beta_volume_automation_delete.md) - Deletes a Volume Automation
* [stackit beta volume automation describe](./stackit_beta_volume_automation_describe.md) - Shows details of a Volume Automation
* [stackit beta volume automation execution](./stackit_beta_volume_automation_execution.md) - Provides functionality for Volume Automation Execution
* [stackit beta volume automation generate-payload](./stackit_beta_volume_automation_generate-payload.md) - Generates a payload to update volume automation
* [stackit beta volume automation list](./stackit_beta_volume_automation_list.md) - List all Volume Automations
* [stackit beta volume automation template](./stackit_beta_volume_automation_template.md) - Provides functionality for Volume Automation Templates
* [stackit beta volume automation update](./stackit_beta_volume_automation_update.md) - Updates a Volume Automation

54 changes: 54 additions & 0 deletions docs/stackit_beta_volume_automation_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
## stackit beta volume automation create

Creates a Volume Automation

### Synopsis

Creates a Volume Automation.
The input for the automation can be provided as a JSON string or a file path prefixed with "@".
See https://docs.api.stackit.cloud/documentation/automation-service/version/v1#tag/Volume-Automations/operation/CreateVolumeAutomation for information regarding the payload structure.


```
stackit beta volume automation create [flags]
```

### Examples

```
Creates a Volume Automation with name "my-automation", template ID "xxx" and input from the file "./input-payload.json"
$ stackit beta volume automation create --name my-automation --template-id xxx --input @./input-payload.json

Creates a Volume Automation with name "my-automation", description "CLI Example", template ID "xxx" and input from the file "./input-payload.json"
$ stackit beta volume automation create --name my-automation --description "CLI Example" --template-id xxx --input @./input-payload.json

Creates a Volume Automation with name "my-automation", template ID "xxx", rrule schedule trigger "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR" and input from the file "./input-payload.json"
$ stackit beta volume automation create --name my-automation --template-id xxx --trigger-schedule-rrule "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR" --input @./input-payload.json
```

### Options

```
--description string Description of the automation
-h, --help Help for "stackit beta volume automation create"
--input string Input for the automation (JSON). Can be a string or a file path, if prefixed with "@" (example: @./payload.json).
--name string Name of the automation
--template-id string Template ID which should be used for the automation
--trigger-schedule-rrule string Trigger schedule (RRULE) for the automation
```

### 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 beta volume automation](./stackit_beta_volume_automation.md) - Provides functionality for Volume Automation

40 changes: 40 additions & 0 deletions docs/stackit_beta_volume_automation_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
## stackit beta volume automation delete

Deletes a Volume Automation

### Synopsis

Deletes a Volume Automation.

```
stackit beta volume automation delete AUTOMATION_ID [flags]
```

### Examples

```
Delete a Volume Automation with ID "xxx"
$ stackit beta volume automation delete xxx
```

### Options

```
-h, --help Help for "stackit beta volume automation 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 beta volume automation](./stackit_beta_volume_automation.md) - Provides functionality for Volume Automation

40 changes: 40 additions & 0 deletions docs/stackit_beta_volume_automation_describe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
## stackit beta volume automation describe

Shows details of a Volume Automation

### Synopsis

Shows details of a Volume Automation.

```
stackit beta volume automation describe AUTOMATION_ID [flags]
```

### Examples

```
Describe the Volume Automation with ID "xxx"
$ stackit beta volume automation describe xxx
```

### Options

```
-h, --help Help for "stackit beta volume automation 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 beta volume automation](./stackit_beta_volume_automation.md) - Provides functionality for Volume Automation

48 changes: 48 additions & 0 deletions docs/stackit_beta_volume_automation_generate-payload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
## stackit beta volume automation generate-payload

Generates a payload to update volume automation

### Synopsis

Generates a JSON payload with values to be used as --input for volume automation update.
See https://docs.api.stackit.cloud/documentation/automation-service/version/v1#tag/Volume-Automations/operation/PartialUpdateVolumeAutomation for information regarding the input structure.

```
stackit beta volume automation generate-payload [flags]
```

### Examples

```
Generate a payload with values of a volume automation, and adapt it with custom values to different configuration options.
$ stackit beta volume automation generate-payload --automation-id XXX --file-path ./input-payload.json
<Modify payload in file>
$ stackit beta volume automation update xxx --input @./input-payload.json

Generate a payload with values of a volume automation, and preview it in the terminal.
$ stackit beta volume automation generate-payload --automation-id XXX
```

### Options

```
--automation-id string Automation ID from which the input values should be used
-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 beta volume automation 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 beta volume automation](./stackit_beta_volume_automation.md) - Provides functionality for Volume Automation

44 changes: 44 additions & 0 deletions docs/stackit_beta_volume_automation_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
## stackit beta volume automation list

List all Volume Automations

### Synopsis

List all Volume Automations.

```
stackit beta volume automation list [flags]
```

### Examples

```
List all Volume Automations
$ stackit beta volume automation list

List up to 10 Volume Automations
$ stackit beta volume automation list --limit 10
```

### Options

```
-h, --help Help for "stackit beta volume automation 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, 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 beta volume automation](./stackit_beta_volume_automation.md) - Provides functionality for Volume Automation

61 changes: 61 additions & 0 deletions docs/stackit_beta_volume_automation_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
## stackit beta volume automation update

Updates a Volume Automation

### Synopsis

Updates a Volume Automation.
The input for the automation can be provided as a JSON string or a file path prefixed with "@".
Updates are always applied as a patch. Omitted fields in the JSON will be ignored and remain unchanged after the update. Fields can be removed by setting them explicitly to null.
See https://docs.api.stackit.cloud/documentation/automation-service/version/v1#tag/Volume-Automations/operation/PartialUpdateVolumeAutomation for information regarding the payload structure.


```
stackit beta volume automation update AUTOMATION_ID [flags]
```

### Examples

```
Update volume automation with ID "xxx" with input from the file "./input-payload.json"
$ stackit beta volume automation update xxx --input @./input-payload.json

Update volume automation with ID "xxx" with name "my-updated-automation"
$ stackit beta volume automation update xxx --name "my-updated-automation"

Update volume automation with ID "xxx" with description "Updated automation from STACKIT CLI"
$ stackit beta volume automation update xxx --description "Updated automation from STACKIT CLI"

Update volume automation with ID "xxx" with disabling trigger schedule rrule
$ stackit beta volume automation update xxx --disable-trigger-schedule

Update volume automation with ID "xxx" with trigger schedule rrule "FREQ=WEEKLY;BYDAY=MO"
$ stackit beta volume automation update xxx --trigger-schedule-rrule "FREQ=WEEKLY;BYDAY=MO"
```

### Options

```
--description string Description of the automation
--disable-trigger-schedule If set, trigger schedule will be disabled
-h, --help Help for "stackit beta volume automation update"
--input string Input for the automation (JSON). Can be a string or a file path, if prefixed with "@" (example: @./payload.json).
--name string Name of the automation
--trigger-schedule-rrule string Trigger schedule (RRULE) for the automation
```

### 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 beta volume automation](./stackit_beta_volume_automation.md) - Provides functionality for Volume Automation

12 changes: 12 additions & 0 deletions internal/cmd/beta/volume/automation/automation.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,14 @@ package automation
import (
"github.com/spf13/cobra"

"github.com/stackitcloud/stackit-cli/internal/cmd/beta/volume/automation/create"
"github.com/stackitcloud/stackit-cli/internal/cmd/beta/volume/automation/delete"
"github.com/stackitcloud/stackit-cli/internal/cmd/beta/volume/automation/describe"
"github.com/stackitcloud/stackit-cli/internal/cmd/beta/volume/automation/execution"
generatepayload "github.com/stackitcloud/stackit-cli/internal/cmd/beta/volume/automation/generate-payload"
"github.com/stackitcloud/stackit-cli/internal/cmd/beta/volume/automation/list"
"github.com/stackitcloud/stackit-cli/internal/cmd/beta/volume/automation/template"
"github.com/stackitcloud/stackit-cli/internal/cmd/beta/volume/automation/update"
"github.com/stackitcloud/stackit-cli/internal/pkg/types"
"github.com/stackitcloud/stackit-cli/internal/pkg/utils"
)
Expand All @@ -22,6 +28,12 @@ func NewCmd(params *types.CmdParams) *cobra.Command {
}

func addSubcommands(cmd *cobra.Command, params *types.CmdParams) {
cmd.AddCommand(create.NewCmd(params))
cmd.AddCommand(delete.NewCmd(params))
cmd.AddCommand(describe.NewCmd(params))
cmd.AddCommand(execution.NewCmd(params))
cmd.AddCommand(generatepayload.NewCmd(params))
cmd.AddCommand(list.NewCmd(params))
cmd.AddCommand(template.NewCmd(params))
cmd.AddCommand(update.NewCmd(params))
}
Loading
Loading