While Amalgam8 supports multi-tenancy, for the sake of simplicity, this demo will setup Amalgam8 in single-tenant mode.


Download and unzip the latest release of Amalgam8 demos from the Amalgam8 Releases page. You should find a folder named examples after extracting files from the zip archive.


  • Docker You need docker 1.10 or higher and docker-compose 1.5.1 or higher.

  • Python 2.7.9 or higher. If you are using Linux or Mac OS X, you should already have the requisite version of Python in your system.

Additional Requirements

  • If you are planning to use Kubernetes, then you need a working kubernetes installation. To install kubernetes locally, checkout minikube.

  • If you are planning to run the demos on IBM Bluemix, you need to install the Bluemix CLI version 0.4.1 or later with the IBM-Containers plugin 0.5.800 or later.

With the requirements out of the way, lets move on to the next stage: running Amalgam8.

Setting up the Control Plane

The Amalgam8 Control Plane consists of two components: the service registry and the route controller. In addition to these two components, for the purposes of this demo, a stock ELK stack is also included as part of the control plane deployment scripts, to collect logs from the microservices in the application.

Elasticsearch 5.0 requires increasing the max map count for certain linux environments such as Vagrant VMs, Docker Machine and Minikube. If you are running any of these tools, please run the following command on those VMs:

sudo sysctl -w vm.max_map_count=262144

Note: You can ssh into the minikube virtual machine by running minikube ssh

The commands to deploy the control plane for different environments are as follows:

Docker Compose

docker-compose -f examples/docker-controlplane.yaml up -d

Kubernetes on localhost or on Google Cloud

kubectl create -f examples/k8s-controlplane.yaml

IBM Bluemix

  1. Login to Bluemix and initialize the container environment using

    bluemix login
    bluemix ic init
  2. Create Bluemix routes (DNS names) for the registry, controller and the bookinfo app’s gateway:

    bluemix cf create-route <your bluemix space> mybluemix.net -n <your registry route>
    bluemix cf create-route <your bluemix space> mybluemix.net -n <your controller route>

    where <your bluemix space> is the name of your Bluemix space and <your route ...> is a unique route name for registry and controller. For example my-space-name-a8-registry and my-space-name-a8-controller. Make a note of the route names you choose for the next step.

  3. Customize the examples/bluemix.cfg in the downloaded folder as follows:
    • BLUEMIX_REGISTRY_NAMESPACE should be your Bluemix registry namespace obtained from the folowing command:

      bluemix ic namespace-get
    • REGISTRY_HOSTNAME should be the route name assigned to the registry in the previous step

    • CONTROLLER_HOSTNAME should be the route name assigned to the controller in the previous step

  4. Deploy the control plane services (registry and controller) on bluemix.

    examples/a8-bluemix create controlplane

    Verify that the controller and registry are running using the following commands:

    bluemix ic groups

    You should see the groups amalgam8_controller and amalgam8_registry listed in the output.

Setting up the Amalgam8 CLI

The a8ctl command line utility provides a convenient way to setup and manage routes across microservices as well as inspect the state of the system. The CLI can be installed by building the binary directly or pulling the binary from the releases page here.

Run the folowing commands to install the a8ctl into your home directory:

wget -O /usr/local/bin/a8ctl https://github.com/amalgam8/amalgam8/releases/download/{RELEASE_VERSION}/a8ctl-{OS_VERSION}

Or build the a8ctl binary from source:

git clone https://github.com/amalgam8/amalgam8.git
cd amalgam8/

# linux users
make build.cli.linux

# OSX users
make build.cli.darwin

# Windows users
make build.cli.windows

Add the location of the a8ctl command to the PATH environment variable.

export PATH=$PATH:$GOPATH/src/github.com/amalgam8/amalgam8/bin

To use the Amalgam8 CLI (a8ctl) for the demo walkthroughs we need to setup two environment variables: A8_CONTROLLER_URL and A8_REGISTRY_URL. These variables should point to the publicly accessible REST endpoints exposed by the Amalgam8 controller and registry respectively.

The value of these variables depends on the environment where you setup the control plane.

Docker Compose

export A8_CONTROLLER_URL=http://localhost:31200
export A8_REGISTRY_URL=http://localhost:31300


On minikube

export A8_CONTROLLER_URL=http://$(minikube ip):31200
export A8_REGISTRY_URL=http://$(minikube ip):31300

On Google Cloud Platform, assign a public IP to the Node running the controller and the registry, and set the environment variables respectively.

IBM Bluemix

export A8_CONTROLLER_URL=http://<controller route>.mybluemix.net
export A8_REGISTRY_URL=http://<registry route>.mybluemix.net

where <controller route> and <registry route> correspond to the routes that you set for the controller and registry respectively.