Skip to content

Shared steps

Workflow steps that are used in multiple Layer 2 Circuit workflows.

generate_fqdn_list(subscription)

Generate the list of FQDNs that this workflow should target.

This list will consist of two elements, one for each far end of the circuit.

Source code in gso/workflows/l2_circuit/shared_steps.py 
16
17
18
19
20
21
22
23
24
25
26
@step("Generate FQDN list")
def generate_fqdn_list(subscription: Layer2Circuit) -> State:
    """Generate the list of FQDNs that this workflow should target.

    This list will consist of two elements, one for each far end of the circuit.
    """
    return {
        "fqdn_list": [
            side.sbp.edge_port.node.router_fqdn for side in subscription.layer_2_circuit.layer_2_circuit_sides
        ]
    }

extract_partner_name_from_edge_port(subscription)

Expand a subscription model of a Layer 2 Circuit.

This method will include the name of each Edge Port's partner to be used in Ansible playbooks.

Source code in gso/workflows/l2_circuit/shared_steps.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
@step("Expand subscription dictionary")
def extract_partner_name_from_edge_port(subscription: dict[str, Any]) -> State:
    """Expand a subscription model of a Layer 2 Circuit.

    This method will include the name of each Edge Port's partner to be used in Ansible playbooks.
    """
    modified_subscription = deepcopy(subscription)
    for side in modified_subscription["layer_2_circuit"]["layer_2_circuit_sides"]:
        side["sbp"]["edge_port"]["partner_name"] = get_partner_by_id(
            EdgePort.from_subscription(side["sbp"]["edge_port"]["owner_subscription_id"]).customer_id
        ).name

    return {"modified_subscription": modified_subscription}

provision_l2circuit_dry(modified_subscription, process_id, tt_number, fqdn_list)

Perform a dry run of deploying a Layer 2 Circuit.

Source code in gso/workflows/l2_circuit/shared_steps.py 
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
@step("[DRY RUN] Deploy L2circuit")
def provision_l2circuit_dry(
    modified_subscription: dict[str, Any], process_id: UUIDstr, tt_number: str, fqdn_list: list[str]
) -> LSOState:
    """Perform a dry run of deploying a Layer 2 Circuit."""
    extra_vars = {
        "subscription": modified_subscription,
        "dry_run": True,
        "verb": "deploy",
        "commit_comment": f"GSO_PROCESS_ID: {process_id} - TT_NUMBER: {tt_number} - "
        f"Deploy config for {modified_subscription["description"]}",
    }

    return {
        "playbook_name": "gap_ansible/playbooks/l2circuit.yaml",
        "inventory": {"all": {"hosts": dict.fromkeys(fqdn_list)}},
        "extra_vars": extra_vars,
    }

provision_l2circuit_real(modified_subscription, process_id, tt_number, fqdn_list)

Perform a dry run of deploying a Layer 2 Circuit.

Source code in gso/workflows/l2_circuit/shared_steps.py 
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
@step("[REAL RUN] Deploy L2circuit")
def provision_l2circuit_real(
    modified_subscription: dict[str, Any], process_id: UUIDstr, tt_number: str, fqdn_list: list[str]
) -> LSOState:
    """Perform a dry run of deploying a Layer 2 Circuit."""
    extra_vars = {
        "subscription": modified_subscription,
        "dry_run": False,
        "verb": "deploy",
        "commit_comment": f"GSO_PROCESS_ID: {process_id} - TT_NUMBER: {tt_number} - "
        f"Deploy config for {modified_subscription["description"]}",
    }

    return {
        "playbook_name": "gap_ansible/playbooks/l2circuit.yaml",
        "inventory": {"all": {"hosts": dict.fromkeys(fqdn_list)}},
        "extra_vars": extra_vars,
    }

terminate_l2circuit_dry(process_id, tt_number, modified_subscription, fqdn_list)

Perform a dry run of removing old configuration of a Layer 2 Circuit.

Source code in gso/workflows/l2_circuit/shared_steps.py 
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
@step("[DRY RUN] Remove old config")
def terminate_l2circuit_dry(
    process_id: UUIDstr, tt_number: TTNumber, modified_subscription: dict[str, Any], fqdn_list: list[str]
) -> LSOState:
    """Perform a dry run of removing old configuration of a Layer 2 Circuit."""
    extra_vars = {
        "subscription": modified_subscription,
        "dry_run": True,
        "verb": "terminate",
        "commit_comment": f"GSO_PROCESS_ID: {process_id} - TT_NUMBER: {tt_number} - "
        f"Remove config for {modified_subscription["description"]}",
    }

    return {
        "playbook_name": "gap_ansible/playbooks/l2circuit.yaml",
        "inventory": {"all": {"hosts": dict.fromkeys(fqdn_list)}},
        "extra_vars": extra_vars,
    }

terminate_l2circuit_real(process_id, tt_number, modified_subscription, fqdn_list)

Remove old configuration of a Layer 2 Circuit.

Source code in gso/workflows/l2_circuit/shared_steps.py 
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
@step("[FOR REAL] Remove old config")
def terminate_l2circuit_real(
    process_id: UUIDstr, tt_number: TTNumber, modified_subscription: dict[str, Any], fqdn_list: list[str]
) -> LSOState:
    """Remove old configuration of a Layer 2 Circuit."""
    extra_vars = {
        "subscription": modified_subscription,
        "dry_run": False,
        "verb": "terminate",
        "commit_comment": f"GSO_PROCESS_ID: {process_id} - TT_NUMBER: {tt_number} - "
        f"Remove config for {modified_subscription["description"]}",
    }

    return {
        "playbook_name": "gap_ansible/playbooks/l2circuit.yaml",
        "inventory": {"all": {"hosts": dict.fromkeys(fqdn_list)}},
        "extra_vars": extra_vars,
    }