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: AVD with Ansible Automation Platform Guide #3910

Open
wants to merge 6 commits into
base: devel
Choose a base branch
from

Conversation

JulioPDX
Copy link
Contributor

Change Summary

This getting started guide will walk AVD users through getting up and running with AVD and AAP.

Proposed changes

Please see change summary

How to test

View docs generated with PR

Checklist

Repository Checklist

  • My code has been rebased from devel before I start
  • I have read the CONTRIBUTING document.
  • My change requires a change to the documentation and documentation have been updated accordingly.
  • I have updated molecule CI testing accordingly. (check the box if not applicable)

@JulioPDX JulioPDX requested review from a team as code owners April 26, 2024 00:33
@JulioPDX JulioPDX self-assigned this Apr 26, 2024
@github-actions github-actions bot added the type: documentation Improvements or additions to documentation label Apr 26, 2024
mkdocs.yml Outdated Show resolved Hide resolved
Please note, that this guide leverages AAP version 2.4. The workflows should be similar in newer versions; if there are any questions, please see the official [AAP documentation](https://access.redhat.com/documentation/en-us/red_hat_ansible_automation_platform/2.4).

- An accessible lab topology running Arista EOS.
- An AVD project or Git repository with playbooks and an inventory. To get started, you may also use any of our [example topologies](../../examples/single-dc-l3ls/README.md).
Copy link
Contributor

Choose a reason for hiding this comment

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

"AVD project" is referring to an AAP project right? Maybe a clarification could help here

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I meant an AVD project or a git repo that has the usual items (inventory, group vars, playbooks)

tasks:
- name: Provision CVP with AVD configuration
import_role:
name: eos_config_deploy_cvp
Copy link
Contributor

Choose a reason for hiding this comment

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

Perhaps add a Studios example with cv_deploy?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Do you mean to replace this one or show an additional build and deploy step with cv_deploy?

Copy link
Contributor

Choose a reason for hiding this comment

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

I agree here, we should start giving examples for the role cv_deploy, considering it is the new way to use static configlets studios.

Copy link

sonarcloud bot commented May 31, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

Copy link
Contributor

@danieltudares danieltudares left a comment

Choose a reason for hiding this comment

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

LGTM, great job Julio!

@JulioPDX
Copy link
Contributor Author

JulioPDX commented Jun 4, 2024

Going to set overwrite on the variables as well to make the source of truth rule all the things.

@JulioPDX
Copy link
Contributor Author

JulioPDX commented Jun 4, 2024

Going to set overwrite on the variables as well to make the source of truth rule all the things.

Disregard, the way we set overwrite on inventory sync, even if folks added a custom var to host or groups, those would be removed when the inventory is updated. Only difference is if someone supplies a job specific variable.

@ClausHolbechArista ClausHolbechArista added the one approval This PR has one approval and is only missing one more. label Jun 7, 2024

## Requirements to get started

Please note, that this guide leverages AAP version 2.4. The workflows should be similar in newer versions; if there are any questions, please see the official [AAP documentation](https://access.redhat.com/documentation/en-us/red_hat_ansible_automation_platform/2.4).
Copy link
Contributor

@xaviramon xaviramon Jun 7, 2024

Choose a reason for hiding this comment

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

Can we suggest to open an issue with us to keep this document up to date?


Our topology leverages two spines and four leaf nodes to create a layer three leaf spine topology. The topology is managed by Arista CloudVision Portal (CVP). In our case, the EOS nodes are constantly streaming to CVP and gives us the ability to provision the nodes with CVP. AAP will act as our controller to communicate any updates to CVP, which can then push the updates to our topology.

![Topology leveraging Ansible Automation Platform to communicate with CloudVision](../_media/getting-started/aap-avd/aap-cvp-eos.svg)
Copy link
Contributor

Choose a reason for hiding this comment

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

For consistency in the document, should we change RH AAP for AAP? And cvp in capital letters (ie CVP)?
Also, the colour of the arrows, does it mean anything? If yes, what? If not, I think to use the same colour will be a good idea

Copy link
Member

Choose a reason for hiding this comment

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

I agree with just AAP. Good catch and we should just use CloudVision (CV).


## Job templates and workflow templates

One thing that may need some clarification is the naming of "job templates." These map to playbooks within our project. There is also an option to build workflow templates: a series of job templates with some control logic built-in. For this example, we will use a job template to build and deploy our node configurations with CVP.
Copy link
Contributor

Choose a reason for hiding this comment

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

"job templates".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
one approval This PR has one approval and is only missing one more. type: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

8 participants