Working with Service Commissioning Files

This page explains how to work with services from the service overview page of the Connectware web interface.

Important

If your service fails to install, remove, enable or disable, already created resources will be rolled back and removed to avoid cluttering the Connectware with unused data.

Install a service

Commissioning files are installed using the web-based interface of the Connectware on the service overview page:

  1. On the navigation panel click on Services to reach the service overview page.

../../../_images/1_service_menu_toolbar.png

  1. Press the + Button in the toolbar to add a new service.

    ../../../_images/2_service_menu.png

  2. In the Create Service dialog click Choose File and select a commissioning file from your local computer in the file browser, confirming your selection with Ok.

    ../../../_images/3_select_service_file_dialog.png

  3. This will fill in the information in the right part of this dialog window, the Configure the new service section. If your service commissioning file provides configurable parameters, you can now enter customized values for your service. Depending on the commissioning file, parameter descriptions and default values may be available. Additionally, the commissioning file can be reviewed by expanding the Click to see commissioning file tab in the left part. Once you are finished click on Install.

    ../../../_images/4_service_configure_dialog.png

  4. In case everything was configured correctly, you should see the new service added to the service list, initially in the Disabled state.

    ../../../_images/5_service_install_success.png

Enable a service

Enabling, updating, or reconfiguring a service can only be done from the Service Details View by selecting the service in the list.

../../../_images/service_select.png

Continue here: Enable/Disable the Service

Your service now enters the Enabling state, in which all resources which were defined in the commissioning file are being created.

../../../_images/3_service_enabling.png

Once the Enabling has finished successfully, your service will reach the Enabled status and a confirmation message is displayed.

../../../_images/4_service_enable_success.png

Disable a service

  1. To disable a running service, simply select the service from the service list (1.) and then select Disable selected service button (2.) from the toolbar.

../../../_images/1_disable_service_toolbar.png

  1. This will open the Disable Service dialog. To disable the running service, confirm your selection by clicking Disable.

../../../_images/2_disable_service_dialog.png

Important

Disabling a service will destroy running containers, enabled connections, endpoints and mappings. Volumes however will remain in its current state and will reattach to the service once it is enabled again.

Remove a service

Note

To remove a running service, it has to be disabled first. Please follow the instructions contained in the preceding section Disable a service section to do so.

  1. To remove a disabled service, simply select the service from the service list (1.) and then click the Delete selected service button (2.) from the toolbar.

../../../_images/1_delete_service_toolbar.png

  1. This will open the Delete Service dialog. To complete the service deletion, confirm your selection by clicking Delete in the bottom right corner of the dialog window.

../../../_images/2_delete_service_dialog.png

Important

Removing a service will not remove volumes defined by the service commissioning file. These volumes will remain in its current state and reattach to the service once it is installed and enabled again.

Update a service

Enabling, updating, or reconfiguring a service can only be done from the Service Details View by selecting the service in the list.

../../../_images/service_select.png

Continue here: Update a Service