GraphQL is a query language for APIs and has been adopted by popular web services, including GitHub, ArangoDB and Nautobot, a network automation platform. This session introduces GraphQL and demonstrates using Nautobot as a Source of Truth for managing the configuration of Arista Containerized EOS (cEOS) routers using Ansible. Network engineers who wish to learn GraphQL for Nautobot, Ansible, and cEOS will benefit from this session. A sample code repository will be published for attendees.

1. Introduction to GraphQL
A use case using Arista cEOS and Nautobot
Thursday, March 10, 2022

2. Introduction to GraphQL for NetDevOps Engineers
Details
GraphQL is a query language for APIs and has been
adopted by popular web services, including GitHub,
ArangoDB and Nautobot, a network automation platform.
This session introduces GraphQL and demonstrates
using Nautobot as a Source of Truth for managing the
configuration of Arista Containerized EOS (cEOS) routers
using Ansible.
Network engineers who wish to learn GraphQL for
Nautobot, Ansible, and cEOS will benefit from this
session. A sample code repository will be published for
attendees.
Photo Credit: Dan Dimmock on Unsplash

3. What’s in it for me?
gitlab.com/joelwking/graphql4netdevops
Arista CloudEOS
Network to Code
Ansible

4. gitlab.com/joelwking/graphql4netdevops

5. topology
CONTAINER
(HOST) EC2 INSTANCE
CONTAINER
NET1
NET2
AristacEOSLab
version4.26.4M Nautobot
CONTAINER
sshadmin@<ec2_instance>-p 2201 -p 2202
http://<ec2_instance>:8001
VSCODE DEVCONTAINER
httpapi_port:4431 : 4432
ansible.netcommon.httpapi
ansible.netcommon.network_cli

6. Install lab environment
RACKS
PODS (RACK GROUPS)
RACKS
Inventory
Receiving
Connection
Initial
Config
LAB_BUILD.md
DAY ZERO

7. populate Nautobot
CONTAINER
(HOST) EC2 INSTANCE
CONTAINER
NET1
NET2
AristacEOSLab
version4.26.4M Nautobot
CONTAINER
http://<ec2_instance>:8001
files/global.yml
build_nautobot.yml
group_vars/all.yml
nautobot:
url: "http://{{ lab_instance }}:8001"
token: '{{ vault_nautobot.token }}'
ANSIBLE PLAYBOOK

8. onboard device using a YAML file
host_vars/ceos1.example.net.yml
files/inventory.yml
group_vars/cloud_ceos/vars.yml
files/vault.yml

9. onboard device into Nautobot

11. history
https://engineering.fb.com/2015/09/14/core-data/graphql-a-data-query-language
Developed in 2012, for Facebook’s native mobile apps - query language for APIs - returns JSON

12. GraphQL vs APIs
• Supports Queries (via GET or POST)
modifying state in the server (mutation)
• HTTP via a single URL endpoint
• Returns the data that's explicitly requested
(avoiding versioning)
• Query fields are same as the results
(you get back what you expect)
• Arguments implement data transformations
e.g. height(unit: FOOT)
Supports all REST Verbs: POST PATCH GET …
HTTP suite of URLs for each resource
New features to an API = new version
Postman, Swagger | OpenAPI
Client-side data transformations

13. GraphQL
GraphQL is a query language for your API
{ API } { GraphQL } nautobot.query_graphql
Nautobot

14. GraphiQL
http://ec2-54-175-161-85.compute-1.amazonaws.com:8001/graphql/
GraphiQL is an in-browser tool for writing,
validating, and testing GraphQL queries.

15. GraphiQL is an in-browser tool Schema definition

16. arguments
{
"data": {
"devices": [
{
"name": "ceos1.example.net",
"interfaces": [
{
"mtu": 9214,
"name": "Ethernet1"
}
],
"tags": [
{
"name": "r00"
}
],
"device_role": {
"name": "LEAF"
}
}
]
}
}
GraphQL, every field and nested object can get its own set of arguments
RESULT
query ArgumentExample {
devices(name: "ceos1.example.net") {
name
interfaces(name: "Ethernet1") {
mtu
name
}
tags {
name
}
device_role{
name
}
}
}

17. graph Variables
factor dynamic values out of the query and pass them as a separate dictionary.
Eliminate any static value(s) in the
query with $variableName
Declare $variableName as one of the variables
accepted by the query
Pass variableName: value in the separate,
transport-specific (usually JSON) variables
dictionary

18. arguments: limiting results

19. multiple GraphQL operations in a request
query MultipleQueries {
devices(name: "ceos1.example.net") {
name
interfaces(name: "Ethernet1") {
mtu
name
}
tags {
name
}
device_role{
name
}
}
device_roles {
name
color
description
}
}
{
"data": {
"devices": [
{
"name": "ceos1.example.net",
"interfaces": [
{
"mtu": 9214,
"name": "Ethernet1"
}
],
"tags": [
{
"name": "r00"
}
],
"device_role": {
"name": "LEAF"
}
}
],
"device_roles": [
{
"name": "LEAF",
"color": "ffeeff",
"description": ""
},
{
"name": "SPINE",
"color": "ffeeff",
"description": ""
},

20. - name: configure a device defined in Nautobot
hosts: '{{ group_name | default("cloud_ceos") }}'
gather_facts: false
vars:
graph_vars:
device_name: '{{ inventory_hostname }}'
tip
./configure_device.yml --limit ceos1.example.net
execute a GraphQL query per device at the beginning of the playbook
--limit ceos1.example.net,ceos2.example.net

21. ansible-playbook ./configure_device.yml --limit ceos1.example.net,ceos2.example.net -f 1
-i files/inventory.yml

22. GraphQL
inventory plugin
ok: [ceos1.example.org] => {
"hostvars[inventory_hostname]": {
"ansible_check_mode": false,
...
"ansible_host": "ceos1.example.org",
"ansible_inventory_sources": [
"/workspaces/graphql4netdevops/playbooks/files/inventory_gql.yml"
],
"device": {
"interfaces": [
...
{
"address": "198.51.100.3/32",
"description": "management",
"name": "Loopback0",
"tags": [
"loopback"
],
"type": "Virtual"
}
],
"name": "ceos1.example.org",
"rack": "r10",
"role": "LEAF",
"serial_number": "AD3C6BFFD846916E0875D8EDAA7F83FB-2",
"site": "RALEIGH",
"type": "N5860-48SC"
},
"device_role": {
"name": "LEAF"
},
ansible-playbook
./graph_ql_as_inventory.yml
-i files/inventory_gql.yml
- name: GraphQL as an inventory source
hosts: all
gather_facts: false
tasks:
- name: Display all variables/facts
debug:
var: hostvars[inventory_hostname]

24. gitlab.com/joelwking/graphql4netdevops
/ config_contexts
Nautobot
{
devices(name: "ceos1.example.net") {
name
config_context
tags {
name
}
device_role{
name
}
}
}

25. Git as a data source

26. config contexts + extensibility + GraphQL
RACKS
PODS (RACK GROUPS)
RACKS
R04
RACKS
PODS (RACK GROUPS)
RACKS
ASN
64521
ASN
64621
TAG
TAG
ceos1.example.net

27. {
"_metadata":{
"name":"r00",
"weight": 1000,
"description":"Rack specific",
"is_active":true,
"tags":[{"slug": "r00"}],
"schema":""
},
"asn":{
"number":64521},
"acl": {
"definitions":{
"named ": {
"PERMIT_ROUTES":[
"10 permit ipanyany"
]
}
}
}
}
config contexts + extensibility + GraphQL
RACKS
PODS (RACK GROUPS)
RACKS
R04
RACKS
PODS (RACK GROUPS)
RACKS
ASN
64521
ASN
64621
TAG
TAG
r00.json
Assignments:
Region, Site, Role, Device type, Platform, Cluster group, Cluster, Tenant group,
Tenant, Tag

28. GraphQL results
config context by device and tag
TAG

29. Learning environment
Arista cEOS
Ansible
VSCode
Nautobot
Overview of GraphQL
GraphIQL
arguments
variables
Ansible inventory plugin
Configuration Contexts
Git as a Data Source
Reference config contexts in GraphQL Query

30. past sessions content posted at
https://www.wwt.com/community/programmability-and-
automation-meetup-group/

31.  GraphQL
https://graphql.org/learn/
 graphql4netdevops
https://gitlab.com/joelwking/graphql4netdevops
 Programmability and Automation Meetup Group [RECORDINGS]
https://www.wwt.com/community/programmability-and-automation-meetup-group/
 GraphQL user guide
https://nautobot.readthedocs.io/en/latest/user-guides/graphql/
 Config Contexts
https://nautobot.readthedocs.io/en/latest/additional-features/config-contexts/
https://blog.networktocode.com/post/keeping-data-clean-in-nautobot/
 Nautobot Solution Guide
https://www.networktocode.com/wp-
content/uploads/2021/02/Nautobot_Technical_Solution_Guide.pdf