Release version 1.13.7
[sdc.git] / catalog-be / src / main / resources / import / tosca / artifact-types / artifactTypes.yml
1 tosca.artifacts.Root:
2     description: This is the default (root) TOSCA Artifact Type definition that all other TOSCA base Artifact Types derive from.
3
4 tosca.artifacts.Deployment:
5     derived_from: tosca.artifacts.Root
6     description: This artifact type represents the parent type for all deployment artifacts in TOSCA. This class of artifacts typically represents a binary packaging of an application or service that is used to install/create or deploy it as part of a node's lifecycle.
7     
8 tosca.artifacts.Deployment.Image:
9     derived_from: tosca.artifacts.Deployment
10     description: This artifact type represents a parent type for any "image" which is an opaque packaging of a TOSCA Node's deployment (whether real or virtual) whose contents are typically already installed and pre-configured (i.e., "stateful") and prepared to be run on a known target container.
11
12 tosca.artifacts.Deployment.Image.VM:
13     derived_from: tosca.artifacts.Deployment
14     description: This artifact represents the parent type for all Virtual Machine (VM) image and container formatted deployment artifacts. These images contain a stateful capture of a machine (e.g., server) including operating system and installed software along with any configurations and can be run on another machine using a hypervisor which virtualizes typical server (i.e., hardware) resources.
15
16 tosca.artifacts.nfv.SwImage:
17     derived_from: tosca.artifacts.Deployment.Image
18     description: describes the software image which is directly loaded on the virtualisation container realizing of the VDU or is to be loaded on a virtual
19
20 tosca.artifacts.Implementation:
21     derived_from: tosca.artifacts.Root
22     description: This artifact type represents the parent type for all implementation artifacts in TOSCA. These artifacts are used to implement operations of TOSCA interfaces either directly (e.g., scripts) or indirectly (e.g., config. files).
23     
24 tosca.artifacts.Implementation.Bash:
25     derived_from: tosca.artifacts.Implementation
26     description: This artifact type represents a Bash script type that contains Bash commands that can be executed on the Unix Bash shell.
27
28 tosca.artifacts.Implementation.Python:
29     derived_from: tosca.artifacts.Implementation
30     description: This artifact type represents a Python file that contains Python language constructs that can be executed within a Python interpreter.
31
32 tosca.artifacts.Implementation.nfv.Mistral:
33     derived_from: tosca.artifacts.Implementation
34     description: artifacts for Mistral workflows
35     mime_type: application/x-yaml
36     file_ext: [ yaml ]
37     
38 tosca.artifacts.File:
39     derived_from: tosca.artifacts.Root
40     description: This artifact type is used when an artifact definition needs to have its associated file simply treated as a file and no special handling/handlers are invoked (i.e., it is not treated as either an implementation or deployment artifact type).
41
42 tosca.artifacts.asd.deploymentItem:
43     version: 0.1
44     derived_from: tosca.artifacts.Root
45     description: "Describes the artifact type of asd deployment item"
46     file: "URI or path of the artifact"
47     properties:
48         item_id:
49             description: "The identifier of this asd deployment item"
50             required: true
51             type: string
52         artifact_type:
53             description: >
54                 Specify artifact type.
55             required: true
56             type: string
57             constraints:
58                 - valid_values: ["helm_chart", "helmfile", "crd", "terraform" ]
59         deployment_order:
60             description: >
61                 Specifies the deployment stage that the DeploymentArtifact belongs to.
62                 A lower value specifies that the DeploymentArtifact belongs to an earlier
63                 deployment stage. When this value is omitted, the deployment order
64                 will be decided by the orchestrator.
65             required: false
66             type: integer
67         lifecycle_parameters:
68             description: "list of parameters that can be overridden at deployment time "
69             required: false
70             type: list
71             entry_schema:
72                 type: string