Skip to content

Commit 3b90267

Browse files
Onboard Argus (plans and instance) (#158)
* Onboard Argus: plans command, config (set and unset) and client (#147) * Onboard Argus (instance): create command and utils (#133) * Onboard Argus instance: create command init * create command: complete functionality and start testing * create command: added testing for utils * update utils error message * Add custom Argus error and fix create command testing * fix error formatting in utils * fix error formatting * Onboard Argus (instance): update command (#149) * Onboard Argus Instance: update command * update command: support no plan info provided * update command: testing * fix linting * update command: handle empty instance name * update documentation * update command: handle empty name update and corner cases * fix linting * update command: improve error message * address comments in PR * Update internal/cmd/argus/instance/update/update.go Co-authored-by: João Palet <joao.palet@outlook.com> * fix linting --------- Co-authored-by: João Palet <joao.palet@outlook.com> * Onboard Argus (instance): delete command (#151) * Onboard Argus Instance: delete command * delete command: add docs * Onboard Argus (instance): list and describe commands (#155) * Onboard Argus Instance: list command * Onboard Argus Instance: describe command * describe command: dont display name if empty * describe command: update output * describe command: remove additional check * describe command: add grafana url * add docs and address comments * update command: improve examples, add name shorthand flag (#160) --------- Co-authored-by: João Palet <joao.palet@outlook.com>
1 parent 656b3c6 commit 3b90267

36 files changed

+3302
-1
lines changed

docs/stackit.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ stackit [flags]
2525

2626
### SEE ALSO
2727

28+
* [stackit argus](./stackit_argus.md) - Provides functionality for Argus
2829
* [stackit auth](./stackit_auth.md) - Provides authentication functionality
2930
* [stackit config](./stackit_config.md) - Provides functionality for CLI configuration options
3031
* [stackit curl](./stackit_curl.md) - Executes an authenticated HTTP request to an endpoint

docs/stackit_argus.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
## stackit argus
2+
3+
Provides functionality for Argus
4+
5+
### Synopsis
6+
7+
Provides functionality for Argus.
8+
9+
```
10+
stackit argus [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help Help for "stackit argus"
17+
```
18+
19+
### Options inherited from parent commands
20+
21+
```
22+
-y, --assume-yes If set, skips all confirmation prompts
23+
--async If set, runs the command asynchronously
24+
-o, --output-format string Output format, one of ["json" "pretty"]
25+
-p, --project-id string Project ID
26+
```
27+
28+
### SEE ALSO
29+
30+
* [stackit](./stackit.md) - Manage STACKIT resources using the command line
31+
* [stackit argus instance](./stackit_argus_instance.md) - Provides functionality for Argus instances
32+
* [stackit argus plans](./stackit_argus_plans.md) - Lists all Argus service plans
33+

docs/stackit_argus_instance.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
## stackit argus instance
2+
3+
Provides functionality for Argus instances
4+
5+
### Synopsis
6+
7+
Provides functionality for Argus instances.
8+
9+
```
10+
stackit argus instance [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help Help for "stackit argus instance"
17+
```
18+
19+
### Options inherited from parent commands
20+
21+
```
22+
-y, --assume-yes If set, skips all confirmation prompts
23+
--async If set, runs the command asynchronously
24+
-o, --output-format string Output format, one of ["json" "pretty"]
25+
-p, --project-id string Project ID
26+
```
27+
28+
### SEE ALSO
29+
30+
* [stackit argus](./stackit_argus.md) - Provides functionality for Argus
31+
* [stackit argus instance create](./stackit_argus_instance_create.md) - Creates an Argus instance
32+
* [stackit argus instance delete](./stackit_argus_instance_delete.md) - Deletes an Argus instance
33+
* [stackit argus instance describe](./stackit_argus_instance_describe.md) - Shows details of an Argus instance
34+
* [stackit argus instance list](./stackit_argus_instance_list.md) - Lists all Argus instances
35+
* [stackit argus instance update](./stackit_argus_instance_update.md) - Updates an Argus instance
36+
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
## stackit argus instance create
2+
3+
Creates an Argus instance
4+
5+
### Synopsis
6+
7+
Creates an Argus instance.
8+
9+
```
10+
stackit argus instance create [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Create an Argus instance with name "my-instance" and specify plan by name
17+
$ stackit argus instance create --name my-instance --plan-name Monitoring-Starter-EU01
18+
19+
Create an Argus instance with name "my-instance" and specify plan by ID
20+
$ stackit argus instance create --name my-instance --plan-id xxx
21+
```
22+
23+
### Options
24+
25+
```
26+
-h, --help Help for "stackit argus instance create"
27+
-n, --name string Instance name
28+
--plan-id string Plan ID
29+
--plan-name string Plan name
30+
```
31+
32+
### Options inherited from parent commands
33+
34+
```
35+
-y, --assume-yes If set, skips all confirmation prompts
36+
--async If set, runs the command asynchronously
37+
-o, --output-format string Output format, one of ["json" "pretty"]
38+
-p, --project-id string Project ID
39+
```
40+
41+
### SEE ALSO
42+
43+
* [stackit argus instance](./stackit_argus_instance.md) - Provides functionality for Argus instances
44+
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
## stackit argus instance delete
2+
3+
Deletes an Argus instance
4+
5+
### Synopsis
6+
7+
Deletes an Argus instance.
8+
9+
```
10+
stackit argus instance delete INSTANCE_ID [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Delete an Argus instance with ID "xxx"
17+
$ stackit argus instance delete xxx
18+
```
19+
20+
### Options
21+
22+
```
23+
-h, --help Help for "stackit argus instance delete"
24+
```
25+
26+
### Options inherited from parent commands
27+
28+
```
29+
-y, --assume-yes If set, skips all confirmation prompts
30+
--async If set, runs the command asynchronously
31+
-o, --output-format string Output format, one of ["json" "pretty"]
32+
-p, --project-id string Project ID
33+
```
34+
35+
### SEE ALSO
36+
37+
* [stackit argus instance](./stackit_argus_instance.md) - Provides functionality for Argus instances
38+
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
## stackit argus instance describe
2+
3+
Shows details of an Argus instance
4+
5+
### Synopsis
6+
7+
Shows details of an Argus instance.
8+
9+
```
10+
stackit argus instance describe INSTANCE_ID [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Get details of an Argus instance with ID "xxx"
17+
$ stackit argus instance describe xxx
18+
19+
Get details of an Argus instance with ID "xxx" in a table format
20+
$ stackit argus instance describe xxx --output-format pretty
21+
```
22+
23+
### Options
24+
25+
```
26+
-h, --help Help for "stackit argus instance describe"
27+
```
28+
29+
### Options inherited from parent commands
30+
31+
```
32+
-y, --assume-yes If set, skips all confirmation prompts
33+
--async If set, runs the command asynchronously
34+
-o, --output-format string Output format, one of ["json" "pretty"]
35+
-p, --project-id string Project ID
36+
```
37+
38+
### SEE ALSO
39+
40+
* [stackit argus instance](./stackit_argus_instance.md) - Provides functionality for Argus instances
41+
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
## stackit argus instance list
2+
3+
Lists all Argus instances
4+
5+
### Synopsis
6+
7+
Lists all Argus instances.
8+
9+
```
10+
stackit argus instance list [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
List all Argus instances
17+
$ stackit argus instance list
18+
19+
List all Argus instances in JSON format
20+
$ stackit argus instance list --output-format json
21+
22+
List up to 10 Argus instances
23+
$ stackit argus instance list --limit 10
24+
```
25+
26+
### Options
27+
28+
```
29+
-h, --help Help for "stackit argus instance list"
30+
--limit int Maximum number of entries to list
31+
```
32+
33+
### Options inherited from parent commands
34+
35+
```
36+
-y, --assume-yes If set, skips all confirmation prompts
37+
--async If set, runs the command asynchronously
38+
-o, --output-format string Output format, one of ["json" "pretty"]
39+
-p, --project-id string Project ID
40+
```
41+
42+
### SEE ALSO
43+
44+
* [stackit argus instance](./stackit_argus_instance.md) - Provides functionality for Argus instances
45+
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
## stackit argus instance update
2+
3+
Updates an Argus instance
4+
5+
### Synopsis
6+
7+
Updates an Argus instance.
8+
9+
```
10+
stackit argus instance update INSTANCE_ID [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Update the plan of an Argus instance with ID "xxx" by specifying the plan ID
17+
$ stackit argus instance update xxx --plan-id yyy
18+
19+
Update the plan of an Argus instance with ID "xxx" by specifying the plan name
20+
$ stackit argus instance update xxx --plan-name Frontend-Starter-EU01
21+
22+
Update the name of an Argus instance with ID "xxx"
23+
$ stackit argus instance update xxx --name new-instance-name
24+
```
25+
26+
### Options
27+
28+
```
29+
-h, --help Help for "stackit argus instance update"
30+
-n, --name string Instance name
31+
--plan-id string Plan ID
32+
--plan-name string Plan name
33+
```
34+
35+
### Options inherited from parent commands
36+
37+
```
38+
-y, --assume-yes If set, skips all confirmation prompts
39+
--async If set, runs the command asynchronously
40+
-o, --output-format string Output format, one of ["json" "pretty"]
41+
-p, --project-id string Project ID
42+
```
43+
44+
### SEE ALSO
45+
46+
* [stackit argus instance](./stackit_argus_instance.md) - Provides functionality for Argus instances
47+

docs/stackit_argus_plans.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
## stackit argus plans
2+
3+
Lists all Argus service plans
4+
5+
### Synopsis
6+
7+
Lists all Argus service plans.
8+
9+
```
10+
stackit argus plans [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
List all Argus service plans
17+
$ stackit argus plans
18+
19+
List all Argus service plans in JSON format
20+
$ stackit argus plans --output-format json
21+
22+
List up to 10 Argus service plans
23+
$ stackit argus plans --limit 10
24+
```
25+
26+
### Options
27+
28+
```
29+
-h, --help Help for "stackit argus plans"
30+
--limit int Maximum number of entries to list
31+
```
32+
33+
### Options inherited from parent commands
34+
35+
```
36+
-y, --assume-yes If set, skips all confirmation prompts
37+
--async If set, runs the command asynchronously
38+
-o, --output-format string Output format, one of ["json" "pretty"]
39+
-p, --project-id string Project ID
40+
```
41+
42+
### SEE ALSO
43+
44+
* [stackit argus](./stackit_argus.md) - Provides functionality for Argus
45+

docs/stackit_config_set.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ stackit config set [flags]
2929
### Options
3030

3131
```
32+
--argus-custom-endpoint string Argus API base URL, used in calls to this API
3233
--authorization-custom-endpoint string Authorization API base URL, used in calls to this API
3334
--dns-custom-endpoint string DNS API base URL, used in calls to this API
3435
-h, --help Help for "stackit config set"

0 commit comments

Comments
 (0)