Operators

Operators allow you to deploy services as turnkey solutions on Clever Cloud. They provision resources, configure them and expose an API and tools to ease their management during their lifecycle. To add operators commands to Clever Tools, enable the operators feature:

clever features enable operators

Then, you can use the commands to manage Keycloak, Matomo, Metabase and Otoroshi instances on Clever Cloud. To list deployed services:

clever keycloak
clever matomo
clever metabase
clever otoroshi

To get information about a deployed service, use:

clever keycloak get myKeycloak
clever matomo get matomo_id --format json

You can target a deployed service by its ID or name.

Service management

To restart or rebuild (restart without cache) a deployed service, use:

clever metabase restart myMetabase
clever otoroshi rebuild otoroshi_id

To open the deployed service dashboard in Clever Cloud Console, use:

clever keycloak open myKeycloak

You can also open the service web management interface or logs of the underlying application:

clever otoroshi open logs myOtoroshi
clever otoroshi open webui otoroshi_id

To open the Otoroshi Swagger UI, use:

clever otoroshi open swaggerui myOtoroshi

Version management

Keycloak, Metabase and Otoroshi support version management. To check the version of a deployed service, use:

clever otoroshi version check otoroshi_id
clever metabase version check myMetabase --format json

In the human output format, version checks can offer an interactive upgrade prompt. Use --format json to inspect versions without this prompt.

To update to a specific available version, use:

clever keycloak version update myKeycloak --target 24.0.1

To select an available version interactively and update the service, omit --target:

clever otoroshi version update otoroshi_id

Network Groups

Keycloak and Otoroshi can be linked to a Network Group. To enable/disable this feature, use:

clever keycloak enable-ng myKeycloak
clever otoroshi disable-ng otoroshi_id

Otoroshictl

You can manage Otoroshi instances with otoroshictl. Clever Tools exports their configuration in a compatible YAML format. With Rust and Cargo installed, use:

# Install otoroshictl and enable the operators feature
cargo install otoroshictl
clever features enable operators

clever otoroshi get-config myOtoroshi | otoroshictl config import --current --stdin
otoroshictl resources get routes