Installing Services

Installing and verifying a service using the CLI or the GUI

Installing a service using the CLI

The general syntax for installing a service with the CLI follows.

dcos package install [--options=<config-file-name>.json] <servicename>

Use the optional --options flag to specify the name of the customized JSON file you created in advanced configuration.

For example, you would use the following command to install Chronos with the default parameters.

dcos package install chronos

Installing a service using the GUI

From the DC/OS GUI you can install services from the Services or Catalog tab. The Catalog tab shows all of the available DC/OS services from the package repositories. The Services tab provides a full featured interface to the native DC/OS Marathon instance.

Catalog tab

  1. Navigate to the Catalog tab in the DC/OS GUI.


    Figure 1. Universe catalog

  2. Click a package.

    1. Click REVIEW & RUN.
    2. Optionally click EDIT, customize parameters, and click REVIEW & RUN.
    3. Click RUN SERVICE.

Services tab

The Services tab provides a full featured interface to the native DC/OS Marathon instance.

  1. Navigate to the Services tab in the DC/OS GUI.

  2. Click RUN A SERVICE and specify your Marathon app definition.

    service tab

    Figure 2. Services screen

You can edit and install the configuration file for your service from the DC/OS GUI. You can also download the config.json file for reference.

  1. From the DC/OS GUI, click on Catalog in the left hand navigation menu. The Catalog will appear.


    Figure 3. Catalog screen

  2. From the Catalog, choose your service. In this case, we will choose Elastic by clicking on the Elastic image. The Elastic service isntance page will appear.

  3. From the Elastic service instance page, click on the REVIEW & RUN button.

    Review button

    Figure 4. Review & Run button

  4. The Edit Configuration page will appear. If you need to see the code, click on the JSON Editor button at the top right.

    JSON editor

    Figure 5. JSON Editor button

  5. The screen will split, showing you the Edit Configuration page and a text editor. Any changes you make to the Edit Configuration page are reflected in the JSON file shown on the right.

    Split screen

    Figure 6. Edit Configuration split screen

  6. When you finish making your changes, click the REVIEW & RUN button. The Review Configuration page will appear. This will show the Preinstall Notes, reminding you of the prerequisites for this service. You have the opportunity to review and edit your configuration file, or download it.

    Review Config

    Figure 7. Review Configuration page

  7. If you have more changes to make, click the Edit Config button. You may also download the config.json file by clicking on the Download Config button. This will start a download to your system’s designated download folder. This is useful to have as reference, upgrading and for backup.

    Split screen

    Figure 8. Download Config button

  8. When you have finished configuring your installation, click the Run Service button on the top right.

    Run Service

    Figure 9. Run Service button

  9. DC/OS will install your service and display a success screen.

    Success screen

    Figure 10. Success screen

  10. From the Services tab, you can see that your service is now running.

    Services tab

    Figure 11. Services screen showing Elastic service

Verifying your installation


dcos package list


Go to the Services tab and confirm that the service is running. For more information, see the GUI documentation.


Figure 3. Service is running

Some services from the Community section of the Catalog will not show up in the DC/OS service listing. For these, inspect the service’s Marathon app in the Marathon GUI to verify that the service is running and healthy.