Hello World tutorial

The easiest way to get started is usually with a hands on approach, the following tutorial will use docker-compose to set a local Nebula cluster on your machine that includes MongoDB, RabbitMQ the API & the worker (which normally you will want be diffrent devices but for testing this is sufficient), it of course requires docker & docker-compose installed so if you don't have them install them first.


Some linux distros have epmd installed (Ubuntu included) which the following rabbitmq container requires so if your having problems with rabbit refusing to run try killing the host epmd and\or host rabbitmq-server for the duration of this tutorial


You can run the following and skip to step 4 if you don't want to change the docker-compose to add a private Docker registry access:

sudo curl -L "https://raw.githubusercontent.com/nebula-orchestrator/docs/master/examples/hello-world/docker-compose.yml" -o docker-compose.yml | sudo docker-compose up -d

  1. First get the docker-compose.yml of this tutorial and save it locally on your machine
  2. Nebula is geared towards using a private registry but will also work with docker hub, to use your own user\pass (by default no auth is used) edit the docker-compose.yml by entering your docker hub user & password into "REGISTRY_AUTH_USER" & "REGISTRY_AUTH_PASSWORD" under the "worker" container, if your using a private registry change the "REGISTRY_HOST" variable as well to point to your private registry, if you are planning on only using public images you can keep the settings as is and use no Docker registry auth.
  3. from the directory where you saved docker-compose.yml at (same name is important) run docker-compose up -d (you might need to sudo su first if you didn't set your user to be part of the docker group), don't worry if you see the worker-manager & api-manager restarting, it's because the mongo & rabbit containers take a couple of seconds to initialize.
  4. You now have a running Nebula cluster, lets use Curl to create an nginx app to fill the "example" APP_NAME app that the worker-manager has set to manage:

    curl -X POST \ \
      -H 'authorization: Basic bmVidWxhOm5lYnVsYQ==' \
      -H 'cache-control: no-cache' \
      -H 'content-type: application/json' \
      -d '{
      "starting_ports": [{"81":"80"}],
      "containers_per": {"server": 1},
      "env_vars": {},
      "docker_image" : "nginx",
      "running": true,
      "volumes": ["/tmp:/tmp/1", "/var/tmp/:/var/tmp/1:ro"],
      "networks": ["nebula"],
      "privileged": false,
      "devices": []
  5. Either wait for the changes to catch (usually few seconds at most) or restart the worker-manager container, you now have your first nebula worker (try logging into in your browser to see), because the network is internal in this tutorial you can only run more on the same machine (which kinda defeats the purpose) but after you deploy Nebula by following the install guide you can run as many workers as you need by having multiple servers running the same worker-manager container with the same envvars\config file.