Using a Database Server or Service

Turbonomic supports a remote Database for historical data. This configuration allows for high availability, backups and handling more IO demands for larger environments or from remote SQL queries (reporting, etc).

This is an overview of the requirements for a remote DB. The DB needs to be created before deploying Turbonomic. Once created, you will need to make changes in the cr yaml. The following are typical settings for a MySQL or MariaDB instance.

Preference: MariaDB 10.5.16. MariaDB 10.2 for Azure DB Services is tolerated. MySQL 5.7 is also supported
- Cluster configuration: master/replica where Turbo communicates to a single replica.
- NOTE: MariaDB Galera or AWS Aurora configurations are not supported
- MariaDB 10.5 requires min. 10.5.16. Other versions have issues that will impact performance.
Select network and security policies that allows communication between the k8s cluster and the Database server. Recommend to leave DB port as 3306.
8 Gb Memory / 2 vCPU minimum
Storage: 100 GB, set to auto-increase, or provide 500 GB
encryption is supported

DB Configurations

Your DB will require the following configurations:

Create the DB instance with the specifications above, and then in Server Configuration (AWS RDS Parameter Group), make the following changes and save:
- event_scheduler on
- log_bin_trust_function_creators on (set its value to ’1′)
- max_allowed_packet 1073741824 (or 1GB if setting by config file)
- sql_mode ERROR_FOR_DIVISION_BY_ZERO, NO_AUTO_CREATE_USER, NO_ENGINE_SUBSTITUTION
- explicit_defaults_for_timestamp should be set to OFF
- wait_timeout set to 28800
- the following character_set variables must be set to 'utf8': character_set_client, character_set_connection, character_set_database, character_set_results, character_set_server
If you are working with your own DB Server / DB Service, create a Turbonomic admin user that will be used by the deployment to create application users, grant privileges. You can define whatever password you want, but it should be reflected in the custom resource yaml. Using an mysql client or CLI, run the following commands against your DB:

CREATE USER 'turboadmin'@'%' IDENTIFIED BY 'vmturbo';
GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, RELOAD, PROCESS, REFERENCES, INDEX, ALTER, SHOW DATABASES, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, REPLICATION SLAVE, REPLICATION CLIENT, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, CREATE USER, EVENT, TRIGGER ON *.* TO 'turboadmin'@'%' WITH GRANT OPTION;

If you are using AWS RDS or an Azure DB service, see section for “AWS RDS DB Service – Additional Configuration” or “Azure DB Service – Additional Configuration”. You will need to precreate the application DB users, databases (empty schema) and grant privileges.
Update the Turbonomic Custom Resource yaml for the external DB properties, and apply. Options to specify the user(s) and password(s) include:
- Values directly in CR
- Use kubernetes secrets, see section Using a Database: Secrets
- Leverage a vault + webhook injection method documented here

For values directly defined in the CR, use the example below as a guide that would be used for MYSQL. This example also contains optional parameters. For a complete list of options, refer to our custom resource definition for our operator under the validation openAPIV3Schema section in the CRD yaml here.

Note that the externalDBName parameter creates an External type k8s Service, and therefore the DB Name must be the FQDN, not short name. Optionally you can use externalDbIP parameter which creates a k8s Endpoint and Service.

  global:
    externalDBName: yourDB.yourURL.com
  properties:
    global:
      enableSecureDBConnection: true
      #comment out sqldialect parameter for MariaDB
      sqlDialect: MYSQL
      dbPort: 6033
      dbRootPassword: vmturbo
      dbRootUsername: turboadmin
   #additional properties may be required for AWS RDS and Azure DB Services

Apply the custom resource yaml to deploy Turbo.

AWS RDS DB Service – Additional Configuration

When using a supported AWS RDS (MariaDB or MYSQL) PaaS service, you will need to pre-create the application databases and users, and then provide this information to the custom resource yaml.

First, complete steps 1 and 2 from “DB Configurations” in the first section above.
Next create application users and empty databases that Turbonomic will use. Note, you can define custom passwords but do not change the user name.

create user 'action'@'%' identified by 'vmturbo';
create user 'auth'@'%' identified by 'vmturbo';
create user 'clustermgr'@'%' identified by 'vmturbo';
create user 'cost'@'%' identified by 'vmturbo';
create user 'group_component'@'%' identified by 'vmturbo';
create user 'market'@'%' identified by 'vmturbo';
create user 'plan'@'%' identified by 'vmturbo';
create user 'repository'@'%' identified by 'vmturbo';
create user 'suspend'@'%' identified by 'vmturbo';
create user 'topology_processor'@'%' identified by 'vmturbo';
create user 'history'@'%' identified by 'vmturbo';
create database action;
create database auth;
create database clustermgr;
create database cost;
create database group_component;
create database market;
create database plan;
create database repository;
create database suspend;
create database topology_processor;
create database vmtdb;
GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALTER, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, EVENT, TRIGGER ON action.* TO 'action'@'%';
GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALTER, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, EVENT, TRIGGER ON auth.* TO 'auth'@'%';
GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALTER, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, EVENT, TRIGGER ON clustermgr.* TO 'clustermgr'@'%';
GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALTER, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, EVENT, TRIGGER ON cost.* TO 'cost'@'%';
GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALTER, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, EVENT, TRIGGER ON group_component.* TO 'group_component'@'%';
GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALTER, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, EVENT, TRIGGER ON market.* TO 'market'@'%';
GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALTER, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, EVENT, TRIGGER ON plan.* TO 'plan'@'%';
GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALTER, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, EVENT, TRIGGER ON repository.* TO 'repository'@'%';
GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALTER, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, EVENT, TRIGGER ON suspend.* TO 'suspend'@'%';
GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALTER, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, EVENT, TRIGGER ON topology_processor.* TO 'topology_processor'@'%';
GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALTER, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, EVENT, TRIGGER ON vmtdb.* TO 'history'@'%';
GRANT PROCESS on *.* TO 'history'@'%';
GRANT PROCESS on *.* TO 'cost'@'%';
GRANT PROCESS on *.* TO 'group_component'@'%';
flush privileges;

Modify the custom resource yaml to reflect the external DB endpoint and all the users created, and apply. Options to specify the user and password include:
- Values directly in CR
- Use kubernetes secrets, see section Using a Database: Secrets with SCENARIO 2
- Leverage a vault + webhook injection method documented here

For values directly defined in the CR, use the example below as a guide. Remember to substitute your values for your “turboadmin” (dbRootUsername), the turboadmin password (dbRootPassword).

Note that the externalDBName parameter creates an External type k8s Service, and therefore the DB Name must be the FQDN, not short name. Optionally you can use externalDbIP parameter which creates a k8s Endpoint and Service.

  global:
    externalDBName: yourDB.yourURL.com

  properties:
    global:
      enableSecureDBConnection: true
      dbRootPassword: vmturbo
      dbRootUsername: turboadmin
    action-orchestrator:
      actionDbUsername: action
      actionDbPassword: vmturbo
    auth:
      authDbUsername: auth
      authDbPassword: vmturbo
    clustermgr:
      clustermgrDbUsername: clustermgr
      clustermgrDbPassword: vmturbo
    cost:
      costDbUsername: cost
      costDbPassword: vmturbo
    group:
      groupComponentDbUsername: group_component
      groupComponentDbPassword: vmturbo
    history:
      historyDbUsername: history
      historyDbPassword: vmturbo
    market:
      marketDbUsername: market
      marketDbPassword: vmturbo 
    plan-orchestrator:
      planDbUsername: plan
      planDbPassword: vmturbo
    repository:
      repositoryDbUsername: repository
      repositoryDbPassword: vmturbo
    suspend:
      suspendDbUsername: suspend
      suspendDbPassword: vmturbo
    topology-processor:
      topologyProcessorDbUsername: topology_processor
      topologyProcessorDbPassword: vmturbo

Apply the custom resource yaml to deploy Turbo.

Azure DB Service – Additional Configuration

When using a supported Azure DB PaaS service, you will need to pre-create the application databases and users, and then provide this information to the custom resource yaml.

First, complete steps 1 and 2 from “DB Configurations” in the first section above.
Next create application users and empty databases that Turbonomic will use. Note, you can define custom passwords but do not change the user name.

create user 'action'@'%' identified by 'vmturbo';
create user 'auth'@'%' identified by 'vmturbo';
create user 'clustermgr'@'%' identified by 'vmturbo';
create user 'cost'@'%' identified by 'vmturbo';
create user 'group_component'@'%' identified by 'vmturbo';
create user 'market'@'%' identified by 'vmturbo';
create user 'plan'@'%' identified by 'vmturbo';
create user 'repository'@'%' identified by 'vmturbo';
create user 'suspend'@'%' identified by 'vmturbo';
create user 'topology_processor'@'%' identified by 'vmturbo';
create user 'history'@'%' identified by 'vmturbo';
create database action;
create database auth;
create database clustermgr;
create database cost;
create database group_component;
create database market;
create database plan;
create database repository;
create database suspend;
create database topology_processor;
create database vmtdb;
GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALTER, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, EVENT, TRIGGER ON action.* TO 'action'@'%';
GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALTER, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, EVENT, TRIGGER ON auth.* TO 'auth'@'%';
GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALTER, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, EVENT, TRIGGER ON clustermgr.* TO 'clustermgr'@'%';
GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALTER, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, EVENT, TRIGGER ON cost.* TO 'cost'@'%';
GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALTER, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, EVENT, TRIGGER ON group_component.* TO 'group_component'@'%';
GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALTER, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, EVENT, TRIGGER ON market.* TO 'market'@'%';
GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALTER, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, EVENT, TRIGGER ON plan.* TO 'plan'@'%';
GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALTER, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, EVENT, TRIGGER ON repository.* TO 'repository'@'%';
GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALTER, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, EVENT, TRIGGER ON suspend.* TO 'suspend'@'%';
GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALTER, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, EVENT, TRIGGER ON topology_processor.* TO 'topology_processor'@'%';
GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, REFERENCES, INDEX, ALTER, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, EVENT, TRIGGER ON vmtdb.* TO 'history'@'%';
GRANT PROCESS on *.* TO 'history'@'%';
GRANT PROCESS on *.* TO 'cost'@'%';
GRANT PROCESS on *.* TO 'group_component'@'%';
flush privileges;

Modify the custom resource yaml to reflect the external DB endpoint and all the users created, and apply. Options to specify the user and password include:
- Values directly in CR
- Use kubernetes secrets, see section Using a Database: Secrets with SCENARIO 2
- Leverage a vault + webhook injection method documented here

For values directly defined in the CR, use the example below as a guide. Remember to substitute your values for your “turboadmin” (dbRootUsername), the turboadmin password (dbRootPassword), and “yourDB”.

Note that the externalDBName parameter creates an External type k8s Service, and therefore the DB Name must be the FQDN, not short name. Optionally you can use externalDbIP parameter which creates a k8s Endpoint and Service.

  global:
    externalDBName: yourDB.yourURL.com

  properties:
    global:
      enableSecureDBConnection: true
      dbRootPassword: vmturbo
      dbRootUsername: turboadmin@yourDB
    action-orchestrator:
      actionDbUsername: action@yourDB
      actionDbPassword: vmturbo
    auth:
      authDbUsername: auth@yourDB
      authDbPassword: vmturbo
    clustermgr:
      clustermgrDbUsername: clustermgr@yourDB
      clustermgrDbPassword: vmturbo
    cost:
      costDbUsername: cost@yourDB
      costDbPassword: vmturbo
    group:
      groupComponentDbUsername: group_component@yourDB
      groupComponentDbPassword: vmturbo
    history:
      historyDbUsername: history@yourDB
      historyDbPassword: vmturbo
    market:
      marketDbUsername: market@yourDB
      marketDbPassword: vmturbo 
    plan-orchestrator:
      planDbUsername: plan@yourDB
      planDbPassword: vmturbo
    repository:
      repositoryDbUsername: repository@yourDB
      repositoryDbPassword: vmturbo
    suspend:
      suspendDbUsername: suspend@yourDB
      suspendDbPassword: vmturbo
    topology-processor:
      topologyProcessorDbUsername: topology_processor@yourDB
      topologyProcessorDbPassword: vmturbo

Apply the custom resource yaml to deploy Turbo.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Using a Database Server or Service

Using a Database Server or Service

DB Configurations

AWS RDS DB Service – Additional Configuration

Azure DB Service – Additional Configuration

Clone this wiki locally