summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJack Lucas <jflucas@research.att.com>2017-08-31 18:25:25 +0000
committerJack Lucas <jflucas@research.att.com>2017-08-31 18:29:39 +0000
commit413edb706447d7226d0bca35742f739c7c734378 (patch)
treedd39adc9ad09588c3ac78694c64d87d5f0f784ae
parentc8bd891fcdbfc035f24eff27f45e641a43adf48d (diff)
Add deployment handler blueprint
Change-Id: I08e728f7278e6ce1048fee1c6a50bbec412c9c10 Issue-Id: DCAEGEN2-78 Signed-off-by: Jack Lucas <jflucas@research.att.com>
-rw-r--r--blueprints/DeploymentHandler-README.md23
-rw-r--r--blueprints/DeploymentHandler.yaml99
2 files changed, 122 insertions, 0 deletions
diff --git a/blueprints/DeploymentHandler-README.md b/blueprints/DeploymentHandler-README.md
new file mode 100644
index 0000000..8b76890
--- /dev/null
+++ b/blueprints/DeploymentHandler-README.md
@@ -0,0 +1,23 @@
+## Deployment Handler Installation Blueprint
+[`DeploymentHandler.yaml`](./DeploymentHandler.yaml) is a Cloudify blueprint that can be used to deploy an instance of the DCAE Deployment Handler (DH) as a Docker container in the DCAE Docker environment.
+
+### Input parameters
+Some deployment parameters can be controlled via inputs supplied to Cloudify at the time a deployment is created from the blueprint.
+The table below describes the available input parameters.
+
+Parameter|Description|Required?|Default
+---------|-----------|---------|-------
+`location_id`|Location where DH is to be deployed; should point to a central site|Yes|None
+`docker_host_override`|Registered service name of the Docker host where DH should be deployed|Yes|`platform_dockerhost`
+`deployment_handler_image`|Fully qualified name of the Docker image to use for DH|Yes|Current stable version of image
+`application_config`|Application-specific configuration parameters (see below)|No|`{}`
+`host_log_root`|root directory for logs in the Docker host file system|Yes|`/opt/onap/log`
+
+### Application configuration
+The DH has sensible defaults for its configuration. The `application_config` input can be used to supply additional configuration information to override defaults and/or to set values for optional parameters. The content of this input is a dictionary with parameter names as keys and parameter values as values. See the documentation for the DH for the available configuration parameters.
+
+### Additional configuration
+`DeploymentHandler.yaml` relies on the DCAE Docker plugin to carry out the actual deployment. The plugin gathers information from the blueprint and the inputs and uses this information to make API calls to a Docker Engine running in the DCAE environment.
+
+Certain aspects of Docker behavior are controlled through inputs to the plugin's `create` operation. This includes mapping directories and files from the host file system into the Docker container's file system. It is also possible to pass environment variables to the container. The inputs to the `create` operation are specified inside the blueprint in the `interfaces` section of node definition for the deployment handler.
+
diff --git a/blueprints/DeploymentHandler.yaml b/blueprints/DeploymentHandler.yaml
new file mode 100644
index 0000000..9cf1cd9
--- /dev/null
+++ b/blueprints/DeploymentHandler.yaml
@@ -0,0 +1,99 @@
+#
+# ============LICENSE_START==========================================
+# ===================================================================
+# Copyright © 2017 AT&T Intellectual Property. All rights reserved.
+# ===================================================================
+# 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.
+# ============LICENSE_END============================================
+#
+# ECOMP and OpenECOMP are trademarks
+# and service marks of AT&T Intellectual Property.
+#
+
+tosca_definitions_version: cloudify_dsl_1_3
+
+description: >
+ This blueprint deploys/manages the DCAE deployment handler as a Docker container
+
+imports:
+ - http://www.getcloudify.org/spec/cloudify/3.4/types.yaml
+ - "{{ ONAPTEMPLATE_RAWREPOURL_org_onap_dcaegen2 }}/type_files/docker/2.1.0/node-type.yaml"
+ - "{{ ONAPTEMPLATE_RAWREPOURL_org_onap_dcaegen2 }}/type_files/relationship/1.0.0/node-type.yaml"
+
+inputs:
+
+ location_id:
+ description: Deployment location
+
+ docker_host_override:
+ description: Target docker host
+ default: 'platform_dockerhost'
+
+ deployment_handler_image:
+ description: Docker image for deployment handler
+ default: '{{ ONAPTEMPLATE_DOCKERREGURL_org_onap_dcaegen2 }}/org.onap.dcaegen2.platform/deployment-handler:1.0.0-SNAPSHOT'
+
+ application_config:
+ description: deployment handler application configuration (to override defaults)
+ default: {}
+
+ host_log_root:
+ description: root directory for logs in the Docker host file system
+ default: '/opt/onap/log'
+
+node_templates:
+
+ # Deployment Handler
+ deployment-handler:
+ type: dcae.nodes.DockerContainerForPlatforms
+ properties:
+ name:
+ 'deployment_handler'
+ image:
+ { get_input: deployment_handler_image }
+ application_config:
+ { get_input: application_config }
+ host_port:
+ 8188
+ container_port:
+ 8443
+ docker_config:
+ healthcheck:
+ type: 'http'
+ interval: '300s'
+ timeout: '5s'
+ endpoint: '/'
+ relationships:
+ - type: dcae.relationships.component_contained_in
+ target: docker_host
+ interfaces:
+ cloudify.interfaces.lifecycle:
+ start:
+ inputs:
+ envs:
+ SOMEVAR: somevalue
+ #volumes:
+ #- host:
+ #path: { concat: [ { get_input: host_log_root }, '/dcae/deployment_handler' ] }
+ #container:
+ #bind: /opt/app/dh/log
+ #mode: rw
+
+ # Docker host
+ docker_host:
+ type: dcae.nodes.SelectedDockerHost
+ properties:
+ location_id:
+ { get_input: location_id }
+ docker_host_override:
+ { get_input: docker_host_override }