Skip to content

Commit f286095

Browse files
bahkauv70bahkauv70
committed
feature: updated documentation
1 parent f77a9d6 commit f286095

9 files changed

+61
-25
lines changed

‎docs/stackit_beta_security-group.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Manage security groups
44

55
### Synopsis
66

7-
Manage the lifecycle of security groups.
7+
Manage the lifecycle of security groups and rules.
88

99
```
1010
stackit beta security-group [flags]
@@ -29,5 +29,6 @@ stackit beta security-group [flags]
2929
### SEE ALSO
3030

3131
* [stackit beta](./stackit_beta.md) - Contains beta STACKIT CLI commands
32+
* [stackit beta security-group group](./stackit_beta_security-group_group.md) - Manage security groups
3233
* [stackit beta security-group rule](./stackit_beta_security-group_rule.md) - Provides functionality for security group rules
3334

‎docs/stackit_beta_security-group_group.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
## stackit beta security-group group
2+
3+
Manage security groups
4+
5+
### Synopsis
6+
7+
Manage the lifecycle of security groups.
8+
9+
```
10+
stackit beta security-group group [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help Help for "stackit beta security-group group"
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" "none" "yaml"]
25+
-p, --project-id string Project ID
26+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
27+
```
28+
29+
### SEE ALSO
30+
31+
* [stackit beta security-group](./stackit_beta_security-group.md) - Manage security groups
32+
* [stackit beta security-group group create](./stackit_beta_security-group_group_create.md) - Creates security groups
33+
* [stackit beta security-group group delete](./stackit_beta_security-group_group_delete.md) - Deletes a security group
34+
* [stackit beta security-group group describe](./stackit_beta_security-group_group_describe.md) - Describes security groups
35+
* [stackit beta security-group group list](./stackit_beta_security-group_group_list.md) - Lists security groups
36+
* [stackit beta security-group group update](./stackit_beta_security-group_group_update.md) - Updates a security group
37+

docs/stackit_beta_security-group_create.md renamed to docs/stackit_beta_security-group_group_create.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## stackit beta security-group create
1+
## stackit beta security-group group create
22

33
Creates security groups
44

@@ -7,7 +7,7 @@ Creates security groups
77
Creates security groups.
88

99
```
10-
stackit beta security-group create [flags]
10+
stackit beta security-group group create [flags]
1111
```
1212

1313
### Examples
@@ -24,7 +24,7 @@ stackit beta security-group create [flags]
2424

2525
```
2626
--description string An optional description of the security group.
27-
-h, --help Help for "stackit beta security-group create"
27+
-h, --help Help for "stackit beta security-group group create"
2828
--labels stringToString Labels are key-value string pairs which can be attached to a network-interface. E.g. '--labels key1=value1,key2=value2,...' (default [])
2929
--name string The name of the security group.
3030
--stateful Create a stateful or a stateless security group
@@ -42,5 +42,5 @@ stackit beta security-group create [flags]
4242

4343
### SEE ALSO
4444

45-
* [stackit beta security-group](./stackit_beta_security-group.md) - Manage security groups
45+
* [stackit beta security-group group](./stackit_beta_security-group_group.md) - Manage security groups
4646

docs/stackit_beta_security-group_delete.md renamed to docs/stackit_beta_security-group_group_delete.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## stackit beta security-group delete
1+
## stackit beta security-group group delete
22

33
Deletes a security group
44

@@ -7,7 +7,7 @@ Deletes a security group
77
Deletes a security group by its internal ID.
88

99
```
10-
stackit beta security-group delete [flags]
10+
stackit beta security-group group delete [flags]
1111
```
1212

1313
### Examples
@@ -20,7 +20,7 @@ stackit beta security-group delete [flags]
2020
### Options
2121

2222
```
23-
-h, --help Help for "stackit beta security-group delete"
23+
-h, --help Help for "stackit beta security-group group delete"
2424
```
2525

2626
### Options inherited from parent commands
@@ -35,5 +35,5 @@ stackit beta security-group delete [flags]
3535

3636
### SEE ALSO
3737

38-
* [stackit beta security-group](./stackit_beta_security-group.md) - Manage security groups
38+
* [stackit beta security-group group](./stackit_beta_security-group_group.md) - Manage security groups
3939

docs/stackit_beta_security-group_describe.md renamed to docs/stackit_beta_security-group_group_describe.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## stackit beta security-group describe
1+
## stackit beta security-group group describe
22

33
Describes security groups
44

@@ -7,7 +7,7 @@ Describes security groups
77
Describes security groups by its internal ID.
88

99
```
10-
stackit beta security-group describe [flags]
10+
stackit beta security-group group describe [flags]
1111
```
1212

1313
### Examples
@@ -20,7 +20,7 @@ stackit beta security-group describe [flags]
2020
### Options
2121

2222
```
23-
-h, --help Help for "stackit beta security-group describe"
23+
-h, --help Help for "stackit beta security-group group describe"
2424
```
2525

2626
### Options inherited from parent commands
@@ -35,5 +35,5 @@ stackit beta security-group describe [flags]
3535

3636
### SEE ALSO
3737

38-
* [stackit beta security-group](./stackit_beta_security-group.md) - Manage security groups
38+
* [stackit beta security-group group](./stackit_beta_security-group_group.md) - Manage security groups
3939

docs/stackit_beta_security-group_list.md renamed to docs/stackit_beta_security-group_group_list.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## stackit beta security-group list
1+
## stackit beta security-group group list
22

33
Lists security groups
44

@@ -7,7 +7,7 @@ Lists security groups
77
Lists security groups by its internal ID.
88

99
```
10-
stackit beta security-group list [flags]
10+
stackit beta security-group group list [flags]
1111
```
1212

1313
### Examples
@@ -17,13 +17,13 @@ stackit beta security-group list [flags]
1717
$ stackit beta security-group list
1818
1919
List groups with labels
20-
$ stackit beta security-group list --labels label1=value1,label2=value2
20+
$ stackit beta security-group list --label-selector label1=value1,label2=value2
2121
```
2222

2323
### Options
2424

2525
```
26-
-h, --help Help for "stackit beta security-group list"
26+
-h, --help Help for "stackit beta security-group group list"
2727
--label-selector string Filter by label
2828
```
2929

@@ -39,5 +39,5 @@ stackit beta security-group list [flags]
3939

4040
### SEE ALSO
4141

42-
* [stackit beta security-group](./stackit_beta_security-group.md) - Manage security groups
42+
* [stackit beta security-group group](./stackit_beta_security-group_group.md) - Manage security groups
4343

docs/stackit_beta_security-group_update.md renamed to docs/stackit_beta_security-group_group_update.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## stackit beta security-group update
1+
## stackit beta security-group group update
22

33
Updates a security group
44

@@ -7,7 +7,7 @@ Updates a security group
77
Updates a named security group
88

99
```
10-
stackit beta security-group update [flags]
10+
stackit beta security-group group update [flags]
1111
```
1212

1313
### Examples
@@ -24,7 +24,7 @@ stackit beta security-group update [flags]
2424

2525
```
2626
--description string An optional description of the security group.
27-
-h, --help Help for "stackit beta security-group update"
27+
-h, --help Help for "stackit beta security-group group update"
2828
--labels stringToString Labels are key-value string pairs which can be attached to a network-interface. E.g. '--labels key1=value1,key2=value2,...' (default [])
2929
--name string The name of the security group.
3030
```
@@ -41,5 +41,5 @@ stackit beta security-group update [flags]
4141

4242
### SEE ALSO
4343

44-
* [stackit beta security-group](./stackit_beta_security-group.md) - Manage security groups
44+
* [stackit beta security-group group](./stackit_beta_security-group_group.md) - Manage security groups
4545

‎docs/stackit_beta_security-group_rule.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ stackit beta security-group rule [flags]
2828

2929
### SEE ALSO
3030

31-
* [stackit beta security-group](./stackit_beta_security-group.md) - Provides functionality for security groups
31+
* [stackit beta security-group](./stackit_beta_security-group.md) - Manage security groups
3232
* [stackit beta security-group rule create](./stackit_beta_security-group_rule_create.md) - Creates a security group rule
3333
* [stackit beta security-group rule delete](./stackit_beta_security-group_rule_delete.md) - Deletes a security group rule
3434
* [stackit beta security-group rule describe](./stackit_beta_security-group_rule_describe.md) - Shows details of a security group rule

‎internal/pkg/services/iaas/utils/utils_test.go‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -662,5 +662,3 @@ func TestGetNetworkRangeFromAPIResponse(t *testing.T) {
662662
})
663663
}
664664
}
665-
666-

0 commit comments

Comments
 (0)