development.md

Amalgam8 Developer Instructions

Note: These instructions are currently only available for Amalgam8 on local Kubernetes.

The easiest way to set up an environment where you can compile and experiment with Amalgam8 source code is by using the same vagrant VM that is used for the sample microservice demos in the examples project. However, in this case you must pull more git repos before doing the "vagrant up".

Alternatively you can set up the required prerequisites that are described in the Vagrantfile by yourself, and then run the samples on your own machine of choice.

To get started using the provided Vagrant file, run the following commands:

git clone git@github.com:amalgam8/examples.git
git clone git@github.com:amalgam8/registry.git
git clone git@github.com:amalgam8/controller.git
git clone git@github.com:amalgam8/sidecar.git

cd examples
vagrant up
vagrant ssh

In this environment, you can run all the same samples and demos that are described in https://github.com/amalgam8/examples/blob/master/README.md, and you have the ability to also compile the code and build the images locally.

You can compile and build the control plane or sidecar images locally, by running one of the following commands:

build-scripts/build-controller.sh
build-scripts/build-registry.sh
build-scripts/build-sidecar.sh

If want to build all three projects, you can run the following command instead:

build-scripts/build-amalgam8.sh

If you change the base sidecar image and rebuild it, ensure that you also locally build the sample images before trying to run them:

apps/helloworld/build.sh
apps/bookinfo/build-services-baseimages.sh

To remove locally-compiled Amalgam8 images and use the Amalgam8 images from Docker Hub:

docker rmi $(docker images | grep "amalgam8/" | awk "{print \$3}")