kubernetes/dcaegen2/components/dcae-cloudify-manager/README.md

   1 #============LICENSE_START========================================================
   2 # ================================================================================
   3 # Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
   4 # Modifications Copyright © 2018 Amdocs, Bell Canada
   5 # ================================================================================
   6 # Licensed under the Apache License, Version 2.0 (the "License");
   7 # you may not use this file except in compliance with the License.
   8 # You may obtain a copy of the License at
   9 #
  10 #     http://www.apache.org/licenses/LICENSE-2.0
  11 #
  12 # Unless required by applicable law or agreed to in writing, software
  13 # distributed under the License is distributed on an "AS IS" BASIS,
  14 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15 # See the License for the specific language governing permissions and
  16 # limitations under the License.
  17 # ============LICENSE_END=========================================================
  18
  19 # DCAE Cloudify Manager Chart
  20
  21 This chart is used to deploy a containerized version of
  22 [Cloudify Manager](http://docs.getcloudify.org/4.3.0/intro/cloudify-manager/),
  23 the orchestration tool used by DCAE.  DCAE uses Cloudify Manager ("CM") to
  24 deploy the rest of the DCAE platform as well to deploy DCAE monitoring and
  25 analytics services dynamically, in response to network events such as VNF startups.
  26
  27 Deployment of CM is the first of two steps in deploying DCAE into ONAP.  After this chart
  28 brings up CM, a second chart (the "bootstrap" chart) installs some plugin extensions onto CM
  29 and uses CM to deploy some DCAE components.
  30
  31 ## Prerequisites
  32 The chart requires one Kubernetes secret to be available in the namespace where it is
  33 being deployed:
  34   - `<namespace_name>-docker-registry-key`, the docker registry secret needed to pull images
  35   from the Docker repository.  This is the same secret used by other OOM charts.
  36
  37 ## DCAE Namespace
  38 DCAE will use CM deploy a number of containers into the ONAP Kubernetes cluster.  In a production
  39 environment, DCAE's dynamic deployment of monitoring and analytics services could result in dozens
  40 of containers being launched.  This chart allows the configuration, through the `dcae_ns` property
  41 in the `values.yaml` of a separate namespace used by CM when it needs to deploy containers into
  42 Kubernetes.  If `dcae_ns` is set, this chart will:
  43   - create the namespace.
  44   - create the Docker registry key secret in the namespace.
  45   - create some Kubernetes `Services` (of the `ExternalName` type) to map some addresses from the common namespace into the DCAE namespace.
  46
  47 ## Use of Consul
  48 DCAE uses [Consul](http://consul.io) to store configuration data for DCAE components.  In R1, DCAE
  49 deployed its own Consul cluster.  In R2, DCAE will use the Consul server deployed by OOM.