Skip to content
Snippets Groups Projects
Commit 97f8ab1e authored by Karel van Klink's avatar Karel van Klink :smiley_cat: Committed by Mohammad Torkashvand
Browse files

Use extension for generating links that open in a new tab

parent 383fec8e
No related branches found
No related tags found
1 merge request!329Feature/update docstrings
...@@ -5,7 +5,7 @@ set -o nounset ...@@ -5,7 +5,7 @@ set -o nounset
export OSS_PARAMS_FILENAME=../gso/oss-params-example.json export OSS_PARAMS_FILENAME=../gso/oss-params-example.json
export TESTING=true export TESTING=true
pip install pyyaml mkdocstrings-python mkdocs_gen_files mkdocs-material mkdocs-literate-nav mkdocs-redirects pip install pyyaml mkdocstrings-python mkdocs_gen_files mkdocs-material mkdocs-literate-nav mkdocs-redirects mkdocs-open-in-new-tab
pip install -e .. pip install -e ..
python ./scripts/gen_wf_redirects.py python ./scripts/gen_wf_redirects.py
......
...@@ -29,6 +29,7 @@ with Path.open(root / "docs" / "wf_redirects.yaml", "w") as redirect_file: ...@@ -29,6 +29,7 @@ with Path.open(root / "docs" / "wf_redirects.yaml", "w") as redirect_file:
file_content = { file_content = {
"plugins": [ "plugins": [
"search", "search",
{"open-in-new-tab": {"add_icon": True}},
{"gen-files": {"scripts": ["scripts/gen_ref_pages.py"]}}, {"gen-files": {"scripts": ["scripts/gen_ref_pages.py"]}},
{"redirects": {"redirect_maps": redirect_map}}, {"redirects": {"redirect_maps": redirect_map}},
{"literate-nav": {"nav_file": "SUMMARY.md"}}, {"literate-nav": {"nav_file": "SUMMARY.md"}},
......
...@@ -22,7 +22,7 @@ classDiagram ...@@ -22,7 +22,7 @@ classDiagram
A node consists of one or more routers, a switch, and a terminal server. A node consists of one or more routers, a switch, and a terminal server.
In general -- as laid out more extensively In general -- as laid out more extensively
<a href="https://wiki.geant.org/display/NETENG/001+-+Topology+and+physical+layout" target="_blank">here</a> [here](https://wiki.geant.org/display/NETENG/001+-+Topology%2C+physical+layout+and+site+design)
(behind login) -- a PoP consists of: (behind login) -- a PoP consists of:
* One or two routers * One or two routers
......
...@@ -18,11 +18,9 @@ library dependencies. ...@@ -18,11 +18,9 @@ library dependencies.
## Inner workings ## Inner workings
LSO uses <a href="https://ansible.readthedocs.io/projects/runner/en/latest/" LSO uses [`ansible-runner`](https://ansible.readthedocs.io/projects/runner/en/latest/) for the execution of Ansible
target="_blank">`ansible-runner`</a> for the execution of Ansible playbooks. playbooks. This package fully dictates the way in which GAP interacts with Ansible itself. LSO only introduces an API
This package fully dictates the way in which GAP interacts with Ansible itself. with a single REST endpoint that exposes its functionality.
LSO only introduces an API with a single REST endpoint that exposes its
functionality.
In the case of GAP, all Ansible playbooks operate without an inventory that In the case of GAP, all Ansible playbooks operate without an inventory that
contains all relevant `group_vars` and `host_vars`. The inventory is passed to contains all relevant `group_vars` and `host_vars`. The inventory is passed to
...@@ -148,15 +146,12 @@ full-fledged API request to LSO, an example call is given. ...@@ -148,15 +146,12 @@ full-fledged API request to LSO, an example call is given.
## Code documentation ## Code documentation
Code documentation for LSO can be found Code documentation for LSO can be found [here](https://workfloworchestrator.org/lso).
<a href="https://workfloworchestrator.org/lso" target="_blank">here</a>.
## Deployment within GÉANT ## Deployment within GÉANT
For the deployment in GÉANT, LSO runs inside a Docker container. The Dockerfile For the deployment in GÉANT, LSO runs inside a Docker container. A Dockerfile that can be used to build this container
used to build this container is available <a href= is available [here](https://github.com/workfloworchestrator/lso/blob/main/Dockerfile.example).
"https://gitlab.software.geant.org/goat/gap/lso/-/blob/develop/Dockerfile"
target="_blank">here</a>.
When building the Docker image, some Ansible roles and collections are installed When building the Docker image, some Ansible roles and collections are installed
that are required for interacting with Juniper and Nokia equipment. For another that are required for interacting with Juniper and Nokia equipment. For another
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment