Skip to main content

We've Moved!

Product Documentation has moved to docs.hitachivantara.com
Hitachi Vantara Knowledge

Services

This section describes the services of HCP for cloud scale as well as how to view, configure, move, and repair services.

Trademarks, Legal disclaimer, Third-party software in this documentation

© 2017 - 2019 Hitachi Vantara Corporation. All rights reserved.

Services Overview

Services perform functions essential to the health or functionality of the system. For example, the Metrics service stores and manages system events, while the Watchdog service ensures that other services remain running. Internally, services run in Docker containers on the instances in the system.

Trademarks, Legal disclaimer, Third-party software in this documentation

© 2017 - 2019 Hitachi Vantara Corporation. All rights reserved.

Service list

The table below describes the services that your system runs. Each service runs within its own Docker container. For each service, the table lists:

Configuration settings: The settings you can configure for the service. For information on configuration, see Configuring service settings.

RAM needed per instance: The amount of RAM that, by default, the service needs on each instance on which it's deployed. For all services except for System services, this value is also the default Docker Container Memory value for the service.

Number of instances: Shows both:

oThe required number of instances on which a service must run for the system to function properly.

oThe recommended number of instances that you should run a service on. These are recommended minimums; if your system includes more instances, you should take advantage of them by running services on them.

  • Whether the service is persistent (that is, it must run on a specific instance) or supports floating (that is, it can run on any instance).
  • Whether the service is scalable or not.
 

Note: For system services, you cannot set the Container Memory size larger than the Max Heap Size setting. For other services, you should not set the Container Memory size larger than the Max Heap Size setting.

Service name and description Configuration settings (changes cause the service to redeploy) Properties
Product services: These services perform system functions. You can move and reconfigure these services.
Cassandra

Decentralized database that can be scaled across large numbers of hardware nodes.

Container Options: Default
  • Container Memory: The hard memory limit for the service's Docker container, in MB. The default is 2.4 GB.
  • CPU: The relative CPU usage weight for the service's Docker container. Generally, a higher value means that the container received more CPU resources than other processes (including other service Docker containers) running on the instance. Enter a decimal number. The default is 0.1.
RAM needed per instance: 2.4 GB
Service Options
  • Max heap: Maximum amount of memory to allocate to the Java heap for each instance of the service. Enter an integer number of bytes. You can optionally specify the suffixes k (kilobytes), m (megabytes), or g (gigabytes). The default is 1800m.
  • Heap new size: Heap size for the Java virtual machine. Valid values are integers representing a number of bytes. You can optionally specify the suffixes k (kilobytes), m (megabytes), or g (gigabytes). The default is 512 MB.
Number of instances:

Required: 3

Recommended: All

Advanced Options:

Compaction Frequency: How often database compaction operations are run. The options are Weekly (default) and Daily.

Caution: Changing this setting can negatively affect the service. Use with caution.

Persistent or floating? Persistent
Supports volume configuration? No
Single or multiple types? Single
Scalable? Yes
Chronos

Job scheduling.

Container Options: Default
  • Container Memory: The hard memory limit for the service's Docker container, in MB. The default is 712 MB.
  • CPU: The relative CPU usage weight for the service's Docker container. Generally, a higher value means that the container received more CPU resources than other processes (including other service Docker containers) running on the instance. Enter a decimal number. The default is 0.1.
RAM needed per instance: 712 MB
Service Options
  • Heap settings: Maximum amount of memory to allocate to the Java heap for each instance of the service. Enter an integer number of bytes. You can optionally specify the suffixes k (kilobytes), m (megabytes), or g (gigabytes). The default is 512 MB.
Number of instances:
  • 1 required
  • 1 recommended
Persistent or floating? Floating
Supports volume configuration? Yes
Single or multiple types? Single
Scalable? No
Elasticsearch

Data indexing and search platform.

Container Options: Default
  • Container Memory: The hard memory limit for the service's Docker container, in MB. The default is 2 GB.
  • CPU: The relative CPU usage weight for the service's Docker container. Generally, a higher value means that the container received more CPU resources than other processes (including other service Docker containers) running on the instance. Enter a decimal number. The default is 0.1.
RAM needed per instance: 2 GB
Service Options
  • Heap settings: Maximum amount of memory to allocate to the Java heap for each instance of the service. Enter an integer number of bytes. You can optionally specify the suffixes k (kilobytes), m (megabytes), or g (gigabytes). The default is 1024 MB.
  • Days to keep logs: The number of days to keep service logs, including access and metrics indexes. The default is 30 days.
  • Index Protection Level: The number of additional replicas (copies) to keep of each index file (shard). Replicas are kept on separate instances. You can set this value for every shard. The default is 1 replica (which means that two copies are kept). The maximum is the number of instances less one.
Number of instances:

Required: 3

Recommended: All

Persistent or floating? Persistent
Supports volume configuration? Yes
Single or multiple types? Single
Scalable? Yes
Kafka

Stream processing platform for handling real-time data streams.

Container Options: Default
  • Container Memory: The hard memory limit for the service's Docker container, in MB. The default is 2 GB.
  • CPU: The relative CPU usage weight for the service's Docker container. Generally, a higher value means that the container received more CPU resources than other processes (including other service Docker containers) running on the instance. Enter a decimal number. The default is 0.1.
RAM needed per instance: 2 GB
Service Options
  • Heap settings: Maximum amount of memory to allocate to the Java heap for each instance of the service. Enter an integer number of bytes. You can optionally specify the suffixes k (kilobytes), m (megabytes), or g (gigabytes). The default is -Xmx1800m-Xms512m.
Number of instances:

Required: 3

Recommended: All

Persistent or floating? Persistent
Supports volume configuration? Yes
Single or multiple types? Single
Scalable? Yes
Logstash

Collection engine for event data. Can perform transformations on the data it collects and then send that data to a number of outputs.

Container Options: Default
  • Container Memory: The hard memory limit for the service's Docker container, in MB. The default is 700 MB.
  • CPU: The relative CPU usage weight for the service's Docker container. Generally, a higher value means that the container received more CPU resources than other processes (including other service Docker containers) running on the instance. Enter a decimal number. The default is 0.1.
RAM needed per instance: 700 MB
Service Options
  • Max heap: Maximum amount of memory to allocate to the Java heap for each instance of the service. Enter an integer number of bytes. You can optionally specify the suffixes k (kilobytes), m (megabytes), or g (gigabytes). The default is 512 MB.
Number of instances:

Required: 1

Recommended: 1

Persistent or floating? Floating
Supports volume configuration? No
Single or multiple types? Single
Scalable? No
MAPI Gateway

Serves MAPI endpoints.

Container Options: Default
  • Container Memory: The hard memory limit for the service's Docker container, in MB. The default is 768 MB.
  • CPU: The relative CPU usage weight for the service's Docker container. Generally, a higher value means that the container received more CPU resources than other processes (including other service Docker containers) running on the instance. Enter a decimal number. The default is 0.1.
RAM needed per instance: 768 MB
Service Options
  • Max Heap Size: Maximum amount of memory to allocate to the Java heap for each instance of the service. Enter an integer number of bytes. You can optionally specify the suffixes k (kilobytes), m (megabytes), or g (gigabytes). The default is 64 MB.
Number of instances:

Required: 1

Recommended: All

Persistent or floating? Floating
Supports volume configuration? No
Single or multiple types? Single
Scalable? Yes
Metadata Cache

Cache for system metadata.

Container Options: Default
  • Container Memory: The hard memory limit for the service's Docker container, in MB. The default is 768 MB.
  • CPU: The relative CPU usage weight for the service's Docker container. Generally, a higher value means that the container received more CPU resources than other processes (including other service Docker containers) running on the instance. Enter a decimal number. The default is 0.1.
RAM needed per instance: 768 MB
Service Options
  • Max Heap Size: Maximum amount of memory to allocate to the Java heap for each instance of the service. Enter an integer number of bytes. You can optionally specify the suffixes k (kilobytes), m (megabytes), or g (gigabytes). The default is 512 MB.
Number of instances:

Required: 1

Recommended: 1

Persistent or floating? Persistent
Supports volume configuration? No
Single or multiple types? Single
Scalable? No
Metadata Coordination

Coordinates the different metadata gateway services, and coordinates metadata partitions.

Container Options: Default
  • Container Memory: The hard memory limit for the service's Docker container, in MB. The default is 768 MB.
  • CPU: The relative CPU usage weight for the service's Docker container. Generally, a higher value means that the container received more CPU resources than other processes (including other service Docker containers) running on the instance. Enter a decimal number. The default is 0.1.
RAM needed per instance: 768 MB
Service Options
  • Max Heap Size: Maximum amount of memory to allocate to the Java heap for each instance of the service. Enter an integer number of bytes. You can optionally specify the suffixes k (kilobytes), m (megabytes), or g (gigabytes). The default is 64 MB.
Number of instances:

Required: 1

Recommended: 1

Persistent or floating? Floating
Supports volume configuration? No
Single or multiple types? Single
Scalable? No
Metadata Gateway

Stores and protects metadata and serves it to other services.

Container Options: Default
  • Container Memory: The hard memory limit for the service's Docker container, in MB. The default is 4096 MB.
  • CPU: The relative CPU usage weight for the service's Docker container. Generally, a higher value means that the container received more CPU resources than other processes (including other service Docker containers) running on the instance. Enter a decimal number. The default is 0.1.
RAM needed per instance: 768 MB
Service Options
  • Max Heap Size: Maximum amount of memory to allocate to the Java heap for each instance of the service. Enter an integer number of bytes. You can optionally specify the suffixes k (kilobytes), m (megabytes), or g (gigabytes). The default is 2048 MB.
Number of instances:

Required: 3

Recommended: all

Persistent or floating? Persistent
Supports volume configuration? No
Single or multiple types? Single
Scalable? Yes
Metadata Policy Engine

Executes asynchronous metadata updates.

Container Options: Default
  • Container Memory: The hard memory limit for the service's Docker container, in MB. The default is 2048 MB.
  • CPU: The relative CPU usage weight for the service's Docker container. Generally, a higher value means that the container received more CPU resources than other processes (including other service Docker containers) running on the instance. Enter a decimal number. The default is 0.1.
RAM needed per instance: 768 MB
Service Options
  • Max Heap Size: Maximum amount of memory to allocate to the Java heap for each instance of the service. Enter an integer number of bytes. You can optionally specify the suffixes k (kilobytes), m (megabytes), or g (gigabytes). The default is 1024 MB.
Number of instances:

Required: 1

Recommended: 1

Persistent or floating? Floating
Supports volume configuration? No
Single or multiple types? Single
Scalable? No
Metrics

Data indexing and search platform.

Container Options: Default
  • Container Memory: The hard memory limit for the service's Docker container, in MB. The default is 768 MB.
  • CPU: The relative CPU usage weight for the service's Docker container. Generally, a higher value means that the container received more CPU resources than other processes (including other service Docker containers) running on the instance. Enter a decimal number. The default is 0.1.
RAM needed per instance: 768 MB
Service Options
  • Prometheus Scrape Interval: The time interval between runs of the metrics collection task. Enter an integer number of seconds. You can optionally specify the suffix s (seconds). The default is 10 seconds.
  • Prometheus Database Path: Storage location for prometheus local time-series db. Enter a path. The default is tsdb/.
  • Prometheus Database Retention: The number of days to retain files. Enter an integer number of days. You can optionally specify the suffix d (days). The default is 15 days.
Number of instances:

Required: 1

Recommended: All

Persistent or floating? Persistent
Supports volume configuration? No
Single or multiple types? Single
Scalable? Yes
S3 Gateway

Serves S3 API endpoints and communicates with storage components.

Container Options: Default
  • Container Memory: The hard memory limit for the service's Docker container, in MB. The default is 768 MB.
  • CPU: The relative CPU usage weight for the service's Docker container. Generally, a higher value means that the container received more CPU resources than other processes (including other service Docker containers) running on the instance. Enter a decimal number. The default is 0.1.
RAM needed per instance: 768 MB
Service Options
  • Max Heap Size: Maximum amount of memory to allocate to the Java heap for each instance of the service. Enter an integer number of bytes. You can optionally specify the suffixes k (kilobytes), m (megabytes), or g (gigabytes). The default is 512 MB.
Number of instances:

Required: 1

Recommended: All

HTTP Options:
  • Enable HTTP: Select to enable HTTP connections.
  • Max Http Request Headers: The maximum number of HTTP request headers to allow. Enter an integer. The default is 100 request headers.
Persistent or floating? Floating
Supports volume configuration? No
Single or multiple types? Single
Scalable? Yes
Tracing Agent

Provides end-to-end distributed tracing for S3 API calls and MAPI calls.

Container Options: Default
  • Container Memory: The hard memory limit for the service's Docker container, in MB. The default is 768 MB.
  • CPU: The relative CPU usage weight for the service's Docker container. Generally, a higher value means that the container received more CPU resources than other processes (including other service Docker containers) running on the instance. Enter a decimal number. The default is 0.1.
RAM needed per instance: 768 MB
Service Options
  • Collector TChannel Hostname: Enter a host name. The default is localhost.
  • Collector TChannel Port: Enter a port number. The default is 14267.
Number of instances:

Required: All

Persistent or floating? Floating
Supports volume configuration? No
Single or multiple types? Single
Scalable? Yes
Tracing Collector

Provides end-to-end distributed tracing for S3 API calls and MAPI calls.

Container Options: Default
  • Container Memory: The hard memory limit for the service's Docker container, in MB. The default is 768 MB.
  • CPU: The relative CPU usage weight for the service's Docker container. Generally, a higher value means that the container received more CPU resources than other processes (including other service Docker containers) running on the instance. Enter a decimal number. The default is 0.1.
RAM needed per instance: 768 MB
Service Options
  • ElasticSearch Hostname: Enter a host name. The default is localhost.
  • ElasticSearch Port: Enter a port number. The default is 9200.
  • Sampling Rate: The sampling rate for all clients implementing remote sampling. Enter a number between 0 and 1 inclusive. The default is 1.
Number of instances:

Required: 1

Recommended: All

Persistent or floating? Floating
Supports volume configuration? No
Single or multiple types? Single
Scalable? Yes
Tracing Query

Provides end-to-end distributed tracing for S3 API calls and MAPI calls.

Container Options: Default
  • Container Memory: The hard memory limit for the service's Docker container, in MB. The default is 768 MB.
  • CPU: The relative CPU usage weight for the service's Docker container. Generally, a higher value means that the container received more CPU resources than other processes (including other service Docker containers) running on the instance. Enter a decimal number. The default is 0.1.
RAM needed per instance: 768 MB
Service Options
  • ElasticSearch Hostname: Enter a host name. The default is localhost.
  • ElasticSearch Port: Enter a port number. The default is 9200.
Number of instances:

Required: 1

Recommended: All

Persistent or floating? Floating
Supports volume configuration? No
Single or multiple types? Single
Scalable? Yes
System services: These services manage system resources and ensure that the system remains available and accessible. These services cannot be moved or reconfigured.
System Management application

The system management application.

Service Options
  • Max heap size: Maximum amount of memory to allocate to the Java heap for each instance of the service. Enter an integer number of bytes. You can optionally specify the suffixes k (kilobytes), m (megabytes), or g (gigabytes). The default is 512 MB.
RAM needed per instance: N/A
Number of instances: N/A
Persistent or floating? Persistent
Supports volume configuration? Yes
Single or multiple types? Single
Scalable? No
Cluster Coordination

Manages hardware resource allocation.

N/A RAM needed per instance: N/A
Number of instances: N/A
Persistent or floating? Persistent
Supports volume configuration? No
Single or multiple types? Single
Scalable? No
Cluster Worker

Receives and performs work from other services.

N/A RAM needed per instance: N/A
Number of instances: N/A
Persistent or floating? Persistent
Supports volume configuration? Yes
Single or multiple types? Single
Scalable? No
Network Proxy

Network request load balancer.

Security Protocol: Select which TLS versions to use:
  • TLS 1.0
  • TLS 1.1
  • TLS 1.2
  • TLS 1.3
RAM needed per instance: N/A
SSL Ciphers: If you want to provide your own cipher suite, enter it here. Number of instances: N/A
Custom Global Configuration:Select Enable Advanced Global Configuration to enable adding your own parameters to the HAProxy "global" section. Persistent or floating? Persistent
Custom Defaults Configuration:Select Enable Defaults Configuration to enable adding your own parameters to the HAProxy "global" section. Supports volume configuration? Yes
Single or multiple types? Single
Scalable? No
Sentinel

Runs internal system processes and monitors the health of the other services.

Service Options
  • Max heap size: Maximum amount of memory to allocate to the Java heap for each instance of the service. Enter an integer number of bytes. You can optionally specify the suffixes k (kilobytes), m (megabytes), or g (gigabytes). The default is 256 MB.
RAM needed per instance: N/A
Number of instances: N/A
Persistent or floating? persistent
Supports volume configuration? Yes
Single or multiple types? Single
Scalable? No
Service Deployment

Handles deployment of high-level services (that is, the services that you can configure).

N/A RAM needed per instance: N/A
Number of instances: N/A
Persistent or floating? Persistent
Supports volume configuration? Yes
Single or multiple types? Single
Scalable? No
Synchronization

Coordinates service configuration settings and other information across instances.

Service Options
  • Max heap size: Maximum amount of memory to allocate to the Java heap for each instance of the service. Enter an integer number of bytes. You can optionally specify the suffixes k (kilobytes), m (megabytes), or g (gigabytes). The default is 1024 MB.
RAM needed per instance: N/A
Number of instances: N/A
Persistent or floating? Persistent
Supports volume configuration? Yes
Single or multiple types? Single
Scalable? No
Watchdog

Monitors the other System services and restarts them if necessary. Also responsible for initial system startup.

Service Options
  • Max heap size: Maximum amount of memory to allocate to the Java heap for each instance of the service. Enter an integer number of bytes. You can optionally specify the suffixes k (kilobytes), m (megabytes), or g (gigabytes). The default is 1024 MB.
  • Heap new size: Heap size for the Java virtual machine. Valid values are integers representing a number of bytes. You can optionally specify the suffixes k (kilobytes), m (megabytes), or g (gigabytes). The default is 512 MB.
RAM needed per instance: N/A
Number of instances: N/A
Persistent or floating? Persistent
Supports volume configuration? Yes
Single or multiple types? Yes
Scalable? No

Trademarks, Legal disclaimer, Third-party software in this documentation

© 2017 - 2019 Hitachi Vantara Corporation. All rights reserved.

Viewing services

You can use System Management application, CLI, and REST API to view the status of all services for the system.

Related topics:

Service list

Service units

System Management application instructions
Related CLI command(s)

getService

listServices

For information on running CLI commands, see CLI reference.

Related REST API method(s)

GET /services

GET /services/{id}

For information on specific REST API methods, in the System Management application, click on the help icon (help-icon.png). Then:

To view the administrative REST API methods, click on REST API - Admin.

For general information about the administrative REST API, see REST API reference.

Trademarks, Legal disclaimer, Third-party software in this documentation

© 2017 - 2019 Hitachi Vantara Corporation. All rights reserved.

Managing services

This section describes how you can reconfigure, restart, and otherwise manage the services running on your system.

Trademarks, Legal disclaimer, Third-party software in this documentation

© 2017 - 2019 Hitachi Vantara Corporation. All rights reserved.

Moving and scaling services

You can change a service to run on:

Additional instances (for example, if you need improved service performance and availability)

Fewer instances (for example, if you want to free up resources on an instance for running other services)

A different set of instances (for example, if you are retiring the piece of hardware on which an instance is installed)

For information on:

Individual services and the number of instances they should run on, see Service list.

Monitoring service relocation operations, see Monitoring service operations.

 

Tip:  Use the Available Instances option to have a floating service be eligible to run on any instance in the system, including any new instances added in the future.

System Management application instructions
Related CLI command(s)

updateServiceConfig

For information on running CLI commands, see CLI reference.

Related REST API method(s)

POST /services/configure

For information on specific REST API methods, in the System Management application, click on the help icon (help-icon.png). Then:

To view the administrative REST API methods, click on REST API - Admin.

For general information about the administrative REST API, see REST API reference.

Trademarks, Legal disclaimer, Third-party software in this documentation

© 2017 - 2019 Hitachi Vantara Corporation. All rights reserved.

Configuring service settings

You can configure settings for some of the services that the system runs. For information on the settings you can configure for each service, see Service list.

For information on adding user-managed volumes to a service that supports them, see Adding volumes to services.

 

Note: If you make an unwanted change to a service configuration, wait for the operation to finish before creating a new operation to correct the service configuration.

System Management application instructions

1.Click on the Services panel.

2.Click on the service you want to configure.

3.On the Configuration tab, configure the service.

For information on the settings available for each service, see Service list.

4.Click on the Update button.

Related CLI command(s)

updateServiceConfig

For information on running CLI commands, see CLI reference.

Related REST API method(s)

POST /services/configure

For information on specific REST API methods, in the System Management application, click on the help icon (help-icon.png). Then:

To view the administrative REST API methods, click on REST API - Admin.

For general information about the administrative REST API, see REST API reference.

Trademarks, Legal disclaimer, Third-party software in this documentation

© 2017 - 2019 Hitachi Vantara Corporation. All rights reserved.

Repairing services

If a service becomes slow, unresponsive, or shows a status of Failed, you can run a service operation to repair it. Repairing a service stops and restarts the service on each instance on which it's running.

For information on viewing service health and activity, see Monitoring services.

 

Important: Depending on which service you're repairing, parts of the system will be unavailable until the repair operation finishes.

To repair a service:

1.Click on the Services panel.

2.Select the service you want to repair.

3.Click on the Repair button.

Trademarks, Legal disclaimer, Third-party software in this documentation

© 2017 - 2019 Hitachi Vantara Corporation. All rights reserved.

 

  • Was this article helpful?