A Appendix
A.1 Appendix A- CNC Console cnDBTier API Configurations
CNC Console is integrated with cnDBTier in a containerized Oracle Communications Cloud Native Environment. The cnDBTier APIs are read only APIs that can be viewed in CNC Console.
From the left navigation menu, navigate then click cnDBTier tab. The cnDBTier page is displayed.
- In the CNC Console GUI, select the CNCC instance from the drop-down list.
-
Click the cnDBTier tab under CNCC. The cnDBTier page is displayed.
Click the Backup List to view the list of completed backups along with backup Id, backup size, and backup creation timestamp. The Backup List page is displayed.
Table A-1 Backup List Parameters
| Attribute | Description |
|---|---|
| Site Name | This attribute displays the name of the current site. |
| Backup Details | This attribute displays the current cnDBTier backup status. |
| Backup Id | This attribute displays the ID of the stored backup. |
| Backup Size (bytes) | This attribute displays the size of the stored backup. |
| Creation TimeStamp | This attribute displays the time recorded when the backup was stored. |
Click the cnDBTier Backup Status to view cnDBTier backup status. The cnDBTier Backup Status page is displayed.
Table A-2 cnDBTier Backup Status Parameters
| Attribute | Description |
|---|---|
| Current Timestamp | This attribute displays the current system time. |
| Is Backup In Progress | This attribute displays the current cnDBTier backup status. |
| Next Backup Scheduled Timestamp | This attribute displays the time for the next scheduled backup. |
Click cnDBTier Health to view the health status of the microservices such as replication, backup manager, monitor services, NDB services. The cnDBTier Health page is displayed.
Backup Manager Health StatusClick the Backup Manager Health Status to view the health status of the backup manager. The Backup Manager Health Status page is displayed.
Table A-3 Backup Manager Health Status Parameters
| Attribute | Description |
|---|---|
| Service Name | This attribute displays the service name of the backup manager microservice. |
| Service Status | This attribute displays the service status of the backup manager microservice. Possible values are UP and DOWN. |
| DB Connection Status | This attribute displays the database connection status of the backup manager microservice. Possible values are UP and DOWN. |
| Overall Backup Manager Service Health | This attribute displays the overall health status of the backup manager microservice. Possible values are UP and DOWN. |
| Backup Executor Health Status | This attribute displays the following information like node id and DB connection status of the backup executor. |
| Node Id | This attribute displays the id of the node. |
| DB Connection Status | This attribute displays the backup executor database connection status with the nodes. Possible values are UP and DOWN. |
Click the Monitor Health Status to view the health status of the services. The Monitor Health Status page is displayed.
Table A-4 Monitor Health Status Parameters
| Attribute | Description |
|---|---|
| Service Name | This attribute displays the service name of the monitor microservice. |
| DB Connection Status | This attribute displays the database connection status of the monitor microservice. Possible values are UP and DOWN. |
| Metric Scrape Status | This attribute displays the status of the metric scrape, that is if the metrics are fetched or not. If the metrics are fetched then the service is up and vice versa. Possible values are UP and DOWN. |
| Overall Monitor Service Health | This attribute displays the overall health status of the monitor microservice. Possible values are UP and DOWN. |
Click the NDB Health Status to view the health status of the network database. The NDB Health Status page is displayed.
Table A-5 NDB Health Status Parameters
| Attribute | Description |
|---|---|
| Local Site Name | This attribute displays the name of the current site (Site 1, Site 2 ). |
| NDB Health Status Details | This attribute displays the health status of the network database such as the name of the NDB service, status of the service, health status of PVC. |
| Service Name | This attribute displays the service name |
| Service Status | This attribute displays the status of the service. Possible values are UP and DOWN. |
| PVC Health Status | This attribute displays the health status of the PVC. Possible values are UP, DOWN, and NA. Note: This attribute is set to NA when some of the database pods are not connected to the PVC. |
Click the Replication Health Status to view the health status of the replication sites. The Replication Health Status page is displayed.
Table A-6 Replication Health Status Parameters
| Attribute | Description |
|---|---|
| Local Site Name | This attribute displays the name of the current site (Site 1, Site 2). |
| Health Status Details | This attribute displays the health status details of the local site like replication service name, replication service status, database connection status of the replication service, and the overall health status of the replication microservices. The number of rows in this table varies depending on the type of deployment (for example, two-site, three-site deployments). |
| Service Name | This attribute displays the name of the available replication service. |
| Service Status | This attribute displays the status of the available replication service. Possible values are UP and DOWN. |
| DB Connection Status | This attribute displays the database connection status of the replication microservice. Possible values are UP and DOWN. |
| Overall Replication Service Health | This attribute displays the overall health status of the replication microservice. Possible values are UP and DOWN. |
Click cnDBTier Version to view the version. The cnDBTier Version page is displayed.
Table A-7 cnDBTier Version Parameters
| Attribute | Description |
|---|---|
| cnDBTier Version | This attribute displays the cnDBTier version. |
| NDB Version | This attribute displays the network database (NDB) version. |
Click the Database Statistics Report to view the available databases. The Database Statistics Report page is displayed.
Table A-8 Database Statistics Report Parameters
| Attribute | Description |
|---|---|
| Database Count | This attribute displays the number of available databases. |
| Database Tables Count | This attribute displays the available database names and their table count. |
| Database Name | This attribute displays the database name. |
| Table Count | This attribute displays the table count for each database. |
| Database Table Rows Count | This attribute displays the rows present in each table |
| Database Name | This attribute displays the database name. |
- Click the icon available next to the database name to view the View Database Table Rows Count screen. The View Database Table Rows Count page is displayed.
Table A-9 View Database Table Rows Count Parameters
| Attribute | Description |
|---|---|
| Database Name | This attribute displays the database name. |
| Tables | This attribute displays the table names and the corresponding rows in each table. |
| Table Name | This attribute displays the table name. |
| Row Count | This attribute displays the table rows present in each table. |
Click Georeplication Recovery to view the Georeplication Recovery Status of cnDBTier cluster. The Georeplication Recovery page is displayed. The Update Cluster As Failed, Start Georeplication Recovery, and Georeplication Recovery Status appear underneath the Georeplication Recovery Status on the left menu.
Update Cluster As Failed- Click the Update Cluster As Failed to mark the cluster as FAILED. The Update Cluster As Failed page is displayed.
- Click Update Cluster. The selected cluster name is updated in the Failed Cluster Names field.
Table A-10 Update Cluster As Failed Parameters
| Attribute | Description |
|---|---|
| Cluster Names | This field displays a list of cnDBTier clusters that can be marked as failed. |
| Failed Cluster Names | This field displays a cnDBTier cluster that is marked as failed. |
- Click the Start Georeplication Recovery to start the georeplication recovery process for a failed site. The Start Georeplication Recovery page is displayed.
- Click Start Georeplication Recovery to initiate georeplication recovery.
Table A-11 Start Georeplication Recovery Parameters
| Attribute | Description |
|---|---|
| Failed Cluster Name | This field displays a list of all the clusters that have been marked as failed. |
| Backup Cluster Name (Optional) | This field displays a list of all the healthy clusters. If no cluster is selected, the system uses the first available healthy cluster for the backup. |
Click the Georeplication Recovery Status to view the status of georeplication recovery for cnDBTier clusters. The Georeplication Recovery Status page is displayed.
Table A-12 Georeplication Recovery Status Parameters
| Attribute | Description |
|---|---|
| Local Cluster Name | This field displays the name of the local cluster. |
| Georeplication Recover Status Details | This field displays the details of the georeplication recovery status of cnDBTier clusters. |
| Cluster Name | This field displays the clusters by name. |
| Georeplication Recovery Status | This field displays the current georeplication recovery status of the corresponding cluster |
Georeplication Recovery Status
Table A-13 Georeplication Recovery Status Parameters
| Attribute | Description |
|---|---|
| ACTIVE | The cluster is in a healthy state, and replication is up and running with its respective mate cluster. |
| REINSTALLED | The cluster enters this state during fatal error recovery when the end user reinstalls the cluster. |
| STARTDRRESTORE | When Georeplication recovery is started, the cluster will transition into this state. |
| INITIATEBACKUP | When Georeplication recovery is started, the cluster will identify a healthy cluster for backup initiation and transition into this state. |
| CHECKBACKUP | When the backup is initiated, the georeplication recovery cluster will monitor the progress of the backup until its completion. If the backup fails, the cluster will restart the backup. |
| COPY_BACKUP | Upon completion of the backup, the georeplication recovery cluster will request the transfer of the backup from the healthy cluster to the georeplication recovery cluster |
| CHECK_BACKUP_COPY | When backup copy is started, the georeplication recovery cluster will monitor the backup transfer progress till its completion and if it fails the cluster will re-initiate the backup transfer. |
| BACKUPCOPIED | When the backup copy is started, the georeplication recovery cluster will monitor the progress of the backup transfer until its completion. If the transfer fails, the cluster will restart the backup transfer. |
| BACKUPEXTRACTED | This state indicates that the backup has been successfully extracted at the georeplication recovery cluster, allowing the restoration of the backup to start. |
| FAILED | This state is used by the end user to mark a specific cluster as failed and hence georeplication recovery is essential to recover the cluster. This state can also indicate that georeplication recovery started and the database is restored using the healthy cluster backup. |
| UNKNOWN | This state is used by the end user to mark a specific cluster as failed, necessitating georeplication recovery for cluster recovery. Additionally, this state can indicate that georeplication recovery has started and the database has been restored using the backup from the healthy cluster. |
| RECONNECTSQLNODES | This state is used to instruct SQL nodes to be offline during backup restoration to prevent any records from entering the binlog of the georeplication recovery cluster. |
| BACKUPRESTORE | This state indicates that the backup, successfully copied from the healthy cluster, is currently being used to restore the georeplication recovery cluster. |
| RESTORED | When the backup is successfully restored in the georeplication recovery cluster, the cluster will enter this state to start the reestablishment of replication channels. |
| BINLOGINITIALIZED | This state indicates the start of binlogs for the restoration of replication channels, necessary to start the restore process |
| RECONFIGURE | When the binlog is restarted, the georeplication recovery cluster will reestablish the replication channels with respect to all its mate clusters. |
Click Georeplication Status to view the local site and remote site name. The Georeplication Status page is displayed.
Georeplication Status
Table A-14 Georeplication Status Parameters
| Attribute | Description |
|---|---|
| Local Site Name |
This attribute displays the local site name. Note: The number of local site names may vary depending on the type of geo-replication used. |
| Remote Site Name | This attribute displays the remote site name. Note: The number of remote site names may vary depending on the type of geo-replication used. |
| Replication Status |
This attribute displays the replication status with corresponding sites. Note: The number of replication statuses may vary depending on the type of geo-replication used. |
| Seconds Behind Remote Site |
This attribute displays the number of seconds that the last record read by the local site is behind the latest record written by the remote site for all the replication groups. Note: The number of replication statuses may vary depending on the type of geo-replication used. |
- Click the icon in the Actions menu to view the View Georeplication Status screen. The Georeplication Status page is displayed.
Georeplication Status
Table A-15 Georeplication Status Parameters
| Attribute | Description |
|---|---|
| Replication Group Delay | This attribute displays the delay in seconds for the remote site for individual replication groups. |
| Replication Channel Group Id | This attribute displays the ID of the replication channel group. |
- Click the icon to view the Replication Group Delay attributes. The Replication Group Delay page is displayed.
View Replication Group Delay
Table A-16 Replication Group Delay Parameters
| Attribute | Description |
|---|---|
| Channel Details | This attribute displays the channel details such as Remote Replication IP and Role. |
| Remote Replication IP | This attribute displays the IP of the remote replication channel. |
| Role | This attribute displays the role of the replication channel IP. |
- Click Georeplication Status Across All Sites to access the georeplication status across all configured sites in the cnDBTier cluster. The Georeplication Status Across All Sites page is displayed.
- Click the view icon option to view the View Georeplication Status Across All Sites attributes. The View Georeplication Status Across All Sites page is displayed.
Table A-17 Georeplication Recovery Across All Sites Parameters
| Attribute | Description |
|---|---|
| Remote Site Name | This field displays the remote site involved in replication with the local site. |
| Replication Details per Group Id | This field displays the list of replication-group specific details with the site name and the remote site name. |
| Site Name | This field displays the primary site for which the georeplication status is being reported. |
| Site To Mate Site Replication Status | This field displays the overall georeplication status with all the groups. |
- Click the view icon option to view the View Georeplication Status Across All Sites attributes.The View Georeplication Status Across All Sites page is displayed.
Table A-18 View Georeplication Status Across All Sites Parameters
| Attribute | Description |
|---|---|
| All SQL Status Details | This field displays the detailed SQL and replication state information for all SQL nodes for the specified replication group. |
| Replication Channel Group Status | This field displays the replication status for the specific replication group. |
| Replication Group ID | This field displays the unique identifier assigned to the replication group. |
- Click the view icon option to view the View All SQL Status Details attributes. The View All SQL Status Details page is displayed.
Table A-19 View All SQL Status Details Parameters
| Attribute | Description |
|---|---|
| SQL Node | This field displays the SQL node whose replication metrics are being reported. |
| Source Host | This field displays the remote host from which the SQL node pulls replication data. |
| External IP | This field displays the external endpoint through which the SQL node is accessible within the site. |
| Replica I/O Running Status |
This field displays whether the replication I/O thread is currently active or not. Possible values: Yes or No. |
| Replica SQL Running Status |
This field displays whether the SQL thread responsible for applying replicated changes is running or not. Possible values: Yes or No. |
| Server ID | This field displays the unique server identifier used in the replication topology. |
| Role | This field displays the role of the SQL node within the replication setup (for example, ACTIVE or STANDBY). |
| Last Error Code | This field displays the most recent SQL thread error code encountered during replication. |
| Last Error Message | This field displays the most recent error message reported by the SQL thread. |
| Last I/O Error Code | This field displays the most recent I/O thread error code encountered during replication. |
| Last I/O Error Message | This field displays the most recent error message reported by the I/O thread. |
| Last SQL Error Code | This field displays the most recent SQL execution error code encountered while applying replicated transactions. |
| Last SQL Error Message | This field displays the last SQL execution error message reported. |
| SQL Remaining Delay |
This field displays the replication lag or delay (if any) between the source site and this SQL node. Unit: seconds. |
- From the left navigation menu, navigate to Gracefully Stop and Start Georeplication. The Gracefully Stop and Start Georeplication pages are displayed.
- Click Stop Georeplication from the left navigation menu to stop the georeplication between the sites. The Edit Gracefully Stop Georeplication page is displayed.
- Click Stop Georeplication to stop the replication between the sites.
-
Click Start Georeplication from the left navigation menu to start the georeplication between the sites. The Start Georeplication page is displayed.
Table A-20 Gracefully Stop and Start Georeplication Parameters
| Attribute | Description |
|---|---|
| Site Name | This attribute displays the name of the current site. |
| Remote Site Name | This attribute displays the list of the remote site name. |
| Replication Channel Group Ids | This attribute displays the list of replication group ids of the current site. |
| Georeplication Details | This attribute displays the details of the georeplication sites and their status. |
Georeplication Details
Table A-21 Georeplication Details Parameters
| Attribute | Description |
|---|---|
| Site Name | This attribute displays the name of the current site. |
| Remote Site Name | This attribute displays the name of the remote site. |
| Replication Channel Group Id | This attribute displays the replication group id. |
| Replication Status |
This attribute displays the status of the georeplication between sites.
|
| Switch Over Status |
|
- From the left navigation menu, navigate to the IP Preference for Replication Channel. The IP Preference for Replication Channel page is displayed.
- Click Actions to view the IP preference set for the sites. The Edit IP Preference for Replication Channel page is displayed.
Table A-22 IP Preference for Replication Channel Parameters
| Attribute | Description |
|---|---|
| Local Site Name | This attribute displays the name of the current site. |
| Remote Site Name | This attribute displays the remote site name. |
|
Preferred Family Preferred IP Family Type |
This attribute displays the current site's preferred IP family type. IPV4- Indicates the IP Type selected is IPV4. IPV6- Indicates the IP Type selected is IPV6. |
| Status | This attribute displays the current site's preferred IP family status. |
Click Local Cluster Status to view the local cluster status for the current site. The Local Cluster Status page is displayed.
Table A-23 Local Cluster Status Parameters
| Attribute | Description |
|---|---|
| Site Name | This attribute displays the name of the current site. |
| Cluster Status | This attribute displays the local cluster status for the current site. |
Click the On Demand Backup to create a new backup and view the status of initiated on demand backups. The On Demand Backup page is displayed.
Table A-24 On Demand Backup Parameters
| Attribute | Description |
|---|---|
| Site Name | This attribute displays the name of the current site. |
| DR Status | This attribute displays the disaster recovery status. |
| Backup Id | This attribute displays the ID of the stored backup. |
| Backup Status | This attribute displays the status of the backup. |
| Remote Transfer Status | This attribute displays the status of the remote transfer. |
| Initiate Backup |
The attribute displays whether the backup is initiated or not. Note: You can read and write this API. |
- Click Edit. The Edit On Demand Backup page appears.
- Note: The Edit mode is available only for Initiate Backup.
- Use the Toggle button to initiate the backup and click Save. A confirmation message "Saved successfully" appears.
- Click Cancel to navigate back to the On Demand Backup page.
- Click Refresh to reload the On Demand Backup page.
Click the HeartBeat Status to view the connectivity between local site and remote site. The HeartBeat Status page is displayed.
Table A-25 HeartBeat Status Parameters
| Attribute | Description |
|---|---|
| Site Name | This attribute displays the name of the current site. |
| Heartbeat Details | This attribute displays the following information such as the remote site name, heart beat status, heart beat lag, and replication channel group id. |
| Remote Site Name | This attribute displays the remote site name. |
| Heartbeat Status | This attribute displays the connectivity status with corresponding sites. |
| Heartbeat Lag | This attribute displays the lag or latency in seconds it took to synchronize between sites. |
| Replication channel Group Id | This attribute displays the ID of the replication channel group. |