diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst index 4dc66b8eac5e2e408f220c93b8c4be80cf8e3301..5a090e7e00d1662129843c2637af81bcd54d3368 100644 --- a/docs/source/glossary.rst +++ b/docs/source/glossary.rst @@ -57,15 +57,24 @@ Glossary of terms LAG Link Aggregation: a bundle of multiple network connections. + LAN + Local Area Network + LSO Lightweight Service Orchestrator NET Network Entity Title: used for :term:`ISIS` routing. + OIDC + OpenID Connect + OOB Out-of-band access + OPA + Open Policy Agent + OSS Operational Support Systems @@ -79,8 +88,8 @@ Glossary of terms UUID Universally Unique Identifier + VLAN + Virtual LAN + WFO `Workflow Orchestrator <https://workfloworchestrator.org/>`_ - - LAN - Local Area Network diff --git a/docs/source/module/api/v1/imports/index.rst b/docs/source/module/api/v1/imports/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..2564784d3f8318135a672ba3dd8542f2386a8ac5 --- /dev/null +++ b/docs/source/module/api/v1/imports/index.rst @@ -0,0 +1,19 @@ +``gso.api.v1.imports`` +====================== + +.. automodule:: gso.api.v1.imports + :members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + iptrunk + office_router + router + site + super_pop_switch diff --git a/docs/source/module/api/v1/imports/iptrunk.rst b/docs/source/module/api/v1/imports/iptrunk.rst new file mode 100644 index 0000000000000000000000000000000000000000..da47e4a640744e47196d7250c1340785a8a5c352 --- /dev/null +++ b/docs/source/module/api/v1/imports/iptrunk.rst @@ -0,0 +1,6 @@ +``gso.api.v1.imports.iptrunk`` +============================== + +.. automodule:: gso.api.v1.imports.iptrunk + :members: + :show-inheritance: diff --git a/docs/source/module/api/v1/imports/office_router.rst b/docs/source/module/api/v1/imports/office_router.rst new file mode 100644 index 0000000000000000000000000000000000000000..b6a54fcb421b608bf066ede51d5bc664470a9543 --- /dev/null +++ b/docs/source/module/api/v1/imports/office_router.rst @@ -0,0 +1,6 @@ +``gso.api.v1.imports.office_router`` +==================================== + +.. automodule:: gso.api.v1.imports.office_router + :members: + :show-inheritance: diff --git a/docs/source/module/api/v1/imports/router.rst b/docs/source/module/api/v1/imports/router.rst new file mode 100644 index 0000000000000000000000000000000000000000..f0fe06a76debe74479067aaa480845ddd265f395 --- /dev/null +++ b/docs/source/module/api/v1/imports/router.rst @@ -0,0 +1,6 @@ +``gso.api.v1.imports.router`` +============================= + +.. automodule:: gso.api.v1.imports.router + :members: + :show-inheritance: diff --git a/docs/source/module/api/v1/imports/site.rst b/docs/source/module/api/v1/imports/site.rst new file mode 100644 index 0000000000000000000000000000000000000000..0695d701eb50cbd6ec561796f0fea395fd5c617e --- /dev/null +++ b/docs/source/module/api/v1/imports/site.rst @@ -0,0 +1,6 @@ +``gso.api.v1.imports.site`` +=========================== + +.. automodule:: gso.api.v1.imports.site + :members: + :show-inheritance: diff --git a/docs/source/module/api/v1/imports/super_pop_switch.rst b/docs/source/module/api/v1/imports/super_pop_switch.rst new file mode 100644 index 0000000000000000000000000000000000000000..24da1b12c09625e8c57a8fb19fec55139b34085e --- /dev/null +++ b/docs/source/module/api/v1/imports/super_pop_switch.rst @@ -0,0 +1,6 @@ +``gso.api.v1.imports.super_pop_switch`` +======================================= + +.. automodule:: gso.api.v1.imports.super_pop_switch + :members: + :show-inheritance: diff --git a/docs/source/module/api/v1/index.rst b/docs/source/module/api/v1/index.rst index a40080e2019e321c1f4427fd41a0c58c564b5ba2..4b4883c39a62ed61dcb90e275fd24b0fff1749cb 100644 --- a/docs/source/module/api/v1/index.rst +++ b/docs/source/module/api/v1/index.rst @@ -12,7 +12,7 @@ Submodules :maxdepth: 2 :titlesonly: - imports + imports/index subscriptions processes - networks + network diff --git a/docs/source/module/api/v1/imports.rst b/docs/source/module/api/v1/network.rst similarity index 50% rename from docs/source/module/api/v1/imports.rst rename to docs/source/module/api/v1/network.rst index b40e8edaed706c8656407fa1fc8d1b3d9bc060be..a37f21d3055339f356bdec88964f992cecc83963 100644 --- a/docs/source/module/api/v1/imports.rst +++ b/docs/source/module/api/v1/network.rst @@ -1,6 +1,6 @@ -``gso.api.v1.imports`` +``gso.api.v1.network`` ====================== -.. automodule:: gso.api.v1.imports +.. automodule:: gso.api.v1.network :members: :show-inheritance: diff --git a/docs/source/module/api/v1/networks.rst b/docs/source/module/api/v1/networks.rst deleted file mode 100644 index e85dda9ead0424f293134cfba61a0429887c88bd..0000000000000000000000000000000000000000 --- a/docs/source/module/api/v1/networks.rst +++ /dev/null @@ -1,6 +0,0 @@ -``gso.api.v1.subscriptions`` -============================ - -.. automodule:: gso.api.v1.networks - :members: - :show-inheritance: diff --git a/docs/source/module/api/v1/processes.rst b/docs/source/module/api/v1/processes.rst index 82aa87628771ec27ee360bf8c2ac4a79eef248ed..436d9887a5f7e126f9d78c3e6fc09fa374528cf7 100644 --- a/docs/source/module/api/v1/processes.rst +++ b/docs/source/module/api/v1/processes.rst @@ -1,5 +1,5 @@ ``gso.api.v1.processes`` -============================ +======================== .. automodule:: gso.api.v1.processes :members: diff --git a/docs/source/module/services/crm.rst b/docs/source/module/services/crm.rst deleted file mode 100644 index cee4e5018343626463809b6a9cb7a4bb499937ff..0000000000000000000000000000000000000000 --- a/docs/source/module/services/crm.rst +++ /dev/null @@ -1,6 +0,0 @@ -``gso.services.crm`` -==================== - -.. automodule:: gso.services.crm - :members: - :show-inheritance: diff --git a/docs/source/module/services/index.rst b/docs/source/module/services/index.rst index 7b1a1d5540b8c52e0f64c466184864339b36723a..d93ddc5a42b90420c033482720600ba21530568c 100644 --- a/docs/source/module/services/index.rst +++ b/docs/source/module/services/index.rst @@ -12,9 +12,10 @@ Submodules :maxdepth: 2 :titlesonly: - crm infoblox librenms_client lso_client + mailer netbox_client + partners subscriptions diff --git a/docs/source/module/services/mailer.rst b/docs/source/module/services/mailer.rst new file mode 100644 index 0000000000000000000000000000000000000000..f54148cfec985ad723d9319a5558f7641563883a --- /dev/null +++ b/docs/source/module/services/mailer.rst @@ -0,0 +1,6 @@ +``gso.services.mailer`` +======================= + +.. automodule:: gso.services.mailer + :members: + :show-inheritance: diff --git a/docs/source/module/services/partners.rst b/docs/source/module/services/partners.rst new file mode 100644 index 0000000000000000000000000000000000000000..a828b5a3142af6439a3f63b35590310a916aa204 --- /dev/null +++ b/docs/source/module/services/partners.rst @@ -0,0 +1,6 @@ +``gso.services.partners`` +========================= + +.. automodule:: gso.services.partners + :members: + :show-inheritance: diff --git a/docs/source/module/utils/index.rst b/docs/source/module/utils/index.rst index 0bb43e3e0af577d3d15f9ec1cc6e189a19928eb4..52f992ba035f17541d1e5314844ee59490a883bf 100644 --- a/docs/source/module/utils/index.rst +++ b/docs/source/module/utils/index.rst @@ -12,8 +12,8 @@ Submodules :maxdepth: 2 :titlesonly: - shared_choices device_info exceptions helpers + shared_enums workflow_steps diff --git a/docs/source/module/utils/shared_choices.rst b/docs/source/module/utils/shared_choices.rst deleted file mode 100644 index 46460a304905ef81cdd14481cb316d242adc62bf..0000000000000000000000000000000000000000 --- a/docs/source/module/utils/shared_choices.rst +++ /dev/null @@ -1,6 +0,0 @@ -``gso.utils.shared_choices`` -============================ - -.. automodule:: gso.utils.shared_choices - :members: - :show-inheritance: diff --git a/docs/source/module/utils/shared_enums.rst b/docs/source/module/utils/shared_enums.rst new file mode 100644 index 0000000000000000000000000000000000000000..5fe261d499b076c1ba85418caea676f10c5321da --- /dev/null +++ b/docs/source/module/utils/shared_enums.rst @@ -0,0 +1,6 @@ +``gso.utils.shared_enums`` +========================== + +.. automodule:: gso.utils.shared_enums + :members: + :show-inheritance: diff --git a/docs/source/module/workflows/iptrunk/create_imported_iptrunk.rst b/docs/source/module/workflows/iptrunk/create_imported_iptrunk.rst index c7a72a1a1af789e2a07e5d2c1e458f75dec408d1..1e0d42c73a3757c4e3e82cdc7b60686638a4af09 100644 --- a/docs/source/module/workflows/iptrunk/create_imported_iptrunk.rst +++ b/docs/source/module/workflows/iptrunk/create_imported_iptrunk.rst @@ -1,5 +1,5 @@ ``gso.workflows.iptrunk.create_imported_iptrunk`` -====================================== +================================================= .. automodule:: gso.workflows.iptrunk.create_imported_iptrunk :members: diff --git a/docs/source/module/workflows/iptrunk/import_iptrunk.rst b/docs/source/module/workflows/iptrunk/import_iptrunk.rst new file mode 100644 index 0000000000000000000000000000000000000000..4d5379f9c8782b62feabd735bd5d0c494576477d --- /dev/null +++ b/docs/source/module/workflows/iptrunk/import_iptrunk.rst @@ -0,0 +1,6 @@ +``gso.workflows.iptrunk.import_iptrunk`` +======================================== + +.. automodule:: gso.workflows.iptrunk.import_iptrunk + :members: + :show-inheritance: diff --git a/docs/source/module/workflows/iptrunk/index.rst b/docs/source/module/workflows/iptrunk/index.rst index e5135e2e01faf93dd8193448db05d8bc84aecb14..127d1985c0a8c6b86c62182fb0d81ee2951aed59 100644 --- a/docs/source/module/workflows/iptrunk/index.rst +++ b/docs/source/module/workflows/iptrunk/index.rst @@ -15,6 +15,7 @@ Submodules activate_iptrunk create_imported_iptrunk create_iptrunk + import_iptrunk migrate_iptrunk modify_isis_metric modify_trunk_interface diff --git a/docs/source/module/workflows/office_router/import_office_router.rst b/docs/source/module/workflows/office_router/import_office_router.rst new file mode 100644 index 0000000000000000000000000000000000000000..50c55eb5fb6f727468d8c746b7730f66b8ee7665 --- /dev/null +++ b/docs/source/module/workflows/office_router/import_office_router.rst @@ -0,0 +1,6 @@ +``gso.workflows.office_router.import_office_router`` +==================================================== + +.. automodule:: gso.workflows.office_router.import_office_router + :members: + :show-inheritance: diff --git a/docs/source/module/workflows/office_router/index.rst b/docs/source/module/workflows/office_router/index.rst index a3d8b3eb8d84b183bfc58acf2d6ca9ccdc32cb3b..d2aa53dfa3d28f4a06b40b86bc4a1320a0fa8623 100644 --- a/docs/source/module/workflows/office_router/index.rst +++ b/docs/source/module/workflows/office_router/index.rst @@ -12,4 +12,5 @@ Submodules :maxdepth: 2 :titlesonly: - create_imported_office_router + create_imported_office_router + import_office_router diff --git a/docs/source/module/workflows/router/import_router.rst b/docs/source/module/workflows/router/import_router.rst new file mode 100644 index 0000000000000000000000000000000000000000..c0544a275a90226723e71dd3f18cc9fc27d86dde --- /dev/null +++ b/docs/source/module/workflows/router/import_router.rst @@ -0,0 +1,6 @@ +``gso.workflows.router.import_router`` +====================================== + +.. automodule:: gso.workflows.router.import_router + :members: + :show-inheritance: diff --git a/docs/source/module/workflows/router/index.rst b/docs/source/module/workflows/router/index.rst index 08fcc72b429b4e2f7c2bf7d9a40c8dee88ae7015..1913157882cab48dc6d3ddeaafac26acdbf9e8ea 100644 --- a/docs/source/module/workflows/router/index.rst +++ b/docs/source/module/workflows/router/index.rst @@ -15,6 +15,8 @@ Submodules activate_router create_imported_router create_router + import_router + modify_connection_strategy redeploy_base_config terminate_router update_ibgp_mesh diff --git a/docs/source/module/workflows/router/modify_connection_strategy.rst b/docs/source/module/workflows/router/modify_connection_strategy.rst index b60db9b2fcee862a351408d2d66a693c3fc61024..ddecdb9f5e084f5d2b7ce8d273330daa3ed904df 100644 --- a/docs/source/module/workflows/router/modify_connection_strategy.rst +++ b/docs/source/module/workflows/router/modify_connection_strategy.rst @@ -1,5 +1,5 @@ ``gso.workflows.router.modify_connection_strategy`` -========================================= +=================================================== .. automodule:: gso.workflows.router.modify_connection_strategy :members: diff --git a/docs/source/module/workflows/site/import_site.rst b/docs/source/module/workflows/site/import_site.rst new file mode 100644 index 0000000000000000000000000000000000000000..5b5a94bc621843407151a025996d7322b7c10247 --- /dev/null +++ b/docs/source/module/workflows/site/import_site.rst @@ -0,0 +1,6 @@ +``gso.workflows.site.import_site`` +================================== + +.. automodule:: gso.workflows.site.import_site + :members: + :show-inheritance: diff --git a/docs/source/module/workflows/site/index.rst b/docs/source/module/workflows/site/index.rst index b06ffd1398863fdbe347f86d50b2cdbe4122d049..c1b8b06baae294c3316c9c39966914188e5f839d 100644 --- a/docs/source/module/workflows/site/index.rst +++ b/docs/source/module/workflows/site/index.rst @@ -14,5 +14,6 @@ Submodules create_imported_site create_site + import_site modify_site terminate_site diff --git a/docs/source/module/workflows/super_pop_switch/create_imported_super_pop_switch.rst b/docs/source/module/workflows/super_pop_switch/create_imported_super_pop_switch.rst index 69922a13fa966368357b9c17349567f049b3302b..58beb83ef8627beb73bec56980ac23e2d8059ba6 100644 --- a/docs/source/module/workflows/super_pop_switch/create_imported_super_pop_switch.rst +++ b/docs/source/module/workflows/super_pop_switch/create_imported_super_pop_switch.rst @@ -1,6 +1,6 @@ -``gso.workflows.office_router.create_imported_super_pop_switch`` -================================================================ +``gso.workflows.super_pop_switch.create_imported_super_pop_switch`` +=================================================================== -.. automodule:: gso.workflows.office_router.create_imported_super_pop_switch +.. automodule:: gso.workflows.super_pop_switch.create_imported_super_pop_switch :members: :show-inheritance: diff --git a/docs/source/module/workflows/super_pop_switch/import_super_pop_switch.rst b/docs/source/module/workflows/super_pop_switch/import_super_pop_switch.rst new file mode 100644 index 0000000000000000000000000000000000000000..b7cb7e2ed4fbaa1480baea89b43a97c3646402eb --- /dev/null +++ b/docs/source/module/workflows/super_pop_switch/import_super_pop_switch.rst @@ -0,0 +1,6 @@ +``gso.workflows.super_pop_switch.import_super_pop_switch`` +========================================================== + +.. automodule:: gso.workflows.super_pop_switch.import_super_pop_switch + :members: + :show-inheritance: diff --git a/docs/source/module/workflows/super_pop_switch/index.rst b/docs/source/module/workflows/super_pop_switch/index.rst index e76428c78372e5513e8b97ba0e4998fc64a60ace..48672f720f79b81b2441827f5c0a38a3b71789fe 100644 --- a/docs/source/module/workflows/super_pop_switch/index.rst +++ b/docs/source/module/workflows/super_pop_switch/index.rst @@ -12,4 +12,5 @@ Submodules :maxdepth: 2 :titlesonly: - create_imported_super_pop_switch + create_imported_super_pop_switch + import_super_pop_switch diff --git a/docs/vale/styles/config/vocabularies/geant-jargon/accept.txt b/docs/vale/styles/config/vocabularies/geant-jargon/accept.txt index af07d476da370b4fda5d5f2902f784731ae6d5d4..5563489476f4562cb9300cd6688d88b9c579770a 100644 --- a/docs/vale/styles/config/vocabularies/geant-jargon/accept.txt +++ b/docs/vale/styles/config/vocabularies/geant-jargon/accept.txt @@ -26,3 +26,9 @@ TWAMP Pydantic UUID SNMP +V?LAN +OPA +OIDC +OUT +BAND +ALL