...
Note, that this wiki is not maintained anymore, please refer to the wiki in IM subcommittee space: Application Service Descriptor (ASD) onboarding IM
Table of Contents
Introduction:
In today, many complex applications are consisting in a mixed, complex workload, that is described in many Kubernetes resources, e.g. to be run on a certain cluster, etc. In order to deploy the application, the orchestration task would be requiring dealing with different abstract layers of resources, different templates system mapping, and application packaging. Another challenge is to keep up with changes in the cloud infrastructures features enhancement mapping into abstract resource template.
...
An overview of the presentation is available and presented at CNF Task Force in May 2021.
https://wikilf-onap.onapatlassian.orgnet/wiki/download/attachments/9300463416455009/ONAP_Nokia_Ericsson_K8S_application_descriptor_and_packaging_r2.pdf?version=1&modificationDate=1621622424000&api=v2
Application Packaging:
In order to facilitate compatibility with ETSI, ONAP and other telco standards, the CSAR (NFV SOL 004ed351 or ed421) packaging format is used. The only modification is allowing the proposed Application Service Descriptor (ASD) to be a top-level descriptor for the package, instead of an NSD or VNFD as defined in SOL001.
...
An orchestrator is expected to load any container images present in the package onto the correct registry for the target cluster(s) before attempting to deploy the application. Since the images are in OCI format, they should follow the OCI image layout specification, and MUST contain a “name” annotation in their index.json layout descriptor. This name should be used as the “tag” value when the orchestrator provisions the image in the corresponding registry.
for the Application Service Descriptor (ASD) onboarding packaging format, see Application Service Descriptor (ASD) Onboarding Packaging Format .
Application metadata and cloud-native tooling:
...
The overall objective is to keep the items in the descriptor to the bare minimum information, and not duplicate any attributes that might be instead extracted from the Helm Charts. This helps maintain the principle that Helm Charts are the primary deployment artifact for a containerized application and avoids any possible source of error or confusion that such duplication would cause.
Application Service Descriptor (ASD) Information Element (top level)
Attribute | Qualifier | # | Type | Description | |||||||||
asdId | M | 1 | Identifier | Identifier of this ASD information element. This attribute shall be globally unique. The format will be defined in the data model specification phase. | |||||||||
| asdVersion | M | 1 | String | Identifies the version of the ASD | |||||||||
asdSchemaVersion | M | 1 | Version | Specifies the version of the ASD’s schema (if we modify an ASD field definition, add/remove field definitions, etc.). | |||||||||
asdProvider | M | 1 | String | Provider of the AS and of the ASD. | |||||||||
asdApplicationName | M | 1 | String | Name to identify the Application Service. Invariant for the AS lifetime. | |||||||||
asdApplicationVersion | M | 1 | Version | Specifies the version of the Application (so, if software, DeploymentArtifacts , ASD values, ... change, this changes). | |||||||||
asdApplicationInfoName | OM | 0..1 | String | Human readable name for the Application service. Can change during the AS lifetime. | |||||||||
asdInfoDescription | OM | 0..1 | String | Human readable description of the AS. Can change during the AS lifetime. | |||||||||
asdExtCpd | OM | 0..N | Tbddatatype.ExtCpd | Describes | external interface(s) exposed by this AS enabling connection with a VL. (Similar to VnfExtCpd on VNF-D, but only describing L3 and above interfaces, since K8S can’t do <L3extraServiceRequirements | Othe externally exposed connection points of the application. | |||||||
enhancedClusterCapabilities | M | 0.. | N1 | Tbd | (include here Kubernetes NFDs) < - a flat list from Helm charts | enhancedClusterCapabilities | O | 0..N | Tbd | Describes datatype. enhancedClusterCapabilities | A list of expected capabilities of the target Kubernetes cluster to aid placement of the application service on a suitable cluster | . Examples of capabilities are required networking characteristics, Kubernetes API extensions or quantifiable node specific resources. This attribute can contain information complementing information provided in the referenced DeploymentArtifacts.Note: Modeling of enhancedClusterCapabilities is subject to standardization but is ffs. | Alignment between O2-IMS and O2-DMS of these values is required.|
deploymentItems | M | 1..N | DeploymentItem | Deployment artifacts | (see next table)
The initial attributes essentially describe the application – a unique identifier, a schema version (that enables versioning the data model of the descriptor itself), and basic metadata, like application name and version and human-readable descriptive fields.
The
...
attribute "asdExtCpd" will be used for
...
exposing endpoints (to enable orchestrators to string together or optimally place linked applications
...
.
The attributes “enhancedClusterCapabilities” provides information which is used to aid placement of the application service on a suitable cluster.
Finally, “deploymentItems” is a list of deployment items, i.e. Helm Charts, that together can deploy an application. The table below shows the information element of these deployment item descriptors.
Deployment Item Information Element
Attribute | Qualifier | # | Content | Description | |||
deploymentItemId | M | 1 | Identifier | The identifier of this deployment item | |||
artifactType | M | 1 | String | Specifies the artifact type. One of following values can be chosen: "helm_chart", "helmfile", "crd", "terraform" | |||
artifactId | M | 1 | IdentifierString | Reference to a DeploymentArtifact. It can refer to URI or file path. | |||
deploymentOrder | OM | 0..1 | Integer | Specifies the deployment stage that the DeploymentArtifact belongs to. A lower value specifies that the DeploymentArtifact belongs to an earlier deployment stage, i.e. | , needs to be installed prior to DeploymentArtifact with higher deploymentOrder values. If not specified, the deployment of the DeploymentArtifact can be done in arbitrary order and decided by the orchestrator. | ||
lifecycleParameters | Tbd | tbd | tbd | M | 0..N | String | The list of parameters that can be overridden at deployment time (e.g., the list of parameters in the values.yaml which can be overridden at deployment time) |
asdExtCpd Information Element
Attribute | Qualifier | Cardinality | Content | Description |
|---|---|---|---|---|
| id | M | 1 | String | The identifier of this extCpdData |
| description | M | 1 | String | Describes the service exposed. |
| virtualLinkRequirement | M | 1..N | String | Refers in an abstract way to the network or multiple networks that the ExtCpd shall be exposed on (ex: OAM, EndUser, backhaul, LI, etc). The intent is to enable a network operator to take decision on to which actual VPN to connect the extCpd to. NOTE 1. |
| networkInterfaceRealizationRequirements | M | 0..1 | datatype.networkInterfaceRealizationRequirements | Details container implementation specific requirements on the NetworkAttachmentDefinition to . See NOTE 2 & 3. |
| inputParamMappings | M | 0..1 | datatype.extCpd.ParamMappings | Information on what parameters that are required to be provided to the deployment tools for the asdExtCpd instance. |
| resourceMapping | M | 0..1 | String | Kubernetes API resource name for the resource manifest as specified e.g. in helm.chart for the service, ingress or pod resource declaring the network interface. Enables, together with knowledge on namespace, the orchestrator to lookup the runtime data related to the extCpd. |
NOTE 1: Corresponds more or less to a virtual_link requirement in ETSI NFV SOL001.
NOTE 2: Applies only for ExtCpds representing secondary network interfaces in a pod.
NOTE 3: Several ExtCpd may refer to same additional network interface requirements.
networkInterfaceRealizationRequirements Information Element
Attribute | Qualifier | Cardinality | Content | Description | |
|---|---|---|---|---|---|
| trunkMode | M | 0..1 | ”false” | ”true” | If not present or set to”false”, means that this interface shall connect to single network. If set to ”true” then the network interface shall be a trunk interface (connects to multiple VLANS). | |
| ipam | M | 0..1 | "infraProvided", "orchestrated", "userManaged" | The default value ("infraProvided") means that the CNI specifies how IPAM is done and assigns the IP address to the pod interface. | |
| interfaceType | M | 0..1 | "kernel.netdev", "direct.userdriver", "direct.kerneldriver", "direct.bond", "userspace | This attribute is applicable for passthrough and memif interfaces. Value default value is ”kernel.netdev”. | |
| interfaceOptions | M | 0..N | "virtio", | Alternative vNIC configurations the network interface is verified to work with. | |
| interfaceRedundancy | M | 0..1 | "infraProvided", "activePassiveBond", "activeActiveBond", "activePassiveL3", "activeActiveL3", ”bondCni”, "Left", "Right" | ”infraProvided” means that the application sees one vNIC but that the infrastruture provides redundant access to the network via both switch planes. ”Left” and ”right” indicates a vNIC connected non-redundantly to the network via one specific (left or right) switchplane. All other attributes indicates a mated vNIC pair in the Pod, one connecting to the network via left switchplane and the other connecting to the network via the right switchplane, and with application using them together as a redundant network interface using a particular redundancy method that need to be accomodated in the node infrastructure. | |
| nicOptions | M | 0..N | "examples": ["i710", "mlx-cx5v"] | nics a direct user space driver the application is verified to work with. Allowed values | .yaml in the chart this item referencesfrom ETSI registry. |
datatype.ExtCpd.ParamMappings Information Element
Attribute | Qualifier | Cardinality | Content | Description |
|---|---|---|---|---|
| loadbalancerIP | M | 0..1 | String | 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 ExtCpd represents. Note 2 |
| externalIPs | M | 0..N | String | 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 ExtCpd represents. The param name and provided IP address(es) value will be passed to the deployment tool when deploying the DeploymentArtifacts. Note 2 |
| nadNames | M | 0..N | String | These attributes specifies, for an ExtCpd 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 ExtCpd represents. Note 1,2,3 |
| nadNamespace | M | 0..1 | String | Specifies, for an ExtCpd respesenting a secondary network interface, the name of the deployment artifact input parameter through which the orchestrator can provide the namespace where the NADs are located. Note 2 |
Note 1: When the ExtCpd 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.parameter".
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 ExtCpd.
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 ExtCpd. When three NADs are used in the ExtCpd the NAD implementing the bond attachment interface is provided through the parameter indicated in the third place in the nadNames attribute.
enhancedClusterCapabilities Information Element
Attribute | Qualifier | Cardinality | Content | Description |
|---|---|---|---|---|
Attribute | Qualifier | Cardinality | Content | Description |
| minKernelVersion | M | 1 | String | Describes the minimal required Kernel version, e.g. 4.15.0. Coded as displayed by linux command uname –r |
| requiredKernelModules | M | 0..N | String | Required kernel modules are coded as listed by linux lsmod command, e.g. ip6_tables, cryptd, nf_nat etc. |
| conflictingKernelModules | M | 0..N | String | Kernel modules, which must not be present in the target environment. The kernel modules are coded as listed by linux lsmod command, e.g. ip6_tables, cryptd, nf_nat etc. Example: Linux kernel SCTP module, which may conflict with use of proprietary user space SCTP stack provided by the application. |
requiredCustomResources | M | 0..N | Structure (inlined) | List the required custom resources types in the target environment, identifying each by the "kind" and "apiVersion" field in the K8S resource manifests and in the application. The list shall include those custom resource types which are not delivered with the application. Example: |
>kind | M | 0..1 | String | Kind of the custom resource |
>apiVersion | M | 0..1 | String | apiVersion of the custom resource |
| clusterLabels | M | 0..N | String | This attribute allows to associate arbitrary labels to clusters. These can indicate special infrastructure capabilities (e.g., NW acceleration, GPU compute, etc.). The intent of these labels is to serve as a set of values that can help in application placement decisions. clusterLabels follow the Kubernetes label key-value-nomenclature (https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/). It is recommended that labels follow a standardised meaning e.g. for node features (https://kubernetes-sigs.github.io/node-feature-discovery/v0.9/get-started/features.html#table-of-contents). Example: ClusterLabels |
| requiredPlugin | M | 0..N | Structure (inlined) | A list of the names and versions of the required K8s plugin (e.g. multus v3.8) |
| >requiredPluginName | M | 0..1 | String | The names of the required K8s plugin (e.g. multus) |
| >requiredPluginVersion | M | 0..1 | String | The version of the required plugin (e.g. 3.8) |
References:
- Initial proposal and the background information can be found at: Application Service Descriptor (ASD) and packaging Proposals for CNF - Developer Wiki - Confluence (onap.org)