diff options
Diffstat (limited to 'doc/source/user/instance-status.rst')
| -rw-r--r-- | doc/source/user/instance-status.rst | 50 |
1 files changed, 28 insertions, 22 deletions
diff --git a/doc/source/user/instance-status.rst b/doc/source/user/instance-status.rst index a3a0568c..5e2dfbad 100644 --- a/doc/source/user/instance-status.rst +++ b/doc/source/user/instance-status.rst @@ -2,40 +2,46 @@ Database instance status ======================== -HEALTHY - The database service is functional, e.g. table is accessible. +Trove is maintaining two types of status, named ``status`` and ``operating_status``. -RUNNING - The database service is alive, but maybe not functional yet. +``status`` is reflecting the trove instance VM status and instance task status, e.g. after successfully creating a trove instance, the ``status`` is ``ACTIVE``, when doing backup, the ``status`` is ``BACKUP``, etc. -SHUTDOWN - The database service is stopped. +``operating_status`` is the actual database status inside the trove instance, trove guest agent is actively monitoring the database status and reporting back to trove, e.g. when MySQL service is up and running, the ``operating_status`` should be ``HEALTHY``, if MySQL service is not running for some reason, the ``operating_status`` is ``SHUTDOWN``. + +The possible values for ``status`` are: NEW - The database service creation request is just received by Trove. + The database instance creation request is just received by Trove. BUILD - The database service is being installed. + The database instance is being installed. -BLOCKED - The database service process exists but service is not accessible for some - reason. +ACTIVE + The database instance is up and running. -PROMOTE - Trove is replicating data between a replication group in order to promote a - new master instance. +REBOOT + The database instance is rebooting. -EJECT - The master election is happening within a replication group. +RESIZE + The database instance is being resized. + +UPGRADE + The database instance is upgrading its datastore, e.g. from mysql 5.7.29 to mysql 5.7.30 RESTART_REQUIRED The database service needs to restart, e.g. due to the configuration change. -FAILED - The database service is failed to spawn. +PROMOTE + A replica instance in the replication cluster is being promoted to the primary. + +EJECT + The current primary instance in a replication cluster is being ejected, one of the replicas is going to be elected as the new primary. -ERROR - There are some errors in a running database service. +DETACH + One of the replicas in a replication cluster is being detached and will become a standalone instance. + +SHUTDOWN + The database instance is being shutdown during deletion. -DELETED - The database service is deleted. +BACKUP + The database instance is being backed up. |