Add-on Services

Minimum Required Role: Full Administrator

Cloudera Manager supports adding new types of services (referred to as an add-on service) to Cloudera Manager, allowing such services to leverage Cloudera Manager distribution, configuration, monitoring, resource management, and life-cycle management features. An add-on service can be provided by Cloudera or an independent software vendor (ISV). If you have multiple clusters managed by Cloudera Manager, an add-on service can be deployed on any of the clusters.

Custom Service Descriptor Files

Integrating an add-on service requires a Custom Service Descriptor (CSD) file. A CSD file contains all the configuration needed to describe and manage a new service. A CSD is provided in the form of a JAR file.

Depending on the service, the CSD and associated software may be provided by Cloudera or by an ISV. The integration process assumes that the add-on service software (parcel or package) has been installed and is present on the cluster. The recommended method is for the ISV to provide the software as a parcel, but the actual mechanism for installing the software is up to the ISV. The instructions in Installing an Add-on Service assume that you have obtained the CSD file from the Cloudera repository or from an ISV. It also assumes you have obtained the service software, ideally as a parcel, and have or will install it on your cluster either prior to installing the CSD or as part of the CSD installation process.

Configuring the Location of Custom Service Descriptor Files

The default location for CSD files is /opt/cloudera/csd. You can change the location in the Cloudera Manager Admin Console as follows:
  1. Select Administration > Settings.
  2. Click the Custom Service Descriptors category.
  3. Edit the Local Descriptor Repository Path property.
  4. Click Save Changes to commit the changes.
  5. Restart Cloudera Manager Server:
    systemd-based Operating Systems:
    sudo systemctl restart cloudera-scm-server
    init-based Operating Systems:
    sudo service cloudera-scm-server restart

Installing an Add-on Service

An ISV may provide its software in the form or a parcel, or they may have a different way of installing their software onto your cluster. If their installation process is not via a parcel, then you should install their software before adding the CSD file. Follow the instructions from the ISV for installing the software, if you have not done so already. If the ISV has provided their software as a parcel, they may also have included the location of their parcel repository in the CSD they have provided. In that case, install the CSD first and then install the parcel.

Installing the Custom Service Descriptor File

  1. Acquire the CSD file from Cloudera or an ISV.
  2. Log on to the Cloudera Manager Server host, and place the CSD file under the location configured for CSD files.
  3. Set the file ownership to cloudera-scm:cloudera-scm with permission 644.
  4. Restart the Cloudera Manager Server:
    service cloudera-scm-server restart
  5. Log into the Cloudera Manager Admin Console and restart the Cloudera Management Service.
    1. Do one of the following:
        1. Select Clusters > Cloudera Management Service > Cloudera Management Service.
        2. Select Actions > Restart.
      • On the Home > Status tab, click to the right of Cloudera Management Service and select Restart.
    2. Click Restart to confirm. The Command Details window shows the progress of stopping and then starting the roles.
    3. When Command completed with n/n successful subcommands appears, the task is complete. Click Close.

Installing the Parcel

If you have already installed the external software onto your cluster, you can skip these steps and proceed to Adding an Add-on Service.

  1. Click in the main navigation bar. If the vendor has included the location of the repository in the CSD, the parcel should already be present and ready for downloading. If the parcel is available, skip to step 7.
  2. Use one of the following methods to open the parcel settings page:
    • Navigation bar
      1. Click in the top navigation bar or click Hosts and click the Parcels tab.
      2. Click the Edit Settings button.
    • Menu
      1. Select Administration > Settings.
      2. Select Category > Parcels .
  3. In the Remote Parcel Repository URLs list, click to open an additional row.
  4. Enter the path to the repository.
  5. Click Save Changes to commit the changes.
  6. Click . The external parcel should appear in the set of parcels available for download.
  7. Download, distribute, and activate the parcel. See Managing Parcels.

Adding an Add-on Service

Add the service following the procedure in Adding a Service.

Uninstalling an Add-on Service

  1. Stop all instances of the service.
  2. Delete the service from all clusters. If there are other services that depend on the service you are trying to delete, you must delete those services first.
  3. Log on to the Cloudera Manager Server host and remove the CSD file.
  4. Restart the Cloudera Manager Server:
    service cloudera-scm-server restart
  5. After the server has restarted, log into the Cloudera Manager Admin Console and restart the Cloudera Management Service.
  6. Optionally remove the parcel.