Skip to content

Commit abc2f49

Browse files
committed
docs(ufw):
- updated docs
1 parent 2588cf3 commit abc2f49

4 files changed

Lines changed: 18 additions & 27 deletions

File tree

docs/stackit_ufw_rules_create.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,25 +13,21 @@ stackit ufw rules create [flags]
1313
### Examples
1414

1515
```
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
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 rules create --product redis --sourceIp 1.1.1.1/32 --type ACL --instanceId ID
18+
19+
Create a UFW rule instance of type ACL with sourceIp "2.2.2.2/32" of product "Edge Cloud" for instance with id=ID
20+
$ stackit ufw rules create --product edge-cloud --sourceIp 2.2.2.2/32 --type ACL --instanceId ID
1821
```
1922

2023
### Options
2124

2225
```
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
26+
-h, --help Help for "stackit ufw rules create"
27+
-i, --instanceId string Instance ID that will have attached your rule
28+
--product string The source service (e.g., Edge Cloud, Redis) where you want to attach a rule
29+
-s, --sourceIp string The IP (CIDR) to which the rule applies (e.g. 192.168.0.1/32)
30+
-t, --type string Type (ACL/SecurityRule/SecurityGroup) You can check /provider-options route for them. Unfortunately, this field could be only ACL for the CLI version
3531
```
3632

3733
### Options inherited from parent commands

docs/stackit_ufw_rules_delete.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Deletes a UFW rule instance
44

55
### Synopsis
66

7-
Deletes a UFW rule instance.
7+
Deletes a STACKIT Unified Firewall (UFW) rule instance.
88

99
```
1010
stackit ufw rules delete INSTANCE_ID [flags]
@@ -14,7 +14,7 @@ stackit ufw rules delete INSTANCE_ID [flags]
1414

1515
```
1616
Delete a UFW rule instance with ID "xxx"
17-
$ stackit ufw instance delete xxx
17+
$ stackit ufw rules delete xxx
1818
```
1919

2020
### Options

docs/stackit_ufw_rules_describe.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ stackit ufw rules describe INSTANCE_ID [flags]
1414

1515
```
1616
Get details of a UFW rule instance with ID "xxx"
17-
$ stackit ufw rule instance describe xxx
17+
$ stackit ufw rules describe xxx
1818
1919
Get details of a UFW rule instance with ID "xxx" in JSON format
20-
$ stackit ufw rule instance describe xxx --output-format json
20+
$ stackit ufw rules describe xxx --output-format json
2121
```
2222

2323
### Options

docs/stackit_ufw_rules_update.md

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,15 @@ stackit ufw rules update INSTANCE_ID [flags]
1313
### Examples
1414

1515
```
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
16+
Update a UFW rule instance with "1.1.1.1/32" as sourceIp for instance with ID "xxx"
17+
$ stackit ufw rules update xxx --sourceIp 1.1.1.1/32
1818
```
1919

2020
### Options
2121

2222
```
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)
23+
-h, --help Help for "stackit ufw rules update"
24+
-s, --sourceIp string The IP (CIDR) to which the rule applies (e.g. 192.168.0.1/32)
3025
```
3126

3227
### Options inherited from parent commands

0 commit comments

Comments
 (0)