Skip to main content
Version: Canary 🚧

Trial Network Descriptor

A Trial Network Descriptor is a YAML file that defines the structure and configuration of a trial network, describing all the components involved, their types, names, dependencies, and input parameters. It acts as a blueprint that the TNLCM uses to orchestrate the deployment of the trial network, ensuring that all required resources are created and connected in the correct order.

warning

The format of Trial Network Descriptors has not been finalized and may change in the future.

Trial Network Descriptors are yaml files with a set of expected fields and with the following structure:

trial_network: # Mandatory, contains the description of all entities in the Trial Network
type-name: # Mandatory, entity name. Unique identifier for each entity in the Trial Network
type: # Mandatory, 6G-Library component type
name: # Mandatory, custom name. Not use character \- or \. Exclude components tn_init, tn_bastion and tn_vxlan
debug: # Optional, param to debug component in Jenkins. Possible values true or false
dependencies: # Mandatory, list of dependencies of the component with other components
- type-name
- ...
input: # Mandatory, dictionary with the variables collected from the input part of the 6G-Library
key: value

The TNLCM repository contains some advanced descriptors. Access the documentation to see what is defined in each of them.

note

Each component in the 6G-Library has a descriptor and a readme defined to understand how it works.

Now continue in the TNLCM Usa