2023.1 Series Release Notes

8.0.0

Upgrade Notes

  • Python 3.6 & 3.7 support has been dropped. The minimum version of Python now supported is Python 3.8.

7.1.0

New Features

  • Support both project name and ID in quota CLI.

7.0.0

New Features

  • Support deleting backups in batch.

  • Support operating_status for listing and showing instance. When instance is created successfully, the status is ACTIVE and operating_status is HEALTHY.

  • In multi-region deployment with geo-replicated Swift, the user can restore a backup in one region by manually specifying the original backup data location created in another region. Instance ID or name is not needed anymore for creating backups.

6.0.0

New Features

  • Support specifying and showing datastore version number for several resources such as datastore version, instance and configuration.

  • Support to get backups of a specific project by --project-id PROJECT_ID.

  • Support updating datastore version.

5.1.0

New Features

  • Added support to show and update access settings for instance.

  • Support to rebuild instance.

    openstack database instance rebuild <instance> <new-image-id>

5.0.0

New Features

  • Support backup strategy CLI.

  • Change flavor as an optional parameter (--flavor) for creating instance. When creating replicas, flavor is not requried.

4.1.0

New Features

  • Support to create datastore version in CLI.

4.0.0

New Features

  • Support following commands of updating configuration:

    openstack database configuration parameter set <config_id> <values>
openstack database configuration set <config_id> <values> --name NAME --description DESC

  • Support following replication commands:

    openstack database instance detach
openstack database instance promote
openstack database instance eject

  • Add replication ‘Role’ for listing instances to indicate if the instance is a master or a replica.

Deprecation Notes

  • Trove CLI doesn’t support to get flavor information more. User needs to provide Nova flavor ID when creating trove instance.

  • The following commands are removed:

    openstack database instance detach replica
openstack database instance promote to replica source
openstack database instance eject replica source

3.3.0

New Features

  • Support to force delete instance. By default, only allowed by admin user.

    openstack database instance delete --force <instance>

  • Support to reboot instance.

    openstack database instance reboot <instance>

  • Support to delete datastore version by ID.

    openstack datastore version delete <datastore_version_id>

  • Support to delete datastore by ID or name, this is admin action by default.

    openstack datastore delete <datastore>

3.2.0

New Features

  • Support following instance log actions:

    openstack database log show <instance_id> <log_name>
openstack database log set <instance_id> <log_name> [OPTIONS]

  • Support to show log content and save instance log files:

    openstack database log tail [--lines LINES] <instance> <log_name>
openstack database log save [--file FILE] <instance> <log_name>

Upgrade Notes

  • Python 2.7 support has been dropped. Last release of python-troveclient to support py2.7 is OpenStack Train. The minimum version of Python now supported by python-troveclient is Python 3.6.

3.0.0

New Features

  • Support --is-public and --allowed-cidr for creating instance.

2.19.0

New Features

  • Support --instance-id and --all-projects for getting backups.

2.18.0

New Features

  • Allow users to delete database instances in batch.

  • Admin user can use openstack database instance list --all-projects to get database instances of all the projects.

2.17.0

New Features

  • A –configuration flag was added to the trove cluster-create command, in order to allow a user to attach specific configuration for cluster.

  • Added detailed option to instances client in instances.list command. Now, detailed instance list can be obtained by setting detailed parameter to True. Trove will then include more details in the API response.

  • User can specify the number and volume of mongos/configserver by using the extends argument when creating mongodb cluster. Currently, the supported parameters are, num_configsvr, num_mongos, configsvr_volume_size, configsvr_volume_type, mongos_volume_size and mongos_volume_type.

Bug Fixes

  • [bug 1794663] Fixed wrong keyword arguments to make openstack database flavor list command work properly with --datastore-type and --datastore-version-id options.

2.16.0

New Features

  • The command trove cluster-modules is now available to use in the python-openstackclient CLI as openstack database cluster modules.

  • The command trove configuration-default is now available to use in the python-openstackclient CLI as openstack database configuration default

  • The command trove configuration-instances is now available to use in the python-openstackclient CLI as openstack database configuration instances

  • The command trove detach-replica is now available to use in the python-openstackclient CLI as openstack database instance detach replica

  • The command trove eject-replica-source is now available to use in the python-openstackclient CLI as `` openstack database instance eject replica source``

  • The command trove execution-delete is now available to use in the python-openstackclient CLI as openstack database backup execution delete

  • The command trove log-list is now available to use in the python-openstackclient CLI as openstack database log list

  • The command trove promote-to-replica-source is now available to use in the python-openstackclient CLI as openstack database instance promote to replica source

2.15.0

New Features

  • The command trove cluster-grow is now available to use in the python-openstackclient CLI as openstack database cluster grow

  • The command trove cluster-shrink is now available to use in the python-openstackclient CLI as openstack database cluster shrink

2.14.0

New Features

  • The command trove backup-create is now available to use in the python-openstackclient CLI as openstack database backup create

  • The command trove backup-delete is now available to use in the python-openstackclient CLI as openstack database backup delete

  • The command trove backup-list-instance is now available to use in the python-openstackclient CLI as openstack database backup list instance

  • The command trove backup-show is now available to use in the python-openstackclient CLI as openstack database backup show

  • The command trove cluster-create is now available to use in the python-openstackclient CLI as openstack database cluster create

  • The command trove cluster-delete is now available to use in the python-openstackclient CLI as openstack database cluster delete

  • The command trove cluster-instances is now available to use in the python-openstackclient CLI as openstack database cluster list instances.

  • The command trove cluster-show is now available to use in the python-openstackclient CLI as openstack database cluster show

  • The command trove configuration-attach is now available to use in the python-openstackclient CLI as openstack database configuration attach The command trove configuration-detach is now available to use in the python-openstackclient CLI as openstack database configuration detach

  • The command trove configuration-create is now available to use in the python-openstackclient CLI as openstack database configuration create

  • The command trove configuration-delete is now available to use in the python-openstackclient CLI as openstack database configuration delete

  • The command trove configuration-parameter-list is now available to use in the python-openstackclient CLI as openstack database configuration parameter list

  • The command trove configuration-parameter-show is now available to use in the python-openstackclient CLI as openstack database configuration parameter show

  • The command trove configuration-show is now available to use in the python-openstackclient CLI as openstack database configuration show

  • The command trove database-create is now available to use in the python-openstackclient CLI as openstack database db create

  • The command trove database-delete is now available to use in the python-openstackclient CLI as openstack database db delete

  • The command trove datastore-show is now available to use in the python-openstackclient CLI as openstack datastore show

  • The command trove datastore-version-list is now available to use in the python-openstackclient CLI as openstack datastore version list

  • The command trove datastore-version-show is now available to use in the python-openstackclient CLI as openstack datastore version show

  • The command trove flavor-show is now available to use in the python-openstackclient CLI as openstack database flavor show

  • The command trove force-delete is now available to use in the python-openstackclient CLI as openstack database instance force delete

  • The command trove cluster-force-delete is now available to use in the python-openstackclient CLI as openstack database instance cluster force delete

  • The command trove create is now available to use in the python-openstackclient CLI as openstack database instance create

  • The command trove delete is now available to use in the python-openstackclient CLI as openstack database instance delete

  • The command trove show is now available to use in the python-openstackclient CLI as openstack database instance show

  • The command trove log-enable is now available to use in the python-openstackclient CLI as openstack database log enable.

  • The command trove quota-show is now available to use in the python-openstackclient CLI as openstack database quota show.

  • The command trove quota-update is now available to use in the python-openstackclient CLI as openstack database quota update.

  • The command trove reset-status is now available to use in the python-openstackclient CLI as openstack database instance reset status The command trove cluster-reset-status is now available to use in the python-openstackclient CLI as openstack database cluster reset status

  • The command trove resize-instance is now available to use in the python-openstackclient CLI as openstack database instance resize flavor

  • The command trove resize-volume is now available to use in the python-openstackclient CLI as openstack database instance resize volume

  • The command trove restart is now available to use in the python-openstackclient CLI as openstack database instance restart

  • The command trove root-disable is now available to use in the python-openstackclient CLI as openstack database root disable.

  • The command trove root-enable is now available to use in the python-openstackclient CLI as openstack database root enable.

  • The command trove root-show is now available to use in the python-openstackclient CLI as openstack database root show.

  • The command trove update is now available to use in the python-openstackclient CLI as openstack database instance update.

  • The command trove upgrade is now available to use in the python-openstackclient CLI as openstack database instance upgrade.

  • The command trove cluster-upgrade is now available to use in the python-openstackclient CLI as openstack database cluster upgrade.

  • The command trove user-grant-access and trove user-revoke-access and trove user-show-access are now available to use in the python-openstackclient CLI as openstack database user grant access and openstack database user revoke access and openstack database user show access

  • The command trove user-create is now available to use in the python-openstackclient CLI as openstack database user create

  • The command trove user-delete is now available to use in the python-openstackclient CLI as openstack database user delete

  • The command trove user-show is now available to use in the python-openstackclient CLI as openstack database user show

  • The command trove user-update-attributes is now available to use in the python-openstackclient CLI as openstack database user update attributes

  • This change defines do_action_on_many function as a helper to run an action on many resources (like trove delete). Use command like trove delete instance1 instance2 ... to delete many instances and the same as cluster-delete.

2.11.0

New Features

  • The command trove backup-list is now available to use in the python-openstackclient CLI as openstack database backup list

  • The command trove cluster-list is now available to use in the python-openstackclient CLI as openstack database cluster list

  • The command trove configuration-list is now available to use in the python-openstackclient CLI as openstack database configuration list

  • The command trove database-list is now available to use in the python-openstackclient CLI as openstack database db list

  • The command trove datastore-list is now available to use in the python-openstackclient CLI as openstack datastore list

  • The command trove list is now available to use in the python-openstackclient CLI as openstack database instance list

2.10.0

New Features

  • Support was added to manage users and databases for clusters.

2.9.0

New Features

  • Added support for listing volume types for a given datastore version.

2.8.0

New Features

  • The command trove flavor-list is now available to use in the python-openstackclient CLI as openstack database flavor list

Bug Fixes

  • Add module-instance-count support to list a count of all instances having a specific module applied. Bug 1554900

  • Add module-reapply command to facilitate applying a module again to all instances where it was previously applied. Bug 1554903

  • Having the CLI command display non-redundant information for module-list when invoked with admin privileges now works with both keystone V2 and V3. Bug 1622019

2.7.0

New Features

  • Added cluster-upgrade command to upgrade all instances in a cluster to a new datastore version.

  • Adds –region option to create and cluster-create APIs. For now, these options are excluded from CLI help strings. This is the first step in multiregion support.

  • Added pagination support (limit and marker) to the CLI for configuration-list and configuration-instances.

2.6.0

Other Notes

  • Add ephemeral column in flavor-list Bug 1617980.

  • Use i18n for shell.py Partial-Bug 1379001.

  • Use i18n for v1/shell.py

2.5.0

New Features

  • The reset-status command will set the task and status of an instance to ERROR after which it can be deleted.

  • The force-delete command will allow the deletion of an instance even if the instance is stuck in BUILD state.

  • The –incremental flag for backup-create will add the abiility to create incremental backup based on last full or incremental backup. If no full or incremental backup exists a new full backup will be created.

  • Modules can now be applied in a consistent order, based on the new ‘priority_apply’ and ‘apply_order’ attributes available to module-create and module-update. Blueprint module-management-ordering

  • Adds quota-show and quota-update commands to show the limits for all resources and to change the limit for a single resource. These commands require admin privileges.

  • Implements trove schedule-* and execution-* commands to support scheduled backups.

Bug Fixes

  • Updating a module with all_datastores and all_datastore_versions now works correctly. Bug 1612430

2.4.0

New Features

  • Add a new trove upgrade CLI command and a new Instances.upgrade python API method to implement the new Instance Upgrade feature.

Other Notes

  • Add disk column in flavor-list.

  • Add vCPUs column in flavor-list Bug 1261876.

2.3.0

New Features

  • A –locality flag was added to the trove cluster-create command to allow a user to specify whether instances in a cluster should be on the same hypervisor (affinity) or on different hypervisors (anti-affinity).

  • A –locality flag was added to the trove create command to allow a user to specify whether new replicas should be on the same hypervisor (affinity) or on different hypervisors (anti-affinity).

  • Support was added for modules in cluster-grow and. the CLI consolidated to look more like cluster-create. This means that not including –instance on cluster-grow now raises a MissingArgs exception. Not including a required option in the –instance argument also raises MissingArgs now (instead of the previously raised CommandError). Bug 15778917

  • Support added for error messages when running the Trove show command.

Bug Fixes

  • Allow use of backup name in trove create when restoring a backup.

  • configuration-* cli commands now allow name of configuration group entered instead of just the configuration id. This will allow a user to specify the configuration group name or the id to use for all the cli commands related to configuration groups. Bug 1505529

  • The CLI output from configuration-parameter-list was fixed to properly display the ‘Min Size’ and ‘Max Size’ values. Bug 1572272

  • Fixed CLI output of cluster-create to only print pertinent information so it is consistent with cluster-show. Bug 1563504

  • Remove all the rax references in the client. Use the rackspace plugin for auth if you want to use rax auth with troveclient. Bug 1401804