README.md

   1 # DCAE Blueprints and Bootstrap Container
   2 This repository holds the source code needed to build the
   3 Docker image for the DCAE bootstrap container.  The bootstrap
   4 container runs at DCAE deployment time (via a Helm chart) and
   5 does initial setup of the DCAE environment.  This includes
   6 deploying several service components using Cloudify Manager.
   7
   8 This repository also holds Cloudify blueprints for service components.
   9 The Docker build process copies these blueprints into the Docker image
  10 for the bootstrap container.
  11
  12 _Note: Prior to the Frankfurt release (R6), this repository held blueprint templates
  13 for components deployed using Cloudify Manager.   The build process for this
  14 repository expanded the templates and pushed them to the Nexus raw
  15 repository.  The DCAE bootstrap container was hosted in the `dcaegen2.deployments` repository.  The Docker build process for the bootstrap containter image pulled the blueprints it needed from the Nexus raw repository._
  16
  17 ## DCAE Bootstrap Container
  18 This container is responsible for loading plugins and wagons onto the
  19 DCAE Cloudify Manager instance and for launching DCAE components.
  20
  21 The Docker image build process loads plugins and blueprints into the
  22 image's file system.  The plugins are pulled from the Nexus raw repository.  The
  23 blueprints are copied from the `blueprints` directory in this repository.  At run time, the main script in the container
  24 (`bootstrap.sh`) uploads the plugins to Cloudify Manager, then installs
  25 components using the blueprints.
  26
  27 The container expects to be started with two environment variables:
  28   - `CMADDR` -- the address of the target Cloudify Manager
  29   - `CMPASS` -- the password for Cloudify Manager
  30
  31 The container expects input files to use when deploying the blueprints.
  32 It expects to find them in /inputs.   The normal method for launching
  33 the container is via a Helm Chart launched by OOM.  That chart creates
  34 a Kubernetes ConfigMap containing the input files.  The ConfigMap is
  35 mounted as a volume at /inputs.
  36