...
| 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 1:format Whenof the Content extCpdDatastrings representis a networkRedundant/mated-pair ofspecific for each different
sriovorchestration interfaces,templating theretechnology areused references to 2 or 3 related NADs needed (Helm, Teraform, etc.).
toCurrently beonly passed,a whileformat for otheruse interfacewith typesHelm onlycharts one NAD reference is suggested:
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.) "<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
Currently onlytype: alist
format for use with Helm charts is suggestedentry_schema:
type: string
"helmchartname:[<subchartname>.]^(0..N)[<parentparamname>.]^(0..N)[<paramname>]”.
nad_names:
description: >
NoteSpecifies, 3:for Whetheran theextCpdData optionalrespesenting partsa ofsecondary thenetwork formatinterface,
are present depends on how the
the name(s) of the deployment artifact input parameter(s) isthrough declaredwhich in
the helm chart. An example is:
the orchestrator can provide the names of chartName:subChart1.subChart2.subChart3.Parent1.Parent2.Parent3.paramName.
the network attachment
A direct attacheddefinitions (passthroughNADs) the networkorchestrator interface,has suchcreated as base for anthe sriovnetwork
interface, attachesthe toextCpdData arepresents. network
via only one of the two switch planes
Note 1: When the extCpdData represent a in the infrastructure.networkRedundant/mated-pair of
Whensriov usinginterfaces, athere directare attachedreferences networkto interface2 oneor therefore3 commonlyrelated inNADs aneeded
podto usesbe apassed, matedwhile pairfor ofother sriovinterface networktypes attachments,only whereone eachNAD interfacereference
attachesis sameneeded networkto but via different switchplanebe passed.
Note 2: The applicationformat usesof the matedContent pairstrings ofis networkspecific interfacesfor aseach a singledifferent
logical “swith-path-redundant” network interface – and this is represented
orchestration templating technology used (Helm, Teraform, etc.).
Currently only by a singleformat extCpdData.for
use with Helm charts is suggested:
Also there is a case where a third “bond” attachment interface is used in
"<helmchartname>:[<subchartname>.]^(0..N)[<parentparamname>.]^(0..N)<paramname>".
Whether the optional parts of the format are present depends on how the
the pod, bonding the two direct interfaces so thatparameter theis applicationdeclared doin notthe
helm chart. An example is:
need to handle the redundancy issues – application just uses the bond interface.
chartName:"subChart1.subChart2.subChart3.Parent1.Parent2.Parent3.nadName".
Note 3: A direct attached (passthrough) network Ininterface, thissuch case,as allan threesriov attachments
are together making up a logical
interface, attaches to a network via only “switch-path-redundant” network interface represented by a single extCpdData.
one of the two switch planes
in the Wheninfrastructure.
three NADs are used in the extCpdData the NAD implementing the bond attachment
When using a direct attached network interface one therefore commonly in a
interface is provided through the parameter indicated in the third place in
pod uses a mated pair of sriov network attachments, where each interface
the nadNames attribute.
required: false
attaches type:same list
network but via entry_schema:different switchplane.
type: string
The 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.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 omittedin if the namespacehelm ischart. sameAn asexample theis: application
namespace."chartName:subChart1.subChart2.subChart3.Parent1.Parent2.Parent3.NameSpace".
required: false
type: string |
...