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

doc: Remove BGP deprecated doc #477

Merged
merged 1 commit into from
Nov 22, 2023
Merged

doc: Remove BGP deprecated doc #477

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: 0 additions & 4 deletions docs/advanced_usages/custom-tests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,10 +283,6 @@ In addition to the required `AntaTest.anta_tests` decorator, ANTA offers a set o

- `anta.decorators.deprecated_test`: Use this to log a message of WARNING severity when a test is deprecated.
- `anta.decorators.skip_on_platforms`: Use this to skip tests for functionalities that are not supported on specific platforms.
- `anta.decorators.check_bgp_family_enable`: Use this to skip tests when a particular BGP address family is not configured on the device.

!!! warning
The `check_bgp_family_enable` decorator is deprecated and will eventually be removed in a future major release of ANTA. For more details, please refer to the [BGP tests section](../api/tests.routing.bgp.md).

```python
from anta.decorators import skip_on_platforms
Expand Down
34 changes: 0 additions & 34 deletions docs/api/tests.routing.bgp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,40 +6,6 @@

# ANTA catalog for BGP tests

!!! warning "Deprecation Notice"
As part of our ongoing effort to improve the ANTA catalog and align it with best practices, we are announcing the deprecation of certain BGP tests along with a specific decorator. These will be removed in a future major release of ANTA.

_What is being deprecated?_

- __Tests__: The following BGP tests in the ANTA catalog are marked for deprecation.

```yaml
anta.tests.routing:
bgp:
- VerifyBGPIPv4UnicastState:
- VerifyBGPIPv4UnicastCount:
- VerifyBGPIPv6UnicastState:
- VerifyBGPEVPNState:
- VerifyBGPEVPNCount:
- VerifyBGPRTCState:
- VerifyBGPRTCCount:
```
- __Decorator__: The `check_bgp_family_enable` decorator is also being deprecated as it is no longer needed with the new refactored BGP tests.

_What should you do?_

We strongly recommend transitioning to the new set of BGP tests that have been introduced to replace the deprecated ones. Please refer to each test documentation on this page below.

```yaml
anta.tests.routing:
bgp:
- VerifyBGPPeerCount:
- VerifyBGPPeersHealth:
- VerifyBGPSpecificPeers:
```
___

::: anta.tests.routing.bgp
options:
show_root_heading: false
Expand Down