Skip to content

Commit

Permalink
Merge pull request #149 from itdependsnetworks/docs-bullets
Browse files Browse the repository at this point in the history
Update docs to include bullet standards for mkdocs
  • Loading branch information
jtdub authored Feb 27, 2025
2 parents a348db5 + 844677c commit ac8a102
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
6 changes: 3 additions & 3 deletions docs/custom-workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,9 +103,9 @@ ip access-list extended TEST
To avoid outages during production changes:

1. **Resequence the ACL:** Adjust sequence numbers using the ip access-list resequence command.
* For demonstration, resequence to align 12 to 20.
2. **Temporary Allow-All:** Add a temporary rule (1 permit ip any any) to prevent lockouts.
2. **Cleanup:** Remove the temporary rule (no 1) after applying the changes.
* For demonstration, resequence to align 12 to 20.
1. **Temporary Allow-All:** Add a temporary rule (1 permit ip any any) to prevent lockouts.
1. **Cleanup:** Remove the temporary rule (no 1) after applying the changes.

----

Expand Down
6 changes: 4 additions & 2 deletions docs/future-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,12 @@
The Future Config feature, introduced in version 2.2.0, attempts to predict the state of the running configuration after a change is applied.

This feature is useful in scenarios where you need to determine the anticipated configuration state following a change, such as:

- Verifying that a configuration change was successfully applied to a device
- For example, checking if the post-change configuration matches the predicted future configuration
- For example, checking if the post-change configuration matches the predicted future configuration
- Generating a future-state configuration that can be analyzed by tools like Batfish to assess the potential impact of a change
- Building rollback configurations: once the future configuration state is known, a rollback configuration can be generated by simply creating the remediation in reverse `(rollback = future.config_to_get_to(running))`.
- When building rollbacks for a series of configuration changes, you can use the future configuration from each change as input for the subsequent change. For example, use the future configuration after Change 1 as the input for determining the future configuration after Change 2, and so on.
- When building rollbacks for a series of configuration changes, you can use the future configuration from each change as input for the subsequent change. For example, use the future configuration after Change 1 as the input for determining the future configuration after Change 2, and so on.

```python
post_change_1_config = running_config.future(change_1_config)
Expand All @@ -17,6 +18,7 @@ change_2_rollback_config = post_change_2_config.config_to_get_to(post_change_1_c
```

Currently, this algorithm does not account for:

- negate a numbered ACL when removing an item
- sectional exiting
- negate with
Expand Down

0 comments on commit ac8a102

Please sign in to comment.