Skip to content
Snippets Groups Projects
Commit 43b77409 authored by Simone Spinelli's avatar Simone Spinelli
Browse files

Refinement to structure and home page

parent 7c5eccbf
Branches
Tags
2 merge requests!14Develop,!13Update documentation structure
Pipeline #83925 failed
docs/assets/images/TNC23_diagrams-WFO-LSO_interaction.drawio.png

71.7 KiB

docs/assets/images/TNC23_diagrams-WFO_GAP.drawio.png

127 KiB

docs/assets/images/gap_architecture_diagram.png

264 KiB

This diff is collapsed.
# GÉANT Automation Platform (GAP) # GÉANT Automation Platform (GAP)
Welcome to the documentation of the GÉANT Automation Platform, or GAP for short. \ Welcome to the documentation of the GÉANT Automation Platform, or GAP for short.
The focus of this platform is configuration management and service orchestration for the GÉANT IP/MPLS network. The focus of this platform is configuration management and service orchestration for the GÉANT IP/MPLS network.
## What is GAP
GAP represents the vision of GÉANT in terms of Network Automation and Orchestration and it summarise few years of experiments and initiatives in this field with the aim of fulfilling the following objectives:
- to have a simple interface for managing network service lifecycle (provisioning, deprovisioning, modification) that ensures that the correct configuration is pushed on the network
- to have a platform - not a single product - that is capable of adapt and evolve according to GÉANT needs
- to have certainty that OSS/BSS systems are in sync with the actual configuration running in the network
- to introduce a different way of working that avoids fragmentation and silos.
GAP is partially based on Open Source Software and partially internally developed and integrates with most of the tooling already in use in GÉANT.
More information about the GAP architecture is available in the [Architecture](./architecture/index.md) section.
## About this documentation portal
This site is organized in 4 main sections:
- [Architecture](./architecture/index.md): covers the architecture of GAP including all the components and the interactions between them
- [Legacy GAP](./legacy_platform/overview.md): provides operational guides of the legacy GAP platform based on Ansible and Jenkins
- [Admin guide](./admin_guide/index.md): covers the detail information of the domain models in WFO, the description of the workflows and all the ansible mechanics
- [User guide](./user_guide/index.md): provides operational guides of the Worflow Orchestrator based GAP
The documentation provided in this portal is final and reviewed. For information about the ongoing work please refer to the wiki [GOAT Wiki](https://wiki.geant.org/display/NNAT/GOAT+-+Geant+Orchestration+and+Automation+Team)
Also this documentation does not cover the design of network services, just the modelling and the mechanics related with automation.
# Overview
Configuration management is the process that maintains consistency and integrity of the network and of the services
built on top of it. It ensures that the network meets requirements in terms of functionalities, performance, and
security.
In the context of the IP/MPLS layer and particularly the backbone routers, different teams manage configuration
in different ways. To deploy new nodes and to operate the network, they use various tools en methods. These tools check
compliance and quality afterward: this approach requires much manual work, and it's inherently error-prone.
This project aims to standardize the configuration and the configuration deployment process. By using Open Source tools
and DevOps strategies there is one single framework to deploy and to operate. Considering the network configuration as
code and managing it under a version control system (GitLab) will enable better visibility and control of changes and
will help standardize the way of working.
The goal is to reduce configuration drifts and exceptions, MTTR in case of fault, and possibly the
number and the severity of incidents. To verify configuration compliance before it gets deployed, several policies are
in place. Multiple non-production environments are used to automatically run regression and acceptance tests, in order
to ensure the highest quality and to detect problems early.
Automated configuration management must be considered as the foundation of further work in network automation, towards
service orchestration trough different technology domains (Optical, IP/MPLS, Applications) and intent-based
networking.
...@@ -20,7 +20,7 @@ theme: ...@@ -20,7 +20,7 @@ theme:
- navigation.instant - navigation.instant
- navigation.tracking - navigation.tracking
- navigation.sections - navigation.sections
- navigation.expand - toc.integrate
- navigation.path - navigation.path
- navigation.indexes - navigation.indexes
- content.code.copy - content.code.copy
...@@ -43,12 +43,17 @@ extra_css: ...@@ -43,12 +43,17 @@ extra_css:
# Page tree # Page tree
nav: nav:
- Home: index.md - Home: index.md
- Overview: overview/index.md
- Architecture: - Architecture:
- architecture/index.md - architecture/index.md
- Modeling: - DTAP:
- architecture/modeling/index.md - architecture/dtap/index.md
- Ports: architecture/modeling/ports.md - Test: architecture/dtap/test.md
- Acceptance: architecture/dtap/acceptance.md
- Production: architecture/dtap/production.md
- Components:
- Ansible: architecture/components/ansible/index.md
- WorkflowOrchestrator: architecture/components/wfo/index.md
- Netbox: architecture/components/netbox/index.md
- User Guide: - User Guide:
- user_guide/index.md - user_guide/index.md
- Sites: - Sites:
...@@ -58,7 +63,15 @@ nav: ...@@ -58,7 +63,15 @@ nav:
- user_guide/routers/index.md - user_guide/routers/index.md
- user_guide/routers/deploy_router.md - user_guide/routers/deploy_router.md
- IP Trunks: user_guide/iptrunks/index.md - IP Trunks: user_guide/iptrunks/index.md
- Admin Guide: admin_guide/index.md - Admin Guide:
- admin_guide/index.md
- Ansible:
- admin_guide/Ansible/ansible.md
- WFO:
- Diagram: admin_guide/WFO/overview.md
- Sites: admin_guide/WFO/sites.md
- Routers: admin_guide/WFO/routers.md
- Iptrunks: admin_guide/WFO/iptrunks.md
- Legacy Platform: - Legacy Platform:
- Overview: legacy_platform/overview.md - Overview: legacy_platform/overview.md
- New Router Deployment: legacy_platform/new_router_deployment.md - New Router Deployment: legacy_platform/new_router_deployment.md
...@@ -76,4 +89,8 @@ markdown_extensions: ...@@ -76,4 +89,8 @@ markdown_extensions:
pygments_lang_class: true pygments_lang_class: true
- pymdownx.inlinehilite - pymdownx.inlinehilite
- pymdownx.snippets - pymdownx.snippets
- pymdownx.superfences - pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment