Skip to content

Commit 275db0c

Browse files
alexTiuganalexTiugan
committed
docs(ufw):
- added generated docs
1 parent 29eaa37 commit 275db0c

11 files changed

Lines changed: 306 additions & 6 deletions

‎docs/stackit.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ stackit [flags]
5959
* [stackit service-account](./stackit_service-account.md) - Provides functionality for service accounts
6060
* [stackit ske](./stackit_ske.md) - Provides functionality for SKE
6161
* [stackit sqlserverflex](./stackit_sqlserverflex.md) - Provides functionality for SQLServer Flex
62+
* [stackit ufw](./stackit_ufw.md) - Provides functionality for UFW
6263
* [stackit valkey](./stackit_valkey.md) - Provides functionality for Valkey
6364
* [stackit volume](./stackit_volume.md) - Provides functionality for volumes
6465

‎docs/stackit_ufw.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
## stackit ufw
2+
3+
Provides functionality for UFW
4+
5+
### Synopsis
6+
7+
Provides functionality for STACKIT Unified Firewall (UFW).
8+
9+
```
10+
stackit ufw [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help Help for "stackit ufw"
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+
--region string Target region for region-specific requests
27+
--verbosity string Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info")
28+
```
29+
30+
### SEE ALSO
31+
32+
* [stackit](./stackit.md) - Manage STACKIT resources using the command line
33+
* [stackit ufw rules](./stackit_ufw_rules.md) - Provides functionality for UFW rules
34+

‎docs/stackit_ufw_rules.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
## stackit ufw rules
2+
3+
Provides functionality for UFW rules
4+
5+
### Synopsis
6+
7+
Provides functionality for STACKIT Unified Firewall (UFW) rules.
8+
9+
```
10+
stackit ufw rules [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help Help for "stackit ufw rules"
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+
--region string Target region for region-specific requests
27+
--verbosity string Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info")
28+
```
29+
30+
### SEE ALSO
31+
32+
* [stackit ufw](./stackit_ufw.md) - Provides functionality for UFW
33+
* [stackit ufw rules create](./stackit_ufw_rules_create.md) - Creates a UFW rule instance
34+
* [stackit ufw rules delete](./stackit_ufw_rules_delete.md) - Deletes a UFW rule instance
35+
* [stackit ufw rules describe](./stackit_ufw_rules_describe.md) - Shows details of a UFW rule instance
36+
* [stackit ufw rules list](./stackit_ufw_rules_list.md) - Lists all UFW rules
37+
* [stackit ufw rules update](./stackit_ufw_rules_update.md) - Updates a UFW rule instance
38+

‎docs/stackit_ufw_rules_create.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
## stackit ufw rules create
2+
3+
Creates a UFW rule instance
4+
5+
### Synopsis
6+
7+
Creates a STACKIT Unified Firewall (UFW) rule instance.
8+
9+
```
10+
stackit ufw rules create [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Create a UFW rule instance of type ACL with sourceIp "1.1.1.1/32" of product "redis" for instance with id=ID
17+
$ stackit ufw instance create --product redis --sourceIp 1.1.1.1/32 --type ACL --instanceId ID
18+
```
19+
20+
### Options
21+
22+
```
23+
-D, --description string Description
24+
-d, --direction string Direction (the direction of the traffic, typically ingress or egress, for security rules type)
25+
-e, --etherType string Specifies the bound of the rule (for security rules type)
26+
-h, --help Help for "stackit ufw rules create"
27+
-i, --instanceId string Instance ID that will have attached your rule
28+
-f, --offset int32 Offset - Position in the ACL list of an instance, will be ignored at creation (default -1)
29+
-r, --portRange string Port range (the Port range to which the rule applies, for security rules type)
30+
--product string The source service (e.g., Load Balancer, Redis) where you want to attach a rule
31+
--protocol string The network protocol (e.g. TCP, UDP, ICMP, for security rules type)
32+
-g, --securityGroupId string Security group ID - The ID of the Security Group
33+
-s, --sourceIp string The IP (CIDR) to which the rule applies (e.g. 192.168.0.1/32)
34+
-t, --type string Type (ACL/SecurityRule/SecurityGroup/PublicIP) You can check /provider-options route for them
35+
```
36+
37+
### Options inherited from parent commands
38+
39+
```
40+
-y, --assume-yes If set, skips all confirmation prompts
41+
--async If set, runs the command asynchronously
42+
-o, --output-format string Output format, (one of: [json, pretty, none, yaml])
43+
-p, --project-id string Project ID
44+
--region string Target region for region-specific requests
45+
--verbosity string Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info")
46+
```
47+
48+
### SEE ALSO
49+
50+
* [stackit ufw rules](./stackit_ufw_rules.md) - Provides functionality for UFW rules
51+

‎docs/stackit_ufw_rules_delete.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
## stackit ufw rules delete
2+
3+
Deletes a UFW rule instance
4+
5+
### Synopsis
6+
7+
Deletes a UFW rule instance.
8+
9+
```
10+
stackit ufw rules delete INSTANCE_ID [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Delete a UFW rule instance with ID "xxx"
17+
$ stackit ufw instance delete xxx
18+
```
19+
20+
### Options
21+
22+
```
23+
-h, --help Help for "stackit ufw rules 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, none, yaml])
32+
-p, --project-id string Project ID
33+
--region string Target region for region-specific requests
34+
--verbosity string Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info")
35+
```
36+
37+
### SEE ALSO
38+
39+
* [stackit ufw rules](./stackit_ufw_rules.md) - Provides functionality for UFW rules
40+

‎docs/stackit_ufw_rules_describe.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
## stackit ufw rules describe
2+
3+
Shows details of a UFW rule instance
4+
5+
### Synopsis
6+
7+
Shows details of a STACKIT Unified Firewall (UFW) rule instance.
8+
9+
```
10+
stackit ufw rules describe INSTANCE_ID [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Get details of a UFW rule instance with ID "xxx"
17+
$ stackit ufw rule instance describe xxx
18+
19+
Get details of a UFW rule instance with ID "xxx" in JSON format
20+
$ stackit ufw rule instance describe xxx --output-format json
21+
```
22+
23+
### Options
24+
25+
```
26+
-h, --help Help for "stackit ufw rules 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, none, yaml])
35+
-p, --project-id string Project ID
36+
--region string Target region for region-specific requests
37+
--verbosity string Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info")
38+
```
39+
40+
### SEE ALSO
41+
42+
* [stackit ufw rules](./stackit_ufw_rules.md) - Provides functionality for UFW rules
43+

‎docs/stackit_ufw_rules_list.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
## stackit ufw rules list
2+
3+
Lists all UFW rules
4+
5+
### Synopsis
6+
7+
Lists all STACKIT Unified Firewall (UFW) rules.
8+
9+
```
10+
stackit ufw rules list [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
List all UFW rules
17+
$ stackit ufw rules list
18+
19+
List all UFW rules in JSON format
20+
$ stackit ufw rules list --output-format json
21+
22+
List up to 10 UFW rules
23+
$ stackit ufw rules list --limit 10
24+
```
25+
26+
### Options
27+
28+
```
29+
-h, --help Help for "stackit ufw rules 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, none, yaml])
39+
-p, --project-id string Project ID
40+
--region string Target region for region-specific requests
41+
--verbosity string Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info")
42+
```
43+
44+
### SEE ALSO
45+
46+
* [stackit ufw rules](./stackit_ufw_rules.md) - Provides functionality for UFW rules
47+

‎docs/stackit_ufw_rules_update.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
## stackit ufw rules update
2+
3+
Updates a UFW rule instance
4+
5+
### Synopsis
6+
7+
Updates a STACKIT Unified Firewall (UFW) rule instance.
8+
9+
```
10+
stackit ufw rules update INSTANCE_ID [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Update a UFW rule instance with "1.1.1.1/32" as sourceIp for instance with id=ID
17+
$ stackit ufw instance update ID --sourceIp 1.1.1.1/32
18+
```
19+
20+
### Options
21+
22+
```
23+
-D, --description string Description
24+
-d, --direction string Direction (the direction of the traffic, typically ingress or egress, for security rules type)
25+
-e, --etherType string Specifies the bound of the rule (for security rules type)
26+
-h, --help Help for "stackit ufw rules update"
27+
-r, --portRange string Port range (the Port range to which the rule applies, for security rules type)
28+
--protocol string The network protocol (e.g. TCP, UDP, ICMP, for security rules type)
29+
-s, --sourceIp string The IP (CIDR) to which the rule applies (e.g. 192.168.0.1/32)
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, none, yaml])
38+
-p, --project-id string Project ID
39+
--region string Target region for region-specific requests
40+
--verbosity string Verbosity of the CLI, (one of: [debug, info, warning, error]) (default "info")
41+
```
42+
43+
### SEE ALSO
44+
45+
* [stackit ufw rules](./stackit_ufw_rules.md) - Provides functionality for UFW rules
46+

‎internal/cmd/ufw/rules/create/create.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ type inputModel struct {
5757
func NewCmd(params *types.CmdParams) *cobra.Command {
5858
cmd := &cobra.Command{
5959
Use: "create",
60-
Short: "Creates an UFW rule instance",
60+
Short: "Creates a UFW rule instance",
6161
Long: "Creates a STACKIT Unified Firewall (UFW) rule instance.",
6262
Args: args.NoArgs,
6363
Example: examples.Build(

‎internal/cmd/ufw/rules/describe/describe.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,15 @@ type inputModel struct {
3030
func NewCmd(params *types.CmdParams) *cobra.Command {
3131
cmd := &cobra.Command{
3232
Use: fmt.Sprintf("describe %s", instanceIdArg),
33-
Short: "Shows details of an UFW rule instance",
34-
Long: "Shows details of an STACKIT Unified Firewall (UFW) rule instance.",
33+
Short: "Shows details of a UFW rule instance",
34+
Long: "Shows details of a STACKIT Unified Firewall (UFW) rule instance.",
3535
Args: args.SingleArg(instanceIdArg, utils.ValidateUUID),
3636
Example: examples.Build(
3737
examples.NewExample(
38-
`Get details of an UFW rule instance with ID "xxx"`,
38+
`Get details of a UFW rule instance with ID "xxx"`,
3939
"$ stackit ufw rule instance describe xxx"),
4040
examples.NewExample(
41-
`Get details of an UFW rule instance with ID "xxx" in JSON format`,
41+
`Get details of a UFW rule instance with ID "xxx" in JSON format`,
4242
"$ stackit ufw rule instance describe xxx --output-format json"),
4343
),
4444
RunE: func(cmd *cobra.Command, args []string) error {

0 commit comments

Comments
 (0)