1 # ================================================================================
2 # Copyright (c) 2017-2018 AT&T Intellectual Property. All rights reserved.
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
8 # http://www.apache.org/licenses/LICENSE-2.0
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 # ============LICENSE_END=========================================================
17 # ECOMP is a trademark and service mark of AT&T Intellectual Property.
19 tosca_definitions_version: cloudify_dsl_1_3
22 - http://www.getcloudify.org/spec/cloudify/3.4/types.yaml
26 executor: 'central_deployment_agent'
27 package_name: k8splugin
28 package_version: 1.4.2
32 dcae.types.MSBRegistration:
34 Information for registering an HTTP service into MSB. It's optional to do so,
35 but if MSB registration is desired at least the port property must be provided.
36 If 'port' property is not provided, the plugin will not do the registration.
37 (The properties all have to be declared as not required, otherwise the
38 'msb_registration' property on the node would also be required.)
41 description: The container port at which the service is exposed
45 description: The version identifier for the service
49 description: The URL path (e.g., "/api", not the full URL) to the service endpoint
53 description: Set to true if service endpoint uses SSL (TLS)
57 dcae.types.LoggingInfo:
59 Information for setting up centralized logging via ELK using a "sidecar" container.
60 If 'log_directory' is not provided, the plugin will not set up ELK logging.
61 (The properties all have to be declared as not required, otherwise the
62 'log_info' property on the node would also be required.)
66 The path in the container where the component writes its logs.
67 If the component is following the EELF requirements, this would be
68 the directory where the four EELF files are being written.
69 (Other logs can be placed in the directory--if their names in '.log',
70 they'll also be sent into ELK.)
75 Hope not to use this. By default, the plugin will mount the log volume
76 at /var/log/onap/<component_type> in the sidecar container's file system.
77 'alternate_fb_path' allows overriding the default. Will affect how the log
78 data can be found in the ELK system.
83 dcae.nodes.ContainerizedComponent:
84 # Bese type for all containerized components
85 # Captures common properties and interfaces
86 derived_from: cloudify.nodes.Root
90 description: Full uri of the Docker image
95 Application configuration for this Docker component. The data structure is
96 expected to be a complex map (native YAML) and to be constructed and filled
97 by the creator of the blueprint.
102 This is what is the auxilary portion of the component spec that contains things
103 like healthcheck definitions for the Docker component. Health checks are
107 type: dcae.types.LoggingInfo
109 Information for setting up centralized logging via ELK.
115 The number of instances of the component that should be launched initially
121 Set to true if the orchestrator should always pull a new copy of the image
122 before deploying. By default the orchestrator pulls only if the image is
123 not already present on the Docker host where the container is being launched.
127 dcae.interfaces.update:
129 implementation: k8s.k8splugin.scale
131 implementation: k8s.k8splugin.update_image
133 # The ContainerizedServiceComponent node type is to be used for DCAE service components that
134 # are to be run in a Docker container. This node type goes beyond that of a ordinary Docker
135 # plugin where it has DCAE platform specific functionality:
137 # * Generation of the service component name
138 # * Managing of service component configuration information
140 # The plugin deploys the container into a Kubernetes cluster with a very specific choice
141 # of Kubernetes elements that are deliberately not under the control of the blueprint author.
142 # The idea is to deploy all service components in a consistent way, with the details abstracted
143 # away from the blueprint author.
144 dcae.nodes.ContainerizedServiceComponent:
145 derived_from: dcae.nodes.ContainerizedComponent
147 service_component_type:
149 description: Service component type of the application being run in the container
154 Unique id for this DCAE service instance this component belongs to. This value
155 will be applied as a tag in the registration of this component with Consul.
161 Location id of where to run the container. Not used by the plugin. Here for backward compatibility.
165 service_component_name_override:
168 Manually override and set the name for this Docker container node. If this
169 is set, then the name will not be auto-generated. Platform services are the
170 specific use cases for using this parameter because they have static
171 names for example the CDAP broker.
175 cloudify.interfaces.lifecycle:
177 # Generate service component name and populate config into Consul
178 implementation: k8s.k8splugin.create_for_components
180 # Create Docker container and start
181 implementation: k8s.k8splugin.create_and_start_container_for_components
183 # Stop and remove Docker container
184 implementation: k8s.k8splugin.stop_and_remove_container
186 # Delete configuration from Consul
187 implementation: k8s.k8splugin.cleanup_discovery
188 dcae.interfaces.policy:
189 # This is to be invoked by the policy handler upon policy updates
191 implementation: k8s.k8splugin.policy_update
193 # This node type is intended for DCAE service components that use DMaaP and must use the
195 dcae.nodes.ContainerizedServiceComponentUsingDmaap:
196 derived_from: dcae.nodes.ContainerizedServiceComponent
200 List of DMaaP streams used for publishing.
202 Message router items look like:
209 Data router items look like:
215 This information is forwarded to the dmaap plugin to provision
219 List of DMaaP streams used for subscribing.
221 Message router items look like:
228 Data router items look like:
238 Note that username and password is optional. If not provided or null then the
239 plugin will generate them.
243 cloudify.interfaces.lifecycle:
245 # Generate service component name and populate config into Consul
246 implementation: k8s.k8splugin.create_for_components_with_streams
248 # Create Docker container and start
249 implementation: k8s.k8splugin.create_and_start_container_for_components_with_streams
251 # ContainerizedPlatformComponent is intended for DCAE platform services. Unlike the components,
252 # platform services have well-known names and well-known ports.
253 dcae.nodes.ContainerizedPlatformComponent:
254 derived_from: dcae.nodes.ContainerizedComponent
258 Container name used to register with Consul
262 Name to be registered in the DNS for the service provided by the container.
263 If not provided, the 'name' field is used.
264 This is a work-around for the Kubernetes restriction on having '_' in a DNS name.
265 Having this field allows a component to look up its configuration using a name that
266 includes a '_' while providing a legal Kubernetes DNS name.
271 Network port that the platform service is expecting to expose on the host
277 Network port that the platform service exposes in the container
281 type: dcae.types.MSBRegistration
283 Information for registering with MSB
287 cloudify.interfaces.lifecycle:
289 # Populate config into Consul
290 implementation: k8s.k8splugin.create_for_platforms
292 # Create Docker container and start
293 implementation: k8s.k8splugin.create_and_start_container_for_platforms
295 # Stop and remove Docker container
296 implementation: k8s.k8splugin.stop_and_remove_container
298 # Delete configuration from Consul
299 implementation: k8s.k8splugin.cleanup_discovery
301 # ContainerizedApplication is intended to be more of an all-purpose Docker container node
302 # for non-componentized applications.
303 dcae.nodes.ContainerizedApplication:
304 derived_from: cloudify.nodes.Root
308 description: Name of the Docker container to be given
311 description: Full uri of the Docker image
313 cloudify.interfaces.lifecycle:
315 # Create Docker container and start
316 implementation: k8s.k8splugin.create_and_start_container
318 # Stop and remove Docker container
319 implementation: k8s.k8splugin.stop_and_remove_container
320 dcae.interfaces.scale:
322 implementation: k8s.k8splugin.scale
323 dcae.interfaces.update:
325 implementation: k8s.k8splugin.update_image