| tosca_definitions_version: tosca_simple_yaml_1_0 |
| |
| # compile this with "m4 xos.m4 > xos.yaml" |
| |
| # include macros |
| # Note: Tosca derived_from isn't working the way I think it should, it's not |
| # inheriting from the parent template. Until we get that figured out, use |
| # m4 macros do our inheritance |
| |
| |
| # Service |
| |
| |
| # Subscriber |
| |
| |
| |
| |
| # end m4 macros |
| |
| |
| |
| node_types: |
| tosca.nodes.XOS: |
| derived_from: tosca.nodes.Root |
| description: The root of XOS |
| 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 |
| ui_port: |
| type: integer |
| required: false |
| description: TCP port of user interface |
| bootstrap_ui_port: |
| type: integer |
| required: false |
| descrption: TCP port of bootstrap user interface |
| docker_project_name: |
| type: string |
| required: false |
| description: Docker project name |
| db_container_name: |
| type: string |
| required: false |
| description: Database container name |
| redis_container_name: |
| type: string |
| required: false |
| description: redis container name |
| source_ui_image: |
| type: string |
| required: false |
| description: Source UI docker image name |
| dest_ui_image: |
| type: string |
| required: false |
| description: Dest UI docker image name |
| cert_chain_name: |
| type: string |
| required: false |
| description: Name of file that holds certificate chain |
| enable_build: |
| type: boolean |
| required: false |
| description: True if XOS build should be enabled |
| frontend_only: |
| type: boolean |
| required: false |
| description: True if XOS should not start synchronizer containers |
| extra_hosts: |
| type: string |
| required: false |
| description: List of extra_hosts to pass to docker compose |
| no_start: |
| type: boolean |
| required: false |
| description: Whether to start the Django server or not |
| no_build: |
| type: boolean |
| required: false |
| description: Whether to build the core UI image |
| |
| tosca.nodes.XOSVolume: |
| derived_from: tosca.nodes.Root |
| description: A volume that should be attached to the XOS docker container |
| 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 |
| host_path: |
| type: string |
| required: false |
| description: path of resource on host |
| read_only: |
| type: boolean |
| required: false |
| description: True if mount read only |
| |
| tosca.nodes.XOSGuiExtension: |
| derived_from: tosca.nodes.Root |
| description: A GUI Extension that can be loaded at runtime and need to be persisted |
| 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 |
| files: |
| type: string |
| required: false |
| description: List of comma separated file composing the view |
| |
| tosca.nodes.Service: |
| derived_from: tosca.nodes.Root |
| description: > |
| An XOS Service object. Services may be listed in the Service |
| directory and may be linked together via Tenancy Relationships. |
| capabilities: |
| scalable: |
| type: tosca.capabilities.Scalable |
| service: |
| type: tosca.capabilities.xos.Service |
| 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 |
| kind: |
| type: string |
| default: generic |
| description: Type of service. |
| view_url: |
| type: string |
| required: false |
| description: URL to follow when icon is clicked in the Service Directory. |
| icon_url: |
| type: string |
| required: false |
| description: ICON to display in the Service Directory. |
| enabled: |
| type: boolean |
| default: true |
| published: |
| type: boolean |
| default: true |
| description: If True then display this Service in the Service Directory. |
| public_key: |
| type: string |
| required: false |
| description: Public key to install into Instances to allows Services to SSH into them. |
| private_key_fn: |
| type: string |
| required: false |
| description: Location of private key file |
| versionNumber: |
| type: string |
| required: false |
| description: Version number of Service. |
| |
| tosca.nodes.InterfaceType: |
| derived_from: tosca.nodes.Root |
| description: > |
| An interface type. |
| 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 |
| direction: |
| type: string |
| required: false |
| description: Direction of interface |
| |
| tosca.nodes.ServiceInterface: |
| derived_from: tosca.nodes.Root |
| description: > |
| An interface for the service. |
| 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 |
| |
| 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 |
| 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 |
| 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.ServiceControllerResource: |
| derived_from: tosca.nodes.Root |
| description: > |
| An XOS Service Resource. |
| 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 |
| kind: |
| type: string |
| required: false |
| description: models, admin, django_library, synchronizer, rest, tosca_custom_types, or tosca_resource |
| format: |
| type: string |
| required: false |
| description: python, manifest, or docker |
| url: |
| type: string |
| required: false |
| description: url of resource, may be relative to base_url or absolute |
| |
| 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 |
| |
| tosca.nodes.Component: |
| derived_from: tosca.nodes.Root |
| description: > |
| An XOS Component in the form of a docker container. |
| 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 |
| image: |
| type: string |
| required: false |
| description: the base image for the container |
| command: |
| type: string |
| required: false |
| description: the command to execute in the container |
| ports: |
| type: string |
| required: false |
| description: ports that need to be exposed |
| extra: |
| type: string |
| required: false |
| description: ports that need to be exposed |
| |
| tosca.nodes.ComponentLink: |
| derived_from: tosca.nodes.Root |
| description: > |
| Links between XOS components. |
| 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 |
| container: |
| type: string |
| required: true |
| description: the container that needs to be linked |
| alias: |
| type: string |
| required: true |
| description: alias for the link |
| kind: |
| type: string |
| required: true |
| description: internal or external link |
| constraints: |
| - valid_values: [ 'internal', 'external' ] |
| |
| tosca.nodes.ComponentVolume: |
| derived_from: tosca.nodes.Root |
| description: > |
| Volumes of the XOS components. |
| 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 |
| host_path: |
| type: string |
| required: false |
| description: path of resource on host |
| read_only: |
| type: boolean |
| required: false |
| description: True if mount read only |
| |
| tosca.nodes.ComponentVolumeContainer: |
| derived_from: tosca.nodes.Root |
| description: > |
| Container Volumes used by XOS components. |
| 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 |
| name: |
| type: string |
| required: false |
| description: Identifier of the Container Volume |
| container: |
| type: string |
| required: false |
| description: Name of the Container Volume |
| |
| tosca.relationships.LinkOfComponent: |
| derived_from: tosca.relationships.Root |
| valid_target_types: [ tosca.capabilities.xos.ComponentLink ] |
| |
| tosca.relationships.VolumeOfComponent: |
| derived_from: tosca.relationships.Root |
| valid_target_types: [ tosca.capabilities.xos.ComponentVolume ] |
| |
| tosca.relationships.VolumeContainerOfComponent: |
| derived_from: tosca.relationships.Root |
| valid_target_types: [ tosca.capabilities.xos.ComponentVolumeContainer ] |
| |
| tosca.nodes.Tenant: |
| derived_from: tosca.nodes.Root |
| description: > |
| An ONOS Tenant. |
| properties: |
| kind: |
| type: string |
| default: generic |
| description: Kind of tenant |
| service_specific_id: |
| type: string |
| required: false |
| description: Service specific ID opaque to XOS but meaningful to service |
| service_specific_attribute: |
| type: string |
| required: false |
| description: Service-specific attribute, usually a string containing a json dictionary |
| model: |
| type: string |
| required: false |
| description: Name of model to use when instantiating tenant |
| |
| tosca.nodes.ONOSService: |
| derived_from: tosca.nodes.Root |
| description: > |
| ONOS Service |
| capabilities: |
| scalable: |
| type: tosca.capabilities.Scalable |
| service: |
| type: tosca.capabilities.xos.Service |
| 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 |
| kind: |
| type: string |
| default: generic |
| description: Type of service. |
| view_url: |
| type: string |
| required: false |
| description: URL to follow when icon is clicked in the Service Directory. |
| icon_url: |
| type: string |
| required: false |
| description: ICON to display in the Service Directory. |
| enabled: |
| type: boolean |
| default: true |
| published: |
| type: boolean |
| default: true |
| description: If True then display this Service in the Service Directory. |
| public_key: |
| type: string |
| required: false |
| description: Public key to install into Instances to allows Services to SSH into them. |
| private_key_fn: |
| type: string |
| required: false |
| description: Location of private key file |
| versionNumber: |
| type: string |
| required: false |
| description: Version number of Service. |
| rest_onos/v1/network/configuration/: |
| type: string |
| required: false |
| rest_hostname: |
| type: string |
| required: false |
| rest_port: |
| type: string |
| required: false |
| no_container: |
| type: boolean |
| default: false |
| node_key: |
| type: string |
| required: false |
| |
| |
| tosca.nodes.ONOSApp: |
| derived_from: tosca.nodes.Root |
| description: > |
| An ONOS Application. |
| properties: |
| kind: |
| type: string |
| default: generic |
| description: Kind of tenant |
| service_specific_id: |
| type: string |
| required: false |
| description: Service specific ID opaque to XOS but meaningful to service |
| install_dependencies: |
| type: string |
| required: false |
| dependencies: |
| type: string |
| required: false |
| |
| tosca.nodes.ONOSvBNGApp: |
| derived_from: tosca.nodes.Root |
| description: > |
| An ONOS vBNG Application. |
| properties: |
| kind: |
| type: string |
| default: generic |
| description: Kind of tenant |
| service_specific_id: |
| type: string |
| required: false |
| description: Service specific ID opaque to XOS but meaningful to service |
| dependencies: |
| type: string |
| required: false |
| install_dependencies: |
| type: string |
| required: false |
| component_config: |
| type: string |
| required: false |
| config_addresses.json: |
| type: string |
| required: false |
| config_network-cfg.json: |
| type: string |
| required: false |
| config_virtualbng.json: |
| type: string |
| required: false |
| |
| tosca.nodes.ONOSvOLTApp: |
| derived_from: tosca.nodes.Root |
| description: > |
| An ONOS vOLT Application. |
| properties: |
| kind: |
| type: string |
| default: generic |
| description: Kind of tenant |
| service_specific_id: |
| type: string |
| required: false |
| description: Service specific ID opaque to XOS but meaningful to service |
| dependencies: |
| type: string |
| required: false |
| install_dependencies: |
| type: string |
| required: false |
| component_config: |
| type: string |
| required: false |
| config_network-cfg.json: |
| type: string |
| required: false |
| rest_onos/v1/network/configuration/: |
| type: string |
| required: false |
| autogenerate: |
| type: string |
| required: false |
| |
| tosca.nodes.ONOSVTNApp: |
| derived_from: tosca.nodes.Root |
| description: > |
| An ONOS VTN Application. |
| properties: |
| kind: |
| type: string |
| default: generic |
| description: Kind of tenant |
| service_specific_id: |
| type: string |
| required: false |
| description: Service specific ID opaque to XOS but meaningful to service |
| dependencies: |
| type: string |
| required: false |
| install_dependencies: |
| type: string |
| required: false |
| rest_onos/v1/network/configuration/: |
| type: string |
| required: false |
| autogenerate: |
| type: string |
| required: false |
| |
| tosca.nodes.ONOSvRouterApp: |
| derived_from: tosca.nodes.Root |
| description: > |
| An ONOS vRouter Application. |
| properties: |
| kind: |
| type: string |
| default: generic |
| description: Kind of tenant |
| service_specific_id: |
| type: string |
| required: false |
| description: Service specific ID opaque to XOS but meaningful to service |
| dependencies: |
| type: string |
| required: false |
| install_dependencies: |
| type: string |
| required: false |
| rest_onos/v1/network/configuration/: |
| type: string |
| required: false |
| autogenerate: |
| type: string |
| required: false |
| |
| tosca.nodes.VSGService: |
| description: > |
| CORD: The vSG Service. |
| derived_from: tosca.nodes.Root |
| capabilities: |
| scalable: |
| type: tosca.capabilities.Scalable |
| service: |
| type: tosca.capabilities.xos.Service |
| 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 |
| kind: |
| type: string |
| default: generic |
| description: Type of service. |
| view_url: |
| type: string |
| required: false |
| description: URL to follow when icon is clicked in the Service Directory. |
| icon_url: |
| type: string |
| required: false |
| description: ICON to display in the Service Directory. |
| enabled: |
| type: boolean |
| default: true |
| published: |
| type: boolean |
| default: true |
| description: If True then display this Service in the Service Directory. |
| public_key: |
| type: string |
| required: false |
| description: Public key to install into Instances to allows Services to SSH into them. |
| private_key_fn: |
| type: string |
| required: false |
| description: Location of private key file |
| versionNumber: |
| type: string |
| required: false |
| description: Version number of Service. |
| backend_network_label: |
| type: string |
| required: false |
| description: Label that matches network used to connect HPC and BBS services. |
| dns_servers: |
| type: string |
| required: false |
| node_label: |
| type: string |
| required: false |
| docker_image_name: |
| type: string |
| required: false |
| description: Name of docker image to pull for vSG |
| docker_insecure_registry: |
| type: boolean |
| required: false |
| description: If true, then the hostname:port specified in docker_image_name will be treated as an insecure registry |
| |
| tosca.nodes.VBNGService: |
| derived_from: tosca.nodes.Root |
| description: > |
| CORD: The vBNG Service. |
| capabilities: |
| scalable: |
| type: tosca.capabilities.Scalable |
| service: |
| type: tosca.capabilities.xos.Service |
| 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 |
| kind: |
| type: string |
| default: generic |
| description: Type of service. |
| view_url: |
| type: string |
| required: false |
| description: URL to follow when icon is clicked in the Service Directory. |
| icon_url: |
| type: string |
| required: false |
| description: ICON to display in the Service Directory. |
| enabled: |
| type: boolean |
| default: true |
| published: |
| type: boolean |
| default: true |
| description: If True then display this Service in the Service Directory. |
| public_key: |
| type: string |
| required: false |
| description: Public key to install into Instances to allows Services to SSH into them. |
| private_key_fn: |
| type: string |
| required: false |
| description: Location of private key file |
| versionNumber: |
| type: string |
| required: false |
| description: Version number of Service. |
| vbng_url: |
| type: string |
| required: false |
| description: URL of REST API endpoint for vBNG Service. |
| |
| tosca.nodes.VRouterService: |
| derived_from: tosca.nodes.Root |
| description: > |
| CORD: The vRouter Service. |
| capabilities: |
| scalable: |
| type: tosca.capabilities.Scalable |
| service: |
| type: tosca.capabilities.xos.Service |
| 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 |
| kind: |
| type: string |
| default: generic |
| description: Type of service. |
| view_url: |
| type: string |
| required: false |
| description: URL to follow when icon is clicked in the Service Directory. |
| icon_url: |
| type: string |
| required: false |
| description: ICON to display in the Service Directory. |
| enabled: |
| type: boolean |
| default: true |
| published: |
| type: boolean |
| default: true |
| description: If True then display this Service in the Service Directory. |
| public_key: |
| type: string |
| required: false |
| description: Public key to install into Instances to allows Services to SSH into them. |
| private_key_fn: |
| type: string |
| required: false |
| description: Location of private key file |
| versionNumber: |
| type: string |
| required: false |
| description: Version number of Service. |
| |
| tosca.nodes.FabricService: |
| derived_from: tosca.nodes.Root |
| description: > |
| CORD: The Fabric Service. |
| capabilities: |
| scalable: |
| type: tosca.capabilities.Scalable |
| service: |
| type: tosca.capabilities.xos.Service |
| 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 |
| kind: |
| type: string |
| default: generic |
| description: Type of service. |
| view_url: |
| type: string |
| required: false |
| description: URL to follow when icon is clicked in the Service Directory. |
| icon_url: |
| type: string |
| required: false |
| description: ICON to display in the Service Directory. |
| enabled: |
| type: boolean |
| default: true |
| published: |
| type: boolean |
| default: true |
| description: If True then display this Service in the Service Directory. |
| public_key: |
| type: string |
| required: false |
| description: Public key to install into Instances to allows Services to SSH into them. |
| private_key_fn: |
| type: string |
| required: false |
| description: Location of private key file |
| versionNumber: |
| type: string |
| required: false |
| description: Version number of Service. |
| |
| tosca.nodes.VTNService: |
| derived_from: tosca.nodes.Root |
| description: > |
| CORD: The vRouter Service. |
| capabilities: |
| scalable: |
| type: tosca.capabilities.Scalable |
| service: |
| type: tosca.capabilities.xos.Service |
| 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 |
| kind: |
| type: string |
| default: generic |
| description: Type of service. |
| view_url: |
| type: string |
| required: false |
| description: URL to follow when icon is clicked in the Service Directory. |
| icon_url: |
| type: string |
| required: false |
| description: ICON to display in the Service Directory. |
| enabled: |
| type: boolean |
| default: true |
| published: |
| type: boolean |
| default: true |
| description: If True then display this Service in the Service Directory. |
| public_key: |
| type: string |
| required: false |
| description: Public key to install into Instances to allows Services to SSH into them. |
| private_key_fn: |
| type: string |
| required: false |
| description: Location of private key file |
| versionNumber: |
| type: string |
| required: false |
| description: Version number of Service. |
| privateGatewayMac: |
| type: string |
| required: false |
| localManagementIp: |
| type: string |
| required: false |
| ovsdbPort: |
| type: string |
| required: false |
| sshPort: |
| type: string |
| required: false |
| sshUser: |
| type: string |
| required: false |
| sshKeyFile: |
| type: string |
| required: false |
| mgmtSubnetBits: |
| type: string |
| required: false |
| xosEndpoint: |
| type: string |
| required: false |
| xosUser: |
| type: string |
| required: false |
| xosPassword: |
| type: string |
| required: false |
| vtnAPIVersion: |
| type: string |
| required: false |
| controllerPort: |
| type: string |
| required: false |
| |
| |
| tosca.nodes.CDNService: |
| derived_from: tosca.nodes.Root |
| description: > |
| Content Delivery Network Service. Includes Request Routing and Hypercache. |
| capabilities: |
| scalable: |
| type: tosca.capabilities.Scalable |
| service: |
| type: tosca.capabilities.xos.Service |
| 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 |
| kind: |
| type: string |
| default: generic |
| description: Type of service. |
| view_url: |
| type: string |
| required: false |
| description: URL to follow when icon is clicked in the Service Directory. |
| icon_url: |
| type: string |
| required: false |
| description: ICON to display in the Service Directory. |
| enabled: |
| type: boolean |
| default: true |
| published: |
| type: boolean |
| default: true |
| description: If True then display this Service in the Service Directory. |
| public_key: |
| type: string |
| required: false |
| description: Public key to install into Instances to allows Services to SSH into them. |
| private_key_fn: |
| type: string |
| required: false |
| description: Location of private key file |
| versionNumber: |
| type: string |
| required: false |
| description: Version number of Service. |
| |
| tosca.nodes.CORDSubscriber: |
| derived_from: tosca.nodes.Root |
| description: > |
| CORD: Subscriber. The Subscriber object contains all of the settings |
| for a CORD household. For example, it contains parental control |
| filter settings. |
| capabilities: |
| subscriber: |
| type: tosca.capabilities.xos.Subscriber |
| properties: |
| kind: |
| type: string |
| default: generic |
| description: Kind of subscriber |
| service_specific_id: |
| type: string |
| required: false |
| description: Service specific ID opaque to XOS but meaningful to service |
| firewall_enable: |
| type: boolean |
| default: false |
| description: If True, then firewalling is enabled. |
| url_filter_enable: |
| type: boolean |
| default: false |
| description: If True, then parental controls are enabled. |
| url_filter_level: |
| type: string |
| default: PG |
| description: The default URL filter level for the household. |
| cdn_enable: |
| type: boolean |
| default: true |
| description: If True, then the CDN is enabled. |
| |
| tosca.nodes.CORDUser: |
| derived_from: tosca.nodes.Root |
| description: > |
| CORD: User. The CORD user represents an individual device beloning |
| to the CORD Subscriber. Each device may have its own parental |
| controls. |
| capabilities: |
| device: |
| type: tosca.capabilities.xos.Device |
| properties: |
| level: |
| type: string |
| default: PG_13 |
| description: Parental control level for this device. |
| mac: |
| type: string |
| required: true |
| description: MAC address for this device. |
| |
| tosca.nodes.VOLTService: |
| derived_from: tosca.nodes.Root |
| description: > |
| CORD: The vOLT Service |
| capabilities: |
| scalable: |
| type: tosca.capabilities.Scalable |
| service: |
| type: tosca.capabilities.xos.Service |
| 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 |
| kind: |
| type: string |
| default: generic |
| description: Type of service. |
| view_url: |
| type: string |
| required: false |
| description: URL to follow when icon is clicked in the Service Directory. |
| icon_url: |
| type: string |
| required: false |
| description: ICON to display in the Service Directory. |
| enabled: |
| type: boolean |
| default: true |
| published: |
| type: boolean |
| default: true |
| description: If True then display this Service in the Service Directory. |
| public_key: |
| type: string |
| required: false |
| description: Public key to install into Instances to allows Services to SSH into them. |
| private_key_fn: |
| type: string |
| required: false |
| description: Location of private key file |
| versionNumber: |
| type: string |
| required: false |
| description: Version number of Service. |
| |
| tosca.nodes.VOLTTenant: |
| derived_from: tosca.nodes.Root |
| description: > |
| CORD: A Tenant of the vOLT Service. Each Tenant is tied to a |
| specific vlan_id. |
| properties: |
| kind: |
| type: string |
| default: generic |
| description: Kind of tenant |
| service_specific_id: |
| type: string |
| required: false |
| description: Service specific ID opaque to XOS but meaningful to service |
| s_tag: |
| type: string |
| required: false |
| description: s_tag, identifies which volt port |
| c_tag: |
| type: string |
| required: false |
| description: c_tag, identifies which subscriber within s_tag |
| |
| tosca.nodes.VOLTDevice: |
| derived_from: tosca.nodes.Root |
| description: > |
| CORD: A vOLT Device. |
| 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 |
| openflow_id: |
| type: string |
| required: false |
| description: openflow id |
| driver: |
| type: string |
| required: false |
| description: driver name |
| access_devices: |
| type: string |
| required: false |
| description: list of access devices, in format "uplink vlan", multiple entries separated by commas |
| |
| # XXX - uncomment if we want access device to be specified as separate Tosca |
| # objects, rather than encoding them into VOLTDevice.access_devices |
| # tosca.nodes.AccessDevice: |
| # derived_from: tosca.nodes.Root |
| # description: > |
| # CORD: A vOLT Access Device. |
| # properties: |
| # xos_base_props |
| # uplink: |
| # type: integer |
| # required: false |
| # description: uplink |
| # vlan: |
| # type: integer |
| # required: false |
| # description: vlan |
| |
| tosca.nodes.AccessAgent: |
| derived_from: tosca.nodes.Root |
| description: > |
| CORD: A vOLT Access Agent. |
| 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 |
| mac: |
| type: string |
| required: false |
| description: mac address |
| port_mappings: |
| type: string |
| required: false |
| description: list of port mappings, in format "port mac", multiple entries separated by commas |
| |
| |
| tosca.nodes.User: |
| derived_from: tosca.nodes.Root |
| |
| description: > |
| An XOS User record. Users are able to login and use the XOS GUI. |
| |
| capabilities: |
| user: |
| type: tosca.capabilities.xos.User |
| |
| 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 |
| password: |
| type: string |
| required: false |
| firstname: |
| type: string |
| required: false |
| description: First name of User. |
| lastname: |
| type: string |
| required: false |
| description: Last name of User. |
| phone: |
| type: string |
| required: false |
| description: Phone number of User. |
| user_url: |
| type: string |
| required: false |
| description: URL to User web page. |
| public_key: |
| type: string |
| required: false |
| description: Public key that will be installed in Instances. |
| is_active: |
| type: boolean |
| required: false |
| #default: true |
| description: If True, the user may log in. |
| is_admin: |
| type: boolean |
| required: false |
| #default: false |
| description: If True, the user has root admin privileges. |
| is_readonly: |
| type: boolean |
| required: false |
| #default: false |
| description: If True, the user has read-only privileges in the UI. |
| is_appuser: |
| type: boolean |
| required: false |
| #default: false |
| description: If True, the user may only login to XOS to use apps. |
| login_page: |
| type: string |
| required: false |
| description: Indicates what page the user should go to on login. |
| |
| tosca.nodes.NetworkParameterType: |
| derived_from: tosca.nodes.Root |
| |
| description: > |
| An XOS network parameter type. May be applied to Networks and/or |
| Ports. |
| |
| 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 |
| |
| capabilities: |
| network_parameter_type: |
| type: tosca.capabilities.xos.NetworkParameterType |
| |
| tosca.nodes.NetworkTemplate: |
| derived_from: tosca.nodes.Root |
| |
| description: > |
| An XOS network template. Network templates contain settings associated |
| with a particular class of network. |
| |
| capabilities: |
| network_template: |
| type: tosca.capabilities.xos.NetworkTemplate |
| |
| 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 |
| visibility: |
| type: string |
| required: false |
| description: Indicates whether network is publicly routable. |
| translation: |
| type: string |
| required: false |
| description: Indicates whether network uses address translation. |
| shared_network_name: |
| type: string |
| required: false |
| description: Attaches this template to a specific OpenStack network. |
| shared_network_id: |
| type: string |
| required: false |
| description: Attaches this template to a specific OpenStack network. |
| topology_kind: |
| type: string |
| required: false |
| description: Describes the topology of the network. |
| controller_kind: |
| type: string |
| required: false |
| description: Indicates the type of controller that the network is connected to. |
| access: |
| type: string |
| required: false |
| description: The type of access semantics for this network |
| vtn_kind: |
| type: string |
| required: false |
| description: Network kind to pass to VTN |
| |
| tosca.nodes.network.Network.XOS: |
| # Due to bug? in implementation, we have to copy everything from |
| # tosca definitions tosca.nodes.network.Network here rather than |
| # using derived_from. |
| derived_from: tosca.nodes.Root |
| description: > |
| This is a variant of the TOSCA Network object that includes additional |
| XOS-specific properties. |
| 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 |
| ip_version: |
| type: integer |
| required: no |
| default: 4 |
| constraints: |
| - valid_values: [ 4, 6 ] |
| description: > |
| The IP version of the requested network. Valid values are 4 for ipv4 |
| or 6 for ipv6. |
| cidr: |
| type: string |
| required: no |
| description: > |
| The cidr block of the requested network. |
| start_ip: |
| type: string |
| required: no |
| description: > |
| The IP address to be used as the start of a pool of addresses within |
| the full IP range derived from the cidr block. |
| end_ip: |
| type: string |
| required: no |
| description: > |
| The IP address to be used as the end of a pool of addresses within |
| the full IP range derived from the cidr block. |
| gateway_ip: |
| type: string |
| required: no |
| description: > |
| The gateway IP address. |
| network_name: |
| type: string |
| required: no |
| description: > |
| An identifier that represents an existing Network instance in the |
| underlying cloud infrastructure or can be used as the name of the |
| newly created network. If network_name is provided and no other |
| properties are provided (with exception of network_id), then an |
| existing network instance will be used. If network_name is provided |
| alongside with more properties then a new network with this name will |
| be created. |
| network_id: |
| type: string |
| required: no |
| description: > |
| An identifier that represents an existing Network instance in the |
| underlying cloud infrastructure. This property is mutually exclusive |
| with all other properties except network_name. This can be used alone |
| or together with network_name to identify an existing network. |
| segmentation_id: |
| type: string |
| required: no |
| description: > |
| A segmentation identifier in the underlying cloud infrastructure. |
| E.g. VLAN ID, GRE tunnel ID, etc.. |
| dhcp_enabled: |
| type: boolean |
| required: no |
| default: true |
| description: > |
| Indicates should DHCP service be enabled on the network or not. |
| # XOS-specific |
| ports: |
| type: string |
| required: false |
| description: > |
| A comma-separated list of protocols and ports. For example, |
| "tcp/123, tcp/456-459, udp/111" |
| labels: |
| type: string |
| required: false |
| description: A comma-separated list of labels for this network. |
| permit_all_slices: |
| type: boolean |
| # In the data model, this is defaulted to false. However, to |
| # preserve Tosca semantics, we default it to true instead. |
| default: true |
| description: If True, then any slice may be attached to this network. |
| capabilities: |
| link: |
| type: tosca.capabilities.network.Linkable |
| |
| tosca.nodes.Deployment: |
| derived_from: tosca.nodes.Root |
| description: > |
| An XOS Deployment. |
| capabilities: |
| deployment: |
| type: tosca.capabilities.xos.Deployment |
| 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 |
| accessControl: |
| type: string |
| default: allow all |
| description: ACL that describes who may use this deployment. |
| flavors: |
| type: string |
| required: false |
| description: Comma-separated list of flavors that this deployment supports. |
| |
| tosca.nodes.AddressPool: |
| derived_from: tosca.nodes.Root |
| description: > |
| A pool of addresses |
| capabilities: |
| addresspool: |
| type: tosca.capabilities.xos.AddressPool |
| 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 |
| addresses: |
| type: string |
| required: false |
| description: space-separated list of addresses |
| gateway_ip: |
| type: string |
| required: false |
| description: gateway ip address |
| gateway_mac: |
| type: string |
| required: false |
| description: gateway mac address |
| |
| tosca.nodes.Privilege: |
| derived_from: tosca.nodes.Root |
| description: > |
| A permission granted to an accessor (a user, slice etc.) towards some type of access |
| capabilities: |
| privilege: |
| type: tosca.capabilities.xos.privilege |
| 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 |
| accessor_id: |
| type: integer |
| required: true |
| description: id of the object representing the accessor |
| accessor_type: |
| type: string |
| required: true |
| description: name of the model representing the accessor |
| object_id: |
| type: integer |
| required: true |
| description: id of the object being accessed |
| object_type: |
| type: string |
| required: true |
| description: name of the model representing the object being accessed |
| permission: |
| type: string |
| required: true |
| description: a custom name that defines the type of access |
| granted: |
| type: string |
| required: false |
| description: time at which the permission was granted |
| expires: |
| type: string |
| required: false |
| description: time at which the permission is set to expire |
| |
| tosca.nodes.Image: |
| derived_from: tosca.nodes.Root |
| description: > |
| An XOS Operating System Image. |
| capabilities: |
| image: |
| type: tosca.capabilities.xos.Image |
| 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 |
| kind: |
| type: string |
| required: false |
| description: Type of image (container | VM) |
| disk_format: |
| type: string |
| required: false |
| description: Glance disk format. |
| container_format: |
| type: string |
| required: false |
| description: Glance container format. |
| path: |
| type: string |
| required: false |
| description: Path to Image file |
| tag: |
| type: string |
| required: false |
| description: For Docker images, tag of image |
| |
| tosca.nodes.Controller: |
| derived_from: tosca.nodes.Root |
| description: > |
| An XOS controller. Controllers serve as the interface between |
| XOS and services such as OpenStack. |
| capabilities: |
| controller: |
| type: tosca.capabilities.xos.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 |
| backend_type: |
| type: string |
| required: false |
| description: Type of backend. |
| version: |
| type: string |
| required: false |
| description: Version of backend. |
| auth_url: |
| type: string |
| required: false |
| description: Keystone auth_url. |
| admin_user: |
| type: string |
| required: false |
| description: Keystone username. |
| admin_password: |
| type: string |
| required: false |
| description: Keystone password. |
| admin_tenant: |
| type: string |
| required: false |
| description: Tenant associated with admin account. |
| domain: |
| type: string |
| required: false |
| description: OpenStack domain (or "Default") |
| rabbit_host: |
| type: string |
| required: false |
| description: Rabbit host |
| rabbit_user: |
| type: string |
| required: false |
| description: Rabbit user |
| rabbit_password: |
| type: string |
| required: false |
| description: Rabbit password |
| |
| tosca.nodes.Site: |
| derived_from: tosca.nodes.Root |
| description: > |
| An XOS Site. Sites are containers for Users and/or Nodes. |
| capabilities: |
| site: |
| type: tosca.capabilities.xos.Site |
| 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 |
| display_name: |
| type: string |
| required: false |
| description: Name of the site. |
| site_url: |
| type: string |
| required: false |
| description: URL of site web page. |
| enabled: |
| type: boolean |
| default: true |
| hosts_nodes: |
| type: boolean |
| default: true |
| description: If True, then this site hosts nodes where Instances may be instantiated. |
| hosts_users: |
| type: boolean |
| default: true |
| description: If True, then this site hosts users who may use XOS. |
| is_public: |
| type: boolean |
| default: true |
| # location, longitude, latitude |
| |
| tosca.nodes.Slice: |
| derived_from: tosca.nodes.Root |
| description: > |
| An XOS Slice. A slice is a collection of instances that share |
| common attributes. |
| capabilities: |
| slice: |
| type: tosca.capabilities.xos.Slice |
| 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 |
| enabled: |
| type: boolean |
| default: true |
| description: |
| type: string |
| required: false |
| description: Description of this slice. |
| slice_url: |
| type: string |
| required: false |
| description: URL to web page that describes slice. |
| max_instances: |
| type: integer |
| default: 10 |
| description: Quota of instances that this slice may create. |
| default_isolation: |
| type: string |
| required: false |
| description: default isolation to use when bringing up instances (default to 'vm') |
| network: |
| type: string |
| required: false |
| description: type of networking to use for this slice |
| exposed_ports: |
| type: string |
| required: false |
| description: comma-separated list of protocol _space_ port that represent ports the slice should expose |
| default_node: |
| type: string |
| required: false |
| description: default node to use for this slice |
| |
| tosca.nodes.Node: |
| derived_from: tosca.nodes.Root |
| description: > |
| An XOS Node. Nodes are physical machines that host virtual machines |
| and/or containers. |
| 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 |
| capabilities: |
| node: |
| type: tosca.capabilities.xos.Node |
| |
| tosca.nodes.NodeLabel: |
| derived_from: tosca.nodes.Root |
| description: > |
| An XOS NodeLabel. |
| 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 |
| capabilities: |
| node: |
| type: tosca.capabilities.xos.NodeLabel |
| |
| tosca.nodes.Flavor: |
| derived_from: tosca.nodes.Root |
| description: > |
| An XOS Flavor. |
| 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 |
| flavor: |
| type: string |
| required: false |
| description: openstack flavor name |
| capabilities: |
| flavor: |
| type: tosca.capabilities.xos.Flavor |
| |
| tosca.nodes.SiteRole: |
| derived_from: tosca.nodes.Root |
| description: > |
| An XOS Site Role. |
| 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 |
| capabilities: |
| siterole: |
| type: tosca.capabilities.xos.SiteRole |
| |
| tosca.nodes.SliceRole: |
| derived_from: tosca.nodes.Root |
| description: > |
| An XOS Slice Role. |
| 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 |
| capabilities: |
| slicerole: |
| type: tosca.capabilities.xos.SliceRole |
| |
| tosca.nodes.TenantRole: |
| derived_from: tosca.nodes.Root |
| description: > |
| An XOS Tenant Role. |
| 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 |
| capabilities: |
| tenantrole: |
| type: tosca.capabilities.xos.TenantRole |
| |
| tosca.nodes.DeploymentRole: |
| derived_from: tosca.nodes.Root |
| description: > |
| An XOS Deployment Role. |
| 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 |
| capabilities: |
| deploymentrole: |
| type: tosca.capabilities.xos.DeploymentRole |
| |
| tosca.nodes.DashboardView: |
| derived_from: tosca.nodes.Root |
| description: > |
| An XOS Dashboard View |
| capabilities: |
| dashboardview: |
| type: tosca.capabilities.xos.DashboardView |
| 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 |
| enabled: |
| type: boolean |
| default: true |
| url: |
| type: string |
| required: false |
| description: URL to the dashboard |
| custom_icon: |
| type: boolean |
| default: false |
| description: Whether the dashboard has custom icons |
| |
| tosca.nodes.Tag: |
| derived_from: tosca.nodes.Root |
| description: > |
| An XOS Tag |
| 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 |
| name: |
| type: string |
| required: true |
| descrption: name of tag |
| value: |
| type: string |
| required: false |
| descrption: value of tag |
| |
| tosca.nodes.Compute.Container: |
| derived_from: tosca.nodes.Compute |
| description: > |
| The TOSCA Compute node represents a container on bare metal. |
| attributes: |
| private_address: |
| type: string |
| public_address: |
| type: string |
| capabilities: |
| host: |
| type: tosca.capabilities.Container |
| binding: |
| type: tosca.capabilities.network.Bindable |
| os: |
| type: tosca.capabilities.OperatingSystem |
| scalable: |
| type: tosca.capabilities.Scalable |
| requirements: |
| - local_storage: |
| capability: tosca.capabilities.Attachment |
| node: tosca.nodes.BlockStorage |
| relationship: tosca.relationships.AttachesTo |
| occurrences: [0, UNBOUNDED] |
| |
| tosca.relationships.MemberOfSlice: |
| derived_from: tosca.relationships.Root |
| valid_target_types: [ tosca.capabilities.xos.Slice ] |
| |
| tosca.relationships.MemberOfService: |
| derived_from: tosca.relationships.Root |
| valid_target_types: [ tosca.capabilities.xos.Service ] |
| |
| tosca.relationships.MemberOfSite: |
| derived_from: tosca.relationships.Root |
| valid_target_types: [ tosca.capabilities.xos.Site ] |
| |
| tosca.relationships.MemberOfDeployment: |
| derived_from: tosca.relationships.Root |
| valid_target_types: [ tosca.capabilities.xos.Deployment ] |
| |
| tosca.relationships.TenantOfService: |
| derived_from: tosca.relationships.Root |
| valid_target_types: [ tosca.capabilities.xos.Service ] |
| |
| tosca.relationships.UsedByService: |
| derived_from: tosca.relationships.Root |
| valid_target_types: [ tosca.capabilities.xos.Service ] |
| |
| tosca.relationships.ControllerDeployment: |
| derived_from: tosca.relationships.Root |
| valid_target_types: [ tosca.capabilities.xos.Deployment ] |
| |
| tosca.relationships SiteDeployment: |
| derived_from: tosca.relationships.Root |
| valid_target_types: [ tosca.capabilities.xos.Deployment ] |
| |
| tosca.relationships.UsesController: |
| derived_from: tosca.relationships.Root |
| valid_target_types: [ tosca.capabilities.xos.Controller ] |
| |
| tosca.relationships.ConnectsToNetwork: |
| derived_from: tosca.relationships.Root |
| valid_target_types: [ tosca.capabilities.xos.Network ] |
| |
| tosca.relationships.UsesImage: |
| derived_from: tosca.relationships.Root |
| valid_target_types: [ tosca.capabilities.xos.Image ] |
| |
| tosca.relationships.DefaultImage: |
| derived_from: tosca.relationships.Root |
| valid_target_types: [ tosca.capabilities.xos.Image ] |
| |
| tosca.relationships.SupportsImage: |
| derived_from: tosca.relationships.Root |
| valid_target_types: [ tosca.capabilities.xos.Image ] |
| |
| tosca.relationships.HasPrivilege: |
| derived_from: tosca.relationships.Root |
| valid_target_types: [ tosca.capabilities.xos.Privilege ] |
| |
| tosca.relationships.SupportsPrivilege: |
| derived_from: tosca.relationships.Root |
| valid_target_types: [ tosca.capabilities.xos.Privilege ] |
| |
| tosca.relationships.ConnectsToSlice: |
| derived_from: tosca.relationships.Root |
| valid_target_types: [ tosca.capabilities.xos.Slice ] |
| |
| # tosca.relationships.OwnsNetwork: |
| # derived_from: tosca.relationships.Root |
| # valid_target_types: [ tosca.capabilities.xos.Network ] |
| |
| tosca.relationships.UsesNetworkTemplate: |
| derived_from: tosca.relationships.Root |
| valid_target_types: [ tosca.capabilities.xos.NetworkTemplate ] |
| |
| tosca.relationships.AdminPrivilege: |
| derived_from: tosca.relationships.Root |
| valid_target_types: [ tosca.capabilities.xos.Slice, tosca.capabilities.xos.Site ] |
| |
| tosca.relationships.AccessPrivilege: |
| derived_from: tosca.relationships.Root |
| valid_target_types: [ tosca.capabilities.xos.Slice, tosca.capabilities.xos.Site ] |
| |
| tosca.relationships.PIPrivilege: |
| derived_from: tosca.relationships.Root |
| valid_target_types: [ tosca.capabilities.xos.Site ] |
| |
| tosca.relationships.TechPrivilege: |
| derived_from: tosca.relationships.Root |
| valid_target_types: [ tosca.capabilities.xos.Site ] |
| |
| tosca.relationships.SubscriberDevice: |
| derived_from: tosca.relationships.Root |
| valid_target_types: [ tosca.capabilities.xos.Subscriber ] |
| |
| tosca.relationships.BelongsToSubscriber: |
| derived_from: tosca.relationships.Root |
| valid_target_types: [ tosca.capabilities.xos.Subscriber ] |
| |
| tosca.relationships.BelongsToTenant: |
| derived_from: tosca.relationships.Root |
| valid_target_types: [ tosca.capabilities.xos.Tenant ] |
| |
| tosca.relationships.UsesDashboard: |
| derived_from: tosca.relationships.Root |
| valid_target_types: [ tosca.capabilities.xos.DashboardView ] |
| |
| tosca.relationships.HasLabel: |
| derived_from: tosca.relationships.Root |
| valid_target_types: [ tosca.capabilities.xos.NodeLabel ] |
| |
| tosca.relationships.SupportsFlavor: |
| derived_from: tosca.relationships.Root |
| valid_target_types: [ tosca.capabilities.xos.Flavor ] |
| |
| tosca.relationships.DefaultFlavor: |
| derived_from: tosca.relationships.Root |
| valid_target_types: [ tosca.capabilities.xos.Flavor ] |
| |
| tosca.relationships.ProvidesAddresses: |
| derived_from: tosca.relationships.Root |
| valid_target_types: [ tosca.capabilities.xos.AddressPool ] |
| |
| tosca.relationships.DependsOn: |
| derived_from: tosca.relationships.Root |
| |
| tosca.relationships.TagsObject: |
| derived_from: tosca.relationships.Root |
| |
| tosca.relationships.MemberOfDevice: |
| derived_from: tosca.relationships.Root |
| |
| tosca.relationships.UsesAgent: |
| derived_from: tosca.relationships.Root |
| |
| tosca.relationships.HasResource: |
| derived_from: tosca.relationships.Root |
| |
| tosca.relationships.UsedByController: |
| derived_from: tosca.relationships.Root |
| |
| tosca.relationships.UsedByXOS: |
| derived_from: tosca.relationships.Root |
| |
| tosca.relationships.IsType: |
| derived_from: tosca.relationships.Root |
| |
| tosca.capabilities.xos.Service: |
| derived_from: tosca.capabilities.Root |
| description: An XOS Service |
| |
| tosca.capabilities.xos.Deployment: |
| derived_from: tosca.capabilities.Root |
| description: An XOS Deployment |
| |
| tosca.capabilities.xos.Controller: |
| derived_from: tosca.capabilities.Root |
| description: An XOS Controller |
| |
| tosca.capabilities.xos.Site: |
| derived_from: tosca.capabilities.Root |
| description: An XOS Site |
| |
| tosca.capabilities.xos.Slice: |
| derived_from: tosca.capabilities.Root |
| description: An XOS Slice |
| |
| tosca.capabilities.xos.NetworkTemplate: |
| derived_from: tosca.capabilities.Root |
| description: An XOS network template |
| |
| # tosca.capabilities.xos.Network: |
| # derived_from: tosca.capabilities.Root |
| # description: An XOS network |
| |
| tosca.capabilities.xos.User: |
| derived_from: tosca.capabilities.Root |
| description: An XOS user |
| |
| tosca.capabilities.xos.Subscriber: |
| derived_from: tosca.capabilities.Root |
| description: An XOS Subscriber |
| |
| tosca.capabilities.xos.Device: |
| derived_from: tosca.capabilities.Root |
| description: A device belonging to an XOS subscriber |
| |
| tosca.capabilities.xos.Node: |
| derived_from: tosca.capabilities.Root |
| description: An XOS Node |
| |
| tosca.capabilities.xos.NodeLabel: |
| derived_from: tosca.capabilities.Root |
| description: An XOS NodeLabel |
| |
| tosca.capabilities.xos.Flavor: |
| derived_from: tosca.capabilities.Root |
| description: An XOS Flavor |
| |
| tosca.capabilities.xos.DeploymentRole: |
| derived_from: tosca.capabilities.Root |
| description: An XOS DeploymentRole |
| |
| tosca.capabilities.xos.SliceRole: |
| derived_from: tosca.capabilities.Root |
| description: An XOS SliceRole |
| |
| tosca.capabilities.xos.SiteRole: |
| derived_from: tosca.capabilities.Root |
| description: An XOS SiteRole |
| |
| tosca.capabilities.xos.TenantRole: |
| derived_from: tosca.capabilities.Root |
| description: An XOS TenantRole |
| |
| tosca.capabilities.xos.Tenant: |
| derived_from: tosca.capabilities.Root |
| description: An XOS Tenant |
| |
| tosca.capabilities.xos.Image: |
| derived_from: tosca.capabilities.Root |
| description: An XOS Image |
| |
| tosca.capabilities.xos.DashboardView: |
| derived_from: tosca.capabilities.Root |
| description: An XOS DashboardView |
| |
| tosca.capabilities.xos.NetworkParameterType: |
| derived_from: tosca.capabilities.Root |
| description: An XOS NetworkParameterType |
| |
| tosca.capabilities.xos.AddressPool: |
| derived_from: tosca.capabilities.Root |
| description: An XOS AddressPool |
| |
| tosca.capabilities.xos.Privilege: |
| derived_from: tosca.capabilities.Root |
| description: An XOS Privilege |