Page History

tosca.datatypes.asd.networkInterfaceRequirements:mode (802.1Q or other). 
    derived_from: tosca.datatypes.Root  
    version: 0.1
    When operating in "trunk mode", the Cp is capable of carrying traffic for several VLANs. description: "Describes the datatype for network interface requirements"
    properties:
      trunk_mode:
        description: Absence>
 of this property implies that trunkMode is not configured for the Cp i.e. 
 Information about whether the CP instantiated from this Cp is 
    It is equivalent to boolean value "false".
        required: false
in Trunk       type: boolean
      ipam:mode (802.1Q or other). When operating in "trunk mode", 
        description: >
         the  Cp  is Thecapable defaultof value ("infraProvided") means that the CNI specifies how IPAM is done and assigns 
carrying traffic for several VLANs. 
               Absence of this property implies that trunkMode is not configured 
               for the IP addressCp i.e. It is equivalent to theboolean podvalue interface"false". 
        required required: falsetrue
        type: stringboolean
        constraintsdefault: false
      ipam: 
       - valid_values: ["infraProvided", "orchestrated", "userManaged"]
description: > 
            interfaceType:
  Identifies whether application expects IP address assignment description:to >be 
             This attribute is applicable for passthrough andmanaged memifby interfaces.the 
cluster infrastructure (CNI IPAM plugin), or 
       The default value is ”kernel.netdev”.​ 
    configured by orchestrator via for example helm input parameter, 
              or if IP assignment is handled by the application itself.
       required required: falsetrue
           type: string
        constraints:
          - valid_values: ["kernel.netdevinfraProvided", "direct.userdriverorchestrated", "direct.kerneldriver", "direct.bond", "userspace"]
userManaged"]
        default: "infraProvided"
      interfaceOptioninterface_type:
        description: > 
             ThisIndicates attributewhat istype applicableof fornetwork passthroughinterface andthe memifapplication interfacesexpects. 
            Kernel Thebased defaultvirtual valuenetdev is ”kernel.netdev”.​ 
        required: falsebased on CNIs such as ovs | bridge | 
        type: list
   macvlan | ipvlan, or PCIe entry_schema:
dev directly visible in application 
         type: string
  namespace with kernel or userspace driver or bonded with the Bond  constraints:
            CNI, or userspace-CNI based network interface -
 valid_values: [“virtio", "memif“]
     interfaceRedundancy:
        description: > (requires DPDK-OVS/VPP vSwitch).
           required:  true
 Default value  is "infra-provided”, which means that the infrastructure is expected to provide     type: string
        constraints:
          -   network redundancy for the pod interface. Value "none" means that the application has no 
   valid_values: ["kernel.netdev", "direct.userdriver", "direct.kerneldriver", "direct.bond", "userspace"]
        default: "kernel.netdev"
      interface_option:
        description: > requirement
 on network  redundancy.  Value  ”matedPair”  means  thatThis theattribute Poddescribes asksverified forrealization aoptions matedfor pairthe 
            network ofinterface non-redundant left/right network attachments (typically SRIOV) and handles redundancy on in question. Currently listed options 
            (virtio applicationand level.memif) Theare sameapplicable setfor ofthe networks shall be configured on both interfaces. interfaceType “userspace”.
        required: false
        type: stringlist
        constraintsentry_schema:
            -  valid_values: ["infraProvided", "actPassBond", "actActBond", "actPassL3", "actActL3", "Left", "Right"] 
     nicOptionstype: string
              constraints:
                  - valid_values: [“virtio", "memif“]
     interface_redundancy:
        description: > 
             nics a direct user space driver the application is verified to work with. Allowed values from ETSI registry.​ 
        required: falseIdentifies switch-plane redundancy method the application uses, 
             and that node infrastructure is required to comply with.
        type: list
    "infraProvided", “left” and  entry_schema:
   “right”: The container sees a 
           type: string 

paramMappings:
    version: 1.0
    description: "Describes the datatype for parameter mapping"
    properties:
      ipAddressParameter:
        description: >
              When present, this attribute specifies the name of the deployment artifact input parameter 
 single vNIC that a) the infrastructure bonds over both switchplanes 
             or b) that is connected to the network via only left or 
             right the switchplane.
             The other cases are for througha whichmated thepair orchestratorof canvnics configureconnecting theto IP
 address(es), ipv4 and/or IPv6, for this 
      same network, but where one vNIC connects
  asdExtCpd. The param name and provided    IP address valuevia willleft beswitch passedplane toand the deployment other via right switch plane, 
             and toolwhere the whenapplication deployingmanages the DeploymentArtifactsredundancy. 
        required: false
        type: string
    "activePassiveBond": the nadName:application 
bonds with move of MAC address. 
  description: >
              These attributes specifies, for an asdExtCpd respesenting a secondary network interface, 
  "activeActiveBond“: bonded left/right links must be part of a multi-chassis LAG 
            the name(s) of the deployment artifact input parameters through which the orchestrator  "activePassiveL3": application will move application IP address between the vNICs.
             "activeActiveL3": canthe configureapplication the corresponding network annotation in the pod manifest with references uses anycast/ECMP.
        required: true
        type: string
     to the NAD(s) to be used for creating the network interface.It is expected that the NADs 
       constraints:
          - valid_values: ["infraProvided", "actPassBond", "actActBond", "actPassL3", "actActL3", "Left", "Right"] 
        themselves have been created prior to the deployment of the deployment artifacts. default: "infraProvided"
      nic_options:
        description: > 
        required:  false
      Identifies  for type: string
      nadNamespace:the direct.userdriver interface type, the physical 
        description: >
       nics  the  driver  is Theseverified attributesto specifies, for an asdExtCpd respesenting a secondary network interface, 
work with.
             Allowed values for nic types must be handled via the name(s) of the deployment artifact input parameters through which the orchestrator 
a registry or be standardized.
        required: false
        type: list
        entry_schema:
              type: string 

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.
              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.LBIP". 
        required: false
        type: string
      external_IPs:
        description: >
              When present, this attribute specifies the name of the deployment 
              artifact input parameter through which the orchestrator can 
              configure the extermalIPs parameter of the K8s service or ingress 
              controller, or the pod network interface annotation, that 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>:[<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 
              parameter is declared in the helm chart. An example is: 
              "chartName:subChart1.subChart2.subChart3.Parent1.Parent2.Parent3.NameSpace". 
        required: false
        type: string 

tosca.datatypes.asd.enhancedClusterCapabilities:
    version: 0.1
    derived_from: tosca.datatypes.Root 
    description: "Describes the datatype for parameter mapping"
    properties:
      min_kernel_version:
        description: >
               Describes the minimal required Kernel version, e.g. 4.15.0. 
               Coded as displayed by linux command uname –r
        required: true
        type: string  
      required_kernel_modules:
        description: > 
             Required kernel modules are coded as listed by linux lsmod command, 
             e.g. ip6_tables, cryptd, nf_nat etc.​ 
        required: false
        type: list
        entry_schema:
              type: string 
      conflicting_kernel_modules:
        description: > 
             Kernel modules, which must not be present in the target environment. 
             The kernel modules are coded as listed by linux lsmod command, configure the corresponding network annotation in the pod manifest with references 
              to the NAD(s) to be used for creating the network interface.It is expected that the NADs 
         e.g., ip6_tables, cryptd, nf_nat etc. 
             Example: Linux kernel SCTP module, which would conflict with use of 
     themselves have been created prior to the deployment ofproprietary theuser deploymentspace artifacts.SCTP 
stack  provided  by    required: falsethe application.​ 
        type: string 

enhancedClusterCapabilities:
 required: false
     version   type: 1.0
list
        descriptionentry_schema: "Describes the datatype for parameter mapping"

              propertiestype: string   
      minKernelVersionrequired_custom_resources:
        description: "Describes> the  minimal  required Kernel version, e.g. 4.15.0. Coded as displayed by linux command uname –r"
          
            required:List true
the custom resource kinds required to be supported type:in stringthe target 
         requiredKernelModules:
     environment. The list description:shall >include 
those  custom  resource  kinds  which  
   Required kernel modules are coded as listed by linux lsmod command, e.g. ip6_tables, cryptd, nf_nat etc.​are not delivered with the application.			 
        required: false
        type: list
        entry_schema:
              type: string tosca.datatypes.asd.customResourceRequirement
      conflictingKernelModules cluster_labels:
        description: > 
             KernelThis modules,attribute whichallows mustto notassociate bearbitrary presentlabels in the target environment. to clusters.
             The kernel modules are coded as listed by linux lsmod command, These can indicate special infrastructure capabilities (e.g. ip6_tables, cryptd, nf_nat etc. 
, NW acceleration, 
             GPU compute, etc.). The Example:intent Linuxof kernelthese SCTPlabels module,is whichto wouldserve conflictas witha useset of proprietary
 user space 
          values that can SCTPhelp stackin providedapplication by theplacement applicationdecisions.​ 
           required: false
      clusterLabels follow the Kubernetes label key-value-nomenclature 
    type: list
        entry_schema:(https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/). 
              type: string   
      requiredCustomResources:It is recommended that labels follow a standardized meaning e.g. for node 
        description: > 
             List the required CRDs and their versions in the target environment. 
  features (https://kubernetes-sigs.github.io/node-feature-discovery/v0.9/get-started/features.html#table-of-contents).
             Example: 
           The list shallClusterLabels
 include those CRDs which are not delivered with the application. 
        required: false
        type: list- feature.node.kubernetes.io/cpu-cpuid.AESNI: true               
        entry_schemarequired: false
              type: maplist
              entry_schema:
   :
              descriptiontype: >string
      required_plugin:
        description: a list of the name of the required kind: "Redis", apiVersion: "kubedb.com/v1alpha1"
     K8s plugin
        required: false
            type: stringlist
      clusterLabels:
        description: > entry_schema:
             This attribute allows to associate arbitrary labels to clusters.type: tosca.datatypes.asd.requiredPlugin

tosca.datatypes.asd.customResourceRequirement: 
       version: 0.1
     These can indicate special infrastructure capabilities (e.g., NW acceleration, GPGPU compute, etc.).  derived_from: tosca.datatypes.Root 
       description: > 
           kind:  The intent of these labels is to serve as a set of values that can help in application placement decisions. "Redis", apiVersion: "kubedb.com/v1alpha1" 
       properties: 
           kind:
              This can be specified with the attribute 
         description: "the name of the custom resource requirement"
              type: string 
     -m: Mandatory, means deployment is not attempted if such supportrequired: istrue not
 available in the target system
      api_version:
         -p: As preference - it meansdescription: orchestrator"the willapi tryversion toof selectthe acustom systemresource withrequirement"
 specific requirements,  
          type: string 
           but if not foundrequired: true 

tosca.datatypes.asd.requiredPlugin: 
       version: 0.1
       derived_from: tosca.datatypes.Root 
 it will attempt deployment in a system not having such HW.  
        required: false
      description: "the required type:K8s listplugin"
       properties: entry_schema:
           name:
   type: string   
      requiredPodAnnotations:
   description: "the name of the description:required >K8s plugin"
              Annotationstype: required to be supported.string 
             Example that list requirement for Kubernetes cluster infrastructure support for the Multus network attachment annotationsrequired: true 
           version:
   requiredPodAnnotations: {"k8s.v1.cncf.io/networks", ... } 
        required: false
        type: list
          description: "the version of the required K8s plugin"
             entry_schema:type: string 
              typerequired: string true