Skip to content

Custom services

In order to add your own custom service, the DSH requires you to upload your own container images to its Harbor container image registry, and to deploy it:

  • You can configure the resources and behavior of your service in its service definition.
  • You can monitor and manage the service via the DSH Console.
  • If you expose metrics of your service to the DSH, then you can also monitor it via Grafana.
  • Your service can access the Kafka cluster, access DSH environment variables, etc.
  • You can deploy multiple instances of your service.
  • Custom services can communicate freely with each other within your tenant’s isolated network on the DSH:
    • Custom services of ‘tenant-a’ can communicate freely with each other.
    • A custom service of ‘tenan-a’ can’t communicate freely with a service of of ‘tenant-b’, because the DSH isolates their networks.

Tip

Make sure that your container image complies with the DSH’s requirements. See Requirements of container image for more information.

Adding your service

You need an image in the DSH’s Harbor container image registry to deploy a custom service. Once you added the image, you can take the following steps to deploy a new service on the DSH:

  • Click “Services” > “Overview” in the menu bar of the DSH Console.
  • Click the “+ Service” button at the top of the overview page.
  • Enter a name for your custom service, following the rules below:
    • Only use lowercase letters (a–z), numbers (0–9), and hyphens (-).
    • The name can’t be longer than 45 characters.
    • The name can’t end in a dash (-).
    • You can’t use the following names, because they are reserved for the DSH: loki-read-proxy, zookeeper-proxy, flink-cluster-job-manager, flink-cluster-taskmanager, dbaas_*, zk-*.
  • Complete the service definition of the service. See Service definition for more information.
  • Click the “Start service” button.

The DSH uses the configuration in your service definition to deploy the service.

Managing your service

Once the DSH deployed your service, you can inspect and manage it:

  • Inspect tasks, resources and services
  • Inspect the health of the service
  • Edit the service definition
  • Stop, start and delete the service
  • Scale the number of instances
  • Inspect the logs

See Managing services and applications for more information.