Skip to content
Snippets Groups Projects
Verified Commit 2d47c575 authored by Karel van Klink's avatar Karel van Klink :smiley_cat:
Browse files

fix terms, remove separate glossary page

parent e5b62514
No related branches found
No related tags found
2 merge requests!12Move to MkDocs material,!11Move to MkDocs material
...@@ -5,7 +5,7 @@ Next to this, also troubleshooting and maintenance are included. ...@@ -5,7 +5,7 @@ Next to this, also troubleshooting and maintenance are included.
The structure is: The structure is:
- {term}`WFO` - WFO
- Modelling - Modelling
- Workflow - Workflow
- Maintenance - Maintenance
......
...@@ -8,7 +8,7 @@ versions all configuration, and it's also responsible for managing mechanisms su ...@@ -8,7 +8,7 @@ versions all configuration, and it's also responsible for managing mechanisms su
The stack of tools is kept limited: The stack of tools is kept limited:
* Workflow Orchestrator ({term}`WFO`) orchestrates all changes. * Workflow Orchestrator (WFO) orchestrates all changes.
* Ansible is the tool that deploys configuration. * Ansible is the tool that deploys configuration.
* If needed, custom Python scripts can support extra functionality. * If needed, custom Python scripts can support extra functionality.
...@@ -19,18 +19,17 @@ introduced: ...@@ -19,18 +19,17 @@ introduced:
* A service database. * A service database.
* A workflow engine. * A workflow engine.
All three of these components are deployed as part of {term}`WFO`. More information about {term}`WFO` can be found on All three of these components are deployed as part of WFO. More information about WFO can be found on their website
their website <a href="https://workfloworchestrator.org/" target="_blank">here</a>. <a href="https://workfloworchestrator.org/" target="_blank">here</a>.
(configuration-decomposition)=
## Configuration (de)composition ## Configuration (de)composition
The configuration of a network element can be decomposed in different functional parts: The configuration of a network element can be decomposed in different functional parts:
* Base configuration. * Base configuration.
* Service configuration: * Service configuration:
* {term}`IFS` * IFS
* {term}`CFS` * CFS
The base configuration includes all configuration necessary to provision a new node, and to include it in the network. The base configuration includes all configuration necessary to provision a new node, and to include it in the network.
It covers aspects such as: It covers aspects such as:
......
docs/assets/images/logo.png

2.78 KiB

:root { :root {
--md-primary-fg-color: #EE0F0F; --md-primary-fg-color: #ED1556;
--md-primary-fg-color--light: #ECB7B7; --md-primary-fg-color--light: #F8B8CC;
--md-primary-fg-color--dark: #90030C; --md-primary-fg-color--dark: #6D2077;
} }
# Glossary of terms
{.glossary}
BGP
: Border Gateway Protocol
CFS
: Customer Facing Service
eBGP
: External {term}`BGP`
GA
: Access Port
GAN
: Access Node
GAP
: GÉANT Automation Platform
GP
: Physical Port
iBGP
: Internal {term}`BGP`
IFS
: Interface Facing Service
IP
: Internet Protocol
IS-IS
: Intermediate System to Intermediate System: a routing protocol described in
<a href="https://datatracker.ietf.org/doc/html/rfc7142" target="_blank">{term}`RFC` 7142</a>.
MPLS
: Multi-Protocol Label Switching
MTTR
: Mean Time To Repair
MTU
: Maximum Transmission Unit
NREN
: National Research and Education Network
OOB
: Out-of-band
PoP
: Point of Presence
RFC
: Request For Comments
SDP
: Service Delivery Point
WFO
: <a href="https://workfloworchestrator.org/" target="_blank">Workflow Orchestrator</a>
# GÉANT Automation Platform ({term}`GAP`) # GÉANT Automation Platform (GAP)
Welcome to the documentation of the GÉANT Automation Platform, or {term}`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/{term}`MPLS` network. The focus of this platform is configuration management and service orchestration for the GÉANT IP/MPLS network.
This documentation has the following sections: This documentation has the following sections:
......
# Overview # Overview
The current {term}`GAP` is simple and its fundamental parts are: The current GAP is simple and its fundamental parts are:
- An <a href="https://gitlab.geant.net/neteam/network-automation/na-production/prod_network_inventory/-/tree/master" - An <a href="https://gitlab.geant.net/neteam/network-automation/na-production/prod_network_inventory/-/tree/master"
target="_blank">Ansible inventory</a> stored in Git target="_blank">Ansible inventory</a> stored in Git
...@@ -17,12 +17,12 @@ An overview of the platform is depicted in the following picture: ...@@ -17,12 +17,12 @@ An overview of the platform is depicted in the following picture:
## Functionalities ## Functionalities
Currently, {term}`GAP` is capable of the following capabilities: Currently, GAP is capable of the following capabilities:
- Provisioning of nodes and {term}`IP` trunks: - Provisioning of nodes and IP trunks:
- Deployment of base configuration on a new router - Deployment of base configuration on a new router
- Deployment of a new trunk with metric=9000 - Deployment of a new trunk with metric=9000
- Insertion of a new router in the {term}`iBGP` mesh - Insertion of a new router in the iBGP mesh
- Periodic checks of configuration: - Periodic checks of configuration:
- Verification of single stanza of configuration - Verification of single stanza of configuration
- Others: - Others:
......
...@@ -17,7 +17,7 @@ Every object -- both services and access ports -- is composed of the following b ...@@ -17,7 +17,7 @@ Every object -- both services and access ports -- is composed of the following b
* IP trunk * IP trunk
* IPv4 network * IPv4 network
* IPv6 network * IPv6 network
* {term}`IS-IS` metric * IS-IS metric
* Placement metadata * Placement metadata
* Access node * Access node
* Service delivery point * Service delivery point
...@@ -3,19 +3,19 @@ ...@@ -3,19 +3,19 @@
While a port shouldn't be configured in case there is no service insisting on it, it could happen that more than one While a port shouldn't be configured in case there is no service insisting on it, it could happen that more than one
service is insisting on one port. For this reason, the following entities exist: service is insisting on one port. For this reason, the following entities exist:
{term}`SDP` SDP
: Service Delivery Point: the logical interface where a service is delivered : Service Delivery Point: the logical interface where a service is delivered
{term}`GA` GA
: Access Port: an access point into the GÉANT network : Access Port: an access point into the GÉANT network
{term}`GP` GP
: Physical Port: the physical boundary for the {term}`GA` : Physical Port: the physical boundary for the GA
{term}`GAN` GAN
: Access Node: the node where a service is delivered : Access Node: the node where a service is delivered
These concepts apply to both {term}`CFS`es and {term}`IFS`es. These concepts apply to both CFSes and IFSes.
```{figure} /static/access_port_diagram.png ```{figure} /static/access_port_diagram.png
:alt: Diagram that displays the different entities that make up a GÉANT service. :alt: Diagram that displays the different entities that make up a GÉANT service.
...@@ -26,10 +26,10 @@ A visualisation of how services insist on ports. ...@@ -26,10 +26,10 @@ A visualisation of how services insist on ports.
## Peer-to-peer and multipoint services ## Peer-to-peer and multipoint services
There is a distinction between services -- as mentioned in [configuration (de)composition](#configuration-decomposition) There is a distinction between services -- as mentioned in [configuration (de)composition](#configuration-decomposition)
-- between peer-to-peer and multipoint services. In both cases, {term}`SDP` is the delivery point of a service. -- between peer-to-peer and multipoint services. In both cases, SDP is the delivery point of a service.
However, for multipoint services customers are supposed to be dual-homed in at least two different {term}`GAN`s. However, for multipoint services customers are supposed to be dual-homed in at least two different GANs.
To give some examples, the figure below shows a decomposition of a GeantIP service for an {term}`NREN`. To give some examples, the figure below shows a decomposition of a GeantIP service for an NREN.
```{figure} /static/geant_ip_ports_diagram.png ```{figure} /static/geant_ip_ports_diagram.png
:alt: Diagram that displays the different entities that make up a GeantIP service instance. :alt: Diagram that displays the different entities that make up a GeantIP service instance.
......
...@@ -4,7 +4,7 @@ Configuration management is the process that maintains consistency and integrity ...@@ -4,7 +4,7 @@ Configuration management is the process that maintains consistency and integrity
built on top of it. It ensures that the network meets requirements in terms of functionalities, performance, and built on top of it. It ensures that the network meets requirements in terms of functionalities, performance, and
security. security.
In the context of the IP/{term}`MPLS` layer and particularly the backbone routers, different teams manage configuration 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 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. compliance and quality afterward: this approach requires much manual work, and it's inherently error-prone.
...@@ -13,11 +13,11 @@ and DevOps strategies there is one single framework to deploy and to operate. Co ...@@ -13,11 +13,11 @@ and DevOps strategies there is one single framework to deploy and to operate. Co
code and managing it under a version control system (GitLab) will enable better visibility and control of changes and 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. will help standardize the way of working.
The goal is to reduce configuration drifts and exceptions, {term}`MTTR` in case of fault, and possibly the 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 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 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. 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 Automated configuration management must be considered as the foundation of further work in network automation, towards
service orchestration trough different technology domains (Optical, IP/{term}`MPLS`, Applications) and intent-based service orchestration trough different technology domains (Optical, IP/MPLS, Applications) and intent-based
networking. networking.
...@@ -2,15 +2,15 @@ ...@@ -2,15 +2,15 @@
From a bird's-eye view, the process of deploying a new router in the network is as follows: From a bird's-eye view, the process of deploying a new router in the network is as follows:
1. Manually configure the router such that it's reachable from out-of-band ({term}`OOB`). 1. Manually configure the router such that it's reachable from out-of-band (OOB).
2. Upgrade the router to the most recent OS. 2. Upgrade the router to the most recent OS.
3. Deploy base configuration. 3. Deploy base configuration.
4. Configure trunks to connect the router to the network. 4. Configure trunks to connect the router to the network.
5. Update the protocol meshes (such as {term}`iBGP`). 5. Update the protocol meshes (such as iBGP).
6. Promote the router to the production environment. 6. Promote the router to the production environment.
```{figure} ../static/WFO_deploy_router.png ```{figure} ../static/WFO_deploy_router.png
:alt: Diagram that displays the steps that Workflow Orchestrator takes to provision a new router. :alt: Diagram that displays the steps that Workflow Orchestrator takes to provision a new router.
{term}`WFO` provisions a new router by following the steps shown here. WFO provisions a new router by following the steps shown here.
``` ```
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
A node can either be a router, a switch, or a terminal server. In general -- as laid out more extensively A node can either be a router, a switch, or a terminal server. In general -- as laid out more extensively
<a href="https://wiki.geant.org/display/NETENG/001+-+Topology+and+physical+layout" target="_blank">here</a> (behind <a href="https://wiki.geant.org/display/NETENG/001+-+Topology+and+physical+layout" target="_blank">here</a> (behind
login) -- a {term}`PoP`consists of: login) -- a PoPconsists of:
* One or two routers * One or two routers
* One switch * One switch
...@@ -14,22 +14,22 @@ Globally, the workflow for a new site is as follows: ...@@ -14,22 +14,22 @@ Globally, the workflow for a new site is as follows:
1. Generate base configuration from GitLab 1. Generate base configuration from GitLab
2. Ship the device to its location 2. Ship the device to its location
3. Verify reachability and insert in LibreNMS 3. Verify reachability and insert in LibreNMS
2. Deploy {term}`PoP` router in a 'core' fashion 2. Deploy PoP router in a 'core' fashion
1. Rack it up and configure the hardware 1. Rack it up and configure the hardware
2. Connect the router to the terminal server via both a console connection, and FXP 2. Connect the router to the terminal server via both a console connection, and FXP
3. Deploy base configuration using {term}`GAP` 3. Deploy base configuration using GAP
3. Deploy {term}`PoP` switch 3. Deploy PoP switch
1. Rack it up and configure the hardware 1. Rack it up and configure the hardware
2. Connect the switch to the terminal server via both a console connection, and FXP 2. Connect the switch to the terminal server via both a console connection, and FXP
3. Deploy base configuration using {term}`GAP` 3. Deploy base configuration using GAP
4. Deploy the {term}`PoP` interconnect between router and switch 4. Deploy the PoP interconnect between router and switch
1. Set up a physical connection between router and switch 1. Set up a physical connection between router and switch
2. Deploy configuration using {term}`GAP` 2. Deploy configuration using GAP
5. Deploy IP trunks to connect the router to the rest of the network 5. Deploy IP trunks to connect the router to the rest of the network
1. Set up a physical connection 1. Set up a physical connection
2. Deploy configuration using {term}`GAP` 2. Deploy configuration using GAP
6. Update the {term}`iBGP` mesh to include the new router, promoting it to an edge router 6. Update the iBGP mesh to include the new router, promoting it to an edge router
1. Deploy configuration using {term}`GAP` 1. Deploy configuration using GAP
2. Using {term}`GAP`, insert the devices in LibreNMS 2. Using GAP, insert the devices in LibreNMS
In the context of the automation platform, the {term}`PoP` interconnects mentioned are modeled as separate objects. In the context of the automation platform, the PoP interconnects mentioned are modeled as separate objects.
*[BGP]: Border Gateway Protocol
*[CFS]: Customer Facing Service
*[eBGP]: External BGP
*[GA]: Access Port
*[GAN]: Access Node
*[GAP]: GÉANT Automation Platform
*[GP]: Physical Port
*[iBGP]: Internal BGP
*[IFS]: Interface Facing Service
*[IS-IS]: Intermediate System to Intermediate System
*[MPLS]: Multi-Protocol Label Switching
*[MTTR]: Mean Time To Repair
*[MTU]: Maximum Transmission Unit
*[NREN]: National Research and Education Network
*[OOB]: Out-of-band
*[PoP]: Point of Presence
*[RFC]: Request For Comments
*[SDP]: Service Delivery Point
*[WFO]: Workflow Orchestrator
# General # General
site_name: Geant Automation Platform site_name: GÉANT Automation Platform
site_url: https://docs.gap.geant.org/ site_url: https://docs.gap.geant.org/
site_author: GÉANT Orchestration and Automation Team site_author: GÉANT Orchestration and Automation Team
site_description: General documentation for the GÉANT Automation Platform site_description: General documentation for the GÉANT Automation Platform
...@@ -11,10 +11,27 @@ repo_url: https://gitlab.software.geant.org/goat/gap/geant-automation-platform ...@@ -11,10 +11,27 @@ repo_url: https://gitlab.software.geant.org/goat/gap/geant-automation-platform
# Theme # Theme
theme: theme:
name: material name: material
logo: assets/images/logo.png
icon:
repo: fontawesome/brands/gitlab
features:
- navigation.instant
- navigation.tracking
- navigation.sections
- navigation.expand
- navigation.path
- navigation.indexes
palette: palette:
primary: custom - scheme: custom
toggle:
icon: material/weather-sunny
name: Switch to dark mode
- scheme: slate
toggle:
icon: material/weather-night
name: Switch to light mode
extra_css: extra_css:
- static/stylesheets/extra.css - assets/stylesheets/extra.css
# Page tree # Page tree
nav: nav:
...@@ -24,3 +41,11 @@ nav: ...@@ -24,3 +41,11 @@ nav:
- Modeling: - Modeling:
- modeling/index.md - modeling/index.md
- Ports: modeling/ports.md - Ports: modeling/ports.md
# Extras
markdown_extensions:
- abbr
- attr_list
- pymdownx.snippets:
auto_append:
- includes/glossary.md
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment