Declaring Paz Services

How to describe your apps to Paz

Before you can run services on Paz you need to declare them. The Service Directory is the internal service that stores this information, and you can add, edit and remove service in the "Services" section of the web UI. Here's how.

  • Go to the "Services" section of the Paz web UI.
  • Click "New service".
  • Enter the details of your service. The fields are as follows:
    • Name: the service name, used for unique identification and for routing (e.g. naming a service "api" means it can be reached from other services by the route "api").
    • Description: serves no function other than being descriptive.
    • Docker repository: the repository from which to pull the Docker container for this service. This can include a registry prefix and the repository may be private (which requires you to have configured your CoreOS hosts to have the requisite access to pull the container).
    • Number of instances: the number of instances of this particular service that you'd like the scheduler to launch when it next deploys it.
    • Ports: corresponds to the port mapping arguments of docker run. Add as many port mappings as you'd like, or leave it blank to have Paz expose all on random ports.
    • Environment: pass environment variables to the Docker container when it is launched. If you want to specify the URL of one Paz service as an environment variable to another, then use the service's name in here (e.g. "api").
    • Public Facing: This determines whether or not Paz will create a subdomain for you with your DNS provider (currently only DNSimple is supported). If you're running in Vagrant this will have no effect.