Services
The Services page (/services) lists the services of the selected cluster and opens each one. It needs
cluster:read. Installing needs services:install, operating needs services:operate, changing a configuration
needs configs:edit, the connections need connections:read or connections:manage.
What the screen shows
| Element | Content |
|---|---|
| Services installed in the cluster | state, health, version, mode and high availability of each service |
| Configured connections | external services bound instead of a managed one (for example the PostgreSQL of your organization) |
| Developer packages | client packages to reach the services |
The detail of a service (/services/<name>) has the tabs overview, configuration, Monitoring, alerts, high
availability, console and Components on hosts (state reported by the agents at each heartbeat).
Actions
| Button | Effect | Permission |
|---|---|---|
| Add a service > Install on machines | install wizard: Service, Hosts, Assign, Bindings, Configure, Install (operation service.install) | services:install |
| Add a service > Configure the connection to an existing service | declares an external connection | connections:manage |
| Start, Stop, Restart | operation service.action | services:operate |
| Rolling restart | restart in batches (batch size), health checks between batches | services:operate |
| Service check | runs the service check of the catalog | services:operate |
| Run (custom command) | operation service.command | services:operate |
| Add component hosts | operation service.components | services:install |
| Remove from host | removes one instance | services:install |
| Reinstall | operation service.install on the existing topology | services:install |
| Uninstall | every component is stopped and removed from its hosts (operation service.uninstall) | services:install |
| Configuration tab: save, then apply | new configuration version, then operation service.config_apply | configs:edit |
| High availability (HA) | HA matrix and failover of the service | services:operate |
| Publish the address, Change the password | console access of the service | cluster:manage, vault:manage |
Typical tasks
- Install a service. Add a service > Install on machines, choose the service, the hosts, the placement of each component (the wizard checks the rules of the mode), bind each dependency, review the configuration, select Install. The operation opens: follow it in Operations.
- Change a parameter. Open the service, configuration tab, change the value, save (a new version), apply with a rolling restart.
- Read the logs of a component. Open the service, choose the instance and the number of lines (operation
service.logs).