azure/aria/aria-extension-cloudify/src/aria/extensions/aria_extension_tosca/profiles/tosca-simple-1.0/artifacts.yaml

   1 # Licensed to the Apache Software Foundation (ASF) under one or more
   2 # contributor license agreements.  See the NOTICE file distributed with
   3 # this work for additional information regarding copyright ownership.
   4 # The ASF licenses this file to You under the Apache License, Version 2.0
   5 # (the "License"); you may not use this file except in compliance with
   6 # the License.  You may obtain a copy of the License at
   7 #
   8 #     http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 # Unless required by applicable law or agreed to in writing, software
  11 # distributed under the License is distributed on an "AS IS" BASIS,
  12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 # See the License for the specific language governing permissions and
  14 # limitations under the License.
  15
  16 artifact_types:
  17
  18   tosca.artifacts.Root:
  19     _extensions:
  20       shorthand_name: Root # ARIA NOTE: omitted in the spec
  21       type_qualified_name: tosca:Root
  22       specification: tosca-simple-1.0
  23       specification_section: 5.3.1
  24       specification_url: 'http://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.0/cos01/TOSCA-Simple-Profile-YAML-v1.0-cos01.html#DEFN_TYPE_ARTIFACTS_ROOT'
  25     description: >-
  26       This is the default (root) TOSCA Artifact Type definition that all other TOSCA base Artifact Types derive from.
  27
  28   tosca.artifacts.File:
  29     _extensions:
  30       shorthand_name: File
  31       type_qualified_name: tosca:File
  32       specification: tosca-simple-1.0
  33       specification_section: 5.3.2
  34     description: >-
  35       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).
  36     derived_from: tosca.artifacts.Root
  37
  38   #
  39   # Deployments
  40   #
  41
  42   tosca.artifacts.Deployment:
  43     _extensions:
  44       shorthand_name: Deployment # ARIA NOTE: omitted in the spec
  45       type_qualified_name: tosca:Deployment
  46       specification: tosca-simple-1.0
  47       specification_section: 5.3.3.1
  48       specification_url: 'http://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.0/cos01/TOSCA-Simple-Profile-YAML-v1.0-cos01.html#DEFN_TYPE_ARTIFACTS_DEPLOYMENT'
  49     description: >-
  50       This artifact type represents the parent type for all deployment artifacts in TOSCA. This class of artifacts typically
  51       represents a binary packaging of an application or service that is used to install/create or deploy it as part of a node's
  52       lifecycle.
  53     derived_from: tosca.artifacts.Root
  54
  55   tosca.artifacts.Deployment.Image:
  56     _extensions:
  57       shorthand_name: Deployment.Image
  58       type_qualified_name: tosca:Deployment.Image
  59       specification: tosca-simple-1.0
  60       specification_section: 5.3.3.3
  61       specification_url: 'http://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.0/cos01/TOSCA-Simple-Profile-YAML-v1.0-cos01.html#DEFN_TYPE_ARTIFACTS_DEPLOYMENT_IMAGE'
  62     description: >-
  63       This artifact type represents a parent type for any "image" which is an opaque packaging of a TOSCA Node's deployment
  64       (whether real or virtual) whose contents are typically already installed and pre-configured (i.e., "stateful") and prepared
  65       to be run on a known target container.
  66     derived_from: tosca.artifacts.Deployment
  67
  68   tosca.artifacts.Deployment.Image.VM:
  69     _extensions:
  70       shorthand_name: Deployment.VM # ARIA NOTE: omitted in the spec
  71       type_qualified_name: tosca:Deployment.VM
  72       specification: tosca-simple-1.0
  73       specification_section: 5.3.3.4
  74       specification_url: 'http://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.0/cos01/TOSCA-Simple-Profile-YAML-v1.0-cos01.html#DEFN_TYPE_ARTIFACTS_DEPLOY_IMAGE_VM'
  75     description: >-
  76       This artifact represents the parent type for all Virtual Machine (VM) image and container formatted deployment artifacts.
  77       These images contain a stateful capture of a machine (e.g., server) including operating system and installed software along
  78       with any configurations and can be run on another machine using a hypervisor which virtualizes typical server (i.e.,
  79       hardware) resources.
  80     derived_from: tosca.artifacts.Deployment
  81
  82   #
  83   # Implementations
  84   #
  85
  86   tosca.artifacts.Implementation:
  87     _extensions:
  88       shorthand_name: Implementation # ARIA NOTE: omitted in the spec
  89       type_qualified_name: tosca:Implementation
  90       specification: tosca-simple-1.0
  91       specification_section: 5.3.4.1
  92       specification_url: 'http://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.0/cos01/TOSCA-Simple-Profile-YAML-v1.0-cos01.html#DEFN_TYPE_ARTIFACTS_IMPLEMENTATION'
  93     description: >-
  94       This artifact type represents the parent type for all implementation artifacts in TOSCA. These artifacts are used to
  95       implement operations of TOSCA interfaces either directly (e.g., scripts) or indirectly (e.g., config. files).
  96     derived_from: tosca.artifacts.Root
  97
  98   tosca.artifacts.Implementation.Bash:
  99     _extensions:
 100       shorthand_name: Implementation.Bash # ARIA NOTE: mistake in spec? shouldn't we have "Implementation." as prefix?
 101       type_qualified_name: tosca:Implementation.Bash
 102       specification: tosca-simple-1.0
 103       specification_section: 5.3.4.3
 104     description: >-
 105       This artifact type represents a Bash script type that contains Bash commands that can be executed on the Unix Bash shell.
 106     derived_from: tosca.artifacts.Implementation
 107     mime_type: application/x-sh
 108     file_ext: [ sh ]
 109
 110   tosca.artifacts.Implementation.Python:
 111     _extensions:
 112       shorthand_name: Implementation.Python # ARIA NOTE: mistake in spec? shouldn't we have "Implementation." as prefix?
 113       type_qualified_name: tosca:Implementation.Python
 114       specification: tosca-simple-1.0
 115       specification_section: 5.3.4.4
 116     description: >-
 117       This artifact type represents a Python file that contains Python language constructs that can be executed within a Python
 118       interpreter.
 119     derived_from: tosca.artifacts.Implementation
 120     mime_type: application/x-python
 121     file_ext: [ py ]