diff --git a/LICENSE b/LICENSE index 47a27ba826794dc29b0380cc25225ef15c3d4fc3..a3df5cd7aa939b00c26abe5bf91af8b6d80b36cf 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2023-2024 GÉANT Orchestration and Automation Team +Copyright (c) 2023-2024 GEANT Orchestration and Automation Team Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index b4563b2f937cd4cd5f7918a61fc3251c84aeb7be..95ef4d1984ebc02e6b422f288ed752d39e4ba92a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -# GÉANT Service Orchestrator -The GÉANT interpretation of [``orchestrator-core``](https://github.com/workfloworchestrator/orchestrator-core). +# GEANT Service Orchestrator +The GEANT interpretation of [``orchestrator-core``](https://github.com/workfloworchestrator/orchestrator-core). ## Documentation You can build the documentation locally using [build-docs.sh](build-docs.sh). diff --git a/docs/source/conf.py b/docs/source/conf.py index 74502fb22f8ea416e23b894aae62d6e1d7727368..b99d966e13080727b06e9da6398cd7a9def0d6e9 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -1,7 +1,7 @@ # -- Project information ----------------------------------------------------- -project = "GÉANT Service Orchestrator" -copyright = "2023, GÉANT Vereniging" -author = "GÉANT Orchestration and Automation Team" +project = "GEANT Service Orchestrator" +copyright = "2023, GEANT Vereniging" +author = "GEANT Orchestration and Automation Team" # -- General configuration --------------------------------------------------- extensions = ["sphinx_rtd_theme", "sphinx.ext.autodoc", "sphinxcontrib.jquery"] diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst index 432f73de9e8cdd7f7fd38c5e99f9b434fb1fd82c..0c7792c533ececa4dcdfb8b4f96172dd746c6d43 100644 --- a/docs/source/glossary.rst +++ b/docs/source/glossary.rst @@ -27,7 +27,7 @@ Glossary of terms Fully Quantified Domain Name GSO - GÉANT Service Orchestrator + GEANT Service Orchestrator IAS IAS diff --git a/docs/source/index.rst b/docs/source/index.rst index 5818da8afb4db3fb33ab27b8bf1da24d589b23d1..2df2fad6bc9f48dbef859f8d845a40db5808ccc3 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,7 +1,7 @@ -GÉANT Service Orchestrator +GEANT Service Orchestrator ========================== -Welcome to the documentation of the GÉANT Service Orchestrator, or :term:`GSO` for short. +Welcome to the documentation of the GEANT Service Orchestrator, or :term:`GSO` for short. This documentation has the following sections: diff --git a/docs/vale/styles/config/vocabularies/geant-jargon/accept.txt b/docs/vale/styles/config/vocabularies/geant-jargon/accept.txt index 9172c42e39a10632a75a6e73c17dd9b0e9b5eb41..e41a8b00dee8487f2291d2ef6352fa959026518a 100644 --- a/docs/vale/styles/config/vocabularies/geant-jargon/accept.txt +++ b/docs/vale/styles/config/vocabularies/geant-jargon/accept.txt @@ -1,4 +1,4 @@ -GÉANT Automation Platform +GEANT Automation Platform [GSO|gso] Vereniging [[T|t]erminate|TERMINATE] diff --git a/gso/cli/imports.py b/gso/cli/imports.py index 1a20c14be3840b76a6085f8756af943ef27c9b3d..223278f066141b28d7333c214d24d31c40217357 100644 --- a/gso/cli/imports.py +++ b/gso/cli/imports.py @@ -63,7 +63,7 @@ def generic_import_data( successfully_imported_data = [] data = read_data(filepath) for details in data: - details["customer"] = "GÉANT" + details["customer"] = "GEANT" typer.echo(f"Importing {name_key}: {details[name_key]}") try: initial_data = import_model(**details) @@ -163,7 +163,7 @@ def import_iptrunks(filepath: str = common_filepath_option) -> None: ) try: initial_data = IptrunkImportModel( - customer="GÉANT", + customer="GEANT", geant_s_sid=trunk["id"], iptrunk_type=trunk["config"]["common"]["type"], iptrunk_description=trunk["config"]["common"].get("description", ""), diff --git a/gso/cli/netbox.py b/gso/cli/netbox.py index b4a8b1b6f3a2c387f06e93c77e6956ac6389474b..8765f1a49ecc3653be9b6bf14a730080b5974177 100644 --- a/gso/cli/netbox.py +++ b/gso/cli/netbox.py @@ -14,7 +14,7 @@ def netbox_initial_setup() -> None: """Set up NetBox for the first time. It includes: - - Creating a default site (GÉANT) + - Creating a default site (GEANT) - Creating device roles (Router) """ typer.echo("Initial setup of NetBox ...") @@ -22,7 +22,7 @@ def netbox_initial_setup() -> None: nbclient = NetboxClient() - typer.echo("Creating GÉANT site ...") + typer.echo("Creating GEANT site ...") try: nbclient.create_device_site(DEFAULT_SITE["name"], DEFAULT_SITE["slug"]) typer.echo("Site created successfully.") diff --git a/gso/migrations/versions/2023-11-21_e8378fbcfbf3_add_initial_products.py b/gso/migrations/versions/2023-11-21_e8378fbcfbf3_add_initial_products.py index d2fa1e9929d0056b408379d97fd435178e736921..f273e4fa4321a4fa52ddce15931353606bfa4a06 100644 --- a/gso/migrations/versions/2023-11-21_e8378fbcfbf3_add_initial_products.py +++ b/gso/migrations/versions/2023-11-21_e8378fbcfbf3_add_initial_products.py @@ -10,9 +10,9 @@ from alembic import op # revision identifiers, used by Alembic. revision = 'e8378fbcfbf3' -down_revision = None +down_revision = 'da5c9f4cce1c' branch_labels = ('data',) -depends_on = 'da5c9f4cce1c' +depends_on = None def upgrade() -> None: @@ -132,7 +132,7 @@ INSERT INTO resource_types (resource_type, description) VALUES ('iptrunk_side_ae INSERT INTO resource_types (resource_type, description) VALUES ('site_longitude', 'Longitude of a physical site') RETURNING resource_types.resource_type_id """)) conn.execute(sa.text(""" -INSERT INTO resource_types (resource_type, description) VALUES ('geant_s_sid', 'GÉANT service S-ID') RETURNING resource_types.resource_type_id +INSERT INTO resource_types (resource_type, description) VALUES ('geant_s_sid', 'GEANT service S-ID') RETURNING resource_types.resource_type_id """)) conn.execute(sa.text(""" INSERT INTO product_product_blocks (product_id, product_block_id) VALUES ((SELECT products.product_id FROM products WHERE products.name IN ('IP trunk')), (SELECT product_blocks.product_block_id FROM product_blocks WHERE product_blocks.name IN ('IptrunkBlock'))) diff --git a/gso/migrations/versions/2024-02-14_1c3c90ea1d8c_add_super_pop_switch_product.py b/gso/migrations/versions/2024-02-14_1c3c90ea1d8c_add_super_pop_switch_product.py index aac35ee3331ab554593c1015cd655d69869b8b3c..df3ddd20f1371e6ca287df350cf9ed40eb444c27 100644 --- a/gso/migrations/versions/2024-02-14_1c3c90ea1d8c_add_super_pop_switch_product.py +++ b/gso/migrations/versions/2024-02-14_1c3c90ea1d8c_add_super_pop_switch_product.py @@ -10,7 +10,7 @@ from alembic import op # revision identifiers, used by Alembic. revision = '1c3c90ea1d8c' -down_revision = '113a81d2a40a' +down_revision = '5bea5647f61d' branch_labels = None depends_on = None diff --git a/gso/products/product_blocks/iptrunk.py b/gso/products/product_blocks/iptrunk.py index fa10288cea07580ffb7f5ab48cd5c1520f8d4a6c..8d6d8ee1adf4072b7332105567e3cf55141da060 100644 --- a/gso/products/product_blocks/iptrunk.py +++ b/gso/products/product_blocks/iptrunk.py @@ -138,7 +138,7 @@ class IptrunkBlockProvisioning(IptrunkBlockInactive, lifecycle=[SubscriptionLife class IptrunkBlock(IptrunkBlockProvisioning, lifecycle=[SubscriptionLifecycle.ACTIVE]): """A trunk that's currently deployed in the network.""" - #: GÉANT service ID associated with this trunk. + #: GEANT service ID associated with this trunk. geant_s_sid: str #: A human-readable description of this trunk. iptrunk_description: str diff --git a/gso/products/product_blocks/site.py b/gso/products/product_blocks/site.py index 1852b24615076b2d76dde41db71a9e5d5fcc535f..03ee42561c4505bfd80648bc48a71b2dcd7b0288 100644 --- a/gso/products/product_blocks/site.py +++ b/gso/products/product_blocks/site.py @@ -111,7 +111,7 @@ class SiteBlock(SiteBlockProvisioning, lifecycle=[SubscriptionLifecycle.ACTIVE]) site_latitude: LatitudeCoordinate #: Similar to the latitude, the longitude of a site. site_longitude: LongitudeCoordinate - #: The internal ID used within GÉANT to denote a site. + #: The internal ID used within GEANT to denote a site. site_internal_id: int #: The :term:`BGP` community ID of a site, used to advertise routes learned at this site. site_bgp_community_id: int diff --git a/gso/services/crm.py b/gso/services/crm.py index 810df588e5b3c93081be1796d78bf9b21f4ae23f..b417b88acdaa19e86c8bcd6d2d4a75d29ba6ff03 100644 --- a/gso/services/crm.py +++ b/gso/services/crm.py @@ -1,6 +1,6 @@ """A module that returns the customers available in :term:`GSO`. -For the time being, it's hardcoded to only contain GÉANT as a customer, since this is needed for the deployment of phase +For the time being, it's hardcoded to only contain GEANT as a customer, since this is needed for the deployment of phase 1. """ @@ -16,7 +16,7 @@ def all_customers() -> list[dict]: return [ { "id": "8f0df561-ce9d-4d9c-89a8-7953d3ffc961", - "name": "GÉANT", + "name": "GEANT", }, ] diff --git a/gso/translations/en-GB.json b/gso/translations/en-GB.json index 46f0e96e201e09fd1e8b3e9973084289e108f075..ae4787b6d666e28ebfaa3afd2ea0f544c101cd71 100644 --- a/gso/translations/en-GB.json +++ b/gso/translations/en-GB.json @@ -18,16 +18,16 @@ "vendor": "Router vendor", "router_role": "Router role", - "geant_s_sid": "GÉANT S-SID", + "geant_s_sid": "GEANT S-SID", "iptrunk_description": "IPtrunk description", "iptrunk_type": "IPtrunk type", "iptrunk_speed": "Capacity per port (in Gbits/s)", "iptrunk_minimum_links": "Minimum amount of links", "side_a_ae_iface": "LAG interface name", - "side_a_ae_geant_a_sid": "GÉANT A-SID", + "side_a_ae_geant_a_sid": "GEANT A-SID", "side_a_ae_members": "Aggregated Ethernet member interfaces", "side_b_ae_iface": "LAG interface name", - "side_b_ae_geant_a_sid": "GÉANT A-SID", + "side_b_ae_geant_a_sid": "GEANT A-SID", "side_b_ae_members": "Aggregated Ethernet member interfaces", "migrate_to_different_site": "Migrating to a different Site", "remove_configuration": "Remove configuration from the router", diff --git a/gso/workflows/iptrunk/create_iptrunk.py b/gso/workflows/iptrunk/create_iptrunk.py index e347d111c7689117816a7d60ec04d4571951fd01..9644e117dc27f94b3ef9325c877f2decff0f121e 100644 --- a/gso/workflows/iptrunk/create_iptrunk.py +++ b/gso/workflows/iptrunk/create_iptrunk.py @@ -56,7 +56,7 @@ def initial_input_form_generator(product_name: str) -> FormGenerator: title = product_name tt_number: str - customer: str = ReadOnlyField("GÉANT") + customer: str = ReadOnlyField("GEANT") geant_s_sid: str iptrunk_description: str iptrunk_type: IptrunkType diff --git a/gso/workflows/router/create_router.py b/gso/workflows/router/create_router.py index 978e33ba3205edd747e2193a30eca2f82699a77f..78bd2649b86af7691c992039070717fadf5e6a4d 100644 --- a/gso/workflows/router/create_router.py +++ b/gso/workflows/router/create_router.py @@ -43,7 +43,7 @@ def initial_input_form_generator(product_name: str) -> FormGenerator: title = product_name tt_number: str - customer: str = ReadOnlyField("GÉANT") + customer: str = ReadOnlyField("GEANT") vendor: Vendor router_site: _site_selector() # type: ignore[valid-type] hostname: str diff --git a/gso/workflows/site/create_site.py b/gso/workflows/site/create_site.py index 8e6e13f8436375b4465959985cc115c1e74c40cc..52ed8c95e566a814d0d2c40435fa64a192133e74 100644 --- a/gso/workflows/site/create_site.py +++ b/gso/workflows/site/create_site.py @@ -22,7 +22,7 @@ def initial_input_form_generator(product_name: str) -> FormGenerator: class Config: title = product_name - customer: str = ReadOnlyField("GÉANT") + customer: str = ReadOnlyField("GEANT") site_name: str site_city: str site_country: str diff --git a/setup.py b/setup.py index aca090ffb02788ef8399819c22d01bb6535b8492..1fb1d0a6c23e9c3b9fee7b6b0d304a833e8a959c 100644 --- a/setup.py +++ b/setup.py @@ -3,9 +3,9 @@ from setuptools import find_packages, setup setup( name="geant-service-orchestrator", version="0.9", - author="GÉANT", + author="GEANT", author_email="swd@geant.org", - description="GÉANT Service Orchestrator", + description="GEANT Service Orchestrator", url="https://gitlab.software.geant.org/goat/gap/geant-service-orchestrator", packages=find_packages(), install_requires=[ diff --git a/test/api/test_imports.py b/test/api/test_imports.py index b4d58f86cef94b2992973cc487fcede995819f14..d3e63ea9c267906a01955357c322ac18b0f0668f 100644 --- a/test/api/test_imports.py +++ b/test/api/test_imports.py @@ -23,7 +23,7 @@ def iptrunk_data(nokia_router_subscription_factory, faker): router_side_a = nokia_router_subscription_factory() router_side_b = nokia_router_subscription_factory() return { - "customer": "GÉANT", + "customer": "GEANT", "geant_s_sid": faker.geant_sid(), "iptrunk_type": IptrunkType.DARK_FIBER, "iptrunk_description": faker.sentence(), @@ -107,7 +107,7 @@ def site_data(faker): "site_internal_id": faker.pyint(), "site_tier": SiteTier.TIER1, "site_ts_address": faker.ipv4(), - "customer": "GÉANT", + "customer": "GEANT", } @@ -120,7 +120,7 @@ def router_data(faker, site_data): "router_vendor": Vendor.JUNIPER, "router_site": site_data["site_name"], "ts_port": 1234, - "customer": "GÉANT", + "customer": "GEANT", "router_lo_ipv4_address": mock_ipv4, "router_lo_ipv6_address": faker.ipv6(), "router_lo_iso_address": iso_from_ipv4(mock_ipv4), @@ -134,7 +134,7 @@ def super_pop_switch_data(faker, site_data): "hostname": "127.0.0.1", "super_pop_switch_site": site_data["site_name"], "super_pop_switch_ts_port": 1234, - "customer": "GÉANT", + "customer": "GEANT", "super_pop_switch_mgmt_ipv4_address": mock_ipv4, } @@ -145,7 +145,7 @@ def office_router_data(faker, site_data): "office_router_fqdn": "127.0.0.1", "office_router_site": site_data["site_name"], "office_router_ts_port": 1234, - "customer": "GÉANT", + "customer": "GEANT", "office_router_lo_ipv4_address": faker.ipv4(), "office_router_lo_ipv6_address": faker.ipv6(), } diff --git a/test/workflows/site/test_create_site.py b/test/workflows/site/test_create_site.py index 6a260bc111f055b5724af699da61d4d6a145886f..54fdbce36f654dba93813debe98d0ee957abf883 100644 --- a/test/workflows/site/test_create_site.py +++ b/test/workflows/site/test_create_site.py @@ -65,7 +65,7 @@ def test_site_name_is_incorrect(responses, faker): "site_internal_id": faker.pyint(), "site_tier": SiteTier.TIER1, "site_ts_address": faker.ipv4(), - "customer": get_customer_by_name("GÉANT")["id"], + "customer": get_customer_by_name("GEANT")["id"], }, ]