Manage configuration groups for Cloud Databases with the trove command-line tool

  • Last updated on: 2018-04-19
  • Authored by: Neha Verma

You can save and manage the settings for Cloud Databases instances in configuration groups by using the Cloud Databases API or the python-troveclient command-line interface for the API.

This article describes the commands that you run with python-troveclient to manage configuration groups.

Configuration groups and configuration parameters

A configuration group is a collection of settings that can be saved and applied to one or more instances in Cloud Databases.

A configuration group consists of one or more configuration parameters, which represent the options that can be applied to a datastore. (A datastore is a database running in an instance.) For example, a configuration group might have a configuration parameter of max_connections set to 80, or set the default time zone for the instance with the default_time_zone parameter.

Install the trove client

The python-troveclient package installs the trove command by using the Python package manager tool pip.

For full installation instructions for the trove client, see the Cloud Databases Getting Started Guide.

Further documentation for the trove client is available at the python-troveclient project site.

After you have installed python-troveclient, run the following command to see a full list of available commands:

trove help

Command options

Some of the options that are used by the commands in this article require further explanation or have specific requirements.

Value pairs option

The value pairs option represents one or more parameter name and value pairs. The entry should be in JSON object format, enclosed in single quotation marks with no spaces. In JSON object format, curly braces enclose one or more key pairs that represent configuration values, and the name of the parameter and any string or character value type are enclosed in double quotation marks.

For example, a single name and value pair looks like this:

'{"collation_server":"latin1_swedish_ci"}'

To list two or more pairs in the same option, separate them with a comma as shown in the following example:

'{"collation_server":"latin1_swedish_ci","max_connections":5000}'

You might need to use the configuration-parameter-show command to get the value type of a parameter to ensure that you set it correctly. For example, if you need to set the key_buffer_size parameter, the value type is an integer representing bytes. To set it to 100 MB, you would need to set its value to an integer representing that many bytes (104857600).

Datastore type option

The datastore type option refers to a valid datastore type that can be run on an instance. While you can use the name of the datastore type, we recommend that you use the ID of the datastore type as it is listed in the output of the datastore-list command.

trove datastore-list

Datastore version option

The datastore version option refers to a valid version of a datastore that can be run on an instance. While you can use the name for the datastore version, we recommend that you use the ID of the datastore version as it is listed in the output of the datastore-version-list command.

trove datastore-version-list

Configuration groups and parameters are associated with a datastore version to which they are applied.

Configuration group ID option

The configuration group ID option refers to the ID of an existing configuration group. You can see a list of configuration groups and their IDs by using the configuration-list command.

trove configuration-list

Instance ID option

The instance ID option refers to the ID for an existing instance. You can see a list of instances and their IDs by using the list command.

trove list

Flavor option

The flavor option refers to the ID for an instance flavor. This ID typically refers to the size of the instance, as determined by its allocation of memory. (For example, the 1 GB flavor refers to an instance with 1 GB of memory.) You can see a list of flavors and their IDs by using the flavor-list command.

trove flavor-list

Create and delete configuration groups

This section includes instructions to create and delete configuration groups.

Create a new configuration group

To create a new configuration group, use the configuration-create command with the following options.

trove configuration-create <name> <value_pairs> [--datastore <datastore_type>] [--datastore_version <datastore_version>] [--description <description>]

For example, you might create a configuration group named Stagingconfig with the following key-value pairs:

Key Value
collation_server latin1_swedish_ci
max_connections 80

To create the configuration group, run the following command, replacing the example key-value pairs with your own:

trove configuration-create Stagingconfig '{"collation_server":"latin1_swedish_ci","max_connections":80}' --description "Config for Staging datastore" --datastore MySQL --datastore_version 5.1

The output displays a list of the new configuration group’s properties:

    +----------------------+-----------------------------------------------------------------------+
    |       Property       |                                 Value                                 |
    +----------------------+-----------------------------------------------------------------------+
    | datastore_version_id |                  4f83ff38-3ef3-4a27-8b4c-330dc59857ca                 |
    |     description      |                                  Config for Staging                   |
    |          id          |                  b52de6cc-5c4f-4deb-afbc-f7190ee7573b                 |
    |         name         |                             Stagingconfig                             |
    |        values        | {u'collation_server': u'latin1_swedish_ci', u'max_connections': 80}   |
    +----------------------+-----------------------------------------------------------------------+

For a detailed example that shows how to create and apply a configuration group, see setting the time zone for a Cloud Databases instance.

Delete a configuration group

To delete a configuration group, use the configuration-delete command.

trove configuration-delete <config_id>

Apply configuration groups to instances

A configuration group can be assigned when an instance is created, or it can be assigned to an existing instance. If a configuration group is applied to a running instance, the configuration parameters can affect the datastore’s behavior immediately, although some configuration changes require that the datastore be restarted.

Apply a configuration group to an existing instance

Use the configuration-attach command to assign a configuration group to an existing instance.

trove configuration-attach <instance_id> <config_id>

You can confirm that the configuration group was applied by fetching the instance details with the show command.

trove show <instance_id>

The show command returns the properties of the instance, including an applied configuration group’s ID (shown as the configuration property).

    +-------------------+------------------------------------------------------------------+
    |      Property     |                              Value                               |
    +-------------------+------------------------------------------------------------------+
    |   configuration   |               b52de6cc-5c4f-4deb-afbc-f7190ee7573b               |
    |      created      |                       2014-03-15T21:44:05                        |
    |     datastore     |                              MySQL                               |
    | datastore_version |                               5.1                                |
    |       flavor      |                                1                                 |
    |      hostname     | 6a169ada29c30d2338e0395d277a817a2f7a37e5.qa.rackspaceclouddb.com |
    |         id        |               aab79eba-9eba-4ac3-94fc-e4aaf46b4efb               |
    |        name       |                            CloudDBdev                            |
    |       status      |                              ACTIVE                              |
    |      updated      |                       2014-03-15T21:44:55                        |
    |       volume      |                                1                                 |
    +-------------------+------------------------------------------------------------------+

Create a new instance with a configuration group

Use the create command to create a new instance that uses a custom configuration group:

trove create <name> <flavor> [--size <size>] [--databases <databases> [<databases> ...]] [--users <users> [<users> ...]] [--backup <backup>] [--availability_zone <availability_zone>>] [--configuration <config_id>]

For example, to create an instance named CloudDB using the 1 GB instance flavor (flavor ID 1), a 1 GB volume size, and a configuration group named Devconfig with an ID of 26f6f753-3853-4bf5-9bfe-1765966ad2f6, you would run the following command:

trove create CloudDB 1 --size 1 --configuration 26f6f753-3853-4bf5-9bfe-1765966ad2f6

The output displays the properties of the new instance.

    +-------------------+------------------------------------------------------------------+
    |      Property     |                              Value                               |
    +-------------------+------------------------------------------------------------------+
    |   configuration   |               26f6f753-3853-4bf5-9bfe-1765966ad2f6               |
    |      created      |                       2014-03-15T21:37:32                        |
    |     datastore     |                              MySQL                               |
    | datastore_version |                               5.1                                |
    |       flavor      |                                1                                 |
    |      hostname     | 9bcc18abea9a8b97bc8889ff901a446f297a86ac.qa.rackspaceclouddb.com |
    |         id        |               a920662c-0074-4369-83d4-e2e159f2ed6c               |
    |        name       |                             CloudDB                              |
    |       status      |                              BUILD                               |
    |      updated      |                       2014-03-15T21:37:32                        |
    |       volume      |                                1                                 |
    +-------------------+------------------------------------------------------------------+

Remove the configuration group from an instance

The configuration-detach command clears the configuration that is assigned to an instance and restores the instance to its datastore’s default configuration.

trove configuration-detach <instance_id>

Modify configuration groups

When changing a configuration group’s parameters, you can either change specific parameters without affecting the others in the set or replace the entire configuration set with new values.

Note: The configuration parameter local in-file is supported in Cloud Databases. You can access it in the Cloud Control Panel by clicking on Databases > MySQL Configurations and then modifying an existing configuration or creating a new one.

Change a subset of the parameters of a configuration group

Use the configuration-patch command to change only the specified parameters for a configuration group.

trove configuration-patch <config_id> <value_pairs>

For example, to update the configuration parameter max_connections to 80 for the configuration group Stagingconfig, you would run the command for the configuration group’s ID:

trove configuration-patch b52de6cc-5c4f-4deb-afbc-f7190ee7573b '{"max_connections":80}'

To verify that the configuration group was updated, use the configuration\_show command:

trove configuration-show <config_id>

The command returns the properties of the configuration group.

    +----------------------+---------------------------------------------------------------------+
    |       Property       |                                Value                                |
    +----------------------+---------------------------------------------------------------------+
    | datastore_version_id |                 4f83ff38-3ef3-4a27-8b4c-330dc59857ca                |
    |     description      |                                 None                                |
    |          id          |                 b52de6cc-5c4f-4deb-afbc-f7190ee7573b                |
    |         name         |                            Stagingconfig                            |
    |        values        | {u'collation_server': u'latin1_swedish_ci', u'max_connections': 80} |
    +----------------------+---------------------------------------------------------------------+

Note that the other parameter set on the group, collation_server, is unaffected by the change.

Replace all of the parameters in a configuration group

Use the configuration-update command to replace all of the existing parameters in a configuration group with the supplied values. Any existing values that are not included in the command are removed from the group.

trove configuration-update <config_id> <value_pairs> [--name <name>] [--description <description>]

For example, you might start with an existing group with two values set, character_set_server and max_connections, set as shown in the following table:

Key Value
character_set_server utf8
max_connections 50

If you run the configuration-update command to set a new value for character_set_server only (changing the value to latin1), the max_connections parameter is removed.

trove configuration-update b52de6cc-5c4f-4deb-afbc-f7190ee7573b '{"character_set_server":"latin1"}' --description UpdatedStagingConfig

After the command runs, the output shows that the only value pair set is for character_set_server.

    +----------------------+--------------------------------------+
    |       Property       |                Value                 |
    +----------------------+--------------------------------------+
    | datastore_version_id | 4f83ff38-3ef3-4a27-8b4c-330dc59857ca |
    |     description      |         UpdatedStagingConfig         |
    |          id          | b52de6cc-5c4f-4deb-afbc-f7190ee7573b |
    |         name         |            Stagingconfig             |
    |        values        | {u'character_set_server': u'latin1'} |
    +----------------------+--------------------------------------+

List configuration groups

This section describes different ways to list configuration groups.

View all defined and available configuration groups

Use the configuration-list command to list all of the configuration groups that are currently defined and available.

trove configuration-list

The output is similar to the following example:

    +-------------------------------------+--------------------+---------------------------+---------------------------------------+
    |                  id                  |        name        |        description        |         datastore_version_id         |
    +--------------------------------------+--------------------+---------------------------+--------------------------------------+
    | 0e860b09-60fe-433b-8ead-b9e5371a370c | test_configuration | configuration description | 4f83ff38-3ef3-4a27-8b4c-330dc59857ca |
    | 26f6f753-3853-4bf5-9bfe-1765966ad2f6 |     Devconfig      |        Config for dev env | 4f83ff38-3ef3-4a27-8b4c-330dc59857ca |
    | 321934e8-693e-41ed-ace8-de56747c3275 |     devconfig      |     Config for dev env    | 4f83ff38-3ef3-4a27-8b4c-330dc59857ca |
    | b52de6cc-5c4f-4deb-afbc-f7190ee7573b |   Stagingconfig    |    UpdatedStagingConfig   | 4f83ff38-3ef3-4a27-8b4c-330dc59857ca |
    +--------------------------------------+--------------------+---------------------------+--------------------------------------+

View all of the instances that are associated with a configuration group

Use the configuration-instances command to list all of the instances to which a configuration group is assigned.

trove configuration-instances <config_id>

The output is similar to the following example:

    +--------------------------------------+----------------+
    |                  id                  |      name      |
    +--------------------------------------+----------------+
    | a920662c-0074-4369-83d4-e2e159f2ed6c |    CloudDB     |
    | c46a0bba-6c15-4db5-ad7b-832ee2c0b59d | CloudDBStaging |
    +--------------------------------------+----------------+

View configuration details

This section describes different ways to view configuration details.

View the details for a configuration group

Use the configuration-show command to view the details for a configuration group, including its name, ID, the datastore version ID that with which it is associated, and any defined parameters.

trove configuration-show <config_id>

The output is similar to the following example:

    +----------------------+-----------------------------------------------------------------------+
    |       Property       |                                 Value                                 |
    +----------------------+-----------------------------------------------------------------------+
    | datastore_version_id |                  4f83ff38-3ef3-4a27-8b4c-330dc59857ca                 |
    |     description      |                                  Config for Staging env               |
    |          id          |                  b52de6cc-5c4f-4deb-afbc-f7190ee7573b                 |
    |         name         |                             Stagingconfig                             |
    |        values        | {u'collation_server': u'latin1_swedish_ci', u'max_connections': 50} |
    +----------------------+-----------------------------------------------------------------------+

View the properties for a single configuration parameter that can be configured for a datastore version

Use the configuration-parameter-show command to view the properties of a configuration parameter for a datastore version.

trove configuration-parameter-show <datastore_version> <parameter_name>

The output displays the parameter’s value range, value type, and whether a restart of the instance is required for a parameter change to take effect.

The following example shows the output for the innodb_buffer_pool_size parameter for MySQL 5.1:

    +------------------+-------------------------+
    |     Property     |          Value          |
    +------------------+-------------------------+
    |       max        |       68719476736       |
    |       min        |            0            |
    |       name       | innodb_buffer_pool_size |
    | restart_required |           True          |
    |       type       |         integer         |
    +------------------+-------------------------+

View all of the configuration parameters that can be configured for a datastore version

Use the configuration-parameter-list command to view a list of all the parameters that can be configured for a datastore version.

trove configuration-parameter-list <datastore_version>

The output is similar to the following example:

    +--------------------------------+---------+---------+----------------------+------------------+
    |              name              |   type  |   min   |         max          | restart_required |
    +--------------------------------+---------+---------+----------------------+------------------+
    |    auto_increment_increment    | integer |    1    |        65535         |      False       |
    |     auto_increment_offset      | integer |    1    |        65535         |      False       |
    |           autocommit           | integer |    0    |          1           |      False       |
    |    bulk_insert_buffer_size     | integer |    0    | 18446744073709547520 |      False       |
    |      character_set_client      |  string |         |                      |      False       |
    |    character_set_connection    |  string |         |                      |      False       |
    |     character_set_database     |  string |         |                      |      False       |
    |    character_set_filesystem    |  string |         |                      |      False       |
    |     character_set_results      |  string |         |                      |      False       |
    |      character_set_server      |  string |         |                      |      False       |
    |      collation_connection      |  string |         |                      |      False       |
    |       collation_database       |  string |         |                      |      False       |
    |        collation_server        |  string |         |                      |      False       |
    |        connect_timeout         | integer |    1    |        65535         |      False       |
    |        expire_logs_days        | integer |    1    |        65535         |      False       |
    |    innodb_buffer_pool_size     | integer |    0    |     68719476736      |       True       |
    |     innodb_file_per_table      | integer |    0    |          1           |       True       |
    | innodb_flush_log_at_trx_commit | integer |    0    |          2           |      False       |
    |     innodb_log_buffer_size     | integer | 1048576 |      4294967296      |       True       |
    |       innodb_open_files        | integer |    10   |      4294967296      |       True       |
    |   innodb_thread_concurrency    | integer |    0    |         1000         |      False       |
    |      interactive_timeout       | integer |    1    |        65535         |      False       |
    |        join_buffer_size        | integer |    0    |      4294967296      |      False       |
    |        key_buffer_size         | integer |    0    |      4294967296      |      False       |
    |          local_infile          | integer |    0    |          1           |      False       |
    |       max_allowed_packet       | integer |   1024  |      1073741824      |      False       |
    |       max_connect_errors       | integer |    1    | 18446744073709547520 |      False       |
    |        max_connections         | integer |    1    |        65535         |      False       |
    |      max_user_connections      | integer |    1    |        100000        |      False       |
    |    myisam_sort_buffer_size     | integer |    4    | 18446744073709547520 |      False       |
    |           server_id            | integer |    1    |        100000        |       True       |
    |        sort_buffer_size        | integer |  32768  | 18446744073709547520 |      False       |
    |          sync_binlog           | integer |    0    | 18446744073709547520 |      False       |
    |          wait_timeout          | integer |    1    |       31536000       |      False       |
    +--------------------------------+---------+---------+----------------------+------------------+

View the default configuration settings for a specific instance

Use the configuration-default command to view the default configuration settings for an instance.

trove configuration-default <instance_id>

The output is similar to the following example:

    +---------------------------+-----------------------------+
    |          Property         |            Value            |
    +---------------------------+-----------------------------+
    |          basedir          |             /usr            |
    |      connect_timeout      |              15             |
    |          datadir          |        /var/lib/mysql       |
    |   default_storage_engine  |            innodb           |
    |   ignore-builtin-innodb   |              1              |
    |           innodb          |            FORCE            |
    |  innodb_buffer_pool_size  |             125M            |
    |   innodb_data_file_path   |    ibdata1:10M:autoextend   |
    |   innodb_file_per_table   |              1              |
    |   innodb_log_buffer_size  |              4M             |
    |    innodb_log_file_size   |             50M             |
    | innodb_log_files_in_group |              2              |
    |      join_buffer_size     |              1M             |
    |      key_buffer_size      |             40M             |
    |        local-infile       |              0              |
    |         log_error         |  /var/log/mysql/mysqld.log  |
    |     max_allowed_packet    |             16M             |
    |      max_connections      |              85             |
    |    max_heap_table_size    |             12M             |
    |    max_user_connections   |              75             |
    |       myisam-recover      |            BACKUP           |
    |      open_files_limit     |             3276            |
    |        plugin-load        |     ha_innodb_plugin.so     |
    |            port           |             3306            |
    |     query_cache_limit     |              1M             |
    |      query_cache_size     |              8M             |
    |      query_cache_type     |              1              |
    |      read_buffer_size     |             512K            |
    |    read_rnd_buffer_size   |             512K            |
    |   skip-external-locking   |              1              |
    |     skip_name_resolve     |              1              |
    |           socket          | /var/run/mysqld/mysqld.sock |
    |      sort_buffer_size     |              1M             |
    |   table_definition_cache  |             200             |
    |      table_open_cache     |             200             |
    |     thread_cache_size     |              4              |
    |        thread_stack       |             192K            |
    |       tmp_table_size      |             12M             |
    |           tmpdir          |           /var/tmp          |
    |            user           |            mysql            |
    |        wait_timeout       |             120             |
    +---------------------------+-----------------------------+

Continue the conversation in the Rackspace Community.