xos/tosca/custom_types/xos.yaml

# Copyright 2017-present Open Networking Foundation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.


tosca_definitions_version: tosca_simple_yaml_1_0

node_types:

    tosca.nodes.ServiceController:
        derived_from: tosca.nodes.Root
        description: >
            An XOS Service Controller.
        properties:
            no-delete:
                type: boolean
                default: false
                description: Do not allow Tosca to delete this object
            no-create:
                type: boolean
                default: false
                description: Do not allow Tosca to create this object
            no-update:
                type: boolean
                default: false
                description: Do not allow Tosca to update this object
            replaces:
                type: string
                required: false
                descrption: Replaces/renames this object
            base_url:
                type: string
                required: false
                description: Base url, to allow resources to use relative URLs
            version:
                type: string
                required: false
                description: Version number of this Service Controller
            provides:
                type: string
                required: false
                description: Comma-separated list of things provided
            requires:
                type: string
                required: false
                description: Comma-separated list of requirements
            xproto:
                type: string
                required: false
                description: url of xproto
            models:
                type: string
                required: false
                description: url of models.py
            admin:
                type: string
                required: false
                description: url of admin.py
            django_library:
                type: string
                required: false
                description: libraries used by admin or models
            admin_template:
                type: string
                required: false
                description: url of admin html template
            synchronizer:
                type: string
                required: false
                description: url of synchronizer manifest
            synchronizer_run:
                type: string
                required: false
                description: synchronizer run command
            synchronizer_config:
                type: string
                required: false
                description: synchronizer config filename
            # NOTE: I am deprecated, I've not been removed yet not to break everything
            tosca_custom_types:
                type: string
                required: false
                description: url of tosca custom_types
            # NOTE: I am deprecated, I've not been removed yet not to break everything
            tosca_resource:
                type: string
                required: false
                description: url of tosca resource
            rest_service:
                type: string
                required: false
                description: url of REST API service file
            rest_tenant:
                type: string
                required: false
                description: url of REST API tenant file
            private_key:
                type: string
                required: false
                description: private key
            public_key:
                type: string
                required: false
                description: public key
            vendor_js:
                type: string
                required: false
                description: third-party javascript files
            image:
                type: string
                required: false
                description: Image name for refactored synchronizer containers
            no_build:
                type: boolean
                required: false
                description: If true then refactored synchronizer container image is assumed
            no_deploy:
                type: boolean
                required: false
                description: If true then synchronizer container will not be added to docker-compose

    tosca.nodes.Library:
        derived_from: tosca.nodes.Root
        description: >
            An XOS Library.
        properties:
            no-delete:
                type: boolean
                default: false
                description: Do not allow Tosca to delete this object
            no-create:
                type: boolean
                default: false
                description: Do not allow Tosca to create this object
            no-update:
                type: boolean
                default: false
                description: Do not allow Tosca to update this object
            replaces:
                type: string
                required: false
                descrption: Replaces/renames this object
            base_url:
                type: string
                required: false
                description: Base url, to allow resources to use relative URLs
            version:
                type: string
                required: false
                description: Version number of this Service Controller
            provides:
                type: string
                required: false
                description: Comma-separated list of things provided
            requires:
                type: string
                required: false
                description: Comma-separated list of requirements
            models:
                type: string
                required: false
                description: url of models.py
            admin:
                type: string
                required: false
                description: url of admin.py
            django_library:
                type: string
                required: false
                description: libraries used by admin or models
            admin_template:
                type: string
                required: false
                description: url of admin html template
            tosca_custom_types:
                type: string
                required: false
                description: url of tosca custom_types
            tosca_resource:
                type: string
                required: false
                description: url of tosca resource
            rest_service:
                type: string
                required: false
                description: url of REST API service file
            rest_tenant:
                type: string
                required: false
                description: url of REST API tenant file
            private_key:
                type: string
                required: false
                description: private key
            public_key:
                type: string
                required: false
                description: public key
            vendor_js:
                type: string
                required: false
                description: third-party javascript files