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. For example to list them 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

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

Version management

To check the version of a deployed service, use:

clever matomo version check matomo_id
clever metabase version check myMetabase --format json

To update to a specific version, use:

clever keycloak version update myKeycloak --target 24.0.1

To see a list of available versions, don’t provide a target version:

clever otoroshi version update otoroshi_id

Network Groups

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

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

Otoroshictl

Otoroshi instances can be managed using the otoroshictl command line tool. Clever Tools provides an easy way to use it, by providing Otoroshi instances configuration in a compliant YAML format:

# Install otoroshictl with Rust's Cargo and enable operators/otoroshi command in Clever Tools:
cargo install otoroshictl
clever features enable operators

clever otoroshi get-config <otoroshi_id_or_name> | otoroshictl config import --current --stdin
otoroshictl resources get routes