tosca.datatypes.asd.paramMappings:
version: 0.1
derived_from: tosca.datatypes.Root
description: "Describes the datatype for parameter mapping"
properties:
loadbalancer_IP:
description: >
When present, this attribute specifies the name of the deployment
artifact input parameter through which the orchestrator can
configure the loadbalancerIP parameter of the K8s service
or ingress controller that the ExtCpdextCpdData represents.
required: false
typeNote: string
The format of the Content strings external_IPs:
is specific for each different
description: >
orchestration templating technology used When(Helm, presentTeraform, this attribute specifies the name of the deployment
etc.).
Currently only a format for use with artifactHelm inputcharts parameteris through which the orchestrator cansuggested:
"<helmchartname>:[<subchartname>.]^(0..N)[<parentparamname>.]^(0..N)<paramname>".
configureWhether the extermalIPsoptional parameterparts of the K8sformat serviceare orpresent ingressdepends
on how the
controller, or the podparameter networkis interface annotation, thatdeclared in the
helm chart. An example is:
ExtCpd represents. "chartName:subChart1.subChart2.subChart3.Parent1.Parent2.Parent3.LBIP".
required: false
type: liststring
entryexternal_schemaIPs:
description: >
type: string
nad_name:
When present, description:this >
attribute specifies the name of the deployment
Specifies, for an ExtCpd respesenting a secondary network interface,
artifact input parameter through which the orchestrator can
the name(s) of the NetworkAttachmentDefinitions the orchestrator has
configure createdthe asextermalIPs baseparameter forof the networkK8s interfaceservice theor ExtCpdingress represents.
required: false
type: list
controller, or the pod network entry_schema:
interface annotation, that the
type:extCpdData string
represents.
nad_namespace:
description: >
Specifies, for an asdExtCpd respesenting a secondary network interface,
the namespace where the NetworkAttachmentDefinitions (NADs) are located.Note: The format of the Content strings is specific for each different
orchestration templating technology used (Helm, Teraform, etc.).
Currently only a format for use with Helm charts is suggested:
"<helmchartname>:[<subchartname>.]^(0..N)[<parentparamname>.]^(0..N)<paramname>".
Whether the optional parts of the format are present depends on how the
parameter is declared in the helm chart. An example is:
"chartName:subChart1.subChart2.subChart3.Parent1.Parent2.Parent3.extIP".
required: false
type: list
entry_schema:
type: string
nad_names:
description: >
Specifies, for an extCpdData respesenting a secondary network interface,
the name(s) of the deployment artifact input parameter(s) through which
the orchestrator can provide the names of the network attachment
definitions (NADs) the orchestrator has created as base for the network
interface the extCpdData represents.
Note 1: When the extCpdData represent a networkRedundant/mated-pair of
sriov interfaces, there are references to 2 or 3 related NADs needed
to be passed, while for other interface types only one NAD reference
is needed to be passed.
Note 2: The format of the Content strings is specific for each different
orchestration templating technology used (Helm, Teraform, etc.).
Currently only a format for use with Helm charts is suggested:
"<helmchartname>:[<subchartname>.]^(0..N)[<parentparamname>.]^(0..N)<paramname>".
Whether the optional parts of the format are present depends on how the
parameter is declared in the helm chart. An example is:
chartName:"subChart1.subChart2.subChart3.Parent1.Parent2.Parent3.nadName".
Note 3: A direct attached (passthrough) network interface, such as an sriov
interface, attaches to a network via only one of the two switch planes
in the infrastructure.
When using a direct attached network interface one therefore commonly in a
pod uses a mated pair of sriov network attachments, where each interface
attaches same network but via different switchplane.
The application uses the mated pair of network interfaces as a single
logical “swith-path-redundant” network interface – and this is represented
by a single extCpdData.
Also there is a case where a third “bond” attachment interface is used in
the pod, bonding the two direct interfaces so that the application do not
need to handle the redundancy issues – application just uses the bond interface.
In this case, all three attachments are together making up a logical
“switch-path-redundant” network interface represented by a single extCpdData.
When three NADs are used in the extCpdData the NAD implementing the bond attachment
interface is provided through the parameter indicated in the third place in
the nadNames attribute.
required: false
type: list
entry_schema:
type: string
nad_namespace:
description: >
Specifies, for an extCpdData respesenting a secondary network interface,
the name of the deployment artifact input parameter through which the orchestrator
can provide the namespace where the NetworkAttachmentDefinitions (NADs) are located.
Attribute may be omitted if the namespace is same as the application
namespace.
Note: The format of the Content strings is specific for each different
orchestration templating technology used (Helm, Teraform, etc.).
Currently only a format for use with Helm charts is suggested:
"<helmchartname>:[<subchartname>.]^(0..N)[<parentparamname>.]^(0..N)<paramname>".
Whether the optional parts of the format are present depends on how the
Attributeparameter mayis bedeclared omitted ifin the namespacehelm ischart. sameAn as the applicationexample is:
namespace."chartName:subChart1.subChart2.subChart3.Parent1.Parent2.Parent3.NameSpace".
required: false
type: string | 