Graphiant-Playbooks

Playbooks for Graphiant NaaS.

Refer Graphiant-Playbooks User Guide under Automation Section in Graphiant Documentation for getting started instructions.

Graphiant Playbooks are a collection of automated scripts that are designed to streamline and manage network infrastructure and policies. These playbooks are built using Python and Jinja2 templates to create and apply configurations for multiple Graphiant Edge Devices concurrently using GCSDK API.

graphiant-playbooks/
├── LICENSE               # Project License file
├── README.md             # Project overview/documentation
├── requirements.txt      # Python dependencies
├── configs/              # Input YAML configuration files
├── libs/                 # Python libraries and modules required by the playbooks
├── templates/            # Jinja2 configuration template
├── test/                 # Sample Python test scripts and Config file 
└── scripts/              # Standalone scripts e.g. cloud-init interactive generator 

# configs/
Contains input configuration YAML files used to drive the execution of various playbooks.

# libs/
Includes all necessary Python libraries and helper modules required by the playbooks.

# logs/
Stores all log files generated during execution. Each run creates a timestamped log 
for auditability and debugging purposes.

# templates/
Contains Jinja2 config templates. These templates are dynamically rendered using the 
input from the configs/ directory to produce finalized configuration artifacts.

# test/
Contains Sample Python test files to validate the packages are installed correctly.

# scripts/
Standalone scripts e.g. cloud-init interactive generator.

Pre-requisites

cd graphiant-playbooks/

1. Install Python 3.12+

2. Create and activate python virtual environment

python3.12 -m venv venv
source venv/bin/activate

3. Install the requirement packages

pip3 install -r requirements.txt

Testing virtual environment

1. Update the PYTHONPATH env variable

export PYTHONPATH=$PYTHONPATH:$(pwd)

2. Enter the host URL and credentials under test.ini

[credentials]
username = username
password = password
[host]
url = https://api.graphiant.com

3. Enable the sanity test under test/test.py to fetch the enterprise ID

suite.addTest(TestGraphiantPlaybooks('test_get_enterprise_id'))

4. Run the sanity test and verify the enterprise ID is fetched

python3 test/test.py

Getting Started

Step 1: Define Configurations

All input configs should be placed in the configs/ folder.

• sample_bgp_peering.yaml
• sample_interface_config.yaml
• sample_global_routing_policies.yaml

Note : Also refer the templates under templates/ dir for more details on the supported arguments.

Step 2: Import and Use graphiant-playbooks

from libs.edge import Edge

host = "https://api.graphiant.com"
username = 'username'
password = 'password'
edge = Edge(base_url=host, username=username, password=password)

Step 3:

To Configure the interfaces defined in sample_interface_config.yaml

Configure Interfaces: edge.configure_interfaces("sample_interface_config.yaml")

To Deconfigure the interfaces defined in sample_interface_config.yaml

Deconfigure Interfaces: edge.deconfigure_interfaces("sample_interface_config.yaml")

To configure the Global Prefixes, Routing Policies and BGP Peering

Configure Global Prefixes: edge.configure_global_prefix("sample_global_routing_policies.yaml")
Configure Global Routing Policies: edge.configure_global_bgp_routing_policies("sample_global_routing_policies.yaml")
Configure BGP Peering: edge.configure_bgp_peers("sample_bgp_peering.yaml")

To unlink and deconfigure the BGP Peers

edge.detach_policies_from_bgp_peers("sample_bgp_peering.yaml")
edge.deconfigure_bgp_peers("sample_bgp_peering.yaml")

To Deconfigure the Global BGP Routing Policies

edge.deconfigure_global_bgp_routing_policies("sample_global_routing_policies.yaml")

Note: Make sure the routing policies are not attached to any BGP peering configs before deconfigure

To Deconfigure the Global Prefixes

edge.deconfigure_global_prefix("sample_global_routing_policies.yaml")

Note: Make sure the Global Prefixes are not attached before deconfigure

Source code linter checks

Error linters point out syntax errors or other code that will result in unhandled exceptions and crashes. (pylint, flake8) Style linters point out issues that don't cause bugs but make the code less readable or are not in line with style guides such as Python's PEP 8. (pylint, flake8)

flake8

flake8 ./libs
flake8 ./test

pylint

pylint --errors-only ./libs

jinjalint

djlint configs -e yaml
djlint templates -e yaml

Most modern IDE also have excellent support for python linting tools. For example:

• https://plugins.jetbrains.com/plugin/11084-pylint

• https://plugins.jetbrains.com/plugin/11563-flake8-support

• https://marketplace.visualstudio.com/items?itemName=ms-python.flake8

• https://marketplace.visualstudio.com/items?itemName=ms-python.pylint

Pre-commit checks

pre-commit can be used to install/manage git hooks that will run these linting checks before committing.

pre-commit install