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.
Navigate to the Catalog tab in the DC/OS GUI.
Figure 1. Universe catalog
Click a package.
- Click REVIEW & RUN.
- Optionally click EDIT, customize parameters, and click REVIEW & RUN.
- Click RUN SERVICE.
The Services tab provides a full featured interface to the native DC/OS Marathon instance.
Navigate to the Services tab in the DC/OS GUI.
Click RUN A SERVICE and specify your Marathon app definition.
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.
From the DC/OS GUI, click on Catalog in the left hand navigation menu. The Catalog will appear.
Figure 3. Catalog screen
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.
From the Elastic service instance page, click on the REVIEW & RUN button.
Figure 4. Review & Run button
The Edit Configuration page will appear. If you need to see the code, click on the JSON Editor button at the top right.
Figure 5. JSON Editor button
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.
Figure 6. Edit Configuration split screen
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.
Figure 7. Review Configuration page
If you have more changes to make, click the Edit Config button. You may also download the
config.jsonfile 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.
Figure 8. Download Config button
When you have finished configuring your installation, click the Run Service button on the top right.
Figure 9. Run Service button
DC/OS will install your service and display a success screen.
Figure 10. Success screen
From the Services tab, you can see that your service is now running.
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.