This section contains useful (and sometimes temporary) scripts as well as references to tools, projects and pieces of documentation used for the development of the recipes.
The basic environment setup is explained in the Installation part of the docs.
Playing with Recipes?
Helpful tool to help you quickly setup a local virtualbox-based swarm cluster for testing purposes.
Useful shell script used when you need to wait for a service to be started.
Note: This might no longer be needed since docker introduced the healthchecks feature.
If you'd like to have a basic view of the distribution of containers in your
swarm cluster, you can use the
visualzer.yml file provided in this folder.
docker stack deploy -c visualizer.yml vis
If you'd like a more sophisticated UI with info about your swarm, you can deploy portainer as follows.
docker service create \ --name portainer \ --publish 9000:9000 \ --constraint 'node.role == manager' \ --mount type=bind,src=/var/run/docker.sock,dst=/var/run/docker.sock \ portainer/portainer \ -H unix:///var/run/docker.sock
Alternatively, you can make use of the docker-compose file available in this folder.
docker stack deploy -c portainer.yml portainer
A well-known tool for experimenting with APIs. Do you want to try the curl-based
examples of the recipes from Postman? Import the
available in this folder and make your tests easier. Note: this collection is
work in progress, feel free to contribute!
Instead of uploading pictures in this document, we use
gravizo's power to convert the .dot or PlantUML files
and have them served as pictures online. There is an intermediate conversion
done with gravizo's converter.
Inspect the source of any recipe's
readme.md to see an example.
Other tools for documentation that you may find useful are...
Use this tool when the diagrams start getting too complex of when you foresee the diagram will be complex from the scratch.
Complex in the sense that making a simple change takes more time understanding
.dot than making a manual gui-based change.
When using draw.io, keep the source file in the repository under a
subfolder of the corresponding recipe.
The reference for color names used in
To give more docker-related details we could use this tool to create diagrams from docker-compose files. The tools gives also the .dot file, which would be eventually customized and then turned into a png file using graphviz.
$ dot compose.dot -Tpng -o compose.png