Gitiles
Code Review Sign In
gerrit.opencord.org / exampleservice / 7a916f774639db6a39c5651e1e9b654cc6683ea4 / . / xos / exampleservice.yaml
blob: 04eed5c09536c4c36da10b710a50832f3c317ccb [file] [log] [blame]
Matteo Scandolo35113f72017-08-08 13:05:25 -0700[diff] [blame]1
2# Copyright 2017-present Open Networking Foundation
3#
4# Licensed under the Apache License, Version 2.0 (the "License");
5# you may not use this file except in compliance with the License.
6# 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
Scott Baker619de672016-06-20 12:49:38 -0700[diff] [blame]17tosca_definitions_version: tosca_simple_yaml_1_0
18
19# compile this with "m4 exampleservice.m4 > exampleservice.yaml"
20
21# include macros
22# Note: Tosca derived_from isn't working the way I think it should, it's not
23# inheriting from the parent template. Until we get that figured out, use
24# m4 macros do our inheritance
25
26
27# Service
28
29
30# Subscriber
31
32
33
34
35# end m4 macros
36
37
38
39node_types:
40 tosca.nodes.ExampleService:
41 derived_from: tosca.nodes.Root
42 description: >
43 Example Service
44 capabilities:
45 scalable:
46 type: tosca.capabilities.Scalable
47 service:
48 type: tosca.capabilities.xos.Service
49 properties:
50 no-delete:
51 type: boolean
52 default: false
53 description: Do not allow Tosca to delete this object
54 no-create:
55 type: boolean
56 default: false
57 description: Do not allow Tosca to create this object
58 no-update:
59 type: boolean
60 default: false
61 description: Do not allow Tosca to update this object
62 replaces:
63 type: string
64 required: false
65 descrption: Replaces/renames this object
66 kind:
67 type: string
68 default: generic
69 description: Type of service.
70 view_url:
71 type: string
72 required: false
73 description: URL to follow when icon is clicked in the Service Directory.
74 icon_url:
75 type: string
76 required: false
77 description: ICON to display in the Service Directory.
78 enabled:
79 type: boolean
80 default: true
81 published:
82 type: boolean
83 default: true
84 description: If True then display this Service in the Service Directory.
85 public_key:
86 type: string
87 required: false
88 description: Public key to install into Instances to allows Services to SSH into them.
89 private_key_fn:
90 type: string
91 required: false
92 description: Location of private key file
93 versionNumber:
94 type: string
95 required: false
96 description: Version number of Service.
97 service_message:
98 type: string
99 required: false
100
Scott Bakerffac7182017-07-27 15:21:30 -0700[diff] [blame]101 tosca.nodes.ExampleServiceInstance:
102 derived_from: tosca.nodes.Root
103 description: >
104 A ServiceInstance of the example service
105 properties:
106 kind:
107 type: string
108 default: generic
109 description: Kind of tenant
110 service_specific_id:
111 type: string
112 required: false
113 description: Service specific ID opaque to XOS but meaningful to service
114 tenant_message:
115 type: string
116 required: false
117
118 # deprecated, replaced by ExampleServiceInstance
Scott Baker619de672016-06-20 12:49:38 -0700[diff] [blame]119 tosca.nodes.ExampleTenant:
120 derived_from: tosca.nodes.Root
121 description: >
122 A Tenant of the example service
123 properties:
124 kind:
125 type: string
126 default: generic
127 description: Kind of tenant
128 service_specific_id:
129 type: string
130 required: false
131 description: Service specific ID opaque to XOS but meaningful to service
132 tenant_message:
133 type: string
134 required: false
135