...
| 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>]”.
configureWhether the extermalIPsoptional parameterparts of the K8s service or ingress
format are present depends on how the
parameter controller, oris declared in the podhelm networkchart. interfaceAn annotation,example thatis: the
extCpdData represents.chartName:subChart1.subChart2.subChart3.Parent1.Parent2.Parent3.paramName.
required: false
type: liststring
entryexternal_schemaIPs:
typedescription: string>
nad_names:
description: >
When present, this attribute specifies the name of Specifies,the fordeployment an
extCpdData respesenting a secondary network interface,
artifact input parameter through which the name(s) of the deployment artifact input parameter(s) through which
orchestrator can
configure the orchestratorextermalIPs canparameter provideof the namesK8s ofservice theor networkingress attachment
definitions (NADs)controller, or the orchestratorpod hasnetwork createdinterface as base forannotation, that the network
interface the extCpdData represents.
Note: The 1:format Whenof the extCpdDataContent representstrings a networkRedundant/mated-pair of
is specific for each different
sriov interfaces, thereorchestration aretemplating referencestechnology toused 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. "helmchartname:[<subchartname>.]^(0..N)[<parentparamname>.]^(0..N)[<paramname>]”.
NoteWhether 2:the Theoptional formatparts of the Contentformat stringsare ispresent specificdepends foron eachhow differentthe
orchestrationparameter templatingis technologydeclared usedin (Helm, Teraform, etc.).
the helm chart. An example is:
Currently only a format for use with Helm charts is suggested:
"helmchartname:[<subchartname>.]^(0..N)[<parentparamname>.]^(0..N)[<paramname>]”.
chartName:subChart1.subChart2.subChart3.Parent1.Parent2.Parent3.paramName.
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.paramName.
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 Notenetwork 3:interface Whetherone thetherefore optionalcommonly partsin ofa the
format are present depends on how the
pod uses a mated pair of sriov network parameterattachments, iswhere declaredeach ininterface the
helm chart. An example is:
attaches same network but via different chartName:subChart1.subChart2.subChart3.Parent1.Parent2.Parent3.paramName.switchplane.
A direct attached (passthrough)The application uses the mated pair of network interface, suchinterfaces as ana sriovsingle
logical “swith-path-redundant” network interface, attaches– toand a networkthis viais onlyrepresented one
of the two switch planes
by a single extCpdData.
in the infrastructure.
Also there is a Whencase usingwhere a directthird attached“bond” networkattachment interface oneis thereforeused commonly in a
the pod, usesbonding athe matedtwo pairdirect ofinterfaces sriovso networkthat attachments,the whereapplication eachdo interfacenot
need to handle the redundancy issues attaches– sameapplication networkjust butuses viathe differentbond switchplaneinterface.
TheIn applicationthis usescase, theall matedthree pairattachments ofare networktogether interfacesmaking asup a singlelogical
logical “swith“switch-path-redundant” network interface –represented andby thisa issingle representedextCpdData.
by a single extCpdData.When three NADs are used in the extCpdData the NAD implementing the bond attachment
Also thereinterface is aprovided casethrough wherethe aparameter thirdindicated “bond”in attachmentthe interfacethird isplace used in
the pod, bonding the two direct interfaces so that the application do not nadNames attribute.
required: false
type: list
entry_schema:
need to handle the redundancy issuestype: –string
application just uses the bond interface.
nad_namespace:
description: >
In this case, all three attachmentsSpecifies, arefor togetheran makingextCpdData uprespesenting a logicalsecondary network interface,
the name of the deployment artifact “switch-path-redundant” network interface represented by a single extCpdData.
input parameter through which the orchestrator
can provide Whenthe threenamespace NADswhere arethe used in the extCpdData the NAD implementing the bond attachment
NetworkAttachmentDefinitions (NADs) are located.
Attribute may be omitted if the interfacenamespace is providedsame throughas the parameterapplication
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
"helmchartname:[<subchartname>.]^(0..N)[<parentparamname>.]^(0..N)[<paramname>]”.
Whether the optional parts of the format are canpresent providedepends theon namespacehow where the NetworkAttachmentDefinitions (NADs) are located.
Attributeparameter mayis bedeclared omittedin if the namespacehelm ischart. sameAn asexample theis: application
namespace.chartName:subChart1.subChart2.subChart3.Parent1.Parent2.Parent3.paramName.
required: false
type: string |
...