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.

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: Announce deprecation of arista.cvp v1 modules #429

Merged
merged 1 commit into from
Jan 4, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ build-docker3: ## [DEPRECATED] visit https://github.com/arista-netdevops-communi
webdoc: ## Build documentation to publish static content
( cd $(WEBDOC_BUILD) ; \
python ansible2rst.py ; \
find . -name 'cv_*.rst' -exec pandoc {} --from rst --to gfm -o ../modules/{}.md \;)
find . -name 'cv_*_v3.rst' -exec pandoc {} --from rst --to gfm -o ../modules/{}.md \;)
cp $(CURRENT_DIR)/contributing.md $(WEBDOC_BUILD)/.. ;\

.PHONY: check-cvp-404
Expand Down
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
- [Collection overview](#collection-overview)
- [List of available modules](#list-of-available-modules)
- [List of available roles](#list-of-available-roles)
- [Deprecated modules](#deprecated-modules)
- [Example](#example)
- [Installation](#installation)
- [Dependencies](#dependencies)
Expand Down Expand Up @@ -61,19 +62,20 @@ __Version 3:__
- [__arista.cvp.cv_device_v3__](https://cvp.avd.sh/en/latest/docs/modules/cv_device_v3.rst/) - Manage devices configured on CVP
- [__arista.cvp.cv_task_v3__](https://cvp.avd.sh/en/latest/docs/modules/cv_task_v3.rst/) - Run tasks created on CVP.

__Legacy / Version 1:__
### List of available roles

- [__arista.cvp.dhcp_configuration__](https://cvp.avd.sh/en/latest/roles/dhcp_configuration/) - Configure DHCPD service on a Cloudvision server or any dhcpd service.
- [__arista.cvp.configlet_sync__](https://cvp.avd.sh/en/latest/roles/configlets_sync/) - Synchronize configlets between multiple Cloudvision servers.


## Deprecated modules

- [__arista.cvp.cv_facts__](https://cvp.avd.sh/en/latest/docs/modules/cv_facts.rst/) - Collect CVP facts from server like list of containers, devices, configlet and tasks.
- [__arista.cvp.cv_configlet__](https://cvp.avd.sh/en/latest/docs/modules/cv_configlet.rst/) - Manage configlet configured on CVP.
- [__arista.cvp.cv_container__](https://cvp.avd.sh/en/latest/docs/modules/cv_container.rst/) - Manage container topology and attach configlet and devices to containers.
- [__arista.cvp.cv_device__](https://cvp.avd.sh/en/latest/docs/modules/cv_device.rst/) - Manage devices configured on CVP
- [__arista.cvp.cv_task__](https://cvp.avd.sh/en/latest/docs/modules/cv_task.rst/) - Run tasks created on CVP.

### List of available roles

- [__arista.cvp.dhcp_configuration__](https://cvp.avd.sh/en/latest/roles/dhcp_configuration/) - Configure DHCPD service on a Cloudvision server or any dhcpd service.
- [__arista.cvp.configlet_sync__](https://cvp.avd.sh/en/latest/roles/configlets_sync/) - Synchronize configlets between multiple Cloudvision servers.

## Example

This example outlines how to use `arista.cvp` to create a containers topology on Arista CloudVision.
Expand Down
12 changes: 6 additions & 6 deletions ansible_collections/arista/cvp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,19 +80,19 @@ __Version 3:__
- [__arista.cvp.cv_device_v3__](docs/modules/cv_device_v3.rst/) - Manage devices configured on CVP
- [__arista.cvp.cv_task_v3__](docs/modules/cv_task_v3.rst/) - Run tasks created on CVP.

__Legacy / Version 1:__
### List of available roles

- [__arista.cvp.dhcp_configuration__](roles/dhcp_configuration/) - Configure DHCPD service on a Cloudvision server or any dhcpd service.
- [__arista.cvp.configlet_sync__](roles/configlets_sync/) - Synchronize configlets between multiple Cloudvision servers.

### Deprecated modules

- [__arista.cvp.cv_facts__](docs/modules/cv_facts.rst/) - Collect CVP facts from server like list of containers, devices, configlet and tasks.
- [__arista.cvp.cv_configlet__](docs/modules/cv_configlet.rst/) - Manage configlet configured on CVP.
- [__arista.cvp.cv_container__](docs/modules/cv_container.rst/) - Manage container topology and attach configlet and devices to containers.
- [__arista.cvp.cv_device__](docs/modules/cv_device.rst/) - Manage devices configured on CVP
- [__arista.cvp.cv_task__](docs/modules/cv_task.rst/) - Run tasks created on CVP.

### List of available roles

- [__arista.cvp.dhcp_configuration__](roles/dhcp_configuration/) - Configure DHCPD service on a Cloudvision server or any dhcpd service.
- [__arista.cvp.configlet_sync__](roles/configlets_sync/) - Synchronize configlets between multiple Cloudvision servers.

## Example

This example outlines how to use `arista.cvp` to create a containers topology on Arista CloudVision.
Expand Down
8 changes: 8 additions & 0 deletions ansible_collections/arista/cvp/docs/_build/cv_configlet.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@ Create, Delete, or Update CloudVision Portal Configlets.
:local:
:depth: 2

DEPRECATED
----------

:In: version:
:Why: Updated modules released with increased functionality
:Alternative: Use :ref:`arista.cvp.cv_configlet_v3 <arista.cvp.cv_configlet_v3>` instead.



Synopsis
--------
Expand Down
8 changes: 8 additions & 0 deletions ansible_collections/arista/cvp/docs/_build/cv_container.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@ Manage Provisioning topology.
:local:
:depth: 2

DEPRECATED
----------

:In: version:
:Why: Updated modules released with increased functionality
:Alternative: Use :ref:`arista.cvp.cv_container_v3 <arista.cvp.cv_container_v3>` instead.



Synopsis
--------
Expand Down
8 changes: 8 additions & 0 deletions ansible_collections/arista/cvp/docs/_build/cv_device.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@ Provision, Reset, or Update CloudVision Portal Devices.
:local:
:depth: 2

DEPRECATED
----------

:In: version:
:Why: Updated modules released with increased functionality
:Alternative: Use :ref:`arista.cvp.cv_device_v3 <arista.cvp.cv_device_v3>` instead.



Synopsis
--------
Expand Down
3 changes: 0 additions & 3 deletions ansible_collections/arista/cvp/docs/_build/cv_device_v3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,6 @@ Examples:
::

# task in loose mode using fqdn (default)
---
- name: Device Management in Cloudvision
hosts: cv_server
connection: local
Expand All @@ -116,7 +115,6 @@ Examples:
search_key: fqdn

# task in loose mode using serial
---
- name: Device Management in Cloudvision
hosts: cv_server
connection: local
Expand All @@ -137,7 +135,6 @@ Examples:
search_key: serialNumber

# task in strict mode
---
- name: Device Management in Cloudvision
hosts: cv_server
connection: local
Expand Down
8 changes: 8 additions & 0 deletions ansible_collections/arista/cvp/docs/_build/cv_facts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@ Collect facts from CloudVision Portal.
:local:
:depth: 2

DEPRECATED
----------

:In: version:
:Why: Features are now part of every single v3 modules.
:Alternative:



Synopsis
--------
Expand Down
8 changes: 8 additions & 0 deletions ansible_collections/arista/cvp/docs/_build/cv_task.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@ Execute or Cancel CVP Tasks.
:local:
:depth: 2

DEPRECATED
----------

:In: version:
:Why: Updated modules released with increased functionality
:Alternative: Use :ref:`arista.cvp.cv_task_v3 <arista.cvp.cv_task_v3>` instead.



Synopsis
--------
Expand Down
20 changes: 13 additions & 7 deletions ansible_collections/arista/cvp/docs/modules/cv_configlet.rst.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,25 @@
# cv\_configlet
# cv_configlet

Create, Delete, or Update CloudVision Portal Configlets.

<div class="contents" data-local="" data-depth="2">
<div class="contents" local="" depth="2">

</div>

## DEPRECATED

- In version: `4.0`
- Why : Updated modules released with increased functionality
- Alternative: Use `arista.cvp.cv_configlet_v3` instead.

## Synopsis

CloudVison Portal Configlet compares the list of configlets and config
in configlets against cvp-facts then adds, deletes, or updates them as
appropriate. If a configlet is in cvp\_facts but not in configlets it
will be deleted. If a configlet is in configlets but not in cvp\_facts
it will be created. If a configlet is in both configlets and cvp\_facts
it configuration will be compared and updated with the version in
appropriate. If a configlet is in cvp_facts but not in configlets it
will be deleted. If a configlet is in configlets but not in cvp_facts it
will be created. If a configlet is in both configlets and cvp_facts it
configuration will be compared and updated with the version in
configlets if the two are different.

## Module-specific Options
Expand Down Expand Up @@ -132,4 +138,4 @@ The following options may be specified for this module:

### Author

- EMEA AS Team (@aristanetworks)
- EMEA AS Team (@aristanetworks)
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
# cv\_configlet\_v3
# cv_configlet_v3

Create, Delete, or Update CloudVision Portal Configlets.

Module added in version 3.0.0

<div class="contents" data-local="" data-depth="2">
<div class="contents" local="" depth="2">

</div>

## Synopsis

CloudVison Portal Configlet compares the list of configlets and config
in configlets against cvp-facts then adds, deletes, or updates them as
appropriate. If a configlet is in cvp\_facts but not in configlets it
will be deleted. If a configlet is in configlets but not in cvp\_facts
it will be created. If a configlet is in both configlets and cvp\_facts
it configuration will be compared and updated with the version in
appropriate. If a configlet is in cvp_facts but not in configlets it
will be deleted. If a configlet is in configlets but not in cvp_facts it
will be created. If a configlet is in both configlets and cvp_facts it
configuration will be compared and updated with the version in
configlets if the two are different.

## Module-specific Options
Expand Down Expand Up @@ -93,4 +93,4 @@ The following options may be specified for this module:

### Author

- EMEA AS Team (@aristanetworks)
- EMEA AS Team (@aristanetworks)
12 changes: 9 additions & 3 deletions ansible_collections/arista/cvp/docs/modules/cv_container.rst.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
# cv\_container
# cv_container

Manage Provisioning topology.

<div class="contents" data-local="" data-depth="2">
<div class="contents" local="" depth="2">

</div>

## DEPRECATED

- In version: `4.0`
- Why : Updated modules released with increased functionality
- Alternative: Use `arista.cvp.cv_container_v3` instead.

## Synopsis

CloudVision Portal Configlet configuration requires a dictionary of
Expand Down Expand Up @@ -106,4 +112,4 @@ The following options may be specified for this module:

### Author

- EMEA AS Team (@aristanetworks)
- EMEA AS Team (@aristanetworks)
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# cv\_container\_v3
# cv_container_v3

Manage Provisioning topology.

Module added in version 3.0.0

<div class="contents" data-local="" data-depth="2">
<div class="contents" local="" depth="2">

</div>

Expand Down Expand Up @@ -109,4 +109,4 @@ The following options may be specified for this module:

### Author

- EMEA AS Team (@aristanetworks)
- EMEA AS Team (@aristanetworks)
22 changes: 15 additions & 7 deletions ansible_collections/arista/cvp/docs/modules/cv_device.rst.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,29 @@
# cv\_device
# cv_device

Provision, Reset, or Update CloudVision Portal Devices.

<div class="contents" data-local="" data-depth="2">
<div class="contents" local="" depth="2">

</div>

## DEPRECATED

## DEPRECATED

- In version: `4.0`
- Why : Updated modules released with increased functionality
- Alternative: Use `arista.cvp.cv_device_v3` instead.

## Synopsis

CloudVison Portal Device compares the list of Devices in devices against
cvp-facts then adds, resets, or updates them as appropriate. If a device
is in cvp\_facts but not in devices it will be reset to factory defaults
in ZTP mode If a device is in devices but not in cvp\_facts it will be
provisioned If a device is in both devices and cvp\_facts its configlets
is in cvp_facts but not in devices it will be reset to factory defaults
in ZTP mode If a device is in devices but not in cvp_facts it will be
provisioned If a device is in both devices and cvp_facts its configlets
and imageBundles will be compared and updated with the version in
devices if the two are different. Warning - reset means devices will be
erased and will run full ZTP process. Use this function with caution \!
erased and will run full ZTP process. Use this function with caution !

## Module-specific Options

Expand Down Expand Up @@ -143,4 +151,4 @@ The following options may be specified for this module:

### Author

- EMEA AS Team (@aristanetworks)
- EMEA AS Team (@aristanetworks)
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# cv\_device\_v3
# cv_device_v3

Manage Provisioning topology.

Module added in version 3.0.0

<div class="contents" data-local="" data-depth="2">
<div class="contents" local="" depth="2">

</div>

Expand Down Expand Up @@ -79,7 +79,6 @@ The following options may be specified for this module:
## Examples:

# task in loose mode using fqdn (default)
---
- name: Device Management in Cloudvision
hosts: cv_server
connection: local
Expand All @@ -100,7 +99,6 @@ The following options may be specified for this module:
search_key: fqdn

# task in loose mode using serial
---
- name: Device Management in Cloudvision
hosts: cv_server
connection: local
Expand All @@ -121,7 +119,6 @@ The following options may be specified for this module:
search_key: serialNumber

# task in strict mode
---
- name: Device Management in Cloudvision
hosts: cv_server
connection: local
Expand All @@ -143,4 +140,4 @@ The following options may be specified for this module:

### Author

- EMEA AS Team (@aristanetworks)
- EMEA AS Team (@aristanetworks)
12 changes: 9 additions & 3 deletions ansible_collections/arista/cvp/docs/modules/cv_facts.rst.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
# cv\_facts
# cv_facts

Collect facts from CloudVision Portal.

<div class="contents" data-local="" data-depth="2">
<div class="contents" local="" depth="2">

</div>

## DEPRECATED

- In version: `4.0`
- Why : Updated modules released with increased functionality
- Alternative: All v3 modules are now independents and cv_facts is not required anymore.

## Synopsis

Returns list of devices, configlets, containers and images
Expand Down Expand Up @@ -93,4 +99,4 @@ The following options may be specified for this module:

### Author

- EMEA AS Team (@aristanetworks)
- EMEA AS Team (@aristanetworks)
Loading