Skip to content

Create vrf

A creation workflow for adding a new virtual routing and forwarding (VRF) service.

initial_input_form_generator(product_name)

Gather information about the new router from the operator.

Source code in gso/workflows/vrf/create_vrf.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
def initial_input_form_generator(product_name: str) -> FormGenerator:
    """Gather information about the new router from the operator."""

    class CreateVRFForm(FormPage):
        model_config = ConfigDict(title=product_name)

        tt_number: TTNumber
        partner: ReadOnlyField("GEANT", default_type=str)  # type: ignore[valid-type]
        vrf_name: UniqueField[str]
        route_distinguisher: str
        route_target: str
        vrf_as_number: int

    user_input = yield CreateVRFForm
    user_input = user_input.model_dump()
    summary_fields = ["vrf_name", "route_distinguisher", "route_target", "vrf_as_number"]
    yield from create_summary_form(user_input, product_name, summary_fields)

    return user_input

create_subscription(product, partner)

Create a new VRF subscription.

Source code in gso/workflows/vrf/create_vrf.py 
41
42
43
44
45
46
47
48
49
@step("Create subscription")
def create_subscription(product: UUIDstr, partner: str) -> State:
    """Create a new VRF subscription."""
    subscription = VRFInactive.from_product_id(product, get_partner_by_name(partner).partner_id)

    return {
        "subscription": subscription,
        "subscription_id": subscription.subscription_id,
    }

initialize_subscription(subscription, vrf_name, route_distinguisher, route_target, vrf_as_number)

Initialise the subscription object in the service database.

Source code in gso/workflows/vrf/create_vrf.py 
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
@step("Initialize subscription")
def initialize_subscription(
    subscription: VRFInactive,
    vrf_name: str,
    route_distinguisher: str,
    route_target: str,
    vrf_as_number: int,
) -> State:
    """Initialise the subscription object in the service database."""
    subscription.vrf.vrf_name = vrf_name
    subscription.vrf.route_distinguisher = route_distinguisher
    subscription.vrf.route_target = route_target
    subscription.vrf.vrf_as_number = vrf_as_number
    subscription.description = f"VRF {vrf_name} - {vrf_as_number}"

    return {"subscription": subscription}

create_vrf()

Create a virtual routing and forwarding (VRF) service.

Source code in gso/workflows/vrf/create_vrf.py 
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
@workflow(
    "Create VRF",
    initial_input_form=wrap_create_initial_input_form(initial_input_form_generator),
    target=Target.CREATE,
)
def create_vrf() -> StepList:
    """Create a virtual routing and forwarding (VRF) service."""
    return (
        begin
        >> create_subscription
        >> store_process_subscription(Target.CREATE)
        >> initialize_subscription
        >> set_status(SubscriptionLifecycle.ACTIVE)
        >> resync
        >> done
    )