Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify documentation on sequence number in rules #1007

Merged
merged 1 commit into from
Oct 25, 2023
Merged

Clarify documentation on sequence number in rules #1007

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions website/docs/r/policy_gateway_policy.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ The following arguments are supported:
* `log_label` - (Optional) Additional information (string) which will be propagated to the rule syslog.
* `tag` - (Optional) A list of scope + tag pairs to associate with this Rule.
* `action` - (Optional) The action for the Rule. Must be one of: `ALLOW`, `DROP` or `REJECT`. Defaults to `ALLOW`.
* `sequence_number` - (Optional) It is recommended not to specify sequence number for rules, and rely on NSX to auto-assign them. If you choose to specify sequence numbers, you must make sure the numbers are consistent with order of the rules in configuration. To avoid confusion, either specify sequence numbers in all rules, or none at all.
* `sequence_number` - (Optional) It is recommended not to specify sequence number for rules, but rather rely on provider to auto-assign them. If you choose to specify sequence numbers, you must make sure the numbers are consistent with order of the rules in configuration. Please note that sequence numbers should start with 1, not 0. To avoid confusion, either specify sequence numbers in all rules, or none at all.

## Attributes Reference

Expand All @@ -169,7 +169,7 @@ In addition to arguments listed above, the following attributes are exported:
* `rule`:
* `revision` - Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
* `path` - The NSX path of the policy resource.
* `sequence_number` - Sequence number of the this rule, is defined by order of rules in the list.
* `sequence_number` - Sequence number for the rule.
* `rule_id` - Unique positive number that is assigned by the system and is useful for debugging.

## Importing
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/policy_intrusion_service_policy.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ In addition to arguments listed above, the following attributes are exported:
* `rule`:
* `revision` - Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
* `path` - The NSX policy path for this rule.
* `sequence_number` - Sequence number of the this rule, is defined by order of rules in the list.
* `sequence_number` - Sequence number for this rule, as defined by order of rules in the list.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why removed "as defined by order of rules in the list" on lines 172, 190 but left here?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here sequence_number is read only attribute, so it is only dictated by rule order. In gateway policy and security policy you can specify sequence_number

* `rule_id` - Unique positive number that is assigned by the system and is useful for debugging.

## Importing
Expand Down
4 changes: 2 additions & 2 deletions website/docs/r/policy_security_policy.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ The following arguments are supported:
* `services` - (Optional) Set of service paths to match.
* `log_label` - (Optional) Additional information (string) which will be propagated to the rule syslog.
* `tag` - (Optional) A list of scope + tag pairs to associate with this Rule.
* `sequence_number` - (Optional) It is recommended not to specify sequence number for rules, and rely on NSX to auto-assign them. If you choose to specify sequence numbers, you must make sure the numbers are consistent with order of the rules in configuration. To avoid confusion, either specify sequence numbers in all rules, or none at all.
* `sequence_number` - (Optional) It is recommended not to specify sequence number for rules, and rely on provider to auto-assign them. If you choose to specify sequence numbers, you must make sure the numbers are consistent with order of the rules in configuration. Please note that sequence numbers should start with 1 and not 0. To avoid confusion, either specify sequence numbers in all rules, or none at all.


## Attributes Reference
Expand All @@ -187,7 +187,7 @@ In addition to arguments listed above, the following attributes are exported:
* `rule`:
* `revision` - Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
* `path` - The NSX path of the policy resource.
* `sequence_number` - Sequence number of the this rule, is defined by order of rules in the list.
* `sequence_number` - Sequence number for the rule.
* `rule_id` - Unique positive number that is assigned by the system and is useful for debugging.

## Importing
Expand Down