diff --git a/docs/glossary.md b/docs/glossary.md index a8b04849844b190c92b8db524c6c82ee1ed04b9b..519be3da5793e17d9ec1cf129ca69267ed6b3252 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -34,8 +34,14 @@ MPLS MTTR : Mean Time To Repair +OOB +: Out-of-band + PoP : Point of Presence SDP : Service Delivery Point + +WFO +: Workflow Orchestrator diff --git a/docs/index.md b/docs/index.md index 18f67cbb1dbfe749da2771e3ad04b5c809b43e92..a711d0eb473a072f8213c80be996bc5612276477 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,9 +5,9 @@ The focus of this platform is configuration management and service orchestration ## Table of contents ```{toctree} +:maxdepth: 2 overview/index.md architecture/index.md -processes/node_provisioning.md -processes/deploy_router.md +processes/index.md glossary.md ``` diff --git a/docs/processes/deploy_router.md b/docs/processes/deploy_router.md new file mode 100644 index 0000000000000000000000000000000000000000..6b5518dd1686c754de4c034c3f445a20cb811659 --- /dev/null +++ b/docs/processes/deploy_router.md @@ -0,0 +1,16 @@ +## Router deployment + +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`). +2. Upgrade the router to the most recent OS. +3. Deploy base configuration. +4. Configure trunks to connect the router to the network. +5. Update the protocol meshes (such as {term}`iBGP`). +6. Promote the router to the production environment. + +```{figure} ../static/WFO_deploy_router.png +: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. +``` diff --git a/docs/processes/index.md b/docs/processes/index.md new file mode 100644 index 0000000000000000000000000000000000000000..edc1fd2d7f627dceb7fde061abe327c30100a15b --- /dev/null +++ b/docs/processes/index.md @@ -0,0 +1,9 @@ +# Processes + +This section describes the mechanics for deploying different types of devices in the GÉANT network. + +```{include} node_provisioning.md +``` + +```{include} deploy_router.md +``` diff --git a/docs/processes/node_provisioning.md b/docs/processes/node_provisioning.md index 2cdf3894d2253a1fa8b0392e1a6017d3de4e02af..3afdb6784c808f60215f82c3264414b819b39f10 100644 --- a/docs/processes/node_provisioning.md +++ b/docs/processes/node_provisioning.md @@ -1,9 +1,6 @@ -# Node provisioning +## Node provisioning -This section describes the mechanics for deploying a new node in the GÉANT network. 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 [here](https://wiki.geant.org/display/NETENG/001+-+Topology+and+physical+layout) (behind login) -- a {term}`PoP` consists of: diff --git a/docs/static/WFO_deploy_router.png b/docs/static/WFO_deploy_router.png new file mode 100644 index 0000000000000000000000000000000000000000..6aeb39b0414aacba70243d7a12d8f16253bba728 Binary files /dev/null and b/docs/static/WFO_deploy_router.png differ diff --git a/docs/vale/styles/Vocab/geant-jargon/accept.txt b/docs/vale/styles/Vocab/geant-jargon/accept.txt index 45572995ec47519422ce6bdbbd1d135f3b42d027..b164bf925229b62a35202cc47950263e69ce1a01 100644 --- a/docs/vale/styles/Vocab/geant-jargon/accept.txt +++ b/docs/vale/styles/Vocab/geant-jargon/accept.txt @@ -14,3 +14,6 @@ AAA GÉANT Automation Platform GAP [Mm]ultipoint +WFO +BGP +FXP