diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/alert-center/active-alert.md b/product/en/docs-zcloud-for-mogdb/v6.3/alert-center/active-alert.md new file mode 100644 index 0000000000000000000000000000000000000000..e5f0795e2398227e3ae06e6ac46c970fb0c0155c --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/alert-center/active-alert.md @@ -0,0 +1,97 @@ +--- +title: Active Alert +author: Guo Huan +date: 2024-08-12 +--- + +# Active Alert + +## Function Entrance + +Entry 1: Monitoring Overview --> Active Alert + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-3.png) + +Entry 2: Alert Center --> Active Alert + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-4.png) + +## Function Description + +Display triggered alert messages and provide a response portal. + +## Operating Instructions + +### Active Alert + +Alert messages can be filtered by alert level (Warning, Serious), alert status (Unresponsive, Responded, Ignored) and keyword search, etc. The conditions for filtering and searching can be added manually, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-5.png) + +Click on the top 5 databases in the upper left to filter the display of alerts for the corresponding databases, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-6.png) + +### Alert Message Acknowledgement + +View alert details, such as trigger time, alert content, processing recommendations, etc. + +Click the alert message item, as shown below: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-7.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-8.png) + +### Alert Response + +Closed-loop function for responding to alert messages. + +Click the Response button to respond to an alert, as shown below: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-9.png) + +Set whether subsequent alert messages are sent or not, as shown below: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-10.png) + +When “Send Responded Notification” is checked, the response notification will be sent to the “Response Recipient” configured in the alert template. + +“Continuously sending” means that subsequent alert notifications are sent normally, you can scroll down to select the sending channel and change the sending method of subsequent alert notifications, for example, the default alert template configuration is to send to the platform, change the sending method to email for alert escalation processing. + +“Suspend sending” means to suspend sending third-party channel for the current triggered alert message, but it will still be accumulated in the number of alerts of the platform. Scroll down to select the duration of suspension. + +“Do not send” means that the alert message is no longer sent to the third party channel, but it will still be accumulated in the number of alerts of the platform. + +“Alert sending channel” means the third-party sending channel for subsequent alert messages (if the alert template has a third-party channel configured for this alert item, the default sending channel is the configured channel; if the alert template does not have a third-party channel configured for this alert item, the default sending channel will be empty (only sent to the platform)). + +After responding, the alert will be marked as responded, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-11.png) + +For alert messages that have been responded to, you can also click Respond again to modify the policy, as shown below: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-12.png) + +### Alert Recovery + +If the Alert Center automatically detects that the problem that triggered the alert has disappeared, the alert message is automatically set to Recovered status and moved to Historical Alerts, as shown below: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-13.png) + +### Ignore Alerts + +Alert messages can be ignored, i.e., no more alert messages will be sent for this alert trigger, but they will still be sent normally for subsequent re-triggering, as shown below: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-14.png) + +### Quickly Add To Whitelist + +Quickly add the alert objects and alert items corresponding to the alert messages to the whitelist. After adding, no more alert messages will be sent during the effective time, as shown below: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-15.png) + +### Batch Operations + +Click the multi-selected check box in front of the list, after checking it, you can perform batch response and batch ignore operation on the active alerts, and the alert messages whose status does not support response or ignore will be automatically skipped in the checked alert messages, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-16.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/alert-center/alert-center.md b/product/en/docs-zcloud-for-mogdb/v6.3/alert-center/alert-center.md new file mode 100644 index 0000000000000000000000000000000000000000..3e76a5fd2243af954245e3d5376ff8d9535e7633 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/alert-center/alert-center.md @@ -0,0 +1,17 @@ +--- +title: Alert Center +author: Guo Huan +date: 2024-08-12 +--- + +# Alert Center + ++ **[Alert Center](./feature-alert-center.md)** ++ **[Active Alert](./active-alert.md)** ++ **[Historical Alert](./historical-alert.md)** ++ **[Alert Templates](./alert-templates.md)** ++ **[Alert Contacts](./alert-contacts.md)** ++ **[Alert Message Sending Channel](./alert-message-sending-channel.md)** ++ **[Whitelist of Alerts](./whitelist-of-alerts.md)** ++ **[Alert Item Configuration](./alert-item-configuration.md)** ++ **[Prometheus](./prometheus.md)** diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/alert-center/alert-contacts.md b/product/en/docs-zcloud-for-mogdb/v6.3/alert-center/alert-contacts.md new file mode 100644 index 0000000000000000000000000000000000000000..223c976387bfd4baaacd9f3fcfd0d6547ce72e45 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/alert-center/alert-contacts.md @@ -0,0 +1,61 @@ +--- +title: Alert Contacts +author: Guo Huan +date: 2024-08-12 +--- + +# Alert Contacts + +## Function Entrance + +Alert Center --> Alert Contacts + +## Function Description + +Configure the contact information for receiving alerts. + +## Operating Instructions + +### Alert Contacts + +The list of alert contacts, as shown below: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-57.png) + +Click [Add Contact] in the upper right corner, as shown below: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-58.png) + +Enter the alert contact information, cell phone number for sending SMS alerts and email address for sending email alerts, as shown below: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-59.png) + +Delete the alert contact, as shown below: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-60.png) + +### Alert Contact Group + +Click [Alert contact group] to switch to the Alert contact group screen; + +Alert Contact Group List, with group member types categorized as: Alert Contacts, WeCom Group Chats. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-61.png) + +Click the [New Contact Group] button in the upper right corner; + +Enter the alert contact group information and select the group member type: Alert Contact or WeCom Group Chat; + +Choose Alert Contacts: select group members; + +Choose WeCom Group Chat: enter the group chat name and Webhook address for connectivity testing. After passing the test, click Confirm. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-62.png) + +### Alert Contact Association Group + +Alert Center --> Alert Contacts --> Alert Contacts --> Edit Group; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-63.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-64.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/alert-center/alert-item-configuration.md b/product/en/docs-zcloud-for-mogdb/v6.3/alert-center/alert-item-configuration.md new file mode 100644 index 0000000000000000000000000000000000000000..c5283b895739987f37921a7f00106c85278daf0a --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/alert-center/alert-item-configuration.md @@ -0,0 +1,63 @@ +--- +title: Alert Item Configuration +author: Guo Huan +date: 2024-08-12 +--- + +# Alert Item Configuration + +## Function Entrance + +Alert Center --> Alert Item Configuration + +## Function Description + +After customizing the SQL metric collection, associate it with a custom alert item. + +## Operating Instructions + +### Custom Alert Items + +Click the "Create" button to create a new custom alert template item. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-88.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-89.png) + +- Alert Code: A unique identifier for the alert item; + +- Alert Item Name: The name of the alert item for easy recognition; + +- Alert Message: The alert message that is pushed when the alert is triggered. The following variables can be used (hover over the exclamation mark to display); + +- Alert Object: {{$labels.alertObj}} + +- Data Field Name: {{$labels.xxx}} + +- Alert Triggering Value: {{$value}} + +- Thresholds: ${threshold1}, ${threshold2} + +- Alert Category: Performance, Space Capacity, Availability; + +- Object Type: Supports MogDB/openGauss databases; + +- Alert Metric: Select the specified custom SQL metric collection item; + +- Threshold Comparison: Threshold comparison operator; + +- Warning Level Threshold: The threshold for general warnings; + +- Critical Level Threshold: The threshold for critical warnings; + +- Tolerance Time: To avoid false alarms, the execution time that triggers the alert must be greater than the tolerance time to push the alert; + +- Effective Time: The time period during which the alert template rule is effective. + +Example, as shown in the figure below: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-90.png) + +You can enable, disable, modify, and delete custom alert items. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-91.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/alert-center/alert-message-sending-channel.md b/product/en/docs-zcloud-for-mogdb/v6.3/alert-center/alert-message-sending-channel.md new file mode 100644 index 0000000000000000000000000000000000000000..c3747fdc4280655f997e4fce054f762a42dc0671 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/alert-center/alert-message-sending-channel.md @@ -0,0 +1,203 @@ +--- +title: Alert Message Sending Channel +author: Guo Huan +date: 2024-08-12 +--- + +# Alert Message Sending Channel + +## Function Entrance + +Monitoring Alerts --> Alert Message Sending Channels --> Create + +Note: The alert channel supports email, WeCom, Zabbix, multi-protocol standard message bodies, and other methods. + +## Function Description + +The alert message sending channel refers to the method by which alert messages are sent to those who need to be informed. Based on specific circumstances, the platform comes with built-in alert message sending channels such as email, WeCom, Zabbix, and multi-protocol standard message bodies. + +## Operating Instructions + +### Parameter Configuration + +Click the Create button and enter the IP address, port, and tenant accessKey for the platform's email alert microservice zcloud_mail_sender.service. The accessKey should be configured in the accessKey.properties file, corresponding to the tenant's accessKey. For specific configuration details, please refer to the document "Yunhe Enmo Data Cloud Management Platform zCloud Email Alert Deployment Configuration Documentation.docx". The platform's built-in email alert channel service port is 8206. If you have any questions during the configuration, please contact the product service personnel for support. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-65.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-66.png) + +Click "Confirm", once the service validation is successful, the email alert channel will be displayed on the page. Click the "Enable" switch to control whether to enable or disable this channel. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-67.png) + +Click "Configure" to enter the email server information and the username and password of the email sender. After clicking "Confirm" and the validation is successful, save the settings to make them effective. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-68.png) + +### Notification Message Format + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-69.png) + +You can customize the format of the notification message: + +1. You can directly enter fields in the input box; + +2. You can click "Insert Field" to select common fields from zCloud and insert them into the notification message; + +3. You can click "Preview" to replace the inserted fields with preset values, making it easy to view the preview style of the alert message format. + +### Configuring the WeCom Channel + +The alert notifications can be sent to individual WeCom accounts and WeCom group chats. + +#### Function Entrance + +Alert Center --> Alert Contacts + +Alert Center --> Alert Templates + +Alert Center --> Alert Message Sending Channels + +#### Prerequisites + +1. If the target type is an individual WeCom account, the customer's WeCom administrator needs to provide the application information for receiving alert notifications (including the Corporation ID, Application AgentId, and Application Secret). + +2. If the target type is an individual WeCom account, it is necessary to configure the WeCom email, phone number, and personal email in the alert contact and add it to the corresponding alert template. + +3. If the target type is a WeCom group chat, a group chat robot needs to be created within the chat to obtain the Webhook URL. + +4. If the target type is a WeCom group chat, an alert contact group of the WeCom group chat type needs to be configured within the alert contact group and added to the corresponding alert template. + +#### Individual WeCom Alerts + +Step Overview: + +On the Alert Contact page: Configure personal information such as WeCom email. --> On the Alert Template page: Select the alert contacts. --> On the Alert Message Sending Channel page: Configure the strategy and set up application information. + +Detailed Steps: + +1. Configure the mobile number and WeCom email, personal email for the alert contact. + + You need to set up the WeCom email, personal email, and mobile phone number within the Alert Center --> Alert Contacts --> Edit page; + + At least one of the corporate email, personal email, or mobile phone number must be filled in to be associated with the WeCom ID; The association priority is: WeCom email first, then personal email, and finally mobile phone number. + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-70.png) + +2. Selecting Alert Contacts in the Alert Template + + 2.1. After creating the template, click the edit button. + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-71.png) + + Click the edit icon to configure the alert notification recipients by selecting alert contacts; + + Click the edit icon again to configure the response/timeout notification recipients by selecting alert contacts. + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-72.png) + +3. Configure WeCom channel: push to personal WeCom Account + + 3.1. Navigate to the Alert Center --> Alert Message Sending Channels --> Select the channel named "WeCom" --> Configure. + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-73.png) + + 3.2. On the left side, you will find the list of push strategies, and on the right side, you will see the strategy settings. Click on the strategy name, and the detailed settings for that strategy will be displayed on the right. + + Click "Create New Strategy" to add a new strategy to the list. + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-74.png) + + If you need to delete a strategy, hover your mouse over the strategy name to reveal the delete button. Clicking on it will bring up a delete confirmation dialog box. + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-75.png) + + 3.3. Enter the strategy name and keep the default activation status turned on (if you turn off the activation status, the corresponding strategy status in the left list will be displayed in gray). + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-76.png) + + Select the push target as an individual: + + Enter the Corporation ID, Application AgentId, and Application Secret (the Application AgentId and Application Secret will be displayed encrypted). + + Different strategies cannot have duplicate combinations of "Corporation ID" and "Application AgentId". + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-77.png) + + 3.4. Set up confidentiality settings, including duplicate message checking. + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-78.png) + + Select confidentiality settings: If you choose not to keep the messages confidential, the alert notification messages received by WeCom can be shared externally; If you select to keep the messages confidential, they cannot be shared, and the content will display a watermark. + + Choose duplicate message checking: When enabled, you need to set an interval, with a default of 1800 seconds (30 minutes), and the maximum should not exceed 4 hours; When disabled, no interval is set. + + 3.5. The format of the notification message is the same as described in the Operating Instructions - Notification Message Format. + +#### Group Message Alert + +Step Overview: + +On the Alert Contact Group page: Create an alert contact group of the WeCom group chat type. --> On the Alert Template page: Select the alert contact group of the WeCom group chat type. --> On the Alert Message Sending Channel page: Configure the strategy and choose the alert contact group of the WeCom group chat type. + +Detailed Steps: + +1. Create an alert contact group of the WeCom group chat type. + + 1.1. Click on Alert Center --> Alert Contacts --> Switch to Alert Contact Groups to navigate to the Alert Contact Groups page. + + In the alert contact group list, the group member types are divided into: Alert Contacts, WeCom Group Chats; as shown in the following figure: + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-79.png) + + 1.2. Click the [Add New Contact Group] button in the upper right corner: + + Enter the alert contact group information and select the group member type as WeCom Group Chat: + + For selecting WeCom Group Chat: Enter the group chat name and Webhook URL to perform a connectivity test. After passing the test, click Confirm; + + After clicking Confirm, the group will be displayed in the alert contact group list. + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-80.png) + + How to obtain the Webhook URL: + + In the WeCom group chat, click the More icon in the upper right corner --> Select Add Group Robot. After adding, the Webhook URL will be displayed. + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-81.png) + +2. Selecting a WeCom Group Chat Type Alert Contact Group in the Alert Template: + + 2.1. After creating the template, click the edit button. + + Click the edit icon to configure the alert notification recipients by selecting the alert contact group of the WeCom group chat type. + + Click the edit icon again to modify the response/timeout notification recipients by selecting the alert contact group of the WeCom group chat type. + + The alert contact group will be displayed as: Alert Contact Group Name (Group Chat Name). + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-82.png) + +3. To configure the WeCom channel to send messages to a group chat, follow these steps: + + 3.1. Click on Alert Center --> Alert Message Sending Channels --> Select the channel named "WeCom" --> Configure. + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-83.png) + + 3.2. Click "Create New Strategy" to add a new strategy to the list; Select the push target as a group chat; + + Select the alert contact group (WeCom group), which supports multi-selection and search. + + When selecting the alert contact group, the same alert contact group cannot be added to multiple group chat strategies. + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-84.png) + + 3.3. Set the notification message format, which should be the same as the format described in the Operating Instructions - Notification Message Format. + +#### Save Strategy + +Click the Save button to validate all strategies. If the validation is successful, you will be redirected to the alert message sending channels page. + +If the validation fails, you will not be able to save, and a red icon will be displayed on the left side of the list. Hovering over the red icon will show the reason for the failure. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-85.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/alert-center/alert-templates.md b/product/en/docs-zcloud-for-mogdb/v6.3/alert-center/alert-templates.md new file mode 100644 index 0000000000000000000000000000000000000000..65990eca93556fd18ba8872544cff423f61306e6 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/alert-center/alert-templates.md @@ -0,0 +1,215 @@ +--- +title: Alert Templates +author: Guo Huan +date: 2024-08-12 +--- + +# Alert Templates + +## Alert Templates + +### Function Entrance + +Alert Center --> Alert Templates + +### Function Description + +Alert templates include host and MogDB/openGauss database alert check information. You can perform operations such as creation, modification, deletion, and cloning. + +### Operating Instructions + +#### Create Alert Template + +Click the "Create" button in the upper right corner, enter the alert template name and description, and select the alert object type, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-23.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-24.png) + +Click "Edit" to view the alert template details, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-25.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-26.png) + +#### Associate Alert Objects + +Associate alert objects (hosts or databases) with the alert template. Each alert type's template can only select corresponding type objects (hosts, MogDB/openGauss, etc.), and each template can be associated with multiple objects, but each object can only be associated with one template. Depending on the specific situation of the target object, you can create multiple alert templates and configure threshold values separately. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-27.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-28.png) + +For host-type alert templates, alert objects are grouped by project group: when a host has included databases, the host belongs to the project group where the database is located. + +When multiple databases running on a host belong to different project groups, the host will appear in each project group. For hosts without managed databases, they are displayed in the "Ungrouped" section. The host objects visible to users will be restricted by project groups, and the user role permissions need to include the resource permission of "Monitor all hosts," as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-29.png) + +#### Alert Notification Settings + +Set the repeat sending strategy, the default repeat notification interval is 10 minutes, and the number of receptions is unlimited by default, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-30.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-31.png) + +Associate alert contacts or groups with the alert template, and when a third-party alert message sending channel is configured, it will automatically send to the associated alert person (email or phone) when the alert is triggered. + +When an alert is triggered, it will first send a message to the alert contact. When the contact has responded or the unresponded time exceeds the set timeout, it will send a notification to the response/timeout contact. + +Select alert contacts or alert contact groups: when the alert object is a database type, you can also check to synchronize and send alerts to project group members. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-32.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-33.png) + +Set the active alert timeout strategy, the modified strategy only takes effect for new alerts, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-34.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-35.png) + +Alert recovery notification settings, if "Send recovery notification" is turned on, the recovery notification will be sent to the recipients who have received the alert notification, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-36.png) + +#### Adjust Alert Items + +The alert items in the alert template are displayed at the bottom of the alert template details page, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-37.png) + +#### Predefined Alerts + +Click "Enable State" to enable or disable the alert item, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-38.png) + +Click to modify the tolerance time, effective time, etc., as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-39.png) + +Click the alert item, and the alert setting page will pop up on the right, where you can set a single alert item, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-40.png) + +#### Custom Alerts + +See the custom feature "Custom Alerts." + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-41.png) + +#### Configure Alert Noise Reduction + +Control the frequency of alert triggers, reduce the frequency of alert message sending, and improve the credibility of alerts. + +**Platform's first alert trigger time** <= Metric collection time (scheduled trigger, when the alert is triggered, it will be less than or equal to this value) + Alert item tolerance time (alert duration, to avoid false alerts) + Alert notification interval (alert waiting grouping, to reduce alert resources); + +**Platform's second alert trigger time** >= Metric collection time + Alert item tolerance time + Notification interval + Repeat notification interval (when the repeat notification interval time does not meet the entire n times collection frequency, it will be delayed to the next metric collection time); + +**Platform alert automatic recovery time** <= Metric collection time + Alert item tolerance time; + +**Metric collection time**: Each metric collection frequency can be different, which can be divided into three frequency levels: high frequency (10s-30s), medium frequency (30s-10m), and low frequency (10m-20m). The specific collection frequency can be seen in the alert item below; + +On the predefined alert page, click the alert item, and the alert setting page will pop up on the right, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-42.png) + +**Tolerance time**: Each alert item can be set independently, and the alert will be triggered after the set threshold condition is continuously met for a certain number of seconds; + +**Effective time**: Each alert item can be set independently, and the alert strategy will only be effective within the set time period; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-43.png) + +**Notification interval**: Group waiting time, when the first end to the alert, it will wait for other alerts to come in, exceeding this time is the same group. Reduce the platform alert resource occupation, the default does not need to be adjusted. + +**Repeat notification interval**: Control the frequency of repeated alerts, if the time from the first trigger of the alert to the second trigger is less than or equal to the repeat notification interval time, then the platform does not trigger the alert, does not send a new alert message, the original alert message count remains unchanged; + +If the time from the first trigger of the alert to the second trigger is greater than the repeat notification interval time, then the platform triggers the alert; if the status of the first alert message has been automatically recovered, manually recovered, or manually ignored, then a new alert message is sent (a new first alert time is generated, the third-party alert channel sends according to the alert template setting, not affected by the response setting of the first alert message), the original alert message count remains unchanged; if the status of the first alert message does not change (including responded and unresponded), then the alert message is sent (the first alert time remains unchanged, the third-party alert channel sends according to the first alert information response rules), the original alert message count +1; + +The time to determine whether an alert automatically recovers is not controlled by the interval time. When the metric collection time plus the alert item's tolerance time still does not trigger the alert threshold, it is judged that the alert has recovered, and the alert message is automatically reset to "Recovered." + +#### Delete Alert Template + +Click "Delete" to delete the alert template, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-44.png) + +#### Clone Alert Template + +Alert templates support copying and cloning; in the alert template list, select the alert template you want to clone, and click 'Clone' to open the 'Clone Dialog', as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-45.png) + +1. Each time you clone, the template name will automatically add a _copy suffix to the original name to generate a new template name, and you can manually modify the template name; + +2. The object type defaults to inheriting the object type of the original template, and you can manually modify the object type. Note that if you clone across object types, the alert item-related configurations will not be cloned; + +3. The description defaults to inheriting the content of the original template's description and supports manual modification; + +#### Display and Binding of Unbound Alert Instances + +When the managed database is not bound to any alert template, there will be a numerical reminder on the overview page. Click to drill down to the alert template page, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-46.png) + +On the alert template page, the number of databases that have not been bound to alerts will be displayed by database. You can view the details after hovering, and click to quickly bind the alert template in the pop-up window, as shown in the following figures: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-47.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-48.png) + +## Custom Threshold Scheme + +### Function Entrance + +Alert Center --> Alert Templates --> Custom Threshold Scheme + +### Function Description + +Configure separate threshold schemes for specified alert items of specified alert objects, and its priority will be higher than the threshold schemes in the template. + +### Operating Instructions + +The custom threshold scheme page includes object types, alert items, alert objects, sub-objects, and threshold configurations. It is sorted by object type and alert item, and you can perform fuzzy searches by alert item and object, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-49.png) + +Click Create, and the setting interface will pop up on the right side of the window, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-50.png) + +Select the object type, including various databases and hosts; + +After selecting a certain type of database, you can single-select the database, single-select the alert item, and each alert item can configure the threshold of that alert item, including those six host alert items in each database alert; + +After selecting the host, you can single-select the host, single-select the alert item, and each alert item can configure the threshold of that alert item; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-51.png) + +Select the alert item, and based on the 3rd and 4th level tag settings in the alert item (predefined and custom), you can specify sub-objects; you can specify multiple groups of sub-objects; each sub-object can configure thresholds; + +Sub-object 1 (the name brought by the alert item configuration), for example, fill in the database name, you can choose "Unrestricted"; + +Sub-object 2 (the name brought by the alert item configuration), for example, fill in the tablespace name, you can choose "Unrestricted"; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-52.png) + +Select the alert object, the alert object plus the alert item must not be repeated; + +The same alert item and sub-objects within the alert object must not be repeated; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-53.png) + +When adding a plan, the default threshold is brought from the custom alert item, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-54.png) + +Click on the policy to slide out the interface, which can be modified, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-55.png) + +Click Delete to delete the policy. After deletion, the threshold strategy for that object's alert item in the template will be used, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-56.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/alert-center/feature-alert-center.md b/product/en/docs-zcloud-for-mogdb/v6.3/alert-center/feature-alert-center.md new file mode 100644 index 0000000000000000000000000000000000000000..998593de78856690dafc3e65fa3fd9ca7f1c37b3 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/alert-center/feature-alert-center.md @@ -0,0 +1,23 @@ +--- +title: Alert Center +author: Guo Huan +date: 2024-08-12 +--- + +# Alert Center + +## Function Entrance 1 + +Overview Page --> Alert Center + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-1.png) + +## Function Entrance 2 + +Overview page --> The text below the "Active Alerts" section on the right side. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-2.png) + +## Function Description + +List alert information and categorize the statistics of unresponded alert information. diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/alert-center/historical-alert.md b/product/en/docs-zcloud-for-mogdb/v6.3/alert-center/historical-alert.md new file mode 100644 index 0000000000000000000000000000000000000000..23f5191a3bf39e5a7c9a577b602dfc651bed771b --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/alert-center/historical-alert.md @@ -0,0 +1,43 @@ +--- +title: Historical Alerts +author: Guo Huan +date: 2024-08-12 +--- + +# Historical Alerts + +## Function Entrance + +Alert Center --> Historical Alerts + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-17.png) + +## Function Description + +Displays historical alert statistics and messages for alerts that have been resolved or expired. + +## Operating Instructions + +The search bar at the top allows you to filter the historical alerts displayed on this page by time, and by filtering statistics objects (database type, statistics object, alert item, custom search), as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-18.png) + +It also supports setting the retention time for historical alerts. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-19.png) + +### Trend Changes + +Statistics and display of the number of alerts generated by projects or databases, based on alert object types (alert object, project group, alert item, handler) and other statistical dimensions, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-20.png) + +### Alert Details + +Displays the details of closed-loop (resolved or expired) alert messages; quick filtering can be done according to alert level, alert status, alert category, project group, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-21.png) + +Click the button on the right to add the alert message to the whitelist, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-22.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/alert-center/prometheus.md b/product/en/docs-zcloud-for-mogdb/v6.3/alert-center/prometheus.md new file mode 100644 index 0000000000000000000000000000000000000000..7ba119e158f04e01ffcb6085229d708a100a72c8 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/alert-center/prometheus.md @@ -0,0 +1,13 @@ +--- +title: Prometheus +author: Guo Huan +date: 2024-08-12 +--- + +# Prometheus + +## Operating Instructions + +After the alert template configuration takes effect, you can check it in the Prometheus alert items. Wait for a while (about 1-2 minutes) and then log in to the Prometheus management page of the platform to see if the collection is successful. The address is: `http://platform_IP_address:8093`. Click on status --> rules page and search according to the custom alert name. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-92.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/alert-center/whitelist-of-alerts.md b/product/en/docs-zcloud-for-mogdb/v6.3/alert-center/whitelist-of-alerts.md new file mode 100644 index 0000000000000000000000000000000000000000..4c8e838031de48691d32b15ff938f1cd999d1cbc --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/alert-center/whitelist-of-alerts.md @@ -0,0 +1,41 @@ +--- +title: Alert Whitelist +author: Guo Huan +date: 2024-08-12 +--- + +# Alert Whitelist + +## Function Entrance + +Alert Center --> Alert Whitelist + +## Function Description + +Create an alert whitelist so that alerts for the configured objects within the effective time period will not be triggered. The whitelist defaults to only intercepting newly generated alerts and does not process historical alerts. + +## Operating Instructions + +Click the "Create" button to create a new whitelist. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-86.png) + +Select the whitelist object type, alert object, check the alert items (multiple selections are possible), and choose the start and end times for the whitelist to be effective. + +Some alert items can have a finer granularity of whitelist, which can be precise to tablespaces, file systems, etc. + +The effective time for the alert whitelist supports permanent, specified periodic, and one-time settings: + +1. Permanent: The whitelist is permanently effective. + +2. Specified Period: The whitelist can be periodically effective within the set time period. + +3. Specified Once: The whitelist is effective within a specified fixed time period. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-87.png) + +Click "Confirm" to save. + +On the whitelist list page, click "Edit" to modify the whitelist, + +Click "Delete" to delete the whitelist. \ No newline at end of file diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/backup-recovery-center/backup-management.md b/product/en/docs-zcloud-for-mogdb/v6.3/backup-recovery-center/backup-management.md new file mode 100644 index 0000000000000000000000000000000000000000..64aced41aca3a42ad9913b2d5a4cb4094ca4cbc5 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/backup-recovery-center/backup-management.md @@ -0,0 +1,185 @@ +--- +title: Backup Management +author: Guo Huan +date: 2024-08-12 +--- + +# Backup Management + +## Backup Policies + +### Function Entrance + +Left-hand menu: Backup and Recovery Center --> Backup Policies + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/backup-recovery-center/backup-recovery-center-13.png) + +### Function Description + +To prevent data loss or corruption, you can use policy-based backup or manual backup to back up the database; backup policies initiate backup tasks on a schedule; after a successful backup, a backup dataset is generated and displayed in the backup dataset list. + +### Operating Instructions + +#### Backup Overview + +Statistics on the creation of backup policies for MogDB/openGauss databases, execution status of backup tasks, status of backup servers, and status of backup media. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/backup-recovery-center/backup-recovery-center-14.png) + +Select database types and databases to view the backup policy creation status and backup task statistics for the selected databases. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/backup-recovery-center/backup-recovery-center-15.png) + +Click on the edit icon next to the time to view the task execution status for the recent period. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/backup-recovery-center/backup-recovery-center-16.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/backup-recovery-center/backup-recovery-center-17.png) + +#### Backup Policy List + +Displays databases that have created backup policies and shows multiple policies for the same database under the database unit; + +Displays the specific content of the policy and the status and time of the last backup task execution; + +Search for backup databases, backup media directories, filter database types, and recent backup task statuses in the search box to retrieve policies. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/backup-recovery-center/backup-recovery-center-18.png) + +#### Create Backup Policy + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/backup-recovery-center/backup-recovery-center-19.png) + +**Field Descriptions** + +- Physical Backup: Backs up the database by copying data files or data blocks; + +- Physical Full Backup: Full backup indicates a complete backup of all files; + +- Archive Backup: Backs up the database's change logs, which is part of the physical backup and is usually lightweight and does not affect production operations; + +- Incremental Backup: Each time, only the differences (data blocks) relative to the last full backup or incremental backup are backed up; + +- Backup Media: Refers to the backup space for backup data; + +- Concurrency: The number of backup concurrency opened for each policy for each database. + +#### Modify Backup Policy + +Click on Modify in the operation column to modify the current policy information and initiate a backup; modifications do not affect running or waiting backup tasks and only take effect for subsequent tasks. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/backup-recovery-center/backup-recovery-center-20.png) + +#### Delete Backup Policy + +Click on Delete in the operation column or select the policies to be deleted and then click on Delete; deleting a policy does not affect running or waiting backup tasks. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/backup-recovery-center/backup-recovery-center-21.png) + +#### Batch Adjust Backup Time + +Select one or more policies, click on Batch Adjust Backup Time, a pop-up window will appear, and you can modify the backup period and backup time window. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/backup-recovery-center/backup-recovery-center-22.png) + +#### Immediate Backup + +Click on Immediate Backup in the operation column to immediately execute the current policy and initiate a backup. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/backup-recovery-center/backup-recovery-center-23.png) + +#### Enable/Disable Backup Policy + +Click on the Enable/Disable switch to enable or disable the policy. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/backup-recovery-center/backup-recovery-center-24.png) + +## Physical Backup Datasets + +### Function Entrance + +Left-hand menu: Backup and Recovery Center --> Backup Management --> Backup Datasets --> Physical Backup + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/backup-recovery-center/backup-recovery-center-25.png) + +### Function Description + +Displays the list of datasets generated after a physical backup is completed. + +### Operating Instructions + +Datasets with the status "Available" or "Available but with warnings during the process" can be used for recovery. + +Backup statuses include Available, Available but with warnings, Invalid, and Cleanup Failed: + +- Available: Can be used for recovery +- Available but with warnings: Can be used for recovery, but there were warnings during the backup process; +- Invalid: Retention period expired or files have been deleted but the backup dataset record has not been deleted +- Cleanup Failed: Failed to delete files on the medium + +Click on the icons next to Full Backup and Incremental Backup to display the [Dependencies] pop-up window, showing all incremental backups under the full backup. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/backup-recovery-center/backup-recovery-center-26.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/backup-recovery-center/backup-recovery-center-27.png) + +If there is a break in the archive backup, a red warning icon will be displayed on the left side of the database. Hovering over the icon will show: There is an archive break, and recovery is only possible up to the break point. + +#### View Backup Details + +Hover over the backup details to view the backup details information. + +#### View Parameter Files, Backup Scripts, and Log Details + +Click on Parameter Files, Backup Scripts, and Log Details in the operation column to display the corresponding pop-up windows. + +#### Delete + +Click on the buttons in the operation column: You can view data files, parameter files, backup scripts, and log details. + +When deleting a full backup, all incremental backups under the full backup will be cleaned up first, then the full backup; when deleting an incremental backup, only the backup set of the current incremental backup will be deleted. + +- By default, delete the backup files on the medium, which cannot be canceled; you can manually check to delete the backup set record, only check the backup files, the backup set list will retain the backup set record, and the status will change to Invalid. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/backup-recovery-center/backup-recovery-center-28.png) + +If the deletion of files on the medium fails, the status will change to Cleanup Failed. + +## Backup Tasks + +### Function Entrance + +Left-hand menu: Backup and Recovery Center --> Backup Management --> Backup Tasks + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/backup-recovery-center/backup-recovery-center-29.png) + +### Function Description + +Displays information on backup tasks initiated by backup policies and manual backup tasks. + +### Operating Instructions + +#### Manual Backup + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/backup-recovery-center/backup-recovery-center-30.png) + +Click on the [Manual Backup] button. + +Manual backup is basically the same as creating a backup policy, with the following differences: + +- Does not support multi-selecting databases +- Manual backup removes the checkbox: Only displays databases that have not set up a backup policy +- Manual backup supports backup on the medium and the local machine +- Manual backup removes policy status + +Supports selecting backup on the local machine and the medium, after selecting the local machine, select the file system, view file system space information, and enter the file directory. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/backup-recovery-center/backup-recovery-center-31.png) + +#### Stop Backup Task + +Supports stopping or batch stopping backup tasks with statuses of Running or Waiting. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/backup-recovery-center/backup-recovery-center-32.png) + +Forcefully stop the backup task, and the task status will change to Backup Failed. diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/backup-recovery-center/backup-recovery-center.md b/product/en/docs-zcloud-for-mogdb/v6.3/backup-recovery-center/backup-recovery-center.md new file mode 100644 index 0000000000000000000000000000000000000000..d0d581d76df04c1a088fe617c87b9489d4133b74 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/backup-recovery-center/backup-recovery-center.md @@ -0,0 +1,11 @@ +--- +title: Backup Recovery Center +author: Guo Huan +date: 2024-08-12 +--- + +# Backup Recovery Center + ++ **[Backup Server Management](./backup-server-management.md)** ++ **[Backup Management](./backup-management.md)** ++ **[Recovery Management](./recovery-management.md)** diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/backup-recovery-center/backup-server-management.md b/product/en/docs-zcloud-for-mogdb/v6.3/backup-recovery-center/backup-server-management.md new file mode 100644 index 0000000000000000000000000000000000000000..a5d64c6641671bc83af0339c96b3a31f62e1d248 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/backup-recovery-center/backup-server-management.md @@ -0,0 +1,103 @@ +--- +title: Backup Server Management +author: Guo Huan +date: 2024-08-12 +--- + +# Backup Server Management + +## Function Entrance + +Top right corner configuration --> Platform Configuration Management --> Backup Media Management + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/backup-recovery-center/backup-recovery-center-1.png) + +## Function Description + +Designate existing backup spaces on the backup server (such as NFS, FS, etc.) as backup media. The backup server supports LINUX6,7, Kylin V10, and openEuler. + +## Prerequisites + +1. The backup server has been managed by the zCloud platform. For details, refer to the "User Manual" --> "Platform Basic Features" --> "Host Resource Pool" in the document center; + +2. When backing up MogDB/openGauss, you need to match the corresponding version of the MogDB and openGauss installation package in the media management after logging in to the platform with spadmin; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/backup-recovery-center/backup-recovery-center-2.png) + +## Operating Instructions + +### Designate Backup Server and Backup Media + +Click on the backup media tab, and click on [Designate Backup Media]; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/backup-recovery-center/backup-recovery-center-3.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/backup-recovery-center/backup-recovery-center-4.png) + +Select the host, click on scan, and scan the backup server information; + +The backup server description field defaults to: related resource pool, room, and region information; + +You can modify the backup server description and select the designated backup IP; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/backup-recovery-center/backup-recovery-center-5.png) + +Click on rescan to reselect the host; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/backup-recovery-center/backup-recovery-center-6.png) + +Scanning the host will list the undesignated backup spaces. Enter the subdirectory, project group, and other information to designate a new medium; + +Designate project group: Designate the medium for which project groups can be used. If no project group is selected, it means there is no project group limit. + +Designate purpose: Backup purposes support multiple selections or no selection. After selecting the purpose, only backup media matching the purpose can be chosen when creating a backup strategy. If it is empty, there is no purpose limit; + +Designate network segment: Backup network segments support multiple inputs or no input. After inputting the network segment, it is recommended (not mandatory) to use the same network segment backup media when creating a backup strategy. If it is empty, there is no network segment limit; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/backup-recovery-center/backup-recovery-center-7.png) + +If you need to add a medium that has already designated the backup space, please click on the new backup medium and select the backup space, enter the subdirectory, and other information to generate a new medium directory. + +After designation, you can view the information in the backup media list and the backup server list. + +### Backup Media Management + +You can modify or cancel the designation of designated backup media. + +When canceling the designation of a backup medium, all backup set record information related to this backup medium will be cleaned up, but the backup data on the server will not be deleted. + +#### Modify Backup Media + +Click on the backup media tab, and click on [Modify], as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/backup-recovery-center/backup-recovery-center-8.png) + +After modifying the settings, it will not affect the backup tasks that are running or waiting; + +However, if the concurrency is modified, it will take effect immediately after clicking [Confirm]. + +#### Cancel Backup Media + +When canceling, all backup set records associated with the backup medium will be cleared; but the backup data on the medium will not be deleted. If you need to delete the backup data, you need to delete it manually. + +If the current backup medium is referenced by a backup strategy, it cannot be canceled. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/backup-recovery-center/backup-recovery-center-9.png) + +### Backup Server Management + +Click on the backup server tab to display the details of the backup server list. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/backup-recovery-center/backup-recovery-center-10.png) + +#### Modify Backup Server + +When modifying the backup server, it will not affect the backup tasks that are running or waiting. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/backup-recovery-center/backup-recovery-center-11.png) + +#### Cancel Designated Server + +When canceling the designation of the server, it will cancel the server and the associated backup media; it will clear all backup set records associated with the backup medium; it will not delete the backup data on the medium. If you need to delete it, you need to delete the data manually. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/backup-recovery-center/backup-recovery-center-12.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/backup-recovery-center/recovery-management.md b/product/en/docs-zcloud-for-mogdb/v6.3/backup-recovery-center/recovery-management.md new file mode 100644 index 0000000000000000000000000000000000000000..4419c239576e26b9b035a1c3e2d16b1b8b3becb2 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/backup-recovery-center/recovery-management.md @@ -0,0 +1,49 @@ +--- +title: Recovery Management +author: Guo Huan +date: 2024-08-12 +--- + +# Recovery Management + +## Physical Recovery + +### Function Entrance + +Left-hand menu bar --> Backup and Recovery Center --> Recovery Management --> Physical Recovery + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/backup-recovery-center/backup-recovery-center-33.png) + +### Function Description + +Physical recovery of backup data. + +### Operating Instructions + +#### Create Recovery Task + +① Fill in the source database information and target database information, then click Next to proceed to tablespace mapping; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/backup-recovery-center/backup-recovery-center-34.png) + +② After setting the tablespace mapping, click Next to proceed to pre-recovery validation; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/backup-recovery-center/backup-recovery-center-35.png) + +③ After the pre-recovery validation, click the Confirm button to complete the creation of the recovery task and navigate to the Physical Recovery Task List page. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/backup-recovery-center/backup-recovery-center-36.png) + +#### Physical Recovery Task List + +① Physical Recovery Task List: Displays all created physical recovery tasks and task details and status information; + +② Create Recovery Task button: Click to navigate to the Create Recovery Task page; + +③ Filter: Click to expand the filtering options, where you can add or delete filtering conditions; + +⑤ View Logs: View the operation logs of the recovery task; + +⑥ More: Click the drop-down to display the Stop Recovery and View Script buttons, and click the corresponding button to perform the respective functions. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/backup-recovery-center/backup-recovery-center-37.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/additional-information-management.md b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/additional-information-management.md new file mode 100644 index 0000000000000000000000000000000000000000..96694f317346d8d31af20e3a822f2c4743578ba0 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/additional-information-management.md @@ -0,0 +1,41 @@ +--- +title: Additional Information Management +author: Guo Huan +date: 2024-08-12 +--- + +# Additional Information Management + +## Function Entrance + +Platform Management User spadmin --> Platform Configuration Management --> Database Additional Information Management + +## Function Description + +A new custom attribute feature added after zCloud V2.7.3 version, where values can be obtained from the CMDB interface. + +Users can add custom attribute fields for databases, instances, or users. The added attribute fields will display custom attributes when viewing object details. + +## Operating Instructions + +The attribute object supports switching between database types, with custom attributes for different database types displayed separately; + +Click the "Create" button to create a new custom attribute: + +1. Display Name is the name shown on the page; + +2. Type options may vary depending on the database type; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-104.png) + +Example of creating an instance-level attribute for MogDB "Database Administrator". + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-105.png) + +After obtaining the value from CMDB, it can be viewed in the Additional Information tab of MogDB "Instance Management". + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-106.png) + +You can also click Edit and Delete to make adjustments. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-107.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/basic-data-definition.md b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/basic-data-definition.md new file mode 100644 index 0000000000000000000000000000000000000000..9e413bd5275cee978a65d13c4b68e4513ca1eb7b --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/basic-data-definition.md @@ -0,0 +1,42 @@ +--- +title: Basic Data Definition +author: Guo Huan +date: 2024-08-12 +--- + +# Basic Data Definition + +## Function Entrance + +Login as spadmin --> Platform Configuration Management --> Basic Data Definition + +## Function Description + +Manage the platform's basic data definitions, as well as the management of host resource pools and database resource pools. + +## Operating Instructions + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-68.png) + +Basic resource definitions include the essential information required for platform creation or management operations and can be adjusted according to actual conditions. No special adjustments are needed by default. + +At present, only the following two basic data items need to be focused on: + +| Basic Data | Description | +| -------- | ------------------------------------------ | +| Region | The area where the machine room or host is located, can be configured according to cities or regions | +| Availability Zone | The usable areas within a region, used when configuring host resource pools | + +Region as shown in the figure below: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-69.png) + +Availability Zone as shown in the figure below: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-70.png) + +Database specifications can configure the number of CPUs, memory size, IOPS, disk throughput, and disk space. + +**Note: Disk space resource limits are only supported for Linux CentOS/RedHat 7.X/8.X versions, and the file system format for the database instance data directory must be xfs, with the specified prjquota parameter for mounting.** + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-71.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/basic-features.md b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/basic-features.md new file mode 100644 index 0000000000000000000000000000000000000000..55f3a5431309c0c59ead30d65ccaa29fb704a440 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/basic-features.md @@ -0,0 +1,34 @@ +--- +title: Basic Features +author: Guo Huan +date: 2024-08-12 +--- + +# Basic Features + ++ **[Introduction](./introduction-to-platform-basic-features.md)** ++ **[Platform Tenant Management](./platform-tenant-management.md)** ++ **[Platform User Management](./platform-user-management.md)** ++ **[TOTP Certification](./totp-certification.md)** ++ **[Basic Data Definition](./basic-data-definition.md)** ++ **[Media Management](./media-management.md)** ++ **[Command Management](./command-management.md)** ++ **[Mail Server Configuration](./mail-server-configuration.md)** ++ **[Job Center](./job-center.md)** ++ **[Platform Host Resource Pool](./platform-host-resource-pool.md)** ++ **[Platform Database Pool](./platform-database-pool.md)** ++ **[Platform Proxy Nodes Management](./platform-proxy-nodes-management.md)** ++ **[Platform Components Management](./platform-components-management.md)** ++ **[Additional Information Management](./additional-information-management.md)** ++ **[Operation Log](./operation-log.md)** ++ **[Connection Concurrency Configuration](./connection-concurrency-configuration.md)** ++ **[Customization of Platform Styles](./customization-of-platform-styles.md)** ++ **[Parameter Templates](./parameter-template.md)** ++ **[License](./license.md)** ++ **[Monitor Large Screen](./monitor-large-screen.md)** ++ **[Overview Display](./overview-display.md)** ++ **[Tenant User Management](./tenant-user-management.md)** ++ **[Tenant Host Resource Pool](./tenant-host-resource-pool.md)** ++ **[Tenant Proxy Nodes Management](./tenant-proxy-nodes-management.md)** ++ **[Menu Management](./menu-management.md)** ++ **[Report Center](./report-center.md)** \ No newline at end of file diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/command-management.md b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/command-management.md new file mode 100644 index 0000000000000000000000000000000000000000..82c57f3d634c884a21f2da9b190ab38893816e3d --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/command-management.md @@ -0,0 +1,17 @@ +--- +title: Command Management +author: Guo Huan +date: 2024-08-12 +--- + +# Command Management + +## Function Entrance + +Platform management user spadmin logs in --> Platform Configuration Management --> Command Management + +## Function Description + +Command Management configures the commands used by the database service platform on the operating system, such as a series of commands for database creation. If you encounter an operating system that has not been adapted, you can add the type to this list, then modify the command to update the cache, and retry. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-80.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/connection-concurrency-configuration.md b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/connection-concurrency-configuration.md new file mode 100644 index 0000000000000000000000000000000000000000..a3d038c0fd2811e875e32f387a9cf5799a72a85a --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/connection-concurrency-configuration.md @@ -0,0 +1,25 @@ +--- +title: Connection Concurrency Configuration +author: Guo Huan +date: 2024-08-12 +--- + +# Connection Concurrency Configuration + +## Function Entrance + +Platform user logs in --> Platform Configuration Management --> Connection Concurrency Configuration + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-116.png) + +## Function Description + +Set the concurrency numbers for proxy components/processes and target host agent components/processes. + +The platform has default configurations for proxy templates and host templates. The proxy template is for all proxy clusters, and the host template is for all host resources in the pool. You can modify the concurrency numbers in both templates. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-117.png) + +You can also configure separate connection concurrency schemes for specific objects, which will have a higher priority than the configurations in the templates. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-118.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/customization-of-platform-styles.md b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/customization-of-platform-styles.md new file mode 100644 index 0000000000000000000000000000000000000000..e282877ccd7d379697f5a04ecc4fe8f0b64acd7e --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/customization-of-platform-styles.md @@ -0,0 +1,41 @@ +--- +title: Customization of Platform Styles +author: Guo Huan +date: 2024-08-12 +--- + +# Customization of Platform Styles + +## Function Entrance + +Platform user logs in --> Platform Configuration Management --> Customize Theme + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-119.png) + +## Function Description + +On this page, users can edit the custom theme name, background template, login page LOGO, product page LOGO, and product copyright information of the login page to display product information that is more in line with the company's personalized identity. + +## Operating Instructions + +You can set a custom theme color. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-120.png) + +Product name is required, can not be empty, the user can fill in the 1-24 characters of the custom theme name, the mouse pointer placed in the input box after the hover prompt box to see the editing of the content of the position of the display. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-121.png) + +The Login Page Background, Login Page Logo, and Product Page Logo in the Image Configuration are required and can be uploaded within 2MB. The recommended size of the uploaded image is shown at the back of the upload box. Place the mouse pointer on the hover box after the upload box to see where the uploaded content will be displayed. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-122.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-123.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-124.png) + +After the user has edited the custom theme items, click the Save Theme button, and the configured content will be displayed. Clicking the Restore Theme button will revert the theme to the default zCloud theme configuration. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-125.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-126.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/introduction-to-platform-basic-features.md b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/introduction-to-platform-basic-features.md new file mode 100644 index 0000000000000000000000000000000000000000..cc7e28da55c263ed60b497ed0aa6ba3767e0db6b --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/introduction-to-platform-basic-features.md @@ -0,0 +1,27 @@ +--- +title: Introduction +author: Guo Huan +date: 2024-08-12 +--- + +# Introduction + +**Platform Login URL**: `http://:` + +The default web port is 8080, which can be adjusted. + +**Platform Login Interface** is as follows: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-1.png) + +The zCloud platform is divided into platform users and tenant users. + +**Platform Users**: Manage basic platform parameters, manage media, manage infrastructure, etc.; + +**Tenant Users**: Involved in the management and monitoring of specific databases, can manage users and infrastructure within their own tenant. + +The default platform-level management user for zCloud is: spadmin + +After the platform management user logs in, the interface is as follows, showing statistical presentations of the entire cloud platform's tenants, managed hosts, and types and quantities of databases: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-2.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/job-center.md b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/job-center.md new file mode 100644 index 0000000000000000000000000000000000000000..f08f5abc18b2ef8f201c72c0d2f515f6cfbccd15 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/job-center.md @@ -0,0 +1,17 @@ +--- +title: Job Center +author: Guo Huan +date: 2024-08-12 +--- + +# Job Center + +## Function Entrance + +Login as the spadmin user --> Top menu bar --> Job Center + +## Function Description + +The Job Center allows you to view tasks executed by this user across various modules on the platform. You can check the progress and completion status. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-82.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/license.md b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/license.md new file mode 100644 index 0000000000000000000000000000000000000000..16864b1ed4a38af3238cc1f82081e7ce794d1b0e --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/license.md @@ -0,0 +1,21 @@ +--- +title: License +author: Guo Huan +date: 2024-08-12 +--- + +# License + +## Function Entrance + +Login as the platform user --> License + +## Function Description + +View the current platform license information and purchased modules, as well as update the license. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-130.png) + +To update the platform license, enter the new license number and click the "Update" button. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-131.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/mail-server-configuration.md b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/mail-server-configuration.md new file mode 100644 index 0000000000000000000000000000000000000000..cbf2be28b96a56bba0c428e930d810d289920459 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/mail-server-configuration.md @@ -0,0 +1,19 @@ +--- +title: Mail Server Configuration +author: Guo Huan +date: 2024-08-12 +--- + +# Mail Server Configuration + +## Function Entrance + +Login as the platform management user spadmin --> Platform Configuration Management --> Mail Server Configuration + +## Function Description + +Responsible for configuring the platform's mail server, which can be used to send out inspection subscriptions via email. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-81.png) + +For detailed configuration steps, please refer to [Alert Message Sending Channel](../alert-center/alert-message-sending-channel.md). diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/media-management.md b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/media-management.md new file mode 100644 index 0000000000000000000000000000000000000000..c233df681c1b0f8945f76bedb3d3cb6b46958cc2 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/media-management.md @@ -0,0 +1,55 @@ +--- +title: Media Management +author: Guo Huan +date: 2024-08-12 +--- + +# Media Management + +## Function Entrance + +Login as the platform management user spadmin --> Installation Configuration --> Media Management + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-72.png) + +## Function Description + +Manage the platform's installation media, allowing you to upload media and associate it with database installation media based on relevant versions and operating systems. + +## Operating Instructions + +### Media Entry Management + +Click "Create" in the upper right corner to create a media entry. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-73.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-74.png) + +Click the expand symbol of the media entry to view the details of the media entry. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-75.png) + +### Online Media Upload + +Click "Upload File" to upload and update media online. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-76.png) + +Click "Select File" to choose the file to upload, and you can also check "Delete existing files at the same time" to remove the original media. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-77.png) + +After the progress reaches 100%, click Complete. + +### Offline Media Upload + +You can upload media to the platform server's media directory from the backend, with different paths for each type of media. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-78.png) + +Click "Match Existing Files" under the media entry, and the platform will automatically query the files in the path and calculate the MD5 value. Check the matched media. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-79.png) + +Click "Confirm" to save. diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/menu-management.md b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/menu-management.md new file mode 100644 index 0000000000000000000000000000000000000000..a82e40d7e5965e3434cb58e33dfc5266bf34d08e --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/menu-management.md @@ -0,0 +1,21 @@ +--- +title: Menu Management +author: Guo Huan +date: 2024-08-12 +--- + +# Menu Management + +## Function Entrance + +Top navigation menu management + +## Function Description + +Responsible for managing the horizontal navigation bar on the tenant's interface. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-215.png) + +You can quickly add or remove shortcuts in the top navigation bar: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-216.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/monitor-large-screen.md b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/monitor-large-screen.md new file mode 100644 index 0000000000000000000000000000000000000000..8c79b0c44ecb14c6255eaa1fe90d819fd2440e59 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/monitor-large-screen.md @@ -0,0 +1,188 @@ +--- +title: Monitor Large Screen +author: Guo Huan +date: 2024-08-12 +--- + +# Monitor Large Screen + +## Function Entrance + +Tenant user logs in --> Top navigation bar --> Monitoring Dashboard + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-132.png) + +## Function Description + +The monitoring dashboard allows for real-time monitoring of databases, providing a unified visual display of platform databases from business perspectives and database types, facilitating quick reviews of key indicators. + +For routine monitoring and night shifts, the monitoring dashboard is an important entry point for detecting issues. + +Database types supported: + +**openGauss/MogDB** + +Monitoring dashboard features include: + +- Support for monitoring key indicators of databases across the entire network or within a custom range; +- Support for receiving active alerts and alert voice broadcasts; +- Support for rotating views of database topology, latency, traffic, direction, and other key information; +- Support for rotating views of key performance metrics and memory status of databases. + +## Operating Instructions + +### Page Layout + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-133.png) + +### Key Indicator TOP List + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-134.png) + +1. The indicator ranking for all databases within the monitoring scope, with databases identified by their Chinese names (IPs); + +2. Key indicators default to: + + - CPU usage rate + - Memory usage rate + - Disk usage rate + - Active session count + +3. Users can customize key indicators by going to the page's [Settings] - [Display Settings]; + +4. The key indicator TOP list displays up to 2 indicators per page and regularly rotates to other indicators, or you can quickly switch by clicking on the title; + +5. Users can customize the TOP list's statistical range through the page's [Settings] - [Monitoring Settings], supporting settings for TOP10, TOP20, TOP50; + +6. Clicking on an individual database in the TOP list directly switches to the corresponding database to view topology and detailed information; + +### Active Alert Messages + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-135.png) + +1. Displays current active alert messages, filtering out alerts that are ignored or related to host types; + +2. Active alert messages rotate regularly to the next alert, or you can quickly switch by clicking the arrow in the upper right corner; + +3. Users can customize alert voice broadcasts through the page's [Settings] - [Monitoring Settings], which will play voice messages immediately when new alerts arrive. + +### Rotating Databases + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-136.png) + +1. Displays the currently rotating database, following a left-to-right order; + +2. Each card shows the database type icon, Chinese name, IP; + +3. You can quickly switch databases by clicking on individual cards or by clicking the arrows on either side to switch to the next page; + +4. The rotation includes databases from the key indicator TOP list, alerted databases, and databases manually followed by users; + +5. The rotation order is: followed databases > alerted databases > TOP list triggered thresholds > TOP list untriggered thresholds, and the page will re-sort according to this order after each data refresh; + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-137.png) + +6. When users want to continuously monitor a specific database, they can click the [Pause Rotation] button in the upper right corner of the page. After pausing, the page data will refresh, but the rotation will not automatically switch to the next database set, and the currently viewed database will remain within the rotation range. + +### Database Details - Topology Diagram + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-138.png) + +1. Displays the topology diagram of the currently rotating database; + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-139.png) + +2. Each icon represents an instance or node, showing the name and IP of each node; + +3. When a node's operational status is stopped, the icon turns red, and when database metrics exceed thresholds, the icon turns yellow; + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-140.png) + +4. Each base frame represents a group, showing the name, region, and machine room; + +5. The connections between groups show the data flow, traffic, and latency between primary and secondary databases; + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-141.png) + +6. Clicking on an individual node displays detailed information for that node, with detail fields consistent with the details shown in the right-side chart. You can configure this through [Settings] - [Display Settings]; + +7. Prioritize displaying stopped or threshold-exceeded nodes; when multiple nodes are abnormal or no anomalies exist, prioritize displaying nodes higher in the hierarchy (upper right of the page). + +### Database Details - Right-Side Charts + +1. The right side displays detailed information for the currently rotating database; + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-142.png) + +2. Displays the rotation reason for the current database, including: severe alerts - warning alerts - followed - TOP list; + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-143.png) + +3. Displays the last hour's instance details for the current database, defaulting to: + + - CPU usage rate + - Active session count + - Network traffic/s + - IO traffic/s + +4. Users can customize detail metrics through the page's [Settings] - [Display Settings]; + +5. Detail metrics display up to 4 indicators per page and regularly rotate to other indicators, or you can quickly switch by clicking on the title; + +6. When a database has multiple instances, detail metrics will display up to 5 instances at most; + +7. Displays the memory status of the current database, defaulting to the following three, with differences based on database type: + + - Space usage + - Archive space usage + - Memory usage + +### Settings + +1. Settings entry: Click the [Settings button] in the upper right corner of the page to open the settings pop-up window; + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-144.png) + +2. Choose dashboard scheme: + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-145.png) + + - 2.1 Save the monitoring dashboard's settings as a scheme for quick switching between monitoring schemes. Switching takes effect after clicking [Save]; + - 2.2 The default scheme for the monitoring dashboard is "zCloud Monitoring Dashboard." After modifying the scheme, click [Save] to take effect; + - 2.3 Click [New Scheme] to create a new scheme. Enter a name for the new scheme, supporting 5-20 characters, no duplicates; + - 2.4 After setting up the new scheme, click [Save] to create it successfully. Click [Cancel] to abandon the new scheme and select the previous scheme; + - 2.5 Click [Delete Scheme]. There will be a confirmation pop-up. After confirming, the scheme will be deleted. The default scheme's delete button is disabled, and hovering will show "Default scheme cannot be deleted"; + - 2.6 Click [Set Default Scheme]. There will be a setting pop-up to set a scheme as the default. Entering the page will prioritize the default scheme; + - 2.7 If users modify and close the pop-up or switch schemes without saving, there will be a pop-up reminder "Current modifications are not saved, do you want to discard the save?"; + +3. Monitoring settings: + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-146.png) + + - 3.1 Monitoring scope: The range of databases participating in monitoring, only databases and instances within the scope will be monitored for metrics and alerts; + - 3.2 The default monitoring scope is all network databases, referring to all databases the current user has permission to monitor; + - 3.3 Support for selecting a custom range, allowing users to select databases and instances they want to monitor, supporting quick filtering by project group and role; + - 3.4 Refresh interval: The data refresh interval for the monitoring dashboard, defaulting to 60 seconds, supporting settings from 30 to 3600 seconds. Note that active alert monitoring defaults to a 10-second refresh and is not controlled by the refresh interval; + - 3.5 Key performance indicator statistics: The range for the TOP list statistics on the left side of the page, supporting settings for TOP10, TOP20, TOP50, defaulting to TOP10; + - 3.6 Alert notification settings: When new active alerts occur, voice alert notifications can be triggered; + +4. Rotation settings: + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-147.png) + + - 4.1 Support for users to add followed databases to participate in rotation, up to 20 databases can be followed; + - 4.2 Following databases only supports selecting databases set to be monitored in "Monitoring Settings"; + +5. Display settings: + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-148.png) + + - 5.1 Customize the title of the monitoring dashboard, supporting 5-20 characters; + - 5.2 Customize the theme color of the monitoring dashboard; + - 5.3 Customize the configuration of key indicator TOP lists and database performance indicators. When setting database indicators, distinguish between database types and set them separately by switching databases using the drop-down menu; + - 5.4 Key indicators and indicator indicators have 4 default indicators that cannot be modified in name and expression but can have thresholds and enablement set; + - 5.6 Support for users to add up to 4 custom indicators; + - 5.7 Customize indicator names, supporting 2-16 characters; + - 5.8 Enter Prometheus expressions to obtain the data needed for indicator display, supporting 1-4096 characters; + - 5.9 Set indicator thresholds, which will be marked in red in the corresponding charts when the threshold conditions are met; + - 5.10 Choose whether to enable, disabled indicators will not be displayed on the monitoring dashboard. diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/operation-log.md b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/operation-log.md new file mode 100644 index 0000000000000000000000000000000000000000..06b3716d72ab148f2f81d5e8f90cd73951753d2b --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/operation-log.md @@ -0,0 +1,53 @@ +--- +title: Operation Log +author: Guo Huan +date: 2024-08-12 +--- + +# Operation Log + +## Platform User Operation Log + +### Function Entrance + +Platform user logs in --> Platform Operation Management --> Operation Log + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-108.png) + +### Function Description + +Records the operations of platform users on the platform, which can serve as an audit record for the platform. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-109.png) + +## Tenant User Operation Log + +### Function Entrance + +Tenant user logs in --> Platform Operation Management --> Operation Log + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-110.png) + +### Function Description + +Records the operations of platform users on the platform, which can serve as an audit record for the platform. + +### Operating Instructions + +You can select the statistical time range through the top right corner of the page, or search for specific operators and objects of operation. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-111.png) + +The top of the page displays the number of logins, number of users logged in, and users who have not logged in. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-112.png) + +Click on the expand detail to view specific login information. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-113.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-114.png) + +The list below displays operation log information, supporting filtering by type of operation object, type of operation, and operation status. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-115.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/overview-display.md b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/overview-display.md new file mode 100644 index 0000000000000000000000000000000000000000..bbd6915e6b95d2ec72474eaf168b660826c236c7 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/overview-display.md @@ -0,0 +1,73 @@ +--- +title: Overview Display +author: Guo Huan +date: 2024-08-12 +--- + +# Overview Display + +## Function Entrance + +Expand the left-hand menu --> Overview + +## Function Description + +On the Overview page, you can view a detailed summary of all databases in the platform; the Overview is divided into two perspectives: Monitoring Overview and Total Assets Overview. + +**Monitoring Overview**: Statistics and display of alert situations, database health, performance charts, inspection conditions, and other information. + +**Total Assets Overview**: Statistics and display of the types and quantities of managed hosts and databases under the current tenant; this page also provides entry points for creating databases, managing databases, and managing hosts. + +## Operating Instructions + +### Monitoring Overview + +Switch between monitoring and asset perspectives through the top tabs; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-149.png) + +When viewing the monitoring overview, you can select a specific database type for statistics in the upper left corner of the page, with all databases displayed by default; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-150.png) + +The page displays an overview of active alerts, and you can drill down to the Alert Center by clicking the numbers or the transfer icon in the title; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-151.png) + +The page displays a statistical overview of inspection results, and when the statistical object is a single database, you can drill down to the corresponding database inspection center to view the summary of inspection issues; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-152.png) + +The performance chart section displays CPU usage, memory usage, IOPS, Page In, and active session numbers, and you can sort the charts and select the viewing time; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-153.png) + +### Total Assets Overview + +Under the Total Assets Overview perspective, you can view the quantity of machines used by all databases and the number of hosts in the corresponding host resource pool for that type of database; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-154.png) + +When hovering over the database resource card, expand the resource statistics list and quick transfer link buttons under that database type; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-155.png) + +For individual database resources, when hovering, the top icon is displayed, supporting manual pinning to the main panel for display; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-156.png) + +Click on the corresponding host resource pool statistics item to jump to the details of the corresponding host resource pool; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-157.png) + +Click the quick link to quickly jump to the corresponding functional page; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-158.png) + +The host type panel supports expanding details on hover, and clicking the corresponding resource jumps to the host list page, where the status after filtering by this type is displayed; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-159.png) + +For individual host resources, when hovering, the top icon is displayed, supporting manual pinning to the main panel for display. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-160.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/parameter-template.md b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/parameter-template.md new file mode 100644 index 0000000000000000000000000000000000000000..d40e8e4f0c44ea3347a6c34f88a8e9b662d82c37 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/parameter-template.md @@ -0,0 +1,25 @@ +--- +title: Parameter Templates +author: Guo Huan +date: 2024-08-12 +--- + +# Parameter Templates + +## Function Entrance + +Platform user logs in --> Installation Configuration --> Database Parameter Templates + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-127.png) + +Tenant logs in --> Settings --> Installation Configuration --> Database Parameter Templates + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-128.png) + +## Function Description + +When creating each type of database, the corresponding parameter template will be selected based on the database type, version, and series to serve as the initial parameters for the database. The platform will come with default initialization parameters. Platform management users can set the initialization parameter templates, and tenants can view the platform's parameter templates. If custom parameter templates are needed, they can create their own or clone and modify the default parameter templates. + +**Note: Parameter templates that belong to the platform-level user cannot be modified by tenant-level users. They must be cloned into tenant-level templates to make modifications.** + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-129.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/platform-components-management.md b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/platform-components-management.md new file mode 100644 index 0000000000000000000000000000000000000000..d3af3cab2fd86b6fce560cde2c8e564512594335 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/platform-components-management.md @@ -0,0 +1,19 @@ +--- +title: Platform Components Management +author: Guo Huan +date: 2024-08-12 +--- + +# Platform Components Management + +## Function Entrance + +Platform Operation Management --> Platform Components Management + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-102.png) + +## Function Description + +You can view the status of platform components and perform start and stop operations on them. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-103.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/platform-database-pool.md b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/platform-database-pool.md new file mode 100644 index 0000000000000000000000000000000000000000..226f8d2db438d0fc35cf7c6722823af36c9b9c5d --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/platform-database-pool.md @@ -0,0 +1,23 @@ +--- +title: Platform Database Pool +author: Guo Huan +date: 2024-08-12 +--- + +# Platform Database Pool + +## Function Entrance + +Resource Pool Management --> Database Pool + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-92.png) + +## Function Description + +The database pool is a logical concept of the database service platform. New tenants need to create a database pool for each type of database they wish to create to avoid installation failures due to missing parameters. + +## Operating Instructions + +Click the create button on the right to pop up the creation interface. Among the database types, there are related database options. Choose the appropriate type for different databases, enter the data name, select the tenant, and click confirm. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-93.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/platform-host-resource-pool.md b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/platform-host-resource-pool.md new file mode 100644 index 0000000000000000000000000000000000000000..cec8104d4ebc89004723f557e75840d45cf29d5b --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/platform-host-resource-pool.md @@ -0,0 +1,57 @@ +--- +title: Platform Host Resource Pool +author: Guo Huan +date: 2024-08-12 +--- + +# Platform Host Resource Pool + +## Function Entrance + +Resource Pool Management --> Host Resource Pool + +## Function Description + +The host resource pool categorizes and manages the hosts that need to be managed by the platform according to their location (server room), operating system, etc. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-83.png) + +## Operating Instructions + +### Create Host Resource Pool + +Click the create button in the upper right corner to pop up the following window. Enter the corresponding information and click the confirm button. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-84.png) + +After successful creation, the newly created host resource pool will be visible in the list. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-85.png) + +Click on the host resource pool name to enter the details interface, where you can see the related detailed information. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-86.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-87.png) + +### Configure Proxy + +Go to the details of the host resource pool and click the "Edit" button for the basic information. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-88.png) + +Click "Use a selected Proxy cluster", choose the Proxy you want to use, and click confirm. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-89.png) + +### Resource Pool Database and Services + +Go to the details of the host resource pool and click the "Edit" button next to "Supported database types and services" to select and set the database types and services that the resource pool supports or does not support. The current version only supports MogDB/openGauss. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-90.png) + +### Batch Sync Hosts + +Click the button and confirm in the pop-up window. It will automatically synchronize all host information within the resource pool. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-91.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/platform-proxy-nodes-management.md b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/platform-proxy-nodes-management.md new file mode 100644 index 0000000000000000000000000000000000000000..fb00f86237118ed128ee682616eb4b58d6352578 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/platform-proxy-nodes-management.md @@ -0,0 +1,61 @@ +--- +title: Platform Proxy Nodes Management +author: Guo Huan +date: 2024-08-12 +--- + +# Platform Proxy Nodes Management + +## Function Entrance + +Log in as a platform management user --> Resource Pool Management --> Proxy Nodes Management + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-94.png) + +## Function Description + +This step is also found in the installation manual. The first installation operation after deploying the software is to install the Proxy (agent). This can reduce the troubles caused by network isolation. + +In a network isolation zone, only one proxy server needs to be deployed to ensure that the proxy server can communicate with other database servers, and that the proxy server can communicate with the platform, reducing the need to open the network from the platform to the database target host. + +Under one tenant, install one or a group of proxies (Proxies), multiple jump servers can form a cluster, and different host resource pools can use different proxies (Proxies). + +## Operating Instructions + +### Proxy Installation + +Currently, Proxy only supports operating systems above CentOS/Redhat 7. + +Click on platform management --> Proxy node management, and click the deployment button. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-95.png) + +The following interface pops up: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-96.png) + +Enter the corresponding information and connect to the host to obtain the host-related information. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-97.png) + +Select the installation directory and the target network card, and click confirm. The background will automatically install the uploaded Proxy medium and initialize the installation of Proxy and related components. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-98.png) + +After the installation is complete, click on the IP to go to the detailed interface to see the host and related deployment information, as well as Proxy-related components. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-99.png) + +You can manage the related components on Proxy on this page. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-100.png) + +### Deploying Proxy Cluster + +After deploying a Proxy node, you can continue to deploy additional nodes to form a Proxy cluster. + +Click "Deploy", select "Join an existing Proxy cluster", and drop-down select the Proxy to join. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-101.png) + +Enter the Proxy node information: IP address, SSH port, Proxy management port, server Root or sudo permission user, password, and operate according to Proxy installation. diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/platform-tenant-management.md b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/platform-tenant-management.md new file mode 100644 index 0000000000000000000000000000000000000000..9dad12c6e77103a4722749001c42bc3079a1616c --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/platform-tenant-management.md @@ -0,0 +1,73 @@ +--- +title: Platform Tenant Management +author: Guo Huan +date: 2024-08-12 +--- + +# Platform Tenant Management + +## Function Entrance + +Tenant Management --> Tenants + +## Function Description + +After logging into the platform, click on Tenant Management to see the following interface. You can create, modify, delete, disable, and activate tenants. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-3.png) + +Resources are isolated between tenants, and within a tenant, only the host, database, and other information of that tenant are visible. + +Proxies and basic information (such as data center regions, database specifications, resource pools, etc.) are shared within a tenant, and different tenants need to reconfigure their proxies and basic information. + +Platform users can manage all hosts but cannot monitor host details and manage databases. + +**Note: It is recommended to plan the platform tenant classification in advance when creating a tenant to avoid the inconvenience of further adjustments.** + +## Operating Instructions + +### Create Tenant + +Click on "Create" + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-4.png) + +Enter the basic information; the name and Chinese name refer to the tenant's name. + +The tenant administrator account is the management account for the tenant, which is created when the tenant is created. The account name must not be the same as any account name under other tenants and defaults to having the DBAAS-TENANT-ADMIN permission. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-5.png) + +### Modify Tenant + +Select the tenant and click "Edit" + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-6.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-7.png) + +### Delete Tenant + +Select the tenant and click "Delete" + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-8.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-9.png) + +### Disable and Enable Tenant + +Select the tenant and click "Disable" to disable the tenant + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-10.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-11.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-12.png) + +Select the tenant and click "Enable" to enable the tenant + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-13.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-14.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-15.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/platform-user-management.md b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/platform-user-management.md new file mode 100644 index 0000000000000000000000000000000000000000..ae88f3bc97678aaea42da02ea794d1e909f3ed3b --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/platform-user-management.md @@ -0,0 +1,197 @@ +--- +title: Platform User Management +author: Guo Huan +date: 2024-08-12 +--- + +# Platform User Management + +## Function Entrance + +After logging in as spadmin, navigate to the left-hand menu "User Management" + +## Function Description + +User Management allows you to adjust all users under the platform and tenants, including user information, roles, and project groups. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-16.png) + +## Operating Instructions + +### User Management + +The user menu allows you to adjust all users under the platform and tenants, including creating, deleting, modifying, locking, resetting passwords, setting project groups, and assigning roles. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-17.png) + +### Create User + +Click the "Create" button on the right to create a new user and enter user information. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-18.png) + +#### Modify User + +Click "More" on the right to drop down the menu, then click "Modify" to change user information. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-19.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-20.png) + +#### Delete User + +Click "More" -> "Delete" to remove other users; you cannot delete yourself. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-21.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-22.png) + +#### Change Password + +Click "More" -> "Set Password" to change the user password. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-23.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-24.png) + +#### Lock and Unlock Users + +For users with "Normal" status, click "More" -> "Lock" to prevent other users from logging in; you cannot lock yourself. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-25.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-26.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-27.png) + +For users with "Locked" status, click "More" -> "Unlock" to remove the user lock. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-28.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-29.png) + +#### Associate Roles + +Click "Set Roles" on the right to select and add or remove roles that the user has. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-30.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-31.png) + +#### Associate Project Groups + +Click "Set Project Groups" on the right to select and add or remove the project groups that the user belongs to. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-32.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-33.png) + +### Role Management + +Before creating users, permissions need to be assigned according to actual usage scenarios. + +Roles are the collection units of menu permissions and global database resource permissions on the database service platform. Different permissions are assigned to different roles for quick and convenient authorization and revocation of user permissions. + +The platform is divided into two types of roles: platform user roles granted to platform-level users and tenant user roles granted to tenant-level users. + +Role permissions are divided into functional permissions and resource permissions. **Functional Permissions** control the platform's functional menus, buttons, and links; **Resource Permissions** are global database permissions for managing and monitoring all databases. + +The platform has three default permissions: one platform user role DBAAS-SP-ADMIN, one tenant user role DBAAS-TENANT-ADMIN, and one SQL review and approval role DBAAS-PROJECT-DBA. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-34.png) + +#### Create Role + +Platform user roles: Have platform management permissions but cannot manage databases; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-35.png) + +Tenant user roles: Have control permissions under the corresponding tenant and can manage databases; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-36.png) + +Functional permissions: Assign specific functional menus according to actual needs; + +Resource permissions: Assign global permissions to manage and monitor all databases according to actual needs. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-37.png) + +#### Modify Role + +The platform's default DBAAS-SP-ADMIN and DBAAS-TENANT-ADMIN roles cannot be adjusted; these two roles have all menus under the platform and tenant. + +Click "Modify" to adjust the name, description, and functional permissions. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-38.png) + +#### Delete Role + +When deleting a role, you need to first cancel the user's role association, that is, go to the "User" menu interface, click on "Role Setting" to remove the set roles. + +When a role is associated with users, it cannot be deleted. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-39.png) + +After removing the role association with users, click the "Delete" button, and click "Confirm" to delete the user role. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-40.png) + +### Project Group Management + +Project groups can isolate database permissions under a tenant. + +When creating a database, you will choose the project group it belongs to. If the user role's resource permission does not set global management or monitoring of all databases, users in different project groups cannot see the database information of other project groups. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-41.png) + +#### Create Project Group + +Click the "Create" button in the upper right corner to create a new project group and enter the project group name and description; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-42.png) + +Platform management users need to select the tenant when creating a project group. Project groups cannot cross tenants. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-43.png) + +#### Modify Project Group + +Select the project group and click "Modify" on the right to change the project group information. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-44.png) + +#### Delete Project Group + +Click "Delete" on the right to remove the corresponding project group. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-45.png) + +When deleting a project group, you need to remove all members under the project group in the project group member management in advance, or in the "User" menu, select the relevant users and cancel their project group settings. Otherwise, the deletion will prompt the following message: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-46.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-47.png) + +#### Project Group Member Management + +Click on the project group name to enter the project group management page; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-48.png) + +Click on "Member Management" on the right to batch select and add or remove project group members; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-49.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-50.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-51.png) + +You can also click "Delete" to remove a project group member. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-52.png) + +#### Associating Databases + +Click on "Associate Databases" to switch to the page where the project group is associated with databases. Click the "Modify" button on the right to change the databases associated with the project group. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-53.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/report-center.md b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/report-center.md new file mode 100644 index 0000000000000000000000000000000000000000..1149f12d744ea33eb80772f56c7bd8447803fd64 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/report-center.md @@ -0,0 +1,77 @@ +--- +title: Report Center +author: Guo Huan +date: 2024-08-12 +--- + +# Report Center + +## Function Entrance + +Left-hand function bar --> Report Center + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-217.png) + +## Function Description + +Aggregate and analyze data. + +**Note: Some reports require setting up scheduled tasks to have data. Daily and weekly reports automatically calculate performance metrics for the previous period and may directly connect to the production database to collect data. It is recommended to schedule this during off-peak business hours.** + +### Report Configuration + +Click on Report Center to enter the report list. By default, no report is selected. The report list is manually configured in the database table and cannot currently be configured from the zcloud interface. If you need to make changes, please contact the on-call colleagues for configuration. Reports support fuzzy search by report name. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-218.png) + +### Report Inquiry + +Click on the report name to enter the report management interface, where you can generate reports on a schedule, clean up data on a schedule, view historical report status, and perform real-time inquiries. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-219.png) + +### Real-time Inquiry Reports + +Click on Real-time Inquiry. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-220.png) + +Click on Inquiry to proceed to the Task Center to view the task progress. Once completed, you can view the results in the Historical Reports. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-221.png) + +### View Report Details + +The page displays the report generation time, operator, data source, and allows you to view report details and export the report. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-222.png) + +In the upper right corner, you can filter by month and operator. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-223.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-224.png) + +Click the export button to export the report. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-225.png) + +### Report Export + +Enter the report details to export the report, refer to "View Report Details." + +You can also directly click on export in the Historical Reports interface. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-226.png) + +Export methods support "Merge into one SHEET for export." + +When exporting into one SHEET, the SHEET name is the report name. However, if there is a failure in querying the database ledger, the exported SHEET name will be the database name, i.e., one SHEET with the report name and others with database names that had query errors. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-227.png) + +The exported Excel name is "Report Name_Export Time." + +Note: If the exported database names are the same, they will be distinguished by adding a code. If the database name contains special characters, they will be converted to underscores (_). + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-228.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/tenant-host-resource-pool.md b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/tenant-host-resource-pool.md new file mode 100644 index 0000000000000000000000000000000000000000..d83fe7fbfe923bb55cdb5d478bc4560bf405344d --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/tenant-host-resource-pool.md @@ -0,0 +1,183 @@ +--- +title: Tenant Host Resource Pool +author: Guo Huan +date: 2024-08-12 +--- + +# Tenant Host Resource Pool + +## Function Entrance + +Settings --> Resource Pool Management --> Host Resource Pool + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-196.png) + +## Function Description + +Manage the platform's basic data definitions, as well as host and database resource pools. + +## Operating Instructions + +The host resource pool categorizes and manages hosts that need to be managed by the platform based on their location (data center), operating system, etc. + +### Host Resource Pool and Configuring Proxy + +For details, see the user manual document: Platform Basic Features --> [Platform Host Resource Pool](./platform-host-resource-pool.md) + +### Manage Hosts + +Quick access: Platform tenant main interface - Manage + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-197.png) + +### Import Hosts + +Quick access: Platform tenant main interface - Import + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-198.png) + +### Host Information + +**Function Entrance** + +Settings --> Resource Pool Management --> Host Resource Pool --> Click on the host name + +**Function Description** + +Monitor and display host file system, CPU, memory, network, and other resource information. Display the Agent installation directory, log location, modify the Agent log level, download Agent logs, and upgrade Agents. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-199.png) + +Host resource information + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-200.png) + +Network information: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-201.png) + +**Sync Host Information** + +If the host resources have changed, such as modifying the host name, Agent installation directory, etc., you need to click the "Sync" button to manually sync the information to the platform. This function can also be used to test whether the platform Proxy and Agent are communicating normally. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-202.png) + +**Modify Agent Log Level** + +Modify the Agent log level: Starting from version 2.5.2, the default log level for Agents is INFO, while earlier versions default to WARN. You can click to modify the host Agent log level, with ERROR, WARN, INFO, and DEBUG log levels available. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-203.png) + +Select the log level from the drop-down menu and click the checkmark icon to save. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-204.png) + +**Download Agent Logs** + +Download Agent logs: Click the download icon next to "Agent Log Path" to download Agent logs. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-205.png) + +## Batch Management of Hosts + +### Function Entrance + +Top menu gear --> Settings --> Button --> Resource Pool Management --> Host Resource Pool --> Batch Management of Hosts + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-206.png) + +### Function Description + +Batch management of hosts: Users can quickly manage hosts through batch operations. + +### Operating Instructions + +#### Import Hosts + +Import hosts via Excel + +1. Drag and drop the file into area ① or click the [Choose File] button to upload the Excel host information file to the platform for parsing host information. + +2. Successfully parsed host information is displayed in the hosts to be managed list, with 10/50 showing the number of selected hosts and the total number of imported hosts. + +3. The hosts to be managed list supports multi-select, and selected hosts can proceed to the next management operation. + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-207.png) + +4. After selecting multiple hosts, click the [Batch Modify] button to display the batch modification pop-up window, where you can modify the information of the selected hosts in batches. + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-208.png) + +5. Click the [Modify] button in the list operations column to display the modification pop-up window, where you can modify the information of a single host. + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-209.png) + +6. Click the [Next Step] button to start validating host information and connecting to the hosts. Successful connections will enter the 'Manageable Hosts' confirmation page. If the validation or connection to the host fails, users need to modify the host information according to the prompt to meet the host connection requirements. + +#### Confirmation Before Management + +Manageable Hosts Page + +1. The manageable hosts list displays host information that has passed the validation and successfully connected. Users can confirm the hosts to be managed on this page, and no modifications are supported on this page. + +2. If users find incorrect host information or missed selecting host information on this page, they can click the [Previous Step] button to return to the host import page to re-edit or select hosts. + +3. Click the [Manage] button to initiate host management. + +4. After initiating management, the current management process will generate a management record, which can be viewed in the [Management History Records] tab page. + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-210.png) + +#### Managing Hosts + +Managing Hosts + +1. After initiating management, a management status is added to the list, and the current management process can be viewed. + +2. Click the [View Logs] button in the operations column to display the task logs pop-up window, where you can view the current management task progress. + +3. After initiating management, you can view the current management progress. + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-211.png) + +Completion of Management + +1. After the management process is completed, if there are hosts that failed to be managed, they will be displayed at the top of the list. Managed hosts do not support multi-select, batch modification, or single modification. + +2. After the management process is completed, successfully managed hosts are listed after the failed hosts and do not support selection operations. + +3. Select the failed hosts and click the [Batch Modify] button to display the batch modification pop-up window to modify the host information. + +4. For failed hosts, click the [Modify] button in the operations column to display the modification pop-up window to modify the current host information. + +5. Click the [View Logs] button in the operations column to display the task logs pop-up window, where you can view the current management task progress. + +6. After completing the modification or batch modification of the failed host information, select all failed hosts and click the [Re-manage Failed Hosts] button to re-initiate host management. The record remains unchanged for re-initiated management. If you close the current page, you can find the record in the Management History Records page. + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-212.png) + +#### Management History Records + +Management History Records List + +1. All successfully initiated management processes will generate management history records displayed in the 'Management History Records' tab page. + +2. Use the time controller to filter the management records initiated within a certain period. + +3. The management status column displays different statuses of the management process. + +4. You can view the total number of managed hosts, successfully managed hosts, and failed managed hosts in different management processes in the list. + +5. Click the [View Details] button in the operations column to open a new browser tab displaying the details of the corresponding management process. + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-213.png) + +Management History Records - View Details + +1. Click the [< Batch Management of Hosts] button to return to the management history records list. + +2. The management status column shows the management status of the current management process for the hosts. Click the [funnel] button to filter and view hosts with different management statuses. + +3. Click the [View Logs] button in the operations column to display the task logs pop-up window, where you can view the progress of the current management task. + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-214.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/tenant-proxy-nodes-management.md b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/tenant-proxy-nodes-management.md new file mode 100644 index 0000000000000000000000000000000000000000..a17086ed3dd3f8c685cf738e31268ad7f0c4dab8 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/tenant-proxy-nodes-management.md @@ -0,0 +1,33 @@ +--- +title: Tenant Proxy Nodes Management +author: Guo Huan +date: 2024-08-12 +--- + +# Tenant Proxy Nodes Management + +## Function Entrance + +Settings --> Resource Pool Management --> Proxy Nodes Management + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-229.png) + +## Function Description + +After the tenant is created, one or a group of proxies (Proxies) need to be installed in the tenant's host area. The proxy is used to relay the installation of required media or commands. A proxy (Proxy) must also be installed before managing hosts and other operations. + +## Operating Instructions + +### Proxy Installation + +For details on the function description, see the user manual: [Platform Proxy Nodes Management](./platform-proxy-nodes-management.md) + +### Deploy Proxy Cluster + +After deploying one Proxy node, you can continue to deploy additional nodes to form a Proxy cluster. + +Click "Deploy", select "Join an existing Proxy cluster", and drop-down select the Proxy to join. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-230.png) + +Enter the Proxy node information: IP address, SSH port, Proxy management port, server Root or sudo permission user, password. diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/tenant-user-management.md b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/tenant-user-management.md new file mode 100644 index 0000000000000000000000000000000000000000..4cc026d602612a5fe37f00ea4c4fafc2b15b35b2 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/tenant-user-management.md @@ -0,0 +1,171 @@ +--- +title: Tenant User Management +author: Guo Huan +date: 2024-08-12 +--- + +# Tenant User Management + +## Function Entrance + +Top right corner settings --> User Management + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-161.png) + +## Function Description + +Tenant administrators manage users under the tenant, including user account information, role permissions, project groups, etc. + +**User Management**: Manage tenant account information, set roles and project groups for individual users, maintain contact information, and manage passwords; + +**Role Management**: Create roles and set functional permissions and resource permissions. Users granted corresponding roles will have the permissions of those roles; + +**Project Group Management**: Manage all database resources under the tenant and distinguish between project groups. Users assigned to a project group will have database resource permissions for that group; + +## Operating Instructions + +### User Management + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-162.png) + +#### Create User + +Click the "Create" button on the right to create a new user and enter user information. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-163.png) + +#### Modify User + +Click "More" on the right to drop down the menu, then click "Modify" to change user information. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-164.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-165.png) + +#### Delete User + +Click "More" -> "Delete" to remove other users; you cannot delete yourself. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-166.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-167.png) + +#### Change Password + +Click "More" -> "Set Password" to change the user password. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-168.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-169.png) + +#### Lock and Unlock Users + +For users with "Normal" status, click "More" -> "Lock" to prevent other users from logging in; you cannot lock yourself. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-170.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-171.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-172.png) + +For users with "Locked" status, click "More" -> "Unlock" to unlock the user. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-173.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-174.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-175.png) + +#### Associate Roles + +Click "Set Roles" on the right to select and add or remove roles that the user has. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-176.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-177.png) + +#### Associate Project Groups + +Click "Set Project Groups" on the right to select and add or remove the project groups that the user belongs to. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-178.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-179.png) + +### Role Management + +Roles are adjustments to the menu under the database service platform for this tenant. Different roles are assigned different menus for easy permission management. + +By default, when a tenant is created, a DBAAS-TENANT_ADMIN role is automatically created for the tenant, which includes all menus under the tenant, i.e., all functions. Platform management users or tenant administrators are advised to create and assign roles according to actual situations. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-180.png) + +Click the create button in the upper right corner, enter the corresponding information, select the menus and buttons to grant functional permissions, and click confirm. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-181.png) + +Resource permission items select whether the role can manage or monitor the corresponding database. After selecting resource permissions, you can manage or monitor all databases of the corresponding type; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-182.png) + +### Project Group Management + +Project groups can isolate database permissions under a tenant. + +When creating a database, you will choose the project group it belongs to. If the user role's resource permissions do not set global management or monitoring of all databases, users in different project groups cannot see the database information of other project groups. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-183.png) + +#### Create Project Group + +Click the "Create" button in the upper right corner to create a new project group and enter the project group name and description; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-184.png) + +Platform management users need to select the tenant when creating a project group. Project groups cannot cross tenants. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-185.png) + +#### Modify Project Group + +Select the project group and click "Modify" on the right to change the project group information. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-186.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-187.png) + +#### Delete Project Group + +Click "Delete" on the right to remove the corresponding project group. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-188.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-189.png) + +When deleting a project group, you need to remove all members under the project group in the project group member management in advance, or in the "User" menu, select the relevant users and cancel their project group settings, otherwise, the deletion will prompt the following information: + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-190.png) + +#### Project Group Member Management + +Click on the project group name to enter the project group management page; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-191.png) + +Click "Member Management" on the right to batch select and add or remove project group members; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-192.png) + +You can also click "Delete" to remove a project group member. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-193.png) + +#### Project Group Database Management + +Click "Associate Databases" to switch to the project group associated database page, where you can switch database types at the top; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-194.png) + +Click “Modify” button on the right to modify the database associated with the project group. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-195.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/totp-certification.md b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/totp-certification.md new file mode 100644 index 0000000000000000000000000000000000000000..01c22c036e1b54cb434df2bc45bc8a7a25a7f794 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/basic-features/totp-certification.md @@ -0,0 +1,137 @@ +--- +title: TOTP Certification +author: Guo Huan +date: 2024-08-12 +--- + +# TOTP Certification + +## Function Entrance + +Left-hand navigation menu User Management --> Security Settings + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-54.png) + +## Function Description + +In addition to user password authentication when logging in to zCloud, TOTP (Time-based One-Time Password) authentication is also supported to enhance user login authentication and improve account security. + +## Operating Instructions + +### TOTP Meaning + +1. TOTP (Time-based One-Time Password Algorithm) is an algorithm that takes a timestamp and a pre-shared secret key as inputs to generate a one-time password for authentication against the server, verifying the user's identity. Due to the strong security and unpredictability of the TOTP algorithm, it can effectively protect user account security. + + TOTP authenticators typically generate a new password every 30 or 60 seconds, meaning the verification code refreshes every 30 or 60 seconds and becomes invalid after expiration. This requires clients and servers to maintain very accurate clocks for the dynamically calculated passwords based on time to match. + +2. It can work even without an internet connection: + + To use TOTP technology, there is no need for a valid internet connection on a smartphone or physical keys. TOTP tokens only need to obtain the shared secret key value once. Therefore, the security system and TOTP generator can produce continuous password values without communication. Thus, even if the computer is turned off, the time-based one-time password (TOTP) will continue to operate. + +### Enable/Disable TOTP + +1. The platform administrator spadmin logs in to zCloud; + +2. Go to User Management --> Security Settings; + +3. Click the switch to enable/disable TOTP authentication. + + When enabled, all users (except those on the whitelist) are required to use TOTP for secondary verification when logging in to zCloud; + + When disabled, all users do not need TOTP authentication to log in to zCloud; + + Enabling or disabling TOTP authentication does not require restarting the server. After re-enabling, users can use their previously bound TOTP for secondary verification without needing to re-bind. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-55.png) + +### Set TOTP Whitelist + +If you want some users to not enable TOTP two-factor authentication, you can set up a whitelist; + +1. The platform administrator spadmin logs in to zCloud; + +2. Set up the TOTP whitelist (after enabling TOTP authentication, the platform administrator is default on the whitelist); + +3. Click [Create Whitelist] to move users who do not need to enable TOTP into the whitelist; + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-56.png) + +4. Click Delete to remove users from the whitelist. + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-57.png) + +5. If the platform administrator is removed from the whitelist and later unable to use a mobile phone or authentication device to verify TOTP to log in to zCloud, they can only contact Yunhe Enmo engineers for assistance. + +### Bind TOTP + +Accounts that have not bound TOTP need to perform TOTP two-factor authentication when first entering zCloud. + +1. Users log in to zCloud; + +2. The system prompts users to download and install an authentication app on their mobile phone: Alibaba Cloud APP; + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-58.png) + +3. Scan the QR code to bind; + + When the mouse moves over the icon, it提示s: Scan the QR code in the Alibaba Cloud APP to add + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-59.png) + + Click the help icon to display a popup window "Help Document." + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-60.png) + +4. Users use the installed authentication app: Alibaba Cloud APP top right corner's MFA to scan the QR code; + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-61.png) + +5. The authentication app saves the account, key, and generates a 6-digit dynamic verification code that updates every 30 seconds; + +6. Users enter the 6-digit dynamic verification code generated by the authentication app in zCloud; + +7. zCloud verifies whether the dynamic verification code entered by the user matches the verification code generated by the server; if the verification does not match, please ensure that the mobile phone system time is consistent with the zCloud system time; + +8. If the QR code cannot be scanned: display the text key, users can enter the email to send the text key to the email, and manually add the account and key. + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-62.png) + +9. After binding is successful, click [Enter zCloud]. + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-63.png) + +### Use TOTP Authentication to Enter zCloud + +User accounts that have bound TOTP and are not on the whitelist, and TOTP has been enabled. + +1. Users log in to zCloud; + +2. Users open the Alibaba Cloud APP to view the generated 6-digit dynamic verification code, which updates every 30 seconds; + +3. Users enter the 6-digit dynamic verification code in zCloud; + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-64.png) + +4. zCloud verifies whether the dynamic verification code entered by the user matches the verification code generated by the server; if the verification does not match, please ensure that the mobile phone system time is consistent with the zCloud system time; + + Click the help icon to view the help document. + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-65.png) + +5. If the mobile phone cannot be used, and the TOTP authentication device cannot be used, please contact the administrator for unbinding. + +### Unbind TOTP + +User's zCloud account has been bound to TOTP and supports unbinding. + +1. Contact the tenant administrator or platform administrator to unbind the current account's TOTP; + +2. The tenant administrator or platform administrator enters User Management to unbind the corresponding account's TOTP and displays the TOTP binding status of the corresponding user; + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-66.png) + + Click More --> Unbind TOTP. + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/basic-features/basic-features-67.png) + +3. Unbinding is successful, and the TOTP binding status is displayed as not bound. diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/inspect-center/customized-inspection-templates.md b/product/en/docs-zcloud-for-mogdb/v6.3/inspect-center/customized-inspection-templates.md new file mode 100644 index 0000000000000000000000000000000000000000..b28ab97f5fb05a203b147f2cc633d2a4bef648ad --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/inspect-center/customized-inspection-templates.md @@ -0,0 +1,39 @@ +--- +title: Customized Inspection Templates +author: Guo Huan +date: 2024-08-12 +--- + +# Customized Inspection Templates + +## Prerequisites + +This feature is applicable to zcloud versions 3.3 and later. + +## Operating Instructions + +### Customize Database Inspection Report Template + +1. Modify the logo and content of the inspection report template. For reference, see the "health_check_report.docx" template. + +2. Place the file on the server where the monitor microservice is located. + +3. Configure the path of the template file on consul, with the key: health.check.report.template.path. + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-45.png) + +4. Restart the monitor microservice. + +### Customize Inspection Issue Summary Report Template + +The modification steps are as follows: + +1. Modify the logo and content of the inspection issue summary report. For reference, see the "health_check_summary.docx" template. + +2. Place the file on the server where the monitor microservice is located. + +3. Configure the path of the template file on consul, with the key: health.check.summary.report.template.path. + + ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-46.png) + +4. Restart the monitor microservice. diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/inspect-center/daily-data.md b/product/en/docs-zcloud-for-mogdb/v6.3/inspect-center/daily-data.md new file mode 100644 index 0000000000000000000000000000000000000000..833d2aea03f2b77e3fdc018eee92027bd88f9f98 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/inspect-center/daily-data.md @@ -0,0 +1,21 @@ +--- +title: Daily Data +author: Guo Huan +date: 2024-08-12 +--- + +# Daily Data + +## Function Entrance + +Database Inspection Center --> Routine Data + +## Function Description + +Displays inspection data based on the inspection scenario (the "Routine Inspection Scenario" must be enabled), including the un-inspected databases, databases with exceptions after inspection, or databases with inspection failures under that inspection item for the selected inspection time. + +## Operating Instructions + +Click on Routine Data to view the relevant inspection data. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-23.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/inspect-center/health-assessment.md b/product/en/docs-zcloud-for-mogdb/v6.3/inspect-center/health-assessment.md new file mode 100644 index 0000000000000000000000000000000000000000..b5012847d122390b05b15cc65bc335d7cc0dee7f --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/inspect-center/health-assessment.md @@ -0,0 +1,129 @@ +--- +title: Health Assessment +author: Guo Huan +date: 2024-08-12 +--- + +# Health Assessment + +## Function Entrance + +Database Inspection Center --> Health Assessment + +## Function Description + +Displays databases that have been configured for automatic inspection. + +## Prerequisites + +To subscribe to the inspection report feature, you need to configure the mail server in advance. For details, refer to the document "Platform Basic Features" - "Mail Server". + +## Operating Instructions + +The Health Assessment list is shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-2.png) + +The time frame displays the inspection score and results for the specified date, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-3.png) + +### Automatic Inspection + +Click the "Automatic Inspection Configuration" button to configure the inspection scenario, time, and inspected databases for automatic inspection tasks for various databases, as shown in the following figures: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-4.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-5.png) + +Click the "Automatic Inspection" button on the right to configure the time and switch for each inspection scenario for a single database, as shown in the following figures: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-6.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-7.png) + +The running status of automatic inspection tasks can be viewed in the "Task Center," as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-8.png) + +### Manual Inspection + +Click the manual inspection button to enter the manual inspection function, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-9.png) + +Select a preset inspection scenario from the drop-down menu, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-10.png) + +You can also manually specify the inspection items, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-11.png) + +Click "Start Inspection" to execute, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-12.png) + +After the inspection is completed, you can quickly view the report, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-13.png) + +You can also export the report to a local device, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-14.png) + +### Viewing Inspection Results + +Displays inspection information for all databases, including database name, IP, the most recent inspection start time, status, number of issues, score, and score for the last 7 days. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-15.png) + +The most recent inspection start time: The time of the most recent inspection (including manual and automatic inspections); + +Status: The status of the most recent inspection, including un-inspected (never inspected), successful (all inspection items executed successfully), partial failure (some inspection items failed), and failure (all inspection items failed); + +Number of issues: The number of issues found in the most recent inspection, with specific items displayed when hovering over the number. The first column indicates issues at the warning level (yellow), and the second column indicates issues at the critical level (red) (controlled by the problem level threshold set when the inspection item defines the return data format); + +Score: The score of the most recent inspection, calculated using a weighted algorithm. Inspection score = sum of all inspection items (item score * (item score / total score of all inspection items)). For modifying inspection item scores, refer to [Modify Inspection Items](./inspection-item-configuration.md#modify-inspection-items); + +Score for the last 7 days: Hover over the legend to display a bar chart trend of the inspection scores for the last 7 days. + +### View Report + +Directly view the last inspection results for a specified date, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-16.png) + +### Download Inspection Reports + +#### Batch Download of Inspection Reports + +On the Health Assessment page, select the database and click to download the inspection report, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-17.png) + +#### Download a Single Inspection Report + +On the Health Assessment page, click More on the right --> Download Inspection Report, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-18.png) + +On the platform's inspection report page, click the "Download Report" button in the upper right corner. + +### Compare Inspection Reports + +On the platform's inspection report page, click the "Report Comparison" button in the upper right corner, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-19.png) + +Select the historical report dates you want to compare, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-20.png) + +### Subscribe to Inspection Reports + +Support for sending inspection reports to email on a scheduled basis. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-21.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-22.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/inspect-center/inspect-center.md b/product/en/docs-zcloud-for-mogdb/v6.3/inspect-center/inspect-center.md new file mode 100644 index 0000000000000000000000000000000000000000..d5191e879c0667ea3be8ff3210d45c67c7ecd9e3 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/inspect-center/inspect-center.md @@ -0,0 +1,14 @@ +--- +title: Inspect Center +author: Guo Huan +date: 2024-08-12 +--- + +# Inspect Center + ++ **[Summary of Issues](./summary-of-issues.md)** ++ **[Health Assessment](./health-assessment.md)** ++ **[Daily Data](./daily-data.md)** ++ **[Inspection Item Configuration](./inspection-item-configuration.md)** ++ **[Inspection Whitelist](./inspection-whitelist.md)** ++ **[Customized Inspection Templates](./customized-inspection-templates.md)** \ No newline at end of file diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/inspect-center/inspection-item-configuration.md b/product/en/docs-zcloud-for-mogdb/v6.3/inspect-center/inspection-item-configuration.md new file mode 100644 index 0000000000000000000000000000000000000000..1e45b838b27a6f246f16ebc504b1ee25b9e93110 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/inspect-center/inspection-item-configuration.md @@ -0,0 +1,90 @@ +--- +title: Inspection Item Configuration +author: Guo Huan +date: 2024-08-12 +--- + +# Inspection Item Configuration + +## Function Entrance + +Inspection Center -> Inspection Item Configuration + +## Function Description + +Displays and configures all available inspection items and scenarios. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-24.png) + +## Operating Instructions + +### Modify Inspection Items + +On the "Inspection Item List" page, all inspection items are displayed, and you can search by name and filter by applicable database and status. Click the "Status" switch to enable or disable the inspection item, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-25.png) + +Click "Edit" to enter the edit inspection item page, as shown in the following figures: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-26.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-27.png) + +After editing, click "Preview Collection Result" to test and preview the data, then click "Confirm" to save, as shown in the following figures: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-28.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-29.png) + +### Customize Inspection Items + +On the inspection item list interface, click the create button, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-30.png) + +Inspection object level supports selection: Inspection database group + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-31.png) + +Inspection object: Supports as shown in the figure + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-32.png) + +Default collection items: Supports different collection schemes for different objects + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-33.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-34.png) + +**Fill in the inspection item rules**: + +- Inspection item name: The name of the inspection item; +- Applicable database: MogDB/openGauss; +- Inspection item category: Drop-down selection, Backup and Disaster Recovery, Security and Stability, Space Resources, Standards; +- Inspection object: Drop-down selection; +- Score: Inspection item score, 1-1000 points. The actual inspection score of the platform's inspection items uses a weighted algorithm, inspection score calculation and deduction = Inspection item score * (Inspection item score / Total score of all inspection items); +- Default level: Set the problem level of the inspection item, warning and critical; +- Description: Enter the description of the inspection item; +- Default collection items apply to all versions of hosts and databases, click "Default Collection Items" to modify or the "+" next to it to create a new collection item scope. + +The platform supports SQL scripts and SHELL scripts, drop-down selection, and enter the corresponding collection script in the "Collection Script" box, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-35.png) + +### Inspection Scenarios + +The platform's automatic inspection is configured and inspected by scenario, and a database can be configured with multiple inspection scenarios, each with different timing times. + +Enter the inspection item configuration page, switch to the "Inspection Scenarios" TAB page, and click the "Create" button in the upper right corner to create a new inspection scenario. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-36.png) + +Enter the inspection scenario name, description, drop-down selection of the applicable database for the inspection scenario, and check the applicable inspection items; + +You can click the "Routine Scenario" switch to control whether to set the scenario as a routine inspection scenario. After enabling, you can browse the routine inspection data for that scenario (since comprehensive inspections take longer and have a lower frequency, while inspection problem summaries and inspection reports can only view the most recent report, it is convenient to quickly browse daily problems, see "Routine Inspection Data") as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-37.png) + +Click "Edit" to modify the inspection scenario, and click "Delete" to delete the inspection scenario, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-38.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/inspect-center/inspection-whitelist.md b/product/en/docs-zcloud-for-mogdb/v6.3/inspect-center/inspection-whitelist.md new file mode 100644 index 0000000000000000000000000000000000000000..18516f68bcfed161aea6dca37d8e397748d4d68c --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/inspect-center/inspection-whitelist.md @@ -0,0 +1,57 @@ +--- +title: Inspection Whitelist +author: Guo Huan +date: 2024-08-12 +--- + +# Inspection Whitelist + +## Function Entrance + +Go to the Inspection Center --> Inspection Whitelist. A new menu item "Inspection Whitelist" has been added to the Inspection Center. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-39.png) + +The Inspection Whitelist list shows all fields: When the shielding type is set to shield by object, it defaults to shielding the entire cluster, and the whitelist rule is displayed as --. The list supports filtering by inspection item and status; it is sorted in reverse order by the shielding start time by default, with invalid items at the end; the list supports fuzzy search by inspection item and database name. + +## Function Description + +When frequently using the inspection function, some legacy issues or unresolvable issues cannot be addressed, and you do not want to focus on them in the short term, resulting in a large number of unresolved issues. You can add the corresponding inspection issues or objects to the whitelist for display shielding, to prevent such issues from interfering with normal issues and improve the analysis efficiency of new issues. A new Inspection Whitelist tab page is added to unify the management and viewing of inspection whitelists, displaying the current added whitelist information, and supporting the creation, modification, and deletion of whitelists. + +## Operating Instructions + +### Create Whitelist + +Inspection item name and inspection object: Support searching for inspection item names and inspection objects to create corresponding inspection whitelists. Support selecting the whitelist type to shield by rule or by object; after selecting, specify the corresponding sub-object for the whitelist rule; the effective time supports specifying once and permanently. + +Shielding type: When creating a whitelist, support shielding specific data columns by rule; you can also shield by object, and when choosing to shield by object, it shields the entire inspection object. + +Effective time: Support specifying a time period for one-time shielding, and also support selecting permanent shielding. + +Create a whitelist - Shield by rule, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-40.png) + +Create a whitelist - Shield by object, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-41.png) + +### Modify Whitelist + +Support modifying the whitelist rules for the current inspection objects. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-42.png) + +### Delete Whitelist + +Click the delete button to display the delete popup window, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-43.png) + +### Add Whitelist + +Function Entrance: Inspection Center --> Problem Summary --> Add Whitelist, add a "Add Whitelist" button after the corresponding inspection cluster, as shown in the following figure: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-44.png) + +Click the button to display the add whitelist popup window, support selecting the whitelist type to shield by rule or by object; after selecting the whitelist rule as "None, =, in, contains," specify the corresponding sub-object; the effective time supports specifying once and permanently. diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/inspect-center/summary-of-issues.md b/product/en/docs-zcloud-for-mogdb/v6.3/inspect-center/summary-of-issues.md new file mode 100644 index 0000000000000000000000000000000000000000..6d1b552f59691afb82200f4a803d70c044fa8529 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/inspect-center/summary-of-issues.md @@ -0,0 +1,23 @@ +--- +title: Issue Summary +author: Guo Huan +date: 2024-08-12 +--- + +# Issue Summary + +## Function Entrance + +Database Inspection Center --> Issue Summary + +## Function Description + +Displays a summary of the last daily inspection results for each inspection item by category. + +## Operating Instructions + +Inspection Time: Click to select the inspection time for viewing the issue summary. There is an inheritance relationship. For example, if the inspection item "Database Full Backup Not Performed" was inspected yesterday and the inspection was not conducted today, then the inspection issue summary for today will show the inherited data from yesterday for that inspection item; + +Inspected Databases: Filter and display databases by business group (user project group) in a drop-down menu. Since a database can belong to multiple project groups, if the user role is granted global management and monitoring permissions for all databases, the database will be displayed in the "Unnamed" business group by default. Otherwise, it will be displayed according to the project group associated with the database. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/inspect-center/inspect-center-1.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/automated-installation-and-deployment/automated-installation-and-deployment.md b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/automated-installation-and-deployment/automated-installation-and-deployment.md new file mode 100644 index 0000000000000000000000000000000000000000..2d274f8cd031f6dce2e11945de90800db6be974a --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/automated-installation-and-deployment/automated-installation-and-deployment.md @@ -0,0 +1,10 @@ +--- +title: Automated Installation and Deployment +author: Guo Huan +date: 2024-08-12 +--- + +# Automated Installation and Deployment + ++ **[Database Creation](./create-database.md)** ++ **[Parameter Optimization](./description-of-parameter-optimization.md)** diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/automated-installation-and-deployment/create-database.md b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/automated-installation-and-deployment/create-database.md new file mode 100644 index 0000000000000000000000000000000000000000..3f18d9dae38d8950ea541a083112b382dfeb85fd --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/automated-installation-and-deployment/create-database.md @@ -0,0 +1,80 @@ +--- +title: Database Creation +author: Guo Huan +date: 2024-08-12 +--- + +# Database Creation + +## Function Entrance + +MogDB/openGauss Instance List --> Create + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-14.png) + +## Function Description + +Automated deployment of databases, supporting the installation of MogDB/openGauss databases on clean environments, as well as on environments where MogDB/openGauss databases are already installed. + +| Scenario | Supported Features | +| ----------------------------------- | ----------------------------- | +| Target environment has no MogDB/openGauss database installed | Automatically install MogDB/openGauss database | +| Target environment has MogDB/openGauss database installed | Automatically install MogDB/openGauss database | + +The prerequisite for installing the database is that the platform has managed the target host and it can be found in the host resource pool. Required installation media need to be uploaded, including: ptk tools, MogDB/openGauss installation packages, python. Basic data should be maintained in advance, including: project groups, database pools, parameter templates, to ensure normal network between nodes for the deployment of one primary and multiple standby nodes. + +The currently supported database list is as follows: + +| Deployment Architecture | Database Version | +| ------------------------------------------------------------ | ---------- | +| Single instance | 5.0 | +| primary-standby (up to 1 primary and 8 standbys) | 5.0 | +| Cascade (the total number of standby database and cascade database is less than 9, cascade database do not support connecting to cascade database) | 5.0 | + +## Operating Instructions + +### Step 1: Set Database Basic Information + +If the series is chosen as primary-standby, at least one primary and one standby instance must be created in the second step; if a single instance is chosen, only one instance can be created in the second step and cannot be added; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-15.png) + +### Step 2: Instance Addition + +Select the host of the primary instance and connect successfully before proceeding to subsequent settings; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-16.png) + +After the host connection is successful, continue to set the base file system and directory, data file system directory; + +For primary-standby type instances, the primary instance must install CM; CM will be installed on the same host as the instance by default, only the port and installation directory need to be set; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-17.png) + +You can click the button in the upper right corner to add a standby instance to the current instance; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-18.png) + +After the standby instance host is selected successfully, only the installation of CM, base file system, data file system, and CM installation directory need to be set, which will be consistent with the primary instance; + +**Note: For one primary and one standby, two CMs need to be installed, that is, both primary and standby instances need to enable installation of CM;** + +**For one primary and multiple standby, it supports the installation of 3/5/7/9 odd numbers of CMs, please reasonably choose whether to enable the instance's CM installation;** + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-19.png) + +You can click the button in the upper right corner to continue adding instances, up to 9 instances are supported for a single database; + +### Step 3: Account Settings + +Set up the host account and create a maintenance user; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-20.png) + +### Step 4: Confirm Information + +Confirm the information before installation is correct, click the [Confirm] button to start installation; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-21.png) + +After the installation starts, you can check the installation progress in the task center or the database list. diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/automated-installation-and-deployment/description-of-parameter-optimization.md b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/automated-installation-and-deployment/description-of-parameter-optimization.md new file mode 100644 index 0000000000000000000000000000000000000000..cd2205fdfbbb9bb025ddfc2623021d959f16b3ed --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/automated-installation-and-deployment/description-of-parameter-optimization.md @@ -0,0 +1,103 @@ +--- +title: Parameter Optimization +author: Guo Huan +date: 2024-08-12 +--- + +# Parameter Optimization + +When creating a database, if the optimization parameter switch is enabled and the server memory for the instance to be deployed is greater than 4GB, some recommended parameter values will be set by default to optimize the database. + +**Note: If the server memory is less than 4GB, none of the following parameters will be modified.** + +Below is the list of optimized parameters (consistent with the recommended parameters on the official website of PTK): + +**Part One: Parameters Related to Memory Size (assuming memory size is N, in GB)** + +- When 4 < N <= 8 + +| Parameter | Value | +| ------------------------- | --------- | +| max_connections | 500 | +| max_prepared_transactions | 500 | +| max_process_memory | (0.6*N)GB | +| shared_buffers | (0.2*N)GB | +| work_mem | 16MB | +| maintenance_work_mem | 512MB | +| wal_buffers | 128MB | + +- When 8 < N <= 64 + +| Parameter | Value | +| ------------------------- | --------- | +| max_connections | 1000 | +| max_prepared_transactions | 1000 | +| max_process_memory | (0.7*N)GB | +| shared_buffers | (0.2*N)GB | +| work_mem | 32MB | +| maintenance_work_mem | 1GB | +| wal_buffers | 512MB | + +- When N > 64 + +| Parameter | Value | +| ------------------------- | --------- | +| max_connections | 3000 | +| max_prepared_transactions | 3000 | +| max_process_memory | (0.8*N)GB | +| shared_buffers | (0.3*N)GB | +| work_mem | 64MB | +| maintenance_work_mem | 2GB | +| wal_buffers | 1GB | + +**Part Two: Fixed Optimization Parameter List** + +| Parameter | Value | +| ------------------------------- | -------------------- | +| remote_read_mode | non_authentication | +| password_encryption_type | 1 | +| password_reuse_time | 0 | +| password_lock_time | 0 | +| password_effect_time | 0 | +| session_timeout | 0 | +| modify_initial_password | off | +| wal_level | logical | +| full_page_writes | off | +| wal_log_hints | off | +| xloginsert_locks | 48 | +| advance_xlog_file_num | 10 | +| wal_keep_segments | 1024 | +| most_available_sync | on | +| catchup2normal_wait_time | 0 | +| enable_slot_log | on | +| max_replication_slots | 32 | +| wal_receiver_timeout | 60s | +| sync_config_strategy | none_node | +| log_line_prefix | '%m %u %d %r %p %S' | +| log_checkpoints | on | +| vacuum_cost_limit | 1000 | +| autovacuum_max_workers | 10 | +| autovacuum_naptime | 20s | +| autovacuum_vacuum_cost_delay | 10 | +| autovacuum_vacuum_scale_factor | 0.05 | +| autovacuum_analyze_scale_factor | 0.02 | +| autovacuum_vacuum_threshold | 200 | +| autovacuum_analyze_threshold | 200 | +| autovacuum_io_limits | 104857600 | +| instr_unique_sql_count | 200000 | +| enable_wdr_snapshot | on | +| log_min_duration_statement | 200 | +| track_activity_query_size | 2048 | +| enable_instr_rt_percentile | off | +| cstore_buffers | 16MB | +| local_syscache_threshold | 32MB | +| standby_shared_buffers_fraction | 1 | +| checkpoint_segments | 1024 | +| checkpoint_completion_target | 0.8 | +| max_files_per_process | 100000 | +| behavior_compat_options | display_leading_zero | +| lc_messages | en_US.UTF-8 | +| lc_monetary | en_US.UTF-8 | +| lc_numeric | en_US.UTF-8 | +| lc_time | en_US.UTF-8 | +| enable_opfusion | off | diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/automated-operations-management/automated-operations-management.md b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/automated-operations-management/automated-operations-management.md new file mode 100644 index 0000000000000000000000000000000000000000..9430426a136dd028b3378d4be7ac99839989241f --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/automated-operations-management/automated-operations-management.md @@ -0,0 +1,11 @@ +--- +title: Automated Operations Management +author: Guo Huan +date: 2024-08-12 +--- + +# Automated Operations Management + ++ **[Instance Management](./instance-management.md)** ++ **[High Availability](./high-availability.md)** ++ **[Global High Availability](./global-high-availability.md)** \ No newline at end of file diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/automated-operations-management/global-high-availability.md b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/automated-operations-management/global-high-availability.md new file mode 100644 index 0000000000000000000000000000000000000000..a94c9a064a583974d2c3cc7c245f986b1bd90961 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/automated-operations-management/global-high-availability.md @@ -0,0 +1,50 @@ +--- +title: Global High Availability +author: Guo Huan +date: 2024-08-12 +--- + +# Global High Availability + +## Function Entrance + +MogDB/OG --> High Availability --> Global High Availability Settings + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-34.png) + +## Function Description + +Configure database global high availability switch parameters and view database global high availability switch records. + +## Operating Instructions + +### Global High Availability Settings + +Global High Availability Settings Details + +1. Click the > button to expand the parameter item settings details; +2. Click the > to expand the list of database clusters using the global configuration, allowing users to view the database clusters that are currently calling the current global parameter configuration items; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-35.png) + +High Availability Parameter Settings + +1. Modify Settings/Cancel Settings Click Modify Settings to enter the global high availability parameter settings page; +2. Global high availability parameter configuration area; +3. The current configuration value of the parameter can be viewed; +4. Click the Cancel button to cancel the configuration and return to the global high availability settings details display status; +5. Click the Save Only button to save the modified configuration items, which will not take effect. After saving, the database cluster high availability page will prompt the user to manually reload. Users can click the reload button in the upper right corner of the database cluster high availability page to manually reload; +6. Click the Save and Reload button to save the modified configuration items and reload according to the modified configuration items; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-36.png) + +After [Save Only], the database cluster high availability page displays an un-reload message, as shown in the figure below; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-37.png) + +### Global High Availability Switch Records + +1. Click Global High Availability Switch Records to display the list of global high availability switch records. Users can view the high availability switch record details according to the switch completion time, or click other list items to filter and view switch record information; +2. Click the Service Chinese Name to jump to the high availability switch record list under the corresponding database service; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-38.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/automated-operations-management/high-availability.md b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/automated-operations-management/high-availability.md new file mode 100644 index 0000000000000000000000000000000000000000..ab3d0987cd812833fef88d3334f390b4655350d6 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/automated-operations-management/high-availability.md @@ -0,0 +1,51 @@ +--- +title: High Availability +author: Guo Huan +date: 2024-08-12 +--- + +# High Availability + +## Function Entrance + +MogDB/OG --> Instance Management --> High Availability --> High Availability Settings + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-29.png) + +## Function Description + +Configure database high availability switch parameters and view database high availability switch records. + +## Operating Instructions + +### High Availability Settings + +High Availability Settings Details + +Click the > button to expand the high availability parameter item details; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-30.png) + +High Availability Parameter Settings + +1. Modify Settings/Cancel Settings Click Modify Settings to enter the high availability parameter settings page; +2. Click Use Global Settings to directly call the high availability global configuration; Note 1: After using global settings, some settings are unique to the cluster, so there is a coexistence of cluster high availability and global high availability settings; Note 2: Global high availability cannot be configured under the cluster high availability page. To configure global high availability, please go to MogDB --> High Availability --> Global High Availability Settings; +3. Click Use Database Individual Settings to use the parameters set individually for the database; +4. Configurable items; +5. Global configuration label, this label indicates that the configuration item is a global configuration; +6. Global configurations cannot be modified under the database high availability page. To modify global high availability configurations, please go to MogDB --> High Availability --> Global High Availability Settings; +7. Click the Cancel button to cancel the configuration and return to the high availability settings details display status; +8. Click the Save Only button to save the modified configuration items, which will not take effect. After saving, the page will prompt the user to manually reload. Users can click the reload button in the upper right corner to manually reload; +9. Click the Save and Reload button to save the modified configuration items and reload according to the modified configuration items; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-31.png) + +After [Save Only], the high availability page displays an un-reload message, as shown in the figure below; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-32.png) + +### High Availability Switch Records + +Click High Availability Switch Records to display the list of high availability switch records. Users can view the high availability switch record details according to the switch completion time; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-33.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/automated-operations-management/instance-management.md b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/automated-operations-management/instance-management.md new file mode 100644 index 0000000000000000000000000000000000000000..6a349d4c2b5b2d91a7c6e081a0f3b5939b783cd7 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/automated-operations-management/instance-management.md @@ -0,0 +1,71 @@ +--- +title: Instance Management +author: Guo Huan +date: 2024-08-12 +--- + +# Instance Management + +## Instance List + +### Function Entrance + +Overview --> MogDB --> Instances + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-22.png) + +Left-hand function menu MogDB/OG --> Instance Management + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-23.png) + +### Function Description + +Displays information about MogDB/openGauss databases that are automatically deployed and managed by the platform. + +### Operating Instructions + +Service Name: The unique identifier for the cluster service within the platform. Click the service name to view the cluster service information; + +Series: Single instance, master-slave; + +Instance IP/Port: Instance IP + Port; + +Role: P (Primary node), S (Standby node); + +Database Version: The version of the instance; + +Project Group: The project group to which the database belongs, and platform user database permissions are controlled; + +Status: unknown (unknown, the platform has not collected the instance status), running, stopped; + +If the database is being installed or the installation has failed, you will not be able to view the details. You can view the installation task details in the operations column, retry the installation, or cancel the management. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-24.png) + +## Basic Information + +### Function Entrance + +Instance Management --> Click on the Chinese name of the service + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-25.png) + +### Function Description + +Monitor and display basic information about MogDB/openGauss instances, including version, status, role, etc. The topology diagram shows the primary-standby relationship. + +### Operating Instructions + +Click on the "Chinese Name" and "Project Group" to edit basic information. The topology diagram shows the primary-standby relationship and status. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-26.png) + +## Instance Management + +Display basic information about MogDB/openGauss resources and OS. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-27.png) + +You can switch instances by dropping down instance information. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-28.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/database-performance-monitoring/database-performance-monitoring.md b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/database-performance-monitoring/database-performance-monitoring.md new file mode 100644 index 0000000000000000000000000000000000000000..e37cc3767001140839d4af5be5fbcbfb5056fc5b --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/database-performance-monitoring/database-performance-monitoring.md @@ -0,0 +1,18 @@ +--- +title: Database Performance Monitoring +author: Guo Huan +date: 2024-08-12 +--- + +# Database Performance Monitoring + ++ **[WaitEvent Unified Classification Method](./waitevent-unified-classification-method.md)** ++ **[Performance Analysis Strategy Management](./performance-analysis-strategy-management.md)** ++ **[Performance Analysis](./performance-analysis.md)** ++ **[Session Management](./session-management.md)** ++ **[Session Blocking Analysis](./session-blocking-analysis.md)** ++ **[Transaction Lock Analysis](./transaction-lock-analysis.md)** ++ **[SQL Performance Details](./sql-performance-details.md)** ++ **[Performance Charts](./performance-charts.md)** ++ **[Metrics Comparison](./metrics-comparison.md)** ++ **[Monitor List](./monitor-list.md)** \ No newline at end of file diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/database-performance-monitoring/metrics-comparison.md b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/database-performance-monitoring/metrics-comparison.md new file mode 100644 index 0000000000000000000000000000000000000000..0b1ed1b47a81a80489c9d800fbc69b96ffbbc3aa --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/database-performance-monitoring/metrics-comparison.md @@ -0,0 +1,33 @@ +--- +title: Metrics Comparison +author: Guo Huan +date: 2024-08-12 +--- + +# Metrics Comparison + +## Function Entrance + +Left-hand function bar MogDB/OG Database --> Performance Monitoring --> Select MogDB/OG Instance --> Metrics Comparison + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-89.png) + +## Function Description + +Compare historical key performance metrics of MogDB/OG databases. + +Note: Metrics related to database hosts without host management are not supported. + +## Operating Instructions + +Click on the metric names on the left to select the performance metrics to display, and show the corresponding performance charts (multiple selections are available): + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-90.png) + +Click to select the comparison time period: 1 hour ago, 2 hours ago... 1 month ago (data is available from the time the database was managed by the platform) Click on the time frame in the upper right corner to select the display time range, default is the latest 4 hours: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-91.png) + +When fluctuations are detected, you can select a time segment and jump to the corresponding time period's performance analysis tab for analysis. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-92.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/database-performance-monitoring/monitor-list.md b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/database-performance-monitoring/monitor-list.md new file mode 100644 index 0000000000000000000000000000000000000000..55098a4905c89c405d8ac6b8d68db19e8f5fc82b --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/database-performance-monitoring/monitor-list.md @@ -0,0 +1,13 @@ +--- +title: Monitor List +author: Guo Huan +date: 2024-08-12 +--- + +# Monitor List + +## Function Entrance + +MogDB/OG --> Performance Monitoring + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-93.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/database-performance-monitoring/performance-analysis-strategy-management.md b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/database-performance-monitoring/performance-analysis-strategy-management.md new file mode 100644 index 0000000000000000000000000000000000000000..2b02b88a887ff956084377c7d5e47549ed7e4df1 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/database-performance-monitoring/performance-analysis-strategy-management.md @@ -0,0 +1,55 @@ +--- +title: Performance Analysis Strategy Management +author: Guo Huan +date: 2024-08-12 +--- + +# Performance Analysis Strategy Management + +## Function Entrance + +Top-right menu --> Settings --> Platform Configuration Management --> Performance Analysis Strategy Management + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-39.png) + +## Function Description + +Set and modify database performance analysis strategies, and manage performance analysis strategies. The system defaults to defining a default performance analysis strategy for all databases (by tenant), which cannot be deleted, only modified. + +1. By configuring performance analysis strategies, specify performance analysis: + + - Database whitelist + + - Sub-task switch + + - Collection frequency + + - Analysis Top SQL quantity + + - Lifecycle management + + - Performance fluctuation rule definition + +2. By configuring the relationship between database instances and performance analysis strategies, specify the performance analysis specifications for each database, and manage the performance analysis strategies for database instances. + +## Operating Instructions + +### Performance Analysis Strategy List + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-40.png) + +View the details of the default rules strategy. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-41.png) + +### Shield Performance Analysis Objects and Collection Switch Control + +The Binding Variable SQL PLAN Collection switch can enable the collection of execution plans for SQL with binding variables. When enabled, the SQL execution plan will replace binding variables with fixed values when generating the execution plan. If the replacement fails, the collection of the execution plan fails. Currently, only variables of the following data types are supported for replacement. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-42.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-43.png) + +### Collection Frequency Settings and Rule Definition + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-44.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/database-performance-monitoring/performance-analysis.md b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/database-performance-monitoring/performance-analysis.md new file mode 100644 index 0000000000000000000000000000000000000000..29fe6f9bf57331c033b978a4a948b47b7af58cd5 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/database-performance-monitoring/performance-analysis.md @@ -0,0 +1,151 @@ +--- +title: Performance Analysis +author: Guo Huan +date: 2024-08-12 +--- + +# Performance Analysis + +## Function Entrance + +Entrance 1: MogDB/openGauss --> Performance Monitoring --> Click on the instance name/performance button + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-45.png) + +Entrance 2: MogDB/openGauss --> Instance Management --> Click on the performance button in the operation column + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-46.png) + +Entrance 3: MogDB/openGauss --> Instance Management --> Instance Details --> Performance button + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-47.png) + +Entrance 4: Overview --> Monitoring Overview --> Double-click to display the database list --> Click on the Chinese name to jump to the corresponding database performance details + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-48.png) + +## Function Description + +This page allows you to view real-time/historical performance metrics of instances, including trends of user activity sessions categorized by wait types. When hovering over the trend graph, it displays the number of active sessions at the corresponding time point. It also allows you to drag the time frame to display the corresponding Top SQL and Top Events, Top Sessions, and Top Clients within the selected time range. + +- Activity Session Trend Graph: Defaults to the last 1 hour. Click the time icon in the upper right to quickly select the last 1 hour, last 2 hours... last 48 hours. You can also customize the start and end times, with the longest time being the last 48 hours. +- Auto-refresh: The page is set to close auto-refresh by default. Click the auto-refresh to choose the page refresh frequency of 30S, 1min, 5min, 15min. Click the auto-refresh switch to toggle page auto-refresh. +- Time Frame Size: Defaults to 12 minutes. Hold and drag the mouse left button to select the time range in the chart area, with a minimum selection of 1 minute. The time frame is a light blue box on the real-time activity session (number) trend graph. Dragging the time frame dynamically displays the number of active sessions for each wait event type within the time range. The page dynamically displays the TOP objects within the time range at the bottom. +- Performance Metrics: Quickly jump to the "Historical Sessions" and "Performance Charts" sub-pages to view the key performance metric trends and values of databases and hosts, and combine performance metrics with problem phenomena to troubleshoot and locate issues. + +Use performance analysis in the following scenarios: + +1. Business SQL overhead is too large, causing the database to slow down. + +2. DML statements are blocked and deadlocked. + +3. The database suddenly restarts or crashes. Analyze performance data before the restart; the database is unresponsive, analyze performance data before the database was unresponsive. + +4. Investigate spiky and business performance fluctuations. + +## Operating Instructions + +Select the corresponding cluster from the drop-down menu, select the "Database" and "Instance" drop-down menus to select other nodes of the cluster, and display performance data: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-49.png) + +### Analyze Real-time Database Core Resource Metrics + +Support multi-select instances for comparison, the real-time performance analysis page header displays the statistics and changes of the current database core metrics, which can help identify issues at the earliest time for further analysis. + +Data will be compared based on the last 10 minutes, with an upward red arrow and a downward green arrow. When the threshold is exceeded, the value will be yellow. Hover over the number and arrow to display hint information, comparing the current largest instance with the average value of the last 10 minutes. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-50.png) + +### Analyze Real-time Sessions + +Analyze real-time active session charts, default to the last 1 hour, analyze active session charts, support peak and average value statistics, and the chart supports displaying TOP objects by selecting a time frame. + +The chart analyzes ASH statistics by specific dimensions: + +- Analyze by Wait Class +- Analyze by Top SQL +- Analyze by Top Event + +Support displaying and hiding reference baselines: + +- CPU Usage +- CPU Logical Cores +- Historical Performance Baseline + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-51.png) + +Click "View Historical Sessions for This Period" or "View Performance Charts for This Period" to jump to the corresponding historical sessions or performance charts. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-52.png) + +### Analyze Historical Sessions + +Select the historical time by default to the last 1 month, and analyze the dimension by default to TOP SQL, and count by total occurrences. Analyze the TOP SQL trend within the historical period to find tuning target SQL and performance trends. + +- Support selecting a specific time range to display SQL +- Support double-clicking to drill down to a smaller time granularity, with the smallest unit being hours + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-53.png) + +### Analyze TOP Objects + +The list displays the TOP SQL, TOP Event, TOP Session, and TOP Client for the selected time frame; the TOP drop-down menu can select 5, 10, 25, 50; different databases display different fields. All lists support custom menus. + +**TOP SQL** + +The list marks new and declining SQL, supports SQL remarks function; TOP SQL Activity is divided into the following 4 dimensions: Waitclass, Event, Client, Application, default Waitclass. Compare SQL by different dimensions. + +Support displaying system SQL and counting the number of system SQL statements, default not checked, this function is used to block platform and system SQL statements. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-54.png) + +Hover the mouse over the SQL ID to display the complete SQL ID, execution plan, and SQL text. Support adding SQL remarks and copying SQL text. + +SQL Remarks: + +Click the SQL remark button to display the add SQL remark popup window, select SQL classification, set remark tags, SQL remarks, optimization records, and associate expert knowledge base. After adding, the SQL ID will display the corresponding remark chart, click to view remark information, and support deleting remarks. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-55.png) + +**TOP Event** + +After dragging the time frame selection, click "Event" below to switch to the Wait Event page, displaying the most significant waiting event. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-56.png) + +**TOP Session** + +After dragging the time frame selection, click "Session" below to switch to the Top Session page, displaying the most significant Session and machine information. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-57.png) + +**TOP Client** + +After dragging the time frame selection, click "Client" below to switch to the Top Client page, displaying the information of the related Machine and Program, and the corresponding machine user and proportion. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-58.png) + +### Add Comparison Period + +Support adding a comparison period, click the add comparison period button on the timeline, display the add comparison period popup window, select the comparison start time or quick time option (custom time segment, yesterday's same period, 1 hour ago, 2 hours ago) confirm to add a simultaneous period comparison horizontal coordinate, display the average curve of the comparison period. + +TOP objects display data for the comparison period. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-59.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-60.png) + +After adding a comparison period, it is displayed, and you can cancel the comparison period: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-61.png) + +### Real-time SQL Search + +Click the real-time SQL search button to display the SQL search popup window. You can filter and search real-time SQL by SQL ID, text content, single logical read, single execution duration, single CPU duration, and execution time range. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-62.png) + +Search results: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-63.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/database-performance-monitoring/performance-charts.md b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/database-performance-monitoring/performance-charts.md new file mode 100644 index 0000000000000000000000000000000000000000..0e27a007aabc69176af786b4a21b9db135be7fce --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/database-performance-monitoring/performance-charts.md @@ -0,0 +1,37 @@ +--- +title: Performance Charts +author: Guo Huan +date: 2024-08-12 +--- + +# Performance Charts + +## Function Entrance + +Left-hand function bar MogDB/openGauss --> Performance Monitoring --> Select MogDB/openGauss instance --> Performance Charts + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-83.png) + +## Function Description + +Display key performance metric information such as MogDB/openGauss database status, connection count, TPS, host CPU usage, and host memory usage. The charts displayed can be customized through the "Dashboard Management" function for monitoring charts. See [Customize Dashboard](../../monitor/dashboard-management.md#customize-dashboard). + +## Operating Instructions + +Click on the instance IP or performance to enter the performance chart interface + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-84.png) + +Click "Switch Chart" to switch between performance overview, internal operations, blocking and conflicts, execution statement statistics, tables and indexes, master-slave replication, and host performance. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-85.png) + +Stop/Start Monitoring + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-86.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-87.png) + +When fluctuations are detected, you can select a time segment and jump to the corresponding performance analysis tab to analyze the issue. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-88.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/database-performance-monitoring/session-blocking-analysis.md b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/database-performance-monitoring/session-blocking-analysis.md new file mode 100644 index 0000000000000000000000000000000000000000..f6c7fd68c4cbcc99a9d3c232d9d2bc2159f5adff --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/database-performance-monitoring/session-blocking-analysis.md @@ -0,0 +1,49 @@ +--- +title: Session Blocking Analysis +author: Guo Huan +date: 2024-08-12 +--- + +# Session Blocking Analysis + +## Function Entrance + +MogDB/openGauss --> Performance Monitoring --> Instance --> Session Block Analysis + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-70.png) + +## Function Description + +Session block analysis: Detailed analysis of the session block chain. + +## Operating Instructions + +### Session Block Analysis (Real-time) + +① Switch between real-time and historical pages for session block analysis by clicking the History button. + +② Block status legend: Red dots in the list represent session block sources, and yellow dots represent blocked sessions. + +③ After selecting multiple sessions in the list, the batch kill session button becomes active. Click the Batch Kill Sessions button to display the batch kill session confirmation popup. Click Confirm to delete the selected sessions in batch. + +④ Click the Kill Session button in the list operations column to display the kill session confirmation popup. Click Confirm to terminate a single session. + +⑤ Click the SQL Details button in the list operations column, and a new browser tab will open and redirect to the SQL details page. + +⑥ Click the gear icon button to display the custom list item popup, where you can configure the default display of field columns in the list. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-71.png) + +### Session Block Analysis (Historical) + +① Click the History tab button to switch to the session block analysis historical page. + +② Use the time selector to choose the time range for viewing session block trends and historical session blocks. + +③ Session block trend chart: Displays a line chart of the number of session blocks within the selected time range. The chart supports clicking to select time nodes. + +④ Click on the data fluctuation area in the line chart to view the session block details within that area. The session block details are displayed in the list below. + +⑤ Display the time range information of the selected node in the chart. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-72.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/database-performance-monitoring/session-management.md b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/database-performance-monitoring/session-management.md new file mode 100644 index 0000000000000000000000000000000000000000..3843acd2c7f98264cc56dccd0522b913ef8df5d8 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/database-performance-monitoring/session-management.md @@ -0,0 +1,89 @@ +--- +title: Session Management +author: Guo Huan +date: 2024-08-12 +--- + +# Session Management + +## Function Entrance + +MogDB/openGauss --> Performance Monitoring --> Instance --> Session Management + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-64.png) + +## Function Description + +Session Management: Manage active sessions and view historical sessions. + +## Operating Instructions + +### Real-time Session Management + +Session Statistics TOP20 List + +Click the instance selection box ① to select instances, support multi-select, and list the session statistics TOP20 based on the selected instances. + +Click any field column tag ② to add the corresponding field information to the session statistics TOP20 list, displaying the data information of that field's statistics. + +The session TOP20 list supports single-select session ③. After selecting a session, the selected field tags ② will be used to filter the session list below. + +Click the SQL ID ④ to jump to the corresponding SQL details page. Hover the mouse over the SQL ID ④ to display the SQL ID information popup. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-65.png) + +Session List + +① The session list displays all session information and can be filtered by the number of lines displayed according to the drop-down control ⑤. + +② Kill History Record ② displays the history of sessions that have been killed. + +③ Check the box to view only active sessions, and the session list will only display active sessions. + +④ Check the execution duration box ④ and enter a value in the input box. The list will only display session information with an execution duration less than the entered value. + +⑤ You can choose the default number of lines displayed in the session list through the drop-down box ⑤. + +⑥ Filter Tag: This Tag field value is brought in through the selected column field information in the session statistics TOP20 list. As shown in the figure above ②, if you select 【SQL ID】and 【Username】, these two field values will be used to filter the session list. + +⑦ SQLID Hyperlink ⑦: Click the button to jump to the SQL details page. Hover the mouse over the button to display the SQLID information popup. + +⑧ Kill Session ⑧: Click 【Kill Session】to display the kill session confirmation popup. Click 【Confirm】to terminate the session. + +⑨ Batch Kill Sessions ⑨: After selecting multiple sessions in the list, the button becomes active. Click 【Batch Kill Sessions】to display the batch kill session confirmation popup. Click 【Confirm】to terminate the selected sessions. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-66.png) + +Kill History Record List + +① Click 【Kill History Record】to view the kill history record list. + +② Click the time selector to view the kill history record based on the time range. + +③ Click the 【Settings】icon button to display the custom list item settings popup, where you can set the default display of field columns in the list. + +④ Operation column ④ Click the 【SQL Details】button, and a new browser tab will open and redirect to the SQL details page. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-67.png) + +Session Killing by Strategy + +① Click the 【Session Killing by Strategy】button to display the session killing by strategy popup. Edit the strategy information in the popup, click the 【Save】button to save the current edited strategy information, and click the 【Execute】button to execute the current strategy. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-68.png) + +### Historical Session Management + +Session Statistics TOP20 List + +① On the session management page, click the 【History】Tab button to jump to the session management history page. The page displays historical session information within the user-selected time range. Users can select different time ranges ② to view the historical session information within the selected time range. + +② Time Selection: Click the 【Time Selector】to choose the time range for the session history you want to view. + +③ Quick Time Range Selection. + +④ The maximum time range for the session management history page is 1 hour. + +⑤ You can set the start time and end time through the custom time range. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-69.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/database-performance-monitoring/sql-performance-details.md b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/database-performance-monitoring/sql-performance-details.md new file mode 100644 index 0000000000000000000000000000000000000000..11dbc6e37a7faaac7a43417c2f5555ea53a085f0 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/database-performance-monitoring/sql-performance-details.md @@ -0,0 +1,47 @@ +--- +title: SQL Performance Details +author: Guo Huan +date: 2024-08-12 +--- + +# SQL Performance Details + +## Function Entrance + +Left-hand function bar MogDB/openGauss --> Performance Monitoring --> Select MogDB/openGauss instance --> Click on any SQL ID to drill down into SQL details + +On the MogDB/openGauss database performance detail monitoring page (Performance Trend Top SQL, Historical Top SQL, TOP Sessions, Session Management, Transaction Lock Analysis, Session Block Analysis), you can enter the "SQL Performance Details" page by clicking on any existing SQL ID for SQL performance analysis. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-76.png) + +## Function Description + +By viewing the SQL details, you can understand the detailed information of the SQL statement: + +View the details of the SQL statement, execution plan, and related tables and index information. + +View the historical performance metrics of the SQL to analyze the performance metrics of each execution plan and the trend of these performance metrics. + +## Operating Instructions + +SQL performance details can be viewed in real-time data and historical data on separate detail pages, divided into execution plans and performance data: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-77.png) + +Under the execution plan, it includes the display of SQL text and the first-level related object information of the corresponding execution plan (tables, indexes, etc.). + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-78.png) + +Object Information + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-79.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-80.png) + +Under performance data, it displays the performance charts and performance trend charts of the execution plan. The performance trend chart supports selecting indicators to display in the chart, with a maximum of 20 indicators selected at a time. It shows the maximum, minimum, and average values of the selected indicators. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-81.png) + +Support for switching performance baseline charts. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-82.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/database-performance-monitoring/transaction-lock-analysis.md b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/database-performance-monitoring/transaction-lock-analysis.md new file mode 100644 index 0000000000000000000000000000000000000000..15b074114f0a8147acd04edb19372506c6cb0f59 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/database-performance-monitoring/transaction-lock-analysis.md @@ -0,0 +1,45 @@ +--- +title: Transaction Lock Analysis +author: Guo Huan +date: 2024-08-12 +--- + +# Transaction Lock Analysis + +## Function Entrance + +MogDB/openGauss --> Performance Monitoring --> Instance --> Transaction Lock Analysis + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-73.png) + +## Function Description + +Transaction lock analysis: Analysis of long and large transactions. + +## Operating Instructions + +### Transaction Lock Analysis (Real-time) + +① Instance selection box: Select the instances that require transaction lock analysis, supporting multi-selection; + +② Switch between real-time and historical pages for transaction lock analysis by clicking the History button to switch to the long and large transaction list; + +③ After selecting multiple sessions, the Batch Kill Sessions button becomes active. Click the Batch Kill Sessions button to display the confirmation popup, and click Confirm to terminate the selected sessions; + +④ In the list operation area, click the Kill Session button to individually terminate a session; + +⑤ In the list operation area, click the SQL Details button, and a new browser tab will open and redirect to the SQL details page; + +⑥ Click the gear icon button to display the custom list item popup, where you can configure the default display of field columns in the list. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-74.png) + +### Long and Large Transaction List (Historical) + +① Click the History tab button to switch to the long and large transaction list; + +② Time selection: Choose the historical time range for long and large transactions that you want to view; + +③ SQL sampling statistics: You can view the SQL sampling ratio. Hover the mouse over the SQL sampling statistics bar to display SQL ID, sampling times, SQL text, and other information. Multiple SQL samples will display multiple SQL information; + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-75.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/database-performance-monitoring/waitevent-unified-classification-method.md b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/database-performance-monitoring/waitevent-unified-classification-method.md new file mode 100644 index 0000000000000000000000000000000000000000..e9a20b4307d0881980be31149ac22d99103df852 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/database-performance-monitoring/waitevent-unified-classification-method.md @@ -0,0 +1,268 @@ +--- +title: WaitEvent Unified Classification Method +author: Guo Huan +date: 2024-08-12 +--- + +# WaitEvent Unified Classification Method + +## Advantages of Database WaitEvent Unified Classification + +The openGauss database has a multitude of WaitEvents, with approximately over 500 types. For users who are not familiar with the openGauss database, the barrier to entry is too high. For example, when displaying a "wait transaction sync: XXXXXXXX" WaitEvent, the average user would find it difficult to understand its meaning. However, when we categorize this Event under "Waiting for Transaction Commit," users will quickly realize its implications, i.e., "There may be a bottleneck in transaction commits in the system. This issue might first need to be checked by examining whether the system TPS or business pressure is too high, otherwise, a DBA should be consulted to analyze the problem together." + +## Specific Classification Types + +1. Disk IO: When a session is waiting for disk IO events or is marked as an IO status, it is categorized as this type. + +2. Network: When a session is waiting for network IO or is marked as a network IO status, it is categorized as this type. + +3. Cluster: When a session is marked as waiting for responses from other instances in the cluster or requesting cluster resource locks, it is categorized as a cluster wait. + +4. ON CPU: When a session is undergoing CPU computations such as cache computations, operator computations, sorting computations, etc., it is marked as an ONCPU wait. + +5. TX Lock: When a session is explicitly blocked by DML transaction locks, usually caused by issues in business application programs. + +6. Enqueue Lock: When a session is blocked by other types of sessions (requesting the same resource lock), excluding the TX Lock class of wait types. + +7. Commit: The most common type of concurrent wait, generally occurring during the transaction commit phase. + +8. Concurrency: Other types of concurrent contention waits, caused when a large number of sessions concurrently request some lightweight memory locks, mainly reflecting concurrency issues. + +9. Configuration: Generally includes some concurrent waits, lock waits, Cluster, etc., but the common cause is due to insufficient allocated resources or unreasonable parameter configuration. It is recommended to fix the problem by adjusting configurations or expanding capacity. + +10. Administrative: Includes activities such as index creation, DDL, statistics collection, and database backup, all falling under the category of maintenance management. + +11. Idle: Belongs to idle waits, where the session is suspended and waiting to enter a pending state. + +12. Others: Other classifications, for abnormal or uncommon statuses. + +## Correspondence Table between openGauss Database WaitEvent and WaitClass + +| Version | wait_status Name | wait_status Description | Original Classification | Classification | +| ------- | -------------------------------------------------- | ------------------------------------------------------------ | ----------------------- | -------------- | +| v3.* | none | Not waiting for any event. | | | +| v3.* | wait cmd | Waiting for the completion of reading a network communication packet. | | idle | +| v3.* | wait pooler get conn | Waiting for the pooler to finish obtaining a connection. | | Other | +| v3.* | wait pooler abort conn | Waiting for the pooler to finish terminating a connection. | | Other | +| v3.* | wait pooler clean conn | Waiting for the pooler to finish cleaning up a connection. | | Other | +| v3.* | pooler create conn:[nodename], total N | Waiting for the pooler to establish a connection, currently establishing a connection with the node specified by nodename, and there are N connections waiting to be established. | | Other | +| v3.* | get conn | Obtained a connection to another node. | | Other | +| v3.* | set cmd: [nodename] | Executing SET/RESET/TRANSACTION BLOCK LEVEL PARA SET/SESSION LEVEL PARA SET on a connection, currently executing on the node specified by nodename. | | Other | +| v3.* | cancel query | Canceling an SQL statement being executed on a connection. | | Administrative | +| v3.* | stop query | Stopping a query being executed on a connection. | | Administrative | +| v3.* | wait node: [nodename]\(plevel), total N, [phase] | Waiting to receive data from a connection with a node, currently waiting for data from the plevel thread of nodename, and there are N connections' data pending return. If the status includes phase information, the possible phase states are: begin: indicates the transaction start phase. commit: indicates the transaction commit phase. rollback: indicates the transaction rollback phase. | | Network | +| v3.* | wait transaction sync: xid | Waiting for transaction synchronization specified by xid. | | Commit | +| v3.* | wait wal sync | Waiting for the synchronization of wal log of a specific LSN to the standby machine. | | Commit | +| v3.* | wait data sync | Waiting for the synchronization of data pages to the standby machine. | | Commit | +| v3.* | wait data sync queue | Waiting to put row-stored data pages or column-stored CUs into the synchronization queue. | | Commit | +| v3.* | flush data: [nodename]\(plevel), [phase] | Waiting to send data to the plevel corresponding thread of nodename specified in the network. If the status includes phase information, the possible phase state is wait quota, indicating that the current communication flow is waiting for the quota value. | | Commit | +| v3.* | stream get conn: [nodename], total N | When initializing stream flow, waiting to establish a connection with the consumer object of nodename, and there are currently N pending connection objects. | | Other | +| v3.* | wait producer \ready: [nodename]\(plevel), total N | When initializing stream flow, waiting for each producer to be ready, currently waiting for the producer object of the plevel corresponding thread of nodename to be ready, and there are still N producer objects in a waiting state. | | Other | +| v3.* | synchronize quit | At the end of the stream plan, waiting for the threads in the stream thread group to exit uniformly. | | Other | +| v3.* | wait stream nodegroup destroy | At the end of the stream plan, waiting for the destruction of the stream node group. | | Other | +| v3.* | wait active statement | Waiting for job execution, currently in resource load control. | | Other | +| v3.* | analyze: [relname], [phase] | Currently performing analyze on table relname. If the status includes phase information, it is autovacuum, indicating that the database automatically starts the AutoVacuum thread to perform the analyze analysis operation. | | Administrative | +| v3.* | vacuum: [relname], [phase] | Currently performing vacuum on table relname. If the status includes phase information, it is autovacuum, indicating that the database automatically starts the AutoVacuum thread to perform the vacuum cleanup operation. | | Administrative | +| v3.* | vacuum full: [relname] | Currently performing vacuum full cleanup on table relname. | | Administrative | +| v3.* | create index | Currently creating an index. | | Administrative | +| v3.* | HashJoin - [ build hash \| write file ] | Currently at the HashJoin operator, focusing on the time-consuming execution phase. build hash: indicates that the current HashJoin operator is building a hash table. write file: indicates that the current HashJoin operator is writing data to disk. | | ON CPU | +| v3.* | HashAgg - [ build hash \| write file ] | Currently at the HashAgg operator, focusing on the time-consuming execution phase. build hash: indicates that the current HashAgg operator is building a hash table. write file: indicates that the current HashAgg operator is writing data to disk. | | ON CPU | +| v3.* | HashSetop - [build hash \| write file ] | Currently at the HashSetop operator, focusing on the time-consuming execution phase. build hash: indicates that the current HashSetop operator is building a hash table. write file: indicates that the current HashSetop operator is writing data to disk. | | ON CPU | +| v3.* | Sort \| Sort - [fetch tuple \| write file] | Currently at the Sort operator for sorting, fetch tuple indicates that the Sort operator is fetching a tuple, write file indicates that the Sort operator is writing data to disk. | | ON CPU | +| v3.* | Material \| Material - write file | Currently at the Material operator, write file indicates that the Material operator is writing data to disk. | | ON CPU | +| v3.* | NestLoop | Currently at the NestLoop operator. | | ON CPU | +| v3.* | wait memory | Waiting for memory acquisition. | | Concurrency | +| v3.* | wait sync consumer next step | Stream operator waiting for consumer execution. | | Others | +| v3.* | wait sync producer next step | Stream operator waiting for producer execution. | | Others | +| v3.* | ShmemIndexLock | Used to protect the primary index hash table in shared memory. | lwlock | Concurrency | +| v3.* | OidGenLock | Used to avoid different threads generating the same OID. | lwlock | Concurrency | +| v3.* | XidGenLock | Used to avoid two transactions obtaining the same xid. | lwlock | Concurrency | +| v3.* | ProcArrayLock | Used to avoid concurrent access or modification of the ProcArray shared array. | lwlock | Concurrency | +| v3.* | SInvalReadLock | Used to avoid concurrent execution with cleanup of invalid messages. | lwlock | Concurrency | +| v3.* | SInvalWriteLock | Used to avoid concurrent execution with other write invalid messages, cleanup of invalid messages. | lwlock | Concurrency | +| v3.* | WALInsertLock | Used to avoid concurrent execution with other WAL insertion operations. | lwlock | Concurrency | +| v3.* | WALWriteLock | Used to avoid concurrent WAL disk writing. | lwlock | Concurrency | +| v3.* | ControlFileLock | Used to avoid concurrent read-write, write-write of the pg_control file. | lwlock | Concurrency | +| v3.* | CheckpointLock | Used to avoid concurrent execution of multiple checkpoints. | lwlock | Concurrency | +| v3.* | CLogControlLock | Used to avoid concurrent access or modification of sub-transaction control data structures. | lwlock | Concurrency | +| v3.* | SubtransControlLock | | lwlock | Concurrency | +| v3.* | MultiXactGenLock | Used for serial allocation of unique MultiXact ids. | lwlock | Concurrency | +| v3.* | MultiXactOffsetControlLock | Used to avoid write-write concurrency and read-write concurrency on pg_multixact/offset. | lwlock | Concurrency | +| v3.* | MultiXactMemberControlLock | Used to avoid write-write concurrency and read-write concurrency on pg_multixact/members. | lwlock | Concurrency | +| v3.* | RelCacheInitLock | Used for locking when operating on init files in invalid message scenarios. | lwlock | Concurrency | +| v3.* | CheckpointerCommLock | Used for serial insertion of request structures into the request queue when initiating file flush requests to the checkpointer. | lwlock | Concurrency | +| v3.* | TwoPhaseStateLock | Used to avoid concurrent access or modification of two-phase commit shared arrays. | lwlock | Concurrency | +| v3.* | TablespaceCreateLock | Used to determine if a tablespace already exists. | lwlock | Concurrency | +| v3.* | BtreeVacuumLock | Used to prevent vacuum from cleaning up B-tree pages that are still in use. | lwlock | Concurrency | +| v3.* | AutovacuumLock | Used for serial access to the autovacuum worker array. | lwlock | Concurrency | +| v3.* | AutovacuumScheduleLock | Used for serial allocation of tables that require vacuum. | lwlock | Concurrency | +| v3.* | AutoanalyzeLock | Used for acquiring and releasing resources for tasks that allow Autoanalyze execution. | lwlock | Concurrency | +| v3.* | SyncScanLock | Used to determine the starting position of a relfilenode during a heap scan. | lwlock | Concurrency | +| v3.* | NodeTableLock | Used to protect shared structures that store database node information. | lwlock | Concurrency | +| v3.* | PoolerLock | Used to ensure that two threads do not simultaneously obtain the same connection from the connection pool. | lwlock | Concurrency | +| v3.* | RelationMappingLock | Used to wait for the update of system table to storage location mapping files. | lwlock | Concurrency | +| v3.* | AsyncCtlLock | Used to avoid concurrent access or modification of shared notification status. | lwlock | Concurrency | +| v3.* | AsyncQueueLock | Used to avoid concurrent access or modification of shared notification information queues. | lwlock | Concurrency | +| v3.* | SerializableXactHashLock | Used to avoid write-write concurrency and read-write concurrency on serializable transaction shared structures. | lwlock | Concurrency | +| v3.* | SerializableFinishedListLock | Used to avoid write-write concurrency and read-write concurrency on completed serializable transaction shared linked lists. | lwlock | Concurrency | +| v3.* | SerializablePredicateLockListLock | Used to protect the lock chain held by serializable transactions. | lwlock | Concurrency | +| v3.* | OldSerXidLock | Used to protect the structure that records conflicting serializable transactions. | lwlock | Concurrency | +| v3.* | FileStatLock | Used to protect the data structure that stores statistical file information. | lwlock | Concurrency | +| v3.* | SyncRepLock | Used to protect xlog synchronization information during master-slave replication. | lwlock | Concurrency | +| v3.* | DataSyncRepLock | Used to protect data page synchronization information during master-slave replication. | lwlock | Concurrency | +| v3.* | CStoreColspaceCacheLock | Used to protect the allocation of CU space in column-stored tables. | lwlock | Concurrency | +| v3.* | CStoreCUCacheSweepLock | Used for column CU Cache circular replacement. | lwlock | Concurrency | +| v3.* | MetaCacheSweepLock | Used for metadata circular replacement. | lwlock | Concurrency | +| v3.* | ExtensionConnectorLibLock | Used for initializing ODBC connection scenarios, locking when loading and unloading specific dynamic libraries. | lwlock | Concurrency | +| v3.* | SearchServerLibLock | Used for GPU acceleration scenarios, locking read file operations when initializing and loading specific dynamic libraries. | lwlock | Concurrency | +| v3.* | LsnXlogChkFileLock | Used for serial updating of the master-slave machine xlog flush position points recorded in specific structures. | lwlock | Concurrency | +| v3.* | ReplicationSlotAllocationLock | Used to protect the allocation of stream replication slots on the master side during master-slave replication. | lwlock | Concurrency | +| v3.* | ReplicationSlotControlLock | Used to avoid concurrent updates of stream replication slot status during master-slave replication. | lwlock | Concurrency | +| v3.* | ResourcePoolHashLock | Used to avoid concurrent access or modification of resource pool hash tables. | lwlock | Concurrency | +| v3.* | WorkloadStatHashLock | Used to avoid concurrent access or modification of hash tables composed of SQL requests containing the database master node. | lwlock | Concurrency | +| v3.* | WorkloadIoStatHashLock | Used to avoid concurrent access or modification of hash tables used to count IO information of the current database node. | lwlock | Concurrency | +| v3.* | WorkloadCGroupHashLock | Used to avoid concurrent access or modification of Cgroup information composed of hash tables. | lwlock | Concurrency | +| v3.* | OBSGetPathLock | Used to avoid write-write concurrency and read-write concurrency on obs paths. | lwlock | Concurrency | +| v3.* | WorkloadUserInfoLock | Used to avoid concurrent access or modification of load management user information hash tables. | lwlock | Concurrency | +| v3.* | WorkloadRecordLock | Used to avoid concurrent access or modification of hash tables composed of requests received by the database master node during memory adaptive management. | lwlock | Concurrency | +| v3.* | WorkloadIOUtilLock | Used to protect structures that record iostat, CPU, and other load information. | lwlock | Concurrency | +| v3.* | WorkloadNodeGroupLock | Used to avoid concurrent access or modification of hash tables composed of nodegroup information in memory. | lwlock | Concurrency | +| v3.* | JobShmemLock | Used to protect global variables read periodically in timer task functionality. | lwlock | Concurrency | +| v3.* | OBSRuntimeLock | Used to acquire environment variables, such as GASSHOME. | lwlock | Concurrency | +| v3.* | LLVMDumpIRLock | Used to export the assembly language corresponding to dynamically generated functions. | lwlock | Concurrency | +| v3.* | LLVMParseIRLock | Used to compile and parse pre-written IR functions from IR files at the start of a query. | lwlock | Concurrency | +| v3.* | CriticalCacheBuildLock | Used for loading cache scenarios from shared or local cache initialization files. | lwlock | Concurrency | +| v3.* | WaitCountHashLock | Used to protect shared structures in user statement count functionality scenarios. | lwlock | Concurrency | +| v3.* | BufMappingLock | Used to protect operations on shared buffer mapping tables. | lwlock | Concurrency | +| v3.* | LockMgrLock | Used to protect regular lock structure information. | lwlock | Concurrency | +| v3.* | PredicateLockMgrLock | Used to protect serializable transaction lock structure information. | lwlock | Concurrency | +| v3.* | OperatorRealTLock | Used to avoid concurrent access or modification of global structures that record operator-level real-time data. | lwlock | Concurrency | +| v3.* | OperatorHistLock | Used to avoid concurrent access or modification of global structures that record operator-level historical data. | lwlock | Concurrency | +| v3.* | SessionRealTLock | Used to avoid concurrent access or modification of global structures that record query-level real-time data. | lwlock | Concurrency | +| v3.* | SessionHistLock | Used to avoid concurrent access or modification of global structures that record query-level historical data. | lwlock | Concurrency | +| v3.* | CacheSlotMappingLock | Used to protect CU Cache global information. | lwlock | Concurrency | +| v3.* | BarrierLock | Used to ensure that only one thread is currently creating a Barrier. | lwlock | Concurrency | +| v3.* | dummyServerInfoCacheLock | Used to protect the global hash table that caches accelerated openGauss connection information. | lwlock | Concurrency | +| v3.* | RPNumberLock | Used to accelerate the count of task threads being executed by the database node of openGauss. | lwlock | Concurrency | +| v3.* | CBMParseXlogLock | Cbm protection lock when parsing xlog. | lwlock | Concurrency | +| v3.* | RelfilenodeReuseLock | Avoid incorrectly canceling the link of reused column attribute files. | lwlock | Concurrency | +| v3.* | RcvWriteLock | Prevent concurrent calls to WalDataRcvWrite. | lwlock | Concurrency | +| v3.* | PercentileLock | Used to protect the global PercentileBuffer. | lwlock | Concurrency | +| v3.* | CSNBufMappingLock | Protect csn pages. | lwlock | Concurrency | +| v3.* | UniqueSQLMappingLock | Used to protect the uniquesql hash table. | lwlock | Concurrency | +| v3.* | DelayDDLLock | Prevent concurrent DDL. | lwlock | Concurrency | +| v3.* | CLOG Ctl | Used to avoid concurrent access or modification of Clog control data structures. | lwlock | Concurrency | +| v3.* | Async Ctl | Protect Async buffer. | lwlock | Concurrency | +| v3.* | MultiXactOffset Ctl | Protect the slru buffer of MultiXact offset. | lwlock | Concurrency | +| v3.* | MultiXactMember Ctl | Protect the slrubuffer of MultiXact member. | lwlock | Concurrency | +| v3.* | OldSerXid SLRU Ctl | Protect the slru buffer of old xids. | lwlock | Concurrency | +| v3.* | ReplicationSlotLock | Used to protect ReplicationSlot. | lwlock | Concurrency | +| v3.* | PGPROCLock | Used to protect pgproc. | lwlock | Concurrency | +| v3.* | MetaCacheLock | Used to protect MetaCache. | lwlock | Concurrency | +| v3.* | DataCacheLock | Used to protect datacache. | lwlock | Concurrency | +| v3.* | InstrUserLock | Used to protect InstrUserHTAB. | lwlock | Concurrency | +| v3.* | BadBlockStatHashLock | Used to protect the global_bad_block_stat hash table. | lwlock | Concurrency | +| v3.* | BufFreelistLock | Used to ensure the atomicity of shared buffer free list operations. | lwlock | Concurrency | +| v3.* | CUSlotListLock | Used to control concurrent operations of column-stored buffer slots. | lwlock | Concurrency | +| v3.* | AddinShmemInitLock | Protect the initialization of shared memory objects. | lwlock | Concurrency | +| v3.* | AlterPortLock | Protect the operation of coordinating node changes to the registration port number. | lwlock | Concurrency | +| v3.* | FdwPartitionCaheLock | HDFS partition table buffer management lock. | lwlock | Concurrency | +| v3.* | DfsConnectorCacheLock | DFSConnector buffer management lock. | lwlock | Concurrency | +| v3.* | DfsSpaceCacheLock | HDFS tablespace management buffer management lock. | lwlock | Concurrency | +| v3.* | FullBuildXlogCopyStartPtrLock | Used to protect the operation of Xlog copying in full Build. | lwlock | Concurrency | +| v3.* | DfsUserLoginLock | Used for HDFS user login and authentication. | lwlock | Concurrency | +| v3.* | LogicalReplicationSlotPersistentDataLock | Protecting data in replication slots during logical replication. | lwlock | Concurrency | +| v3.* | WorkloadSessionInfoLock | Protecting access to the memory hash table of load management session info. | lwlock | Concurrency | +| v3.* | InstrWorkloadLock | Protecting access to the memory hash table of load management statistics. | lwlock | Concurrency | +| v3.* | PgfdwLock | Managing instance connections to Foreign servers. | lwlock | Concurrency | +| v3.* | InstanceTimeLock | Acquiring time information for sessions within an instance. | lwlock | Concurrency | +| v3.* | XlogRemoveSegLock | Protecting the recycling operation of Xlog segment files. | lwlock | Concurrency | +| v3.* | DnUsedSpaceHashLock | Updating space usage information corresponding to sessions. | lwlock | Concurrency | +| v3.* | CsnMinLock | Calculating CSNmin. | lwlock | Concurrency | +| v3.* | GPCCommitLock | Protecting the addition operation of the global Plan Cache hash table. | lwlock | Concurrency | +| v3.* | GPCClearLock | Protecting the clearing operation of the global Plan Cache hash table. | lwlock | Concurrency | +| v3.* | GPCTimelineLock | Protecting the operation of checking the Timeline in the global Plan Cache hash table. | lwlock | Concurrency | +| v3.* | TsTagsCacheLock | Managing time-series tag caches. | lwlock | Concurrency | +| v3.* | InstanceRealTLock | Protecting the update operation of the shared instance statistics hash table. | lwlock | Concurrency | +| v3.* | CLogBufMappingLock | Managing commit log caches. | lwlock | Concurrency | +| v3.* | GPCMappingLock | Managing global Plan Cache caches. | lwlock | Concurrency | +| v3.* | GPCPrepareMappingLock | Managing global Plan Cache caches. | lwlock | Concurrency | +| v3.* | BufferIOLock | Protecting I/O operations on shared buffer pages. | lwlock | Concurrency | +| v3.* | BufferContentLock | Protecting the reading and modification of shared buffer page contents. | lwlock | Concurrency | +| v3.* | CSNLOG Ctl | Managing CSN logs. | lwlock | Concurrency | +| v3.* | DoubleWriteLock | Managing double-write operations. | lwlock | Concurrency | +| v3.* | RowPageReplicationLock | Managing the replication of row-stored data pages. | lwlock | Concurrency | +| v3.* | extension | Other lightweight locks. | lwlock | Concurrency | +| v3.* | BufFileRead | Reading data from a temporary file into a specified buffer. | IO | Disk IO | +| v3.* | BufFileWrite | Writing the content of a specified buffer into a temporary file. | IO | Disk IO | +| v3.* | ControlFileRead | Reading the pg_control file. This mainly occurs during database startup, checkpoint execution, and primary-standby verification processes. | IO | Disk IO | +| v3.* | ControlFileSync | Persisting the pg_control file to disk. This happens during database initialization. | IO | Disk IO | +| v3.* | ControlFileSyncUpdate | Persisting the pg_control file to disk. This mainly occurs during database startup, checkpoint execution, and primary-standby verification processes. | IO | Disk IO | +| v3.* | ControlFileWrite | Writing to the pg_control file. This happens during database initialization. | IO | Disk IO | +| v3.* | ControlFileWriteUpdate | Updating the pg_control file. This mainly occurs during database startup, checkpoint execution, and primary-standby verification processes. | IO | Disk IO | +| v3.* | CopyFileRead | Reading file content when copying a file. | IO | Disk IO | +| v3.* | CopyFileWrite | Writing file content when copying a file. | IO | Disk IO | +| v3.* | DataFileExtend | Writing content to a file when extending a file. | IO | Disk IO | +| v3.* | DataFileFlush | Persisting table data files to disk. | IO | Disk IO | +| v3.* | DataFileImmediateSync | Persisting table data files to disk immediately. | IO | Disk IO | +| v3.* | DataFilePrefetch | Asynchronously reading table data files. | IO | Disk IO | +| v3.* | DataFileRead | Synchronously reading table data files. | IO | Disk IO | +| v3.* | DataFileSync | Persisting modifications to table data files to disk. | IO | Disk IO | +| v3.* | DataFileTruncate | Truncating table data files. | IO | Disk IO | +| v3.* | DataFileWrite | Writing content to table data files. | IO | Disk IO | +| v3.* | LockFileAddToDataDirRead | Reading the "postmaster.pid" file. | IO | Disk IO | +| v3.* | LockFileAddToDataDirSync | Persisting the "postmaster.pid" content to disk. | IO | Disk IO | +| v3.* | LockFileAddToDataDirWrite | Writing pid information to the "postmaster.pid" file. | IO | Disk IO | +| v3.* | LockFileCreateRead | Reading the LockFile "%s.lock". | IO | Disk IO | +| v3.* | LockFileCreateSync | Persisting the LockFile "%s.lock" content to disk. | IO | Disk IO | +| v3.* | LockFileCreateWRITE | Writing pid information to the LockFile "%s.lock". | IO | Disk IO | +| v3.* | RelationMapRead | Reading the mapping file between system tables and storage locations. | IO | Disk IO | +| v3.* | RelationMapSync | Persisting the mapping file between system tables and storage locations to disk. | IO | Disk IO | +| v3.* | RelationMapWrite | Writing to the mapping file between system tables and storage locations. | IO | Disk IO | +| v3.* | ReplicationSlotRead | Reading the stream replication slot file. This occurs upon restart. | IO | Disk IO | +| v3.* | ReplicationSlotRestoreSync | Persisting the stream replication slot file to disk. This occurs upon restart. | IO | Disk IO | +| v3.* | ReplicationSlotSync | Persisting the temporary file of the stream replication slot to disk during checkpoint. | IO | Disk IO | +| v3.* | ReplicationSlotWrite | Writing to the temporary file of the stream replication slot during checkpoint. | IO | Disk IO | +| v3.* | SLRUFlushSync | Persisting pg_clog, pg_subtrans, and pg_multixact files to disk. This mainly occurs during checkpoint execution and database shutdown. | IO | Disk IO | +| v3.* | SLRURead | Reading pg_clog, pg_subtrans, and pg_multixact files. | IO | Disk IO | +| v3.* | SLRUSync | Writing dirty pages to files pg_clog, pg_subtrans, and pg_multixact and persisting them to disk. This mainly occurs during checkpoint execution and database shutdown. | IO | Disk IO | +| v3.* | SLRUWrite | Writing to pg_clog, pg_subtrans, and pg_multixact files. | IO | Disk IO | +| v3.* | TimelineHistoryRead | Reading the timeline history file. This occurs during database startup. | IO | Disk IO | +| v3.* | TimelineHistorySync | Persisting the timeline history file to disk. This occurs during database startup. | IO | Disk IO | +| v3.* | TimelineHistoryWrite | Writing to the timeline history file. This occurs during database startup. | IO | Disk IO | +| v3.* | TwophaseFileRead | Reading the pg_twophase file. This occurs during two-phase transaction commit and recovery. | IO | Disk IO | +| v3.* | TwophaseFileSync | Persisting the pg_twophase file to disk. This occurs during two-phase transaction commit and recovery. | IO | Disk IO | +| v3.* | TwophaseFileWrite | Writing to the pg_twophase file. This occurs during two-phase transaction commit and recovery. | IO | Disk IO | +| v3.* | WALBootstrapSync | Persisting the initialized WAL files to disk. This happens during database initialization. | IO | Disk IO | +| v3.* | WALBootstrapWrite | Writing to the initialized WAL files. This happens during database initialization. | IO | Disk IO | +| v3.* | WALCopyRead | Reading existing WAL files and performing copy operations that generate read operations. This occurs after executing archive recovery. | IO | Disk IO | +| v3.* | WALCopySync | Persisting copied WAL files to disk. This occurs after executing archive recovery. | IO | Disk IO | +| v3.* | WALCopyWrite | Reading existing WAL files and performing copy operations that generate write operations. This occurs after executing archive recovery. | IO | Disk IO | +| v3.* | WALInitSync | Persisting newly initialized WAL files to disk. This happens during log recycling or writing logs. | IO | Disk IO | +| v3.* | WALInitWrite | Initializing newly created WAL files to 0. This happens during log recycling or writing logs. | IO | Disk IO | +| v3.* | WALRead | Reading data from xlog journals. This is generated by two-phase file redo-related operations. | IO | Disk IO | +| v3.* | WALSyncMethodAssign | Persisting all currently open WAL files to disk. | IO | Disk IO | +| v3.* | WALWrite | Writing to WAL files. | IO | Disk IO | +| v3.* | WALBufferAccess | WAL Buffer access (for performance reasons, only the number of accesses is counted in the kernel code, not the access time). | IO | Disk IO | +| v3.* | WALBufferFull | Processing related to writing wal files when the WAL Buffer is full. | IO | Disk IO | +| v3.* | DoubleWriteFileRead | Double-write file reading. | IO | Disk IO | +| v3.* | DoubleWriteFileSync | Forcing a double-write file to disk. | IO | Disk IO | +| v3.* | DoubleWriteFileWrite | Writing to a double-write file. | IO | Disk IO | +| v3.* | PredoProcessPending | In parallel log playback, the current record waits for other records to complete playback. | IO | Disk IO | +| v3.* | PredoApply | In parallel log playback, the current working thread waits for other threads to playback up to the LSN of this thread. | IO | Disk IO | +| v3.* | DisableConnectFileRead | HA lock shard logical file reading. | IO | Disk IO | +| v3.* | DisableConnectFileSync | Forcing an HA lock shard logical file to disk. | IO | Disk IO | +| v3.* | DisableConnectFileWrite | Writing to an HA lock shard logical file. | IO | Disk IO | +| | | | | | +| v3.* | relation | Locking tables. | acquire lock | Enqueue Lock | +| v3.* | extend | Locking tables when extending space. | acquire lock | Enqueue Lock | +| v3.* | partition | Locking partitioned tables. | acquire lock | Enqueue Lock | +| v3.* | partition_seq | Locking partitions of partitioned tables. | acquire lock | Enqueue Lock | +| v3.* | page | Locking table pages. | acquire lock | Enqueue Lock | +| v3.* | tuple | Locking tuples on a page. | acquire lock | Enqueue Lock | +| v3.* | transactionid | Locking transaction IDs. | acquire lock | Enqueue Lock | +| v3.* | virtualxid | Locking virtual transaction IDs. | acquire lock | Enqueue Lock | +| v3.* | object | Adding object locks. | acquire lock | Enqueue Lock | +| v3.* | cstore_freespace | Locking column-stored free space. | acquire lock | Enqueue Lock | +| v3.* | userlock | Adding user locks. | acquire lock | Enqueue Lock | +| v3.* | advisory | Adding advisory locks. | acquire lock | Enqueue Lock | diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/installation-and-deployment/description-of-user-privileges.md b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/installation-and-deployment/description-of-user-privileges.md new file mode 100644 index 0000000000000000000000000000000000000000..708a7366fc7d9be5cf57c6ed23848e2b4e2a514a --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/installation-and-deployment/description-of-user-privileges.md @@ -0,0 +1,44 @@ +--- +title: User Privileges +author: Guo Huan +date: 2024-08-12 +--- + +# User Privileges + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Database TypeAccount PurposezCloud Management Account - Select Existing AccountzCloud Management Account - Platform Created
Existing Account TakeoverAccount NameRecommended PermissionsAccount NameDefault PermissionsCreator
MogDB/openGaussPlatform ManagementSupportedNot limitedMinimum permissions: monadminzcloud_platformPermissions: login sysadmin createrole createdb replication auditadminomm or other dba users
Permissions: sysadmin
Monitoring Minimum permissions: monadminzcloud_monitorPermissions: login monadmin
\ No newline at end of file diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/installation-and-deployment/installation-and-deployment.md b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/installation-and-deployment/installation-and-deployment.md new file mode 100644 index 0000000000000000000000000000000000000000..5c4787d521538731bd56a3ee9f412ed588992b67 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/installation-and-deployment/installation-and-deployment.md @@ -0,0 +1,10 @@ +--- +title: Installation and Deployment +author: Guo Huan +date: 2024-08-12 +--- + +# Installation and Deployment + ++ **[Prerequisites](./prerequisites-for-first-time-deployment.md)** ++ **[User Privileges](./description-of-user-privileges.md)** \ No newline at end of file diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/installation-and-deployment/prerequisites-for-first-time-deployment.md b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/installation-and-deployment/prerequisites-for-first-time-deployment.md new file mode 100644 index 0000000000000000000000000000000000000000..8d41d818c38f8fa32bb9ec3cd3f0fcd7f32ba780 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/installation-and-deployment/prerequisites-for-first-time-deployment.md @@ -0,0 +1,31 @@ +--- +title: Prerequisites +author: Guo Huan +date: 2024-08-12 +--- + +# Prerequisites for the First Takeover Deployment of the Database + +1. Takeover host, refer to "Basic Features" --> "[Host Resource Pool](../../basic-features/platform-host-resource-pool.md)" + +2. Create a database pool, refer to "Basic Features" --> "[Platform Database Pool](../../basic-features/platform-database-pool.md)" + +3. Create a project group, refer to "Platform User Management" --> "[Project Group Management](../../basic-features/platform-user-management.md#project-group-management)" + +4. Grant permissions to tenant users, refer to "Platform User Management" --> "[User Management](../../basic-features/platform-user-management.md#user-management)" and "[Role Management](../../basic-features/platform-user-management.md#role-management)" + +**Prerequisites for Installing MogDB Version 5.0 or Higher** + +1. Go to "Platform Management" - "Medium Management" - "ptk" menu, upload the ptk tool, distinguish between x86 and arm versions, to avoid ptk bugs, please upload the latest stable version. + +2. Go to "Platform Management" - "Medium Management" - "MogDB/openGauss" menu, upload the installation package of MogDB/openGauss, distinguish between versions, operating system types/publishers, CPU architectures, minimum operating system versions, and maximum operating system versions. + +3. Go to "Platform Management" - "Medium Management" - "Python" menu, upload python3.6 (centos) / 3.7 (openEuler20.03 22.03, Kylin V10), the requirement is a tar format source package, distinguish between main versions, operating system types/publishers, CPU architectures, minimum operating system versions/maximum versions. + +4. The target host for installing MogDB needs to configure an available yum source for installing dependency packages, and the Agent must be installed and imported into the zCloud platform. + +5. The target host for installing MogDB needs to have Python 2.7.5, all host operating system versions must be exactly the same, and the hostnames must be different. In a one-primary multi-standby scenario, network connectivity between nodes must be ensured. + +6. Clone and customize parameter templates according to the actual situation. + +7. The zCloud platform needs to maintain basic data in advance, including the creation of project groups and database pools. \ No newline at end of file diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/mogdb-opengauss.md b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/mogdb-opengauss.md new file mode 100644 index 0000000000000000000000000000000000000000..f8b16c3f7ad80ae854e1011da052cba50d9d1248 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/mogdb-opengauss.md @@ -0,0 +1,13 @@ +--- +title: MogDB/openGauss +author: Guo Huan +date: 2024-08-12 +--- + +# MogDB/openGauss + ++ **[Takeover](./takeover/takeover.md)** ++ **[Installation and Deployment](./installation-and-deployment/installation-and-deployment.md)** ++ **[Automated Installation and Deployment](./automated-installation-and-deployment/automated-installation-and-deployment.md)** ++ **[Automated Operations Management](./automated-operations-management/automated-operations-management.md)** ++ **[Database Performance Monitoring](./database-performance-monitoring/database-performance-monitoring.md)** \ No newline at end of file diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/takeover/takeover-cancellation.md b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/takeover/takeover-cancellation.md new file mode 100644 index 0000000000000000000000000000000000000000..c9466a28185bcbeb80332ae8e0973a5319628547 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/takeover/takeover-cancellation.md @@ -0,0 +1,23 @@ +--- +title: Takeover Cancellation +author: Guo Huan +date: 2024-08-12 +--- + +# Takeover Cancellation + +## Remove Primary-Standby Instances + +Remove the MogDB/openGauss database from the platform to release the platform's monitoring and management of the database, without actually deleting the database. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-11.png) + +## Remove Standby Instance + +Click on the IP address of the standby database instance. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-12.png) + +Enter the details interface of the standby database instance and click on "Cancel Takeover". + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-13.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/takeover/takeover-with-hosts.md b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/takeover/takeover-with-hosts.md new file mode 100644 index 0000000000000000000000000000000000000000..06c23da653d58fea3f5a16294ba1443da353c2a8 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/takeover/takeover-with-hosts.md @@ -0,0 +1,91 @@ +--- +title: Takeover With Hosts +author: Guo Huan +date: 2024-08-12 +--- + +# Takeover With Hosts + +## Takeover of Primary Database + +### Function Entrance + +Tenant Overview page --> Asset Overview --> Takeover --> MogDB/openGauss + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-1.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-2.png) + +Left-side function menu MogDB/openGauss --> Instance Management --> Takeover --> Takeover With Hosts + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-3.png) + +### Function Description + +The takeover of MogDB/openGauss database primary or single instance is to manage and monitor the already running MogDB/openGauss database primary or single instance in the database cloud platform. + +**The prerequisite for takeover is that the target host has been taken over to the platform (all nodes of the cluster must be taken over), and it can be found in the host resource pool.** + +### Operating Instructions + +Takeover process 1 - Select Host + +Enter the primary database takeover page, select the host where the instance to be taken over is located, and click 【Connect】 to verify. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-4.png) + +Takeover process 2 - Select Instance + +After the host is connected successfully, the database instances not been taken over on the server will be displayed. Select the instance and enter the database administrator username and password. + +**Note: The database administrator should have the permissions to create users and view system parameters, otherwise, the takeover will fail.** + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-5.png) + +Takeover process 3 - Set Cluster Information + +After the user account is verified, cluster information needs to be set, including service name, Chinese name, database pool, and project group. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-6.png) + +Takeover process 4 - Takeover of Standby Instances and CM Instances + +If there are standby instances not taken over and CM nodes under the current primary instance, they will be scanned together and can be taken over together; + +**Note: If the standby instance and CM node are not in operation or the host is not taken over, they cannot be taken over.** + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-7.png) + +Takeover process 4 - Complete Takeover + +Click the 【Confirm】 button and wait for the takeover to complete. + +After successful takeover, the database information can be viewed on the instance management page. + +## Takeover of Standby Instance + +### Function Entrance + +Instance Management --> Click on the service name to enter details --> Below the instance list --> Click on Takeover Standby Instance + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-8.png) + +### Function Description + +The takeover of MogDB/openGauss database standby is to manage and monitor the already running MogDB/openGauss database standby in the database cloud platform. The prerequisite for takeover is that the target host has been taken over to the platform (all nodes of the cluster must be taken over), and it can be found in the host resource pool. + +### Operating Instructions + +The zcloud platform will automatically recognize existing standby databases, and you can select the standby database or CM node to be taken over. + +If there is a situation where the internal IP of the database is different from the management IP filled in during takeover, the correct internal IP must be filled in during takeover, otherwise, the corresponding management IP cannot be found through the internal IP. + +Click "Confirm" to start the takeover. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-9.png) + +After successful takeover, the managed database information can be viewed on the service details page. + +CM nodes need to switch to the high availability page to view. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/mogdb-opengauss/mogdb-opengauss-10.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/takeover/takeover.md b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/takeover/takeover.md new file mode 100644 index 0000000000000000000000000000000000000000..0954ef4531e2f7d46497b43b813022cba82afb0f --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/takeover/takeover.md @@ -0,0 +1,10 @@ +--- +title: Takeover +author: Guo Huan +date: 2024-08-12 +--- + +# Takeover + ++ **[Takeover With Hosts](./takeover-with-hosts.md)** ++ **[Takeover Cancellation](./takeover-cancellation.md)** \ No newline at end of file diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/monitor/dashboard-management.md b/product/en/docs-zcloud-for-mogdb/v6.3/monitor/dashboard-management.md new file mode 100644 index 0000000000000000000000000000000000000000..e8ce24d4592feee763105a269f005a3c9f6b8798 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/monitor/dashboard-management.md @@ -0,0 +1,91 @@ +--- +title: Dashboard Management +author: Guo Huan +date: 2024-08-12 +--- + +# Dashboard Management + +## Function Entrance + +Left-hand function bar --> Monitoring & Alerts --> Dashboard Management + +## Function Description + +Display and modify all available dashboard configurations for the tenant. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/monitor/monitor-6.png) + +## Operating Instructions + +### List + +Modify the dashboard name, category, and activation status. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/monitor/monitor-7.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/monitor/monitor-8.png) + +Click on the dashboard name to enter the dashboard editing page. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/monitor/monitor-9.png) + +### Customize Dashboard + +Create a custom dashboard by modifying an existing dashboard or creating a new one, which can include custom charts. + +In the dashboard editing page, there is no data displayed initially. You can specify MogDB instances, MogDB clusters, and hosts as monitoring data sources to display on the template for configuration and debugging. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/monitor/monitor-10.png) + +Click the "Edit" button to modify individual charts. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/monitor/monitor-11.png) + +Click "Variable Management" to set predefined and custom variables for use when collecting custom charts. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/monitor/monitor-12.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/monitor/monitor-13.png) + +Click the "Add Chart" button to add custom charts. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/monitor/monitor-14.png) + +You can choose single-value charts or graphical charts. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/monitor/monitor-15.png) + +Select the graphical chart to enter the graphical chart customization page. + +The instance, database, host, and time period specified at the top indicate the objects from which data is currently extracted for display, used for debugging. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/monitor/monitor-16.png) + +Specify the chart name and description on the common interface. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/monitor/monitor-17.png) + +On the Data Metrics page, specify the details of data collection, and you can choose built-in metrics or customize collection with Prometheus syntax. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/monitor/monitor-18.png) + +Click the "Add Metric" button to add multiple metrics to the same chart. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/monitor/monitor-19.png) + +The coordinate axis, legend, and icon display can specify the display method of the graph. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/monitor/monitor-20.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/monitor/monitor-21.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/monitor/monitor-22.png) + +After setting up, click "Confirm" to add the new chart to the dashboard. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/monitor/monitor-23.png) + +Click the "Save" button to save the current chart settings and layout in the dashboard. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/monitor/monitor-24.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/monitor/host-monitoring.md b/product/en/docs-zcloud-for-mogdb/v6.3/monitor/host-monitoring.md new file mode 100644 index 0000000000000000000000000000000000000000..d16fad4266bc65496a0e69ad28ff12b376e458b8 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/monitor/host-monitoring.md @@ -0,0 +1,43 @@ +--- +title: Host Monitoring +author: Guo Huan +date: 2024-08-12 +--- + +# Host Monitoring + +## Function Entrance + +Monitoring & Alerts --> Host Monitoring + +## Function Description + +This page displays the host's runtime, CPU and memory utilization rates. Host space information can be viewed through the resource pool, and alert messages will be sent when thresholds are triggered. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/monitor/monitor-1.png) + +## Operating Instructions + +### Start/Stop Host Monitoring + +Activate or deactivate the database cloud management platform's monitoring of the target host. Hosts and databases managed by the platform will have monitoring enabled by default. + +Click Monitoring & Alerts --> Host Monitoring --> Start Monitoring / Stop Monitoring. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/monitor/monitor-2.png) + +### Start/Stop Database Monitoring + +Activate or deactivate the database cloud management platform's monitoring of the target database. Hosts and databases managed by the platform will have monitoring enabled by default. + +Click the corresponding database --> Performance Monitoring --> Start Monitoring / Stop Monitoring. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/monitor/monitor-3.png) + +### View More Details + +For more detailed host performance monitoring data, go to the performance charts of the corresponding database - Host Performance. On the database's performance chart page, click "Switch Chart," and select "Host Performance" from the drop-down menu. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/monitor/monitor-4.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/monitor/monitor-5.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/monitor/metrics-management.md b/product/en/docs-zcloud-for-mogdb/v6.3/monitor/metrics-management.md new file mode 100644 index 0000000000000000000000000000000000000000..bf7116cdcdce2b62119cf12de701240da864c515 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/monitor/metrics-management.md @@ -0,0 +1,111 @@ +--- +title: Metrics Management +author: Guo Huan +date: 2024-08-12 +--- + +# Metrics Management + +## Function Entrance + +Monitor Alerts --> Metrics Management + +## Function Description + +1. View the platform's predefined collection metrics. +2. Create, modify, and delete custom SQL/SHELL collection database metrics, which are collected by the platform through Prometheus. +3. Set the retention period for collection metrics. + +## Operating Instructions + +### Collection Metrics List + +The collection metrics list page displays various database types and host collection metrics currently available on the platform. The left-hand menu allows you to click and switch between views. The number after the name represents the quantity of collection metrics for that type. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/monitor/monitor-25.png) + +The source field can distinguish whether the collection metric is predefined by the platform or created by the user. Predefined metrics can only be viewed and cannot be edited, deleted, or disabled. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/monitor/monitor-26.png) + +Custom metrics support disabling, modifying, and deleting. **These operations may cause the configured alerts and monitoring functions to fail, please proceed with caution**! + +### Create Custom Metrics + +If the platform's predefined collection items do not meet your needs, you can click the [Create] button to create a new metric collection. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/monitor/monitor-27.png) + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/monitor/monitor-28.png) + +**Collection Metric Name**: Supports input in Chinese, the display name of the metric within the platform. + +**Metric English Name**: The unique identifier for the metric collection, in the Prometheus collection item command rules as: database type_custom_metric English name. + +**Metric Grouping**: Host or MogDB/openGauss. + +**Enable Status**: Enabled means automatically activated upon creation. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/monitor/monitor-29.png) + +**Collection Script Type**: Supports SQL or SHELL. + +**Value Type**: + +1. Direct value, Prometheus gauges, an increment-decrement metric type, monitoring and alerting calculate the directly obtained value. +2. Cumulative value, Prometheus counters, an increment-only metric type, unless reset, monitoring and alerting calculate the incremental difference. + +**Collection Frequency**: The interval time between two collections, default is 2 minutes. + +**Collection Dimension**: + +1. Database Cluster: Collect by database, one database is collected once. +2. Database Instance: Collect by instance, all instances will be collected. + +**Collection Scheme**: Supports different collection scripts for different database versions or specified databases. The collection will automatically select the matching collection scheme for data collection. Schemes support adding, deleting, and modifying. + +**SQL Statement**: + +1. The SQL statement for collection must be a select statement. +2. The text must not exceed 10K. +3. Fields must start with an English letter and can include numbers and underscores, dashes, to be consistent with Prometheus label tags. +4. The last field must be numeric because the collected data will be summarized and displayed by Prometheus, and the last field serves as the Prometheus metric value, so it must be numeric. +5. SQL statements can query up to 10 fields. +6. The collection return value should not be too large to avoid affecting performance. +7. Do not end the SQL statement with a semicolon. + +**SHELL Statement**: + +1. The script return result must be in standard JSON format. +2. The field names in the result can only be a combination of English letters, numbers, underscores, and dashes, starting with an English letter. +3. The result can have no more than 10 fields. +4. The last field will serve as the metric value, so it must be numeric. +5. You can introduce variables to obtain current database information, please refer to the page prompts for variables of different database types. + +After inputting the statement, click "Test SQL Statement" to test if the collection SQL can run normally. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/monitor/monitor-30.png) + +You need to select a test database object in the pop-up window: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/monitor/monitor-31.png) + +After a successful test, the result will be displayed: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/monitor/monitor-32.png) + +All schemes must be tested and passed before you can click [Confirm] to save. + +Wait for a while (about 2-3 minutes) and then log in to the platform's Prometheus management page to check if the collection is successful. The address is: `http://platform_IP_address:8093`. Enter the English name of the custom SQL metric collection, and it will automatically associate and display. Click "Execute" to run the query (there may be no data returned within the collection interval). + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/monitor/monitor-33.png) + +Click "Graph" to view historical collection values: + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/monitor/monitor-34.png) + +### Data Retention Settings + +You can set the retention period for the platform's collection metrics, which defaults to 30 days. + +![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/monitor/monitor-35.png) diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/monitor/monitor.md b/product/en/docs-zcloud-for-mogdb/v6.3/monitor/monitor.md new file mode 100644 index 0000000000000000000000000000000000000000..fcdce06706fa935974e5fb13b3da34eaec010802 --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/monitor/monitor.md @@ -0,0 +1,11 @@ +--- +title: Monitoring +author: Guo Huan +date: 2024-08-12 +--- + +# Monitoring + ++ **[Host Monitoring](./host-monitoring.md)** ++ **[Dashboard Management](./dashboard-management.md)** ++ **[Metrics Management](./metrics-management.md)** \ No newline at end of file diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/overview.md b/product/en/docs-zcloud-for-mogdb/v6.3/overview.md new file mode 100644 index 0000000000000000000000000000000000000000..988de31936df71b878ad492846ad217016e665bf --- /dev/null +++ b/product/en/docs-zcloud-for-mogdb/v6.3/overview.md @@ -0,0 +1,35 @@ +--- +title: Product Introduction +author: Guo Huan +date: 2024-08-08 +--- + +# Product Introduction + +## Product Overview + +The zCloud Database Cloud Management Platform (for MogDB) is a platform designed for users of MogDB and openGauss to provide full lifecycle operation and maintenance management of databases. The platform covers the pre-planning, ongoing monitoring, and post-disposal stages of openGauss and MogDB databases, thereby helping DBAs improve database operation and maintenance efficiency and business security. + +
+ +## Application Scenarios + +### Database Automatic Installation and Deployment + +Supports the automated installation and deployment of different versions, architectures, and types of openGauss and MogDB databases, integrating best practice configuration templates to quickly build databases that meet best practice standards. + +### Real-time Monitoring and Alerting + +Provides monitoring and trend analysis of database operation metrics from different dimensions, quickly discovers various database exceptions, and sends real-time alerts. This approach prevents most database issues at the outset, reducing or avoiding the occurrence of failures and minimizing the business impact of outages. + +### Intelligent Health Inspection + +By judging the database operation status data and analyzing related indicators, and combining expert perspectives with algorithm knowledge bases, it comprehensively checks for health hazards in the database. This helps users better understand the database operation status, provides suggestions for improvement, and continuously optimizes the database on a cyclical basis, significantly reducing the workload of DBA personnel. + +### Performance Viewing, Analysis, and Processing + +By analyzing database performance metrics and related objects, it quickly analyzes, locates, and resolves database performance issues, enhancing the stability and reliability of database operations. + +### High Availability Management + +One-click deployment of high-availability database architectures, real-time detection, and automatic fault diagnosis quickly identify abnormal states of business nodes. Under the premise of ensuring data integrity and consistency, it rapidly performs high-availability switching to ensure business continuity. Supports custom high-availability strategies to meet the high-availability and disaster recovery management needs of different scenarios and businesses. \ No newline at end of file diff --git a/product/en/docs-zcloud-for-mogdb/v6.3/toc.md b/product/en/docs-zcloud-for-mogdb/v6.3/toc.md index a7f5553af0296707acf8bec90f3ab3bbc150d510..f3a7a1cdb80a5b2ba665729663ce02600c7200e6 100644 --- a/product/en/docs-zcloud-for-mogdb/v6.3/toc.md +++ b/product/en/docs-zcloud-for-mogdb/v6.3/toc.md @@ -11,7 +11,7 @@ + [Platform Tenant Management](./basic-features/platform-tenant-management.md) + [Platform User Management](./basic-features/platform-user-management.md) + [TOTP Certification](./basic-features/totp-certification.md) - + [Basic-Data-Definition](./basic-features/basic-data-definition.md) + + [Basic Data Definition](./basic-features/basic-data-definition.md) + [Media Management](./basic-features/media-management.md) + [Command Management](./basic-features/command-management.md) + [Mail Server Configuration](./basic-features/mail-server-configuration.md) diff --git a/product/zh/docs-zcloud-for-mogdb/v6.3/alert-center/alert-message-sending-channel.md b/product/zh/docs-zcloud-for-mogdb/v6.3/alert-center/alert-message-sending-channel.md index 19d78a60b585860d48e735ed0ef682c51fd7b7a5..4926e52ec9a7764f2b1118e728ef43d05eeb9e6e 100644 --- a/product/zh/docs-zcloud-for-mogdb/v6.3/alert-center/alert-message-sending-channel.md +++ b/product/zh/docs-zcloud-for-mogdb/v6.3/alert-center/alert-message-sending-channel.md @@ -52,15 +52,15 @@ date: 2024-08-12 #### 涉及功能入口 -告警中心 --＞告警联系人 +告警中心 --> 告警联系人 -告警中心 --＞告警模板 +告警中心 --> 告警模板 -告警中心 --＞告警消息发送通道 +告警中心 --> 告警消息发送通道 #### 前提条件 -1、如果目标类型为个人企业微信，需要客户的企业微信管理员提供接收告警通知的应用信息（包括企业ID、应用Agentld和应用Secret) +1、如果目标类型为个人企业微信，需要客户的企业微信管理员提供接收告警通知的应用信息（包括企业ID、应用Agentld和应用Secret） 2、如果目标类型为个人企业微信，需要在告警联系人中配置企业微信邮箱、手机号码、个人邮箱，并加入到对应告警模板中。 @@ -72,13 +72,13 @@ date: 2024-08-12 步骤概览： -1、告警联系人页面：配置企业微信邮箱等个人信息 --＞2、告警模板页面：选择告警联系人 --＞3、告警消息发送通道页面：配置策略并设置应用等信息 +1、告警联系人页面：配置企业微信邮箱等个人信息 --> 2、告警模板页面：选择告警联系人 --> 3、告警消息发送通道页面：配置策略并设置应用等信息 详细步骤： 1、告警联系人配置手机号和企业微信邮箱、个人邮箱。 -需在告警中心 --＞告警联系人 --＞编辑页面内设置企业微信邮箱，个人邮箱、手机号码； +需在告警中心 --> 告警联系人 --> 编辑页面内设置企业微信邮箱，个人邮箱、手机号码； 企业邮箱，个人邮箱、手机号码至少填1个，能关联到企业微信ID；关联优先级：先用企业微信邮箱，再用个人邮箱、最后用手机号码； @@ -98,7 +98,7 @@ date: 2024-08-12 3、配置企业微信通道：推送给个人企业微信 -3.1、点击告警中心 --＞告警消息发送通道 --＞名称为：企业微信 -->配置 +3.1、点击告警中心 --> 告警消息发送通道 --> 名称为：企业微信 --> 配置 ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-73.png) @@ -112,7 +112,7 @@ date: 2024-08-12 ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-75.png) -3.3、填写策略名称、默认启用状态开启(如关闭启用状态，左侧列表对应策略状态显示灰色）； +3.3、填写策略名称、默认启用状态开启（如关闭启用状态，左侧列表对应策略状态显示灰色）； ![img](https://cdn-mogdb.enmotech.com/docs-media/zcloud-for-mogdb/alert-center/alert-center-76.png) @@ -144,7 +144,7 @@ date: 2024-08-12 1、创建企业微信群聊类型的告警联系组； -1.1、点击告警中心 --> 告警联系人--＞告警联系组切换到告警联系组页面； +1.1、点击告警中心 --> 告警联系人--> 告警联系组切换到告警联系组页面； 告警联系组列表，组成员类型分为：告警联系人、企业微信群聊；如下图： diff --git a/product/zh/docs-zcloud-for-mogdb/v6.3/basic-features/monitor-large-screen.md b/product/zh/docs-zcloud-for-mogdb/v6.3/basic-features/monitor-large-screen.md index c91af08751db177e26a624cebcb085b84f692088..1ac2348991838bfd86bdf2564fb8b2c0f94db650 100644 --- a/product/zh/docs-zcloud-for-mogdb/v6.3/basic-features/monitor-large-screen.md +++ b/product/zh/docs-zcloud-for-mogdb/v6.3/basic-features/monitor-large-screen.md @@ -22,7 +22,7 @@ date: 2024-08-12 **openGauss/MogDB** -监控大屏功 能支持： +监控大屏功能支持： - 支持全网或自定义范围数据库的关键指标排行监控； - 支持接收活动告警和告警语音播报 @@ -133,7 +133,7 @@ date: 2024-08-12 7，展示当前数据库的内存情况，默认为以下三种，根据数据库类型不同，指标会有差异； -- 空间使用量 +- 空间使用量 - 归档空间使用量 - 内存使用量 @@ -185,4 +185,4 @@ date: 2024-08-12 - 5.7，可以自定义指标名称，支持输入2-16个字符； - 5.8，可以输入Prometheus表达式，获取指标所需的展示数据，支持输出入1-4096个字符； - 5.9，可以设置指标的阈值，满足阈值条件后，会在对应的图表内标识为红色； -- 5.10，可以选择是否启用，禁用的指标在监控大屏不会展示； +- 5.10，可以选择是否启用，禁用的指标在监控大屏不会展示； diff --git a/product/zh/docs-zcloud-for-mogdb/v6.3/basic-features/platform-proxy-nodes-management.md b/product/zh/docs-zcloud-for-mogdb/v6.3/basic-features/platform-proxy-nodes-management.md index 727474f979111140ad5d79ba4ce4ffe4a4e7f579..dfa1ccfa1439471195430f7ab5cb55e161f4e6a5 100644 --- a/product/zh/docs-zcloud-for-mogdb/v6.3/basic-features/platform-proxy-nodes-management.md +++ b/product/zh/docs-zcloud-for-mogdb/v6.3/basic-features/platform-proxy-nodes-management.md @@ -14,7 +14,7 @@ date: 2024-08-12 ## 功能说明 -此步骤在安装手册中也有，在部署完软件后第一步安装操作就是安装Proxy(代理）。可减少网络隔离带来的困扰。 +此步骤在安装手册中也有，在部署完软件后第一步安装操作就是安装Proxy（代理）。可减少网络隔离带来的困扰。 在一个网络隔离区中，只需部署一台代理服务器，保证代理服务器可以和其它数据库服务器通信，并且代理服务器和平台通信即可，减少了平台到数据库目标主机网络的开通。 diff --git a/product/zh/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/installation-and-deployment/installation-and-deployment.md b/product/zh/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/installation-and-deployment/installation-and-deployment.md index 5c40e1df8d3af592f3272042e9b6d2d4e9d9744b..c9f9fb014e45e1a84c53ce5022c829545b318dc3 100644 --- a/product/zh/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/installation-and-deployment/installation-and-deployment.md +++ b/product/zh/docs-zcloud-for-mogdb/v6.3/mogdb-opengauss/installation-and-deployment/installation-and-deployment.md @@ -1,5 +1,5 @@ --- -title: 纳管用户权限说明 +title: 安装配置 author: Guo Huan date: 2024-08-12 --- diff --git a/product/zh/docs-zcloud-for-mogdb/v6.3/overview.md b/product/zh/docs-zcloud-for-mogdb/v6.3/overview.md index 0884679cbbd92e814a339564c7bae0f8f962a122..264b48856488222cb63a7f3cdb5e58bd0ebd09f6 100644 --- a/product/zh/docs-zcloud-for-mogdb/v6.3/overview.md +++ b/product/zh/docs-zcloud-for-mogdb/v6.3/overview.md @@ -8,7 +8,7 @@ date: 2024-08-08 ## 产品概述 -zCloud数据库云管平台（for MogDB），是面向使用MogDB、OpenGauss的用户提供数据库全生命运维管理的平台。平台覆盖了OpenGauss和MogDB数据库事前规划、事中监控、事后处置各个阶段，从而帮助DBA提升数据库运维管理效率和业务安全性。 +zCloud数据库云管平台（for MogDB），是面向使用MogDB、openGauss的用户提供数据库全生命运维管理的平台。平台覆盖了openGauss和MogDB数据库事前规划、事中监控、事后处置各个阶段，从而帮助DBA提升数据库运维管理效率和业务安全性。
@@ -16,7 +16,7 @@ zCloud数据库云管平台（for MogDB），是面向使用MogDB、OpenGauss的 ### 数据库自动安装部署 -支持OpenGauss、MogDB数据库不同版本/架构/类型的自动化安装部署，融合了最佳实践配置模板，快速构建标准的符合最佳实践的数据库。 +支持openGauss、MogDB数据库不同版本/架构/类型的自动化安装部署，融合了最佳实践配置模板，快速构建标准的符合最佳实践的数据库。 ### 实时监控告警 diff --git a/product/zh/docs-zcloud-for-mogdb/v6.3/toc.md b/product/zh/docs-zcloud-for-mogdb/v6.3/toc.md index a53aaa3c893c52ccd788d00b978348c03916b4bd..c8ca28082d6ee583f112337556f8edda80085c8a 100644 --- a/product/zh/docs-zcloud-for-mogdb/v6.3/toc.md +++ b/product/zh/docs-zcloud-for-mogdb/v6.3/toc.md @@ -32,7 +32,7 @@ + [租户Proxy节点管理](./basic-features/tenant-proxy-nodes-management.md) + [导航菜单管理](./basic-features/menu-management.md) + [报表中心](./basic-features/report-center.md) -+ [MogDB/openGauss数据库](./mogdb-opengauss/mogdb-opengauss.md) ++ [MogDB/openGauss](./mogdb-opengauss/mogdb-opengauss.md) + [纳管](./mogdb-opengauss/takeover/takeover.md) + [有主机纳管](./mogdb-opengauss/takeover/takeover-with-hosts.md) + [取消纳管](./mogdb-opengauss/takeover/takeover-cancellation.md)