...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
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 extCpdData 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 throughsuggested:
which the orchestrator can
"<helmchartname>:[<subchartname>.]^(0..N)[<parentparamname>.]^(0..N)<paramname>".
configure the extermalIPs parameter ofWhether the K8soptional serviceparts orof ingressthe
format are present depends on how the
controller, or the pod network interface annotation, thatparameter theis
declared in the helm chart. An example is:
extCpdData represents.
required: false"chartName:subChart1.subChart2.subChart3.Parent1.Parent2.Parent3.LBIP".
typerequired: listfalse
entry_schematype: string
external_IPs:
type: string
nad_namesdescription: >
description: >
When present, this Specifies,attribute forspecifies anthe extCpdDataname respesentingof athe secondary networkdeployment interface,
the name(s) of the deployment artifact artifact input parameter(s) through which
the orchestrator can
the orchestrator can provideconfigure the namesextermalIPs parameter of the network attachmentK8s service or ingress
definitions (NADs)controller, or the orchestratorpod hasnetwork createdinterface as base forannotation, that the network
interface the extCpdData represents.
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<helmchartname>:[<subchartname>.]^(0..N)[<parentparamname>.]^(0..N[)<paramname>]”".
Whether 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.paramNameextIP".
required: false
A directtype: attachedlist
(passthrough) network interface, such as an sriov entry_schema:
type: string
interface, attaches to a network via only one of the two switch planes
in the infrastructure. nad_names:
description: >
Specifies, for an extCpdData respesenting a secondary network interface,
When using a direct attached network interface one therefore commonly in a
the name(s) of the deployment artifact input parameter(s) through which
the orchestrator podcan usesprovide athe matednames pair of sriovthe network attachments,attachment where
each interface
definitions (NADs) the attachesorchestrator samehas networkcreated butas viabase differentfor switchplane.
the network
The application usesinterface the matedextCpdData pairrepresents. of
network interfaces as a single
Note 1: When the extCpdData represent logicala “swith-path-redundant” network interface – and this is represented
networkRedundant/mated-pair of
sriov interfaces, there are references to 2 or by3 arelated singleNADs extCpdData.needed
Alsoto therebe ispassed, awhile casefor whereother ainterface thirdtypes “bond”only attachmentone interfaceNAD isreference used
in
is needed theto 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.
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 Whenthe threenamespace NADswhere arethe usedNetworkAttachmentDefinitions in(NADs) theare extCpdDatalocated.
the NAD implementing the bond attachment
Attribute may be omitted if the interfacenamespace is providedsame throughas the application parameter
indicated in the third place in
namespace.
the nadNames attribute.
requiredNote: false
The format of the Content strings type:is list
specific for each different
entry_schema:
orchestration type:templating string
technology used nad_namespace:(Helm, Teraform, etc.).
description: >
Currently only a Specifies,format for anuse extCpdDatawith respesentingHelm acharts secondary network interface,is suggested:
the name of the deployment artifact input parameter through which the orchestrator
can provide the namespace where the NetworkAttachmentDefinitions (NADs) are located."<helmchartname>:[<subchartname>.]^(0..N)[<parentparamname>.]^(0..N)<paramname>".
Whether the optional parts of the format are present depends on how the
Attributeparameter mayis bedeclared omittedin if the namespacehelm ischart. sameAn asexample theis: application
namespace."chartName:subChart1.subChart2.subChart3.Parent1.Parent2.Parent3.NameSpace".
required: false
type: string |
...