Skip to content

Commit

Permalink
doc: Remove BGP deprecated doc (#477)
Browse files Browse the repository at this point in the history
Doc: Remove BGP deprecated doc
  • Loading branch information
gmuloc authored Nov 22, 2023
1 parent 2db3d7b commit 4e1ad90
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 38 deletions.
4 changes: 0 additions & 4 deletions docs/advanced_usages/custom-tests.md
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
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

0 comments on commit 4e1ad90

Please sign in to comment.