diff --git a/umn/source/_static/images/en-us_image_0000001287445428.png b/umn/source/_static/images/en-us_image_0000001287445428.png new file mode 100644 index 0000000..00d2037 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001287445428.png differ diff --git a/umn/source/_static/images/en-us_image_0000001287445440.png b/umn/source/_static/images/en-us_image_0000001287445440.png new file mode 100644 index 0000000..1909444 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001287445440.png differ diff --git a/umn/source/_static/images/en-us_image_0000001287445448.png b/umn/source/_static/images/en-us_image_0000001287445448.png new file mode 100644 index 0000000..1909444 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001287445448.png differ diff --git a/umn/source/_static/images/en-us_image_0000001287445456.png b/umn/source/_static/images/en-us_image_0000001287445456.png new file mode 100644 index 0000000..1909444 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001287445456.png differ diff --git a/umn/source/_static/images/en-us_image_0000001287445460.jpg b/umn/source/_static/images/en-us_image_0000001287445460.jpg new file mode 100644 index 0000000..a386f23 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001287445460.jpg differ diff --git a/umn/source/_static/images/en-us_image_0000001287605360.png b/umn/source/_static/images/en-us_image_0000001287605360.png new file mode 100644 index 0000000..1909444 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001287605360.png differ diff --git a/umn/source/_static/images/en-us_image_0000001287605372.png b/umn/source/_static/images/en-us_image_0000001287605372.png new file mode 100644 index 0000000..1909444 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001287605372.png differ diff --git a/umn/source/_static/images/en-us_image_0000001287765296.png b/umn/source/_static/images/en-us_image_0000001287765296.png new file mode 100644 index 0000000..1909444 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001287765296.png differ diff --git a/umn/source/_static/images/en-us_image_0000001287765312.png b/umn/source/_static/images/en-us_image_0000001287765312.png new file mode 100644 index 0000000..1909444 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001287765312.png differ diff --git a/umn/source/_static/images/en-us_image_0000001287765320.png b/umn/source/_static/images/en-us_image_0000001287765320.png new file mode 100644 index 0000000..1909444 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001287765320.png differ diff --git a/umn/source/_static/images/en-us_image_0000001287765328.jpg b/umn/source/_static/images/en-us_image_0000001287765328.jpg new file mode 100644 index 0000000..30be576 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001287765328.jpg differ diff --git a/umn/source/_static/images/en-us_image_0000001287924936.png b/umn/source/_static/images/en-us_image_0000001287924936.png new file mode 100644 index 0000000..1909444 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001287924936.png differ diff --git a/umn/source/_static/images/en-us_image_0000001287960790.jpg b/umn/source/_static/images/en-us_image_0000001287960790.jpg new file mode 100644 index 0000000..a386f23 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001287960790.jpg differ diff --git a/umn/source/_static/images/en-us_image_0000001288144356.png b/umn/source/_static/images/en-us_image_0000001288144356.png new file mode 100644 index 0000000..99460f8 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001288144356.png differ diff --git a/umn/source/_static/images/en-us_image_0000001288301616.png b/umn/source/_static/images/en-us_image_0000001288301616.png new file mode 100644 index 0000000..780afc2 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001288301616.png differ diff --git a/umn/source/_static/images/en-us_image_0000001288319004.png b/umn/source/_static/images/en-us_image_0000001288319004.png new file mode 100644 index 0000000..064e1ef Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001288319004.png differ diff --git a/umn/source/_static/images/en-us_image_0000001288469984.png b/umn/source/_static/images/en-us_image_0000001288469984.png new file mode 100644 index 0000000..ad9f771 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001288469984.png differ diff --git a/umn/source/_static/images/en-us_image_0000001340205081.png b/umn/source/_static/images/en-us_image_0000001340205081.png new file mode 100644 index 0000000..1909444 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001340205081.png differ diff --git a/umn/source/_static/images/en-us_image_0000001340205085.jpg b/umn/source/_static/images/en-us_image_0000001340205085.jpg new file mode 100644 index 0000000..76e70fb Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001340205085.jpg differ diff --git a/umn/source/_static/images/en-us_image_0000001340285285.png b/umn/source/_static/images/en-us_image_0000001340285285.png new file mode 100644 index 0000000..1909444 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001340285285.png differ diff --git a/umn/source/_static/images/en-us_image_0000001340285301.png b/umn/source/_static/images/en-us_image_0000001340285301.png new file mode 100644 index 0000000..1909444 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001340285301.png differ diff --git a/umn/source/_static/images/en-us_image_0000001340285305.png b/umn/source/_static/images/en-us_image_0000001340285305.png new file mode 100644 index 0000000..1909444 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001340285305.png differ diff --git a/umn/source/_static/images/en-us_image_0000001340285313.png b/umn/source/_static/images/en-us_image_0000001340285313.png new file mode 100644 index 0000000..09717d4 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001340285313.png differ diff --git a/umn/source/_static/images/en-us_image_0000001340285317.jpg b/umn/source/_static/images/en-us_image_0000001340285317.jpg new file mode 100644 index 0000000..a386f23 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001340285317.jpg differ diff --git a/umn/source/_static/images/en-us_image_0000001340320673.jpg b/umn/source/_static/images/en-us_image_0000001340320673.jpg new file mode 100644 index 0000000..a386f23 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001340320673.jpg differ diff --git a/umn/source/_static/images/en-us_image_0000001340405149.png b/umn/source/_static/images/en-us_image_0000001340405149.png new file mode 100644 index 0000000..1909444 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001340405149.png differ diff --git a/umn/source/_static/images/en-us_image_0000001340405153.png b/umn/source/_static/images/en-us_image_0000001340405153.png new file mode 100644 index 0000000..1909444 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001340405153.png differ diff --git a/umn/source/_static/images/en-us_image_0000001340405157.png b/umn/source/_static/images/en-us_image_0000001340405157.png new file mode 100644 index 0000000..1909444 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001340405157.png differ diff --git a/umn/source/_static/images/en-us_image_0000001340564653.png b/umn/source/_static/images/en-us_image_0000001340564653.png new file mode 100644 index 0000000..478a552 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001340564653.png differ diff --git a/umn/source/_static/images/en-us_image_0000001340638257.png b/umn/source/_static/images/en-us_image_0000001340638257.png new file mode 100644 index 0000000..0935390 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001340638257.png differ diff --git a/umn/source/_static/images/en-us_image_0000001340680421.jpg b/umn/source/_static/images/en-us_image_0000001340680421.jpg new file mode 100644 index 0000000..a386f23 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001340680421.jpg differ diff --git a/umn/source/_static/images/en-us_image_0000001340704041.png b/umn/source/_static/images/en-us_image_0000001340704041.png new file mode 100644 index 0000000..1909444 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001340704041.png differ diff --git a/umn/source/_static/images/en-us_image_0000001340709641.png b/umn/source/_static/images/en-us_image_0000001340709641.png new file mode 100644 index 0000000..9fb10da Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001340709641.png differ diff --git a/umn/source/change_history.rst b/umn/source/change_history.rst new file mode 100644 index 0000000..d5af6a7 --- /dev/null +++ b/umn/source/change_history.rst @@ -0,0 +1,87 @@ +:original_name: en-us_topic_0054617978.html + +.. _en-us_topic_0054617978: + +Change History +============== + +.. table:: **Table 1** Change History + + +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Released On | What's New | + +===================================+========================================================================================================================================================================================================================================================================================================+ + | 2020-07-17 | Modified the following content: | + | | | + | | - Added a note in section :ref:`Accessing a DCS Redis Instance ` to advise against hard-coding plaintext passwords in the code. | + | | - Added an explanation of the **SYS.DCS** namespace and optimized the table layout in section :ref:`DCS Metrics `. | + | | - Updated the picture that demonstrates viewing instance metrics in section :ref:`Setting Alarm Rules for Critical Metrics `. | + | | - Optimized the description about CIDR blocks for cross-VPC access and added the table caption in FAQ :ref:`Do DCS Instances Support Cross-VPC Access? ` | + +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 2020-05-30 | Modified the following content: | + | | | + | | - Changed the cluster instance type to Proxy Cluster in section :ref:`DCS `. | + | | - Removed description about creating multiple instances in batches and modified password complexity requirements in section :ref:`Creating a DCS Instance `. | + | | - Removed the instance topology parameter in section :ref:`Viewing Details of a DCS Instance `. | + | | - Changed the default value of the **reserved-memory-percent** parameter to **0** and added a note clarifying that the configuration parameters supported by single-node and master/standby instances are different in section :ref:`Configuring Redis-Specific Parameters `. | + | | - Modified the special characters that the passwords cannot contain in section :ref:`Changing Instance Passwords `. | + | | - Removed the section which describes the function of viewing data storage statics of a Proxy Cluster instance. | + | | - Added a note clarifying that the backup policy function is not supported by single-node instances in section :ref:`Configuring a Backup Policy `. | + | | - Removed Redis Server and Proxy metrics from section :ref:`DCS Metrics `. | + +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 2020-03-25 | Modified the following content: | + | | | + | | - Changed the cluster instance type to Proxy Cluster in section :ref:`DCS `. | + | | - Modified the lists of supported and disabled Redis commands in section :ref:`Redis Command Compatibility `. | + | | - Added the assured/maximum bandwidth parameter in section :ref:`DCS Instance Specifications `. | + | | - Moved the metrics originally described in section :ref:`Related Services ` to section :ref:`DCS Metrics ` and updated the metrics supported by Cloud Eye. | + | | - Modified instance creation parameters in :ref:`Creating a DCS Instance ` according to DCS console upgrade and parameter modifications. | + | | - Modified instance details parameters in section :ref:`Viewing Details of a DCS Instance ` according to DCS console upgrade and parameter modifications. | + | | - Modified instance configuration parameters in section :ref:`Configuring Redis-Specific Parameters `. | + | | - Removed the function of stopping instances. | + | | - Added description about restrictions of starting instances in section :ref:`Starting DCS Instances `. | + | | - Changed parameter **Time Window** to **Maintenance** in section :ref:`Modifying an Instance's Maintenance Time Window `. | + | | - Modified description about configuring instance backup policies in section :ref:`Configuring a Backup Policy `. | + | | - Added chapter :ref:`Monitoring `, updated metrics supported by Cloud Eye, and added description about operations of viewing monitoring data and setting alarm rules. | + | | - Changed the supported number of DBs for single-node and master/standby instances in section :ref:`Does DCS Support Data Read/Write in Multiple Databases? ` | + +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 2019-04-12 | Accepted in OTC-4.0/Agile-04.2019. | + +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 2019-03-30 | Modified the following content: | + | | | + | | - Removed support for creating DCS instances with the specification of 1 GB in sections :ref:`Advantages `, :ref:`DCS Instance Specifications `, and :ref:`Creating a DCS Instance `. | + +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 2018-09-05 | Modified the following content: | + | | | + | | - Opened certain Redis cluster commands. For details about compatibility with DCS commands, see :ref:`Redis Command Compatibility `. | + +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 2018-03-16 | Added the following content: | + | | | + | | - Added the procedure for using a Redis Java (Jedis) client to access a DCS instance. For details, see :ref:`Accessing a DCS Redis Instance `. | + | | - Added descriptions about the Redis-specific parameter **notify-keyspace-events**, anddeleted descriptions about the Redis-specific parameter **maxclients**. For details, see :ref:`Configuring Redis-Specific Parameters `. | + | | - Added the procedures for modifying the time window and security group of a DCS instance. For details, see :ref:`Modifying an Instance's Maintenance Time Window ` and :ref:`Modifying an Instance's Security Group `. | + | | - Added :ref:`Do DCS Instances Support Cross-VPC Access? ` in chapter :ref:`FAQs `. | + | | | + | | Modified the following content: | + | | | + | | - Changed instance password complexity rules. | + +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 2017-11-08 | Added the following content: | + | | | + | | - Provided support for DCS instances in cluster mode. | + | | - Added sections :ref:`Modifying DCS Instance Specifications ` and :ref:`Backing Up and Restoring DCS Instances `. | + | | - Added the **Time Window** parameter. | + | | - Added section :ref:`Setting Up Environments `. | + | | | + | | - Added some FAQs in chapter :ref:`FAQs `. | + +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 2017-05-30 | This issue is the third official release, which incorporates the following changes: | + | | | + | | - Added descriptions about batch deletion of DCS instances. | + | | - Added descriptions about the Redis-specific parameter **latency-monitor-threshold**. | + +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 2017-04-28 | Added the following content: | + | | | + | | - Added descriptions of DCS metrics monitored by Cloud Eye. | + +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 2017-04-05 | This issue is the first official release. | + +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/umn/source/faqs/can_dcs_be_accessed_over_public_networks.rst b/umn/source/faqs/can_dcs_be_accessed_over_public_networks.rst new file mode 100644 index 0000000..fbd9bf1 --- /dev/null +++ b/umn/source/faqs/can_dcs_be_accessed_over_public_networks.rst @@ -0,0 +1,8 @@ +:original_name: en-us_topic_0054235827.html + +.. _en-us_topic_0054235827: + +Can DCS Be Accessed over Public Networks? +========================================= + +DCS cannot be accessed over public networks. The ECS serving as your Redis client and the DCS instances that the Redis client want to access must belong to the same VPC. diff --git a/umn/source/faqs/can_i_modify_configuration_parameters_of_dcs_instances.rst b/umn/source/faqs/can_i_modify_configuration_parameters_of_dcs_instances.rst new file mode 100644 index 0000000..44e6170 --- /dev/null +++ b/umn/source/faqs/can_i_modify_configuration_parameters_of_dcs_instances.rst @@ -0,0 +1,8 @@ +:original_name: en-us_topic_0054235828.html + +.. _en-us_topic_0054235828: + +Can I Modify Configuration Parameters of DCS Instances? +======================================================= + +You can modify configuration parameters for DCS instances in the **Running** state. Note that configuration parameters of DCS instances in Proxy Cluster mode are not modifiable. diff --git a/umn/source/faqs/can_i_recover_data_from_deleted_dcs_instances.rst b/umn/source/faqs/can_i_recover_data_from_deleted_dcs_instances.rst new file mode 100644 index 0000000..e8a00fd --- /dev/null +++ b/umn/source/faqs/can_i_recover_data_from_deleted_dcs_instances.rst @@ -0,0 +1,12 @@ +:original_name: en-us_topic_0054235829.html + +.. _en-us_topic_0054235829: + +Can I Recover Data from Deleted DCS Instances? +============================================== + +Data that is automatically deleted by DCS instances or manually deleted by users using Redis clients cannot be recovered. By default, data is not evicted from DCS instances. However, you can modify the value of the maxmemory-policy parameter to adjust the eviction policy, and then DCS instances evict keys according to the eviction policy. + +If a DCS instance is deleted, instance data will also be removed and cannot be recovered. Therefore, exercise caution when deleting DCS instances. + +Master/Standby DCS instances support data backup. If you have backed up the instance data before deleting them, the deleted instance data can be recovered. diff --git a/umn/source/faqs/do_dcs_instances_in_cluster_mode_support_native_redis_clusters.rst b/umn/source/faqs/do_dcs_instances_in_cluster_mode_support_native_redis_clusters.rst new file mode 100644 index 0000000..0e76b5e --- /dev/null +++ b/umn/source/faqs/do_dcs_instances_in_cluster_mode_support_native_redis_clusters.rst @@ -0,0 +1,8 @@ +:original_name: en-us_topic_0072544389.html + +.. _en-us_topic_0072544389: + +Do DCS Instances in Cluster Mode Support Native Redis Clusters? +=============================================================== + +DCS instances in cluster mode do not support native Redis clusters. DCS clusters use the proxy-based cluster mode, so when you query the parameters of the native Redis cluster, DCS retains the default values for some parameters, for example, **cluster_enabled:0**. diff --git a/umn/source/faqs/do_dcs_instances_support_cross-vpc_access.rst b/umn/source/faqs/do_dcs_instances_support_cross-vpc_access.rst new file mode 100644 index 0000000..a3a9777 --- /dev/null +++ b/umn/source/faqs/do_dcs_instances_support_cross-vpc_access.rst @@ -0,0 +1,35 @@ +:original_name: en-us_topic_0103202022.html + +.. _en-us_topic_0103202022: + +Do DCS Instances Support Cross-VPC Access? +========================================== + +Generally, VPCs are isolated from each other and ECSs cannot access DCS instances that belong to a different VPC from these ECSs. + +However, by establishing VPC peering connections between VPCs, ECSs can access DCS instances across VPCs. + +When using VPC peering connections to access DCS instances across VPCs, adhere to the following rules: + +.. table:: **Table 1** Client CIDR block constraints + + +-----------------------------------+-------------------------------------+ + | CIDR Blocks of DCS Instances | CIDR Blocks Not Allowed for Clients | + +===================================+=====================================+ + | 172.16.0.0/12 to 172.16.0.0/24 | 192.168.1.0/24 | + | | | + | | 192.168.2.0/24 | + | | | + | | 192.168.3.0/24 | + +-----------------------------------+-------------------------------------+ + | 192.168.0.0/16 to 192.168.0.0/24 | 172.31.1.0/24 | + | | | + | 10.0.0.0/8 to 10.0.0.0/24 | 172.31.2.0/24 | + | | | + | | 172.31.3.0/24 | + +-----------------------------------+-------------------------------------+ + +.. note:: + + - The right column lists the CIDR blocks used by the subnets of the resource tenant. The clients cannot use these subnets. + - For more information about creating and using VPC peering connections, see the *Virtual Private Cloud User Guide*. diff --git a/umn/source/faqs/do_i_need_to_enter_a_password_when_accessing_a_dcs_instance_where_can_i_obtain_the_password.rst b/umn/source/faqs/do_i_need_to_enter_a_password_when_accessing_a_dcs_instance_where_can_i_obtain_the_password.rst new file mode 100644 index 0000000..72968d6 --- /dev/null +++ b/umn/source/faqs/do_i_need_to_enter_a_password_when_accessing_a_dcs_instance_where_can_i_obtain_the_password.rst @@ -0,0 +1,10 @@ +:original_name: en-us_topic_0066854411.html + +.. _en-us_topic_0066854411: + +Do I Need to Enter a Password When Accessing a DCS Instance? Where Can I Obtain the Password? +============================================================================================= + +Redis allows clients to access cache service directly without any password. + +In DCS, additional efforts have been made to harden Redis. A client must enter the correct password before it is allowed to access DCS instances. The instance password is manually assigned when you are creating a DCS instance. diff --git a/umn/source/faqs/does_dcs_support_common_redis_clients_such_as_jedis.rst b/umn/source/faqs/does_dcs_support_common_redis_clients_such_as_jedis.rst new file mode 100644 index 0000000..184227b --- /dev/null +++ b/umn/source/faqs/does_dcs_support_common_redis_clients_such_as_jedis.rst @@ -0,0 +1,8 @@ +:original_name: en-us_topic_0054235822.html + +.. _en-us_topic_0054235822: + +Does DCS Support Common Redis Clients Such as Jedis? +==================================================== + +DCS supports all clients compatible with Redis, including Jedis. You can download Redis clients from http://redis.io/clients. diff --git a/umn/source/faqs/does_dcs_support_data_persistence.rst b/umn/source/faqs/does_dcs_support_data_persistence.rst new file mode 100644 index 0000000..da46238 --- /dev/null +++ b/umn/source/faqs/does_dcs_support_data_persistence.rst @@ -0,0 +1,8 @@ +:original_name: en-us_topic_0054235825.html + +.. _en-us_topic_0054235825: + +Does DCS Support Data Persistence? +================================== + +Only master/standby and Proxy Cluster DCS instances support data persistence. diff --git a/umn/source/faqs/does_dcs_support_data_read_write_in_multiple_databases.rst b/umn/source/faqs/does_dcs_support_data_read_write_in_multiple_databases.rst new file mode 100644 index 0000000..181eb81 --- /dev/null +++ b/umn/source/faqs/does_dcs_support_data_read_write_in_multiple_databases.rst @@ -0,0 +1,10 @@ +:original_name: en-us_topic_0071964265.html + +.. _en-us_topic_0071964265: + +Does DCS Support Data Read/Write in Multiple Databases? +======================================================= + +Both single-node and master/standby DCS instances support data read/write in multiple databases. By default, single-node and master/standby DCS instances can read and write data in 256 databases (databases 0-255). + +DCS instances in Proxy Cluster mode do not support data read/write in multiple databases. diff --git a/umn/source/faqs/does_standby_cache_node_remain_synchronized_with_master_cache_node.rst b/umn/source/faqs/does_standby_cache_node_remain_synchronized_with_master_cache_node.rst new file mode 100644 index 0000000..65833ce --- /dev/null +++ b/umn/source/faqs/does_standby_cache_node_remain_synchronized_with_master_cache_node.rst @@ -0,0 +1,13 @@ +:original_name: en-us_topic_0054235824.html + +.. _en-us_topic_0054235824: + +Does Standby Cache Node Remain Synchronized with Master Cache Node? +=================================================================== + +Generally, updates to the master cache node are automatically and asynchronously replicated to the standby cache node. This means that data in the standby cache node may not always be consistent with data in the master cache node. This inconsistency is typically seen in either of the following situations: + +- The input/output (I/O) write speed of the master cache node is faster than the synchronization speed of the standby cache node. +- There is network latency between the master and standby cache nodes. + +If a failover occurs when some data is not yet replicated to the standby cache node, the unreplicated data may be lost after the failover. diff --git a/umn/source/faqs/how_to_select_and_configure_a_security_group.rst b/umn/source/faqs/how_to_select_and_configure_a_security_group.rst new file mode 100644 index 0000000..da7bf09 --- /dev/null +++ b/umn/source/faqs/how_to_select_and_configure_a_security_group.rst @@ -0,0 +1,32 @@ +:original_name: en-us_topic_0082605221.html + +.. _en-us_topic_0082605221: + +How to Select and Configure a Security Group? +============================================= + +An ECS can communicate with a DCS instance if they belong to the same VPC and security group rules are configured correctly. + +It is recommended that the ECS and DCS instance belong to the same security group. After a security group is created, the security group rules, by default, include a rule allowing members in the security group to access each other without any restrictions. + +If the ECS and DCS instance belong to different security groups, add security group rules to ensure that the ECS and DCS instance can access each other. + +.. note:: + + The example rules provided here are based on the assumption that: + + - The ECS on which the client runs belongs to security group **sg-ECS**, and the DCS instance that the client will access belongs to security group **sg-DCS**. + - The port number of the DCS instance is 6379. + - The remote end is a security group or an IP address. + + +.. figure:: /_static/images/en-us_image_0000001340638257.png + :alt: **Figure 1** Security group rules allowing the ECS to access the DCS instance + + **Figure 1** Security group rules allowing the ECS to access the DCS instance + + +.. figure:: /_static/images/en-us_image_0000001288319004.png + :alt: **Figure 2** Security group rules making the DCS instance accessible to the ECS + + **Figure 2** Security group rules making the DCS instance accessible to the ECS diff --git a/umn/source/faqs/index.rst b/umn/source/faqs/index.rst new file mode 100644 index 0000000..70037a8 --- /dev/null +++ b/umn/source/faqs/index.rst @@ -0,0 +1,48 @@ +:original_name: en-us_topic_0054235821.html + +.. _en-us_topic_0054235821: + +FAQs +==== + +- :ref:`Does DCS Support Common Redis Clients Such as Jedis? ` +- :ref:`Should I Install Redis If I Already Have a DCS Instance? ` +- :ref:`Do I Need to Enter a Password When Accessing a DCS Instance? Where Can I Obtain the Password? ` +- :ref:`Does Standby Cache Node Remain Synchronized with Master Cache Node? ` +- :ref:`Does DCS Support Data Persistence? ` +- :ref:`Can DCS Be Accessed over Public Networks? ` +- :ref:`Can I Modify Configuration Parameters of DCS Instances? ` +- :ref:`Can I Recover Data from Deleted DCS Instances? ` +- :ref:`What Is the Default Data Eviction Policy? ` +- :ref:`What Should I Do If the Connection Between My Redis Client and the DCS Instance Times Out? ` +- :ref:`Why Is Available Memory of Unused DCS Instances Less Than Total Memory? Why Is Memory Usage of Unused DCS Instances Greater Than Zero? ` +- :ref:`Does DCS Support Data Read/Write in Multiple Databases? ` +- :ref:`Why Can't I Back Up or Scale Up My DCS Instances? ` +- :ref:`Do DCS Instances in Cluster Mode Support Native Redis Clusters? ` +- :ref:`Why Do My DCS Instances Sometimes Become Unavailable While They Are in Running State? ` +- :ref:`Why Is the Used Instance Memory Displayed on Cloud Eye Console Slightly Higher than the Instance Available Memory? ` +- :ref:`How to Select and Configure a Security Group? ` +- :ref:`Do DCS Instances Support Cross-VPC Access? ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + does_dcs_support_common_redis_clients_such_as_jedis + should_i_install_redis_if_i_already_have_a_dcs_instance + do_i_need_to_enter_a_password_when_accessing_a_dcs_instance_where_can_i_obtain_the_password + does_standby_cache_node_remain_synchronized_with_master_cache_node + does_dcs_support_data_persistence + can_dcs_be_accessed_over_public_networks + can_i_modify_configuration_parameters_of_dcs_instances + can_i_recover_data_from_deleted_dcs_instances + what_is_the_default_data_eviction_policy + what_should_i_do_if_the_connection_between_my_redis_client_and_the_dcs_instance_times_out + why_is_available_memory_of_unused_dcs_instances_less_than_total_memory_why_is_memory_usage_of_unused_dcs_instances_greater_than_zero + does_dcs_support_data_read_write_in_multiple_databases + why_cant_i_back_up_or_scale_up_my_dcs_instances + do_dcs_instances_in_cluster_mode_support_native_redis_clusters + why_do_my_dcs_instances_sometimes_become_unavailable_while_they_are_in_running_state + why_is_the_used_instance_memory_displayed_on_cloud_eye_console_slightly_higher_than_the_instance_available_memory + how_to_select_and_configure_a_security_group + do_dcs_instances_support_cross-vpc_access diff --git a/umn/source/faqs/should_i_install_redis_if_i_already_have_a_dcs_instance.rst b/umn/source/faqs/should_i_install_redis_if_i_already_have_a_dcs_instance.rst new file mode 100644 index 0000000..0563cee --- /dev/null +++ b/umn/source/faqs/should_i_install_redis_if_i_already_have_a_dcs_instance.rst @@ -0,0 +1,8 @@ +:original_name: en-us_topic_0054235823.html + +.. _en-us_topic_0054235823: + +Should I Install Redis If I Already Have a DCS Instance? +======================================================== + +It is not necessary to install Redis in this case. You can access your DCS instance through a Redis client. diff --git a/umn/source/faqs/what_is_the_default_data_eviction_policy.rst b/umn/source/faqs/what_is_the_default_data_eviction_policy.rst new file mode 100644 index 0000000..910f749 --- /dev/null +++ b/umn/source/faqs/what_is_the_default_data_eviction_policy.rst @@ -0,0 +1,40 @@ +:original_name: en-us_topic_0054235830.html + +.. _en-us_topic_0054235830: + +What Is the Default Data Eviction Policy? +========================================= + +Data is evicted from the cache based on the user-defined space limit in order to make space for new data. + +By default, data is not evicted from DCS instances. In the current version of DCS, you can select an eviction policy. + +When maxmemory is reached, you can select one of the following six eviction policies: + +- noeviction + + When the memory limit is reached, DCS instances return errors to clients and no longer process write requests or other requests that could result in more memory being used. However, DEL and a few more exception requests can continue to be processed. + +- allkeys-lru + + DCS instances try to evict the least recently used keys first, in order to make space for new data. + +- volatile-lru + + DCS instances try to evict the least recently used keys with an expire set first, in order to make space for new data. + +- allkeys-random + + DCS instances evict random keys in order to make space for new data. + +- volatile-random + + DCS instances evict random keys with an expire set, in order to make space for new data. + +- volatile-ttl + + DCS instances evict keys with an expire set, and try to evict keys with a shorter time to live (TTL) first, in order to make space for new data. + +.. note:: + + If the configured policy is volatile-lru, volatile-random, or volatile-ttl, and no keys match the configured policy, the eviction behavior will match noeviction. diff --git a/umn/source/faqs/what_should_i_do_if_the_connection_between_my_redis_client_and_the_dcs_instance_times_out.rst b/umn/source/faqs/what_should_i_do_if_the_connection_between_my_redis_client_and_the_dcs_instance_times_out.rst new file mode 100644 index 0000000..ced84c5 --- /dev/null +++ b/umn/source/faqs/what_should_i_do_if_the_connection_between_my_redis_client_and_the_dcs_instance_times_out.rst @@ -0,0 +1,12 @@ +:original_name: en-us_topic_0054235831.html + +.. _en-us_topic_0054235831: + +What Should I Do If the Connection Between My Redis Client and the DCS Instance Times Out? +========================================================================================== + +Reconnect your client to the DCS instance. + +The timeout is probably due to network connectivity problems or DCS instance errors. For example, if your DCS instance is overloaded or experiences a failover, your Redis client returns the error message "Connection timed out" or "Connection reset by peer". + +Some Redis clients do not support automatic reconnection. If you use these Redis clients, the applications that use DCS must be able to proactively initiate reconnection. diff --git a/umn/source/faqs/why_cant_i_back_up_or_scale_up_my_dcs_instances.rst b/umn/source/faqs/why_cant_i_back_up_or_scale_up_my_dcs_instances.rst new file mode 100644 index 0000000..e96b52b --- /dev/null +++ b/umn/source/faqs/why_cant_i_back_up_or_scale_up_my_dcs_instances.rst @@ -0,0 +1,9 @@ +:original_name: en-us_topic_0072544388.html + +.. _en-us_topic_0072544388: + +Why Can't I Back Up or Scale Up My DCS Instances? +================================================= + +- Only master/standby and Proxy Cluster DCS instances can be backed up and restored. Single-node DCS instances do not support backup or restoration. +- DCS instance backup and scale-up are new functions provided by DCS. If your DCS instances were created long time ago, the version of these DCS instances is not upgraded and therefore cannot support some new functions (such as DCS instance backup and scale-up). You can contact technical support personnel to upgrade your DCS instance version. After the upgrade, you can back up and scale up your DCS instances. diff --git a/umn/source/faqs/why_do_my_dcs_instances_sometimes_become_unavailable_while_they_are_in_running_state.rst b/umn/source/faqs/why_do_my_dcs_instances_sometimes_become_unavailable_while_they_are_in_running_state.rst new file mode 100644 index 0000000..ce752aa --- /dev/null +++ b/umn/source/faqs/why_do_my_dcs_instances_sometimes_become_unavailable_while_they_are_in_running_state.rst @@ -0,0 +1,16 @@ +:original_name: en-us_topic_0077673452.html + +.. _en-us_topic_0077673452: + +Why Do My DCS Instances Sometimes Become Unavailable While They Are in Running State? +===================================================================================== + +The most probable cause is a network fault. To locate the fault, perform the following steps: + +#. Log in to the DCS console. +#. In the navigation pane, choose **Cache Manager**. +#. In the same row as the DCS instance whose metrics you want to view, click **View Metric**. +#. View monitoring metrics of the DCS instance. + + - If monitoring metrics change dramatically over a certain period of time, a network fault has occurred. After the network administrator rectifies the problem, reconnect to the DCS instance or perform management operations on the DCS instance again. + - If all monitoring metrics fall within the acceptable range, contact technical support. diff --git a/umn/source/faqs/why_is_available_memory_of_unused_dcs_instances_less_than_total_memory_why_is_memory_usage_of_unused_dcs_instances_greater_than_zero.rst b/umn/source/faqs/why_is_available_memory_of_unused_dcs_instances_less_than_total_memory_why_is_memory_usage_of_unused_dcs_instances_greater_than_zero.rst new file mode 100644 index 0000000..2e3ec20 --- /dev/null +++ b/umn/source/faqs/why_is_available_memory_of_unused_dcs_instances_less_than_total_memory_why_is_memory_usage_of_unused_dcs_instances_greater_than_zero.rst @@ -0,0 +1,10 @@ +:original_name: en-us_topic_0057984494.html + +.. _en-us_topic_0057984494: + +Why Is Available Memory of Unused DCS Instances Less Than Total Memory? Why Is Memory Usage of Unused DCS Instances Greater Than Zero? +====================================================================================================================================== + +Before a newly created DCS instance is put into use, the available memory is less than the total memory because some memory is reserved for system overhead and data persistence (supported by master/standby instances). For more information about the available memory for each type of DCS instance, see :ref:`DCS Instance Specifications `. + +DCS instances use a certain amount of memory for Redis-server buffers and internal data structures. This is why memory usage of unused DCS instances is greater than zero. diff --git a/umn/source/faqs/why_is_the_used_instance_memory_displayed_on_cloud_eye_console_slightly_higher_than_the_instance_available_memory.rst b/umn/source/faqs/why_is_the_used_instance_memory_displayed_on_cloud_eye_console_slightly_higher_than_the_instance_available_memory.rst new file mode 100644 index 0000000..c34bc05 --- /dev/null +++ b/umn/source/faqs/why_is_the_used_instance_memory_displayed_on_cloud_eye_console_slightly_higher_than_the_instance_available_memory.rst @@ -0,0 +1,10 @@ +:original_name: en-us_topic_0078401074.html + +.. _en-us_topic_0078401074: + +Why Is the Used Instance Memory Displayed on Cloud Eye Console Slightly Higher than the Instance Available Memory? +================================================================================================================== + +For DCS instances in single-node and master/standby modes, the used instance memory is measured by the redis-server process. For DCS instances in Proxy Cluster mode, the used cluster memory is the sum of used memory of all shards in the cluster. The redis-server of each shard measures the used memory of the shard. + +Due to internal implementation of the open-source redis-server, the used instance memory is normally slightly higher than the available instance memory. diff --git a/umn/source/getting_started/accessing_a_dcs_redis_instance.rst b/umn/source/getting_started/accessing_a_dcs_redis_instance.rst new file mode 100644 index 0000000..5cd46f4 --- /dev/null +++ b/umn/source/getting_started/accessing_a_dcs_redis_instance.rst @@ -0,0 +1,155 @@ +:original_name: en-us_topic_0054235811.html + +.. _en-us_topic_0054235811: + +Accessing a DCS Redis Instance +============================== + +You can access the created DCS instances through your Redis client. + +DCS works with multiple types of Redis clients. This section describes how to use the redis-cli and Redis Java (Jedis) clients to access a DCS Redis instance. For more information on how to use other Redis clients, visit https://redis.io/clients. + +Prerequisites +------------- + +- The DCS Redis instance you want to access is in the **Running** state. + +- An ECS has been created to serve as your Redis client. + + For more information on how to create ECSs, see the *Elastic Cloud Server User Guide*. + +- The GNU Compiler Collection (GCC) has been installed on the ECS serving as your Redis client. + + .. note:: + + The ECS serving as your Redis client and the DCS instance to be accessed must belong to the same VPC and can communicate with each other. + +Procedure +--------- + +#. Log in to the management console. + +#. Click |image1| in the upper left corner of the management console and select a region. + +#. Click **Service List**, and choose **Database** > **Distributed Cache Service** to launch the DCS console. + +#. In the navigation pane, choose **Cache Manager**. + +#. .. _en-us_topic_0054235811__li7304143: + + Obtain the IP address:port number of the DCS instance. + + a. On the **Cache Manager** page, click the name of the DCS instance you want to access. + b. On the **Basic Information** tab page of the instance, view the **Connection Address** in the **Connection** section. + +#. Access the chosen DCS instance. + + - By using redis-cli + + a. Download the source code package of your Redis client from http://download.redis.io/releases/redis-3.0.7.tar.gz. + + b. Upload the source code package of your Redis client to the ECS serving as your Redis client. + + c. Log in to the ECS that serves as your Redis client. + + d. Run the following command to decompress the **redis-3.0.7** directory from the source code package of your Redis client: + + **tar -xzf redis-3.0.7.tar.gz** + + e. Run the following commands to go to the **redis-3.0.7** directory and compile the source code of your Redis client: + + **cd redis-3.0.7** + + **make** + + f. Run the following commands to access the chosen DCS instance: + + **cd src** + + **./redis-cli -h 192.168.0.148 -p 6379** + + In the second command, use the DCS instance IP address and port number obtained in :ref:`5 `. + + g. On redis-cli, run the following command to authenticate access to the selected DCS instance: + + **auth password** + + In this command, *password* indicates the password used for login to the chosen DCS instance. This password is defined during DCS Redis instance creation. + + If information similar to the following is displayed, access to the chosen DCS instance is authenticated, and you can now read from and write to the chosen DCS instance: + + .. code-block:: console + + [root@dcs-vm ~]# ./redis-cli -h 192.168.0.148 -p 6379 + 192.168.0.148:6379> auth ****** + OK + 192.168.0.148:6379> + + In this example command output: + + - **192.168.0.148** is an example IP address of DCS instance, which is obtained in :ref:`5 `. + - **6379** is an example port number of DCS instance, which is obtained in :ref:`5 `. + + - By using Jedis + + a. Obtain the source code of the Jedis client from https://github.com/xetorthio/jedis. + b. Write code. + + #. Example code for a single Jedis connection + + .. code-block:: + + //Create a connection + String host = "192.168.0.150"; + int port = 6379; + String pwd = "passwd"; + + Jedis client = new Jedis(host, port); + client.auth(pwd); + client.connect(); //Run the set command + String result = client.set("key-string", "Hello, Redis!"); + System.out.println( String.format("set command result:%s", result) ); //Run the get command + String value = client.get("key-string"); + System.out.println( String.format("get command result:%s", value) ); + + .. note:: + + In actual scenarios, replace **passwd** with the actual ciphertext password of the Redis instance. Do not hard-code the plaintext password in the code. This advice also applies to **passwd** configurations in other steps. + + #. Example code for a Jedis connection pool + + .. code-block:: + + //Generate configuration information of a Jedis connection pool + String ip = "192.168.0.150"; + int port = 6379; + String pwd = "passwd"; + GenericObjectPoolConfig config = new GenericObjectPoolConfig(); + config.setTestOnBorrow(false); + config.setTestOnReturn(false); + config.setMaxTotal(100); + config.setMaxIdle(100); + config.setMaxWaitMillis(2000); + JedisPool pool = new JedisPool(config, ip, port, 100000, pwd);//Generate a Jedis connection pool when the client application is being initialized + //Get a Jedis connection from the Jedis connection pool when the client initiates a request + Jedis client = pool.getResource(); + try { + //Run commands + String result = client.set("key-string", "Hello, Redis!"); + System.out.println( String.format("set command result:%s", result) ); + String value = client.get("key-string"); + System.out.println( String.format("get command result:%s", value) ); + } catch (Exception e) { + // TODO: handle exception + } finally { + //Return the Jedis connection to the Jedis connection pool after the client's request is processed + if (null != client) { + pool.returnResource(client); + } + } // end of try block + //Destroy the Jedis pool when the client application is closed + pool.destroy(); + + c. Compile code according to the **readme** file in the source code of the Jedis client. Run the Jedis client to access the chosen DCS Redis instance. + +.. |image1| image:: /_static/images/en-us_image_0000001287765312.png diff --git a/umn/source/getting_started/creating_a_dcs_instance.rst b/umn/source/getting_started/creating_a_dcs_instance.rst new file mode 100644 index 0000000..621d3f3 --- /dev/null +++ b/umn/source/getting_started/creating_a_dcs_instance.rst @@ -0,0 +1,125 @@ +:original_name: en-us_topic_0054235810.html + +.. _en-us_topic_0054235810: + +Creating a DCS Instance +======================= + +Scenario +-------- + +DCS can be used only after DCS instances are created. DCS supports three types of DCS instances: single-node, master/standby, and Proxy Cluster. + +.. important:: + + DCS does not provide built-in encryption. Encrypt any sensitive data before transmitting or storing it. The purpose, scope, processing method, and time limits of data processed by DCS must comply with local laws and regulations. + +Prerequisites +------------- + +- The VPC where the DCS instance to be created is available. Security groups and subnets have been configured for the VPC. +- For more information on how to create VPCs, security groups, and subnets, see :ref:`Setting Up Environments ` or the *Virtual Private Cloud User Guide*. + +Procedure +--------- + +#. Log in to the management console. + +#. Click |image1| in the upper left corner of the management console and select a region. + +#. Click **Service List**, and choose **Database** > **Distributed Cache Service** to launch the DCS console. + +#. Click **Create DCS Instance**. + +#. Specify DCS instance parameters, such as the name, AZ, VPC, security group, and subnet. The following table describes the parameters. + + .. table:: **Table 1** DCS instance parameters + + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | + +===================================+=========================================================================================================================================================================================================================================================+ + | Region | Region in which DCS is located. To select a different region, use the region selector at the upper left of the main menu bar. | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Cache Engine | Cache engine used. Currently supported: **Redis**. | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Version | Currently, only Redis 3.0 is supported. | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Instance Type | Type of the DCS instance being created. | + | | | + | | Single-node, master/standby, and Proxy Cluster types are supported. | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | AZ | AZ in which the new DCS instance resides. If the instance type is master/standby or Proxy Cluster, this parameter is displayed as **Master AZ**. | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Standby AZ | Standby AZ in which the new DCS instance resides. | + | | | + | | If the instance type is master/standby or Proxy Cluster, **Standby AZ** is displayed. Select a standby AZ for the standby node of the instance. | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Instance Specification | Total memory of the new DCS instance. | + | | | + | | - 2, 4, 8, 16, 32, or 64 GB if the DCS instance is in single-node or master/standby mode | + | | | + | | - 64, 128, 256 or 512 GB if the DCS instance is in Proxy Cluster mode | + | | | + | | When creating a DCS instance on the DCS console, available free memory is listed below the **Instance Specification** field. If you need more memory, click **Increase quota** below the **Instance Specification** field and contact customer service. | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | VPC | Select a created VPC, subnet, and specify the IP address. | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Security Group | Security group that controls access to the new DCS instance. | + | | | + | | A security group is a set of access control rules that implements access control for mutually trusted ECSs with the same security protection requirements in the same VPC. | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Password | Password required for accessing the new DCS instance. | + | | | + | | NOTE: | + | | | + | | For security purposes, the system prompts you to enter an instance-specific password when you are accessing the DCS instance. Keep your instance password secure and change it periodically. | + | | | + | | Passwords cannot be left unspecified and must: | + | | | + | | - Consist of 8 to 32 characters. | + | | - Contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (:literal:`\`~!@#$^&*()-_=+\\|{}:,<.>/?`). | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **More Settings** | | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Name of the new DCS instance. | + | | | + | | A DCS instance name cannot be left unspecified and must: | + | | | + | | - Consist of 4 to 64 characters. | + | | - Consist of only letters, digits, hyphens (-), and underscores (_). | + | | - Start with an uppercase or lowercase letter. | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Description | Description of the new DCS instance. | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Auto Backup | Data backup policy. This parameter is displayed only when the instance type is master/standby or Proxy Cluster. For more information on how to configure a backup policy, see :ref:`Configuring a Backup Policy `. | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Maintenance | Time range for any scheduled maintenance activities to occur for cache nodes of this DCS instance. | + | | | + | | Values: | + | | | + | | - 02:00-06:00 | + | | - 06:00-10:00 | + | | - 10:00-14:00 | + | | - 14:00-18:00 | + | | - 18:00-22:00 | + | | - 22:00-02:00 | + +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +#. Click **Buy Now**. + + The displayed page shows the instance information you have specified. + +#. Confirm the instance information and click **Submit**. + +#. After the new DCS instance has been created, return to the **Cache Manager** page to view and manage your DCS instances. + + It takes 5 to 15 minutes to create a DCS instance. However, it will take up to approximately 30 minutes if the DCS instance is in Proxy Cluster mode. + + After a DCS instance has been successfully created, it enters the **Running** state by default. + + .. note:: + + - If the new DCS instance failed to be created, delete the unsuccessful instance creation task by following the procedure in :ref:`Deleting Instance Creation Tasks That Have Failed to Run `. Then, create the DCS instance again. If the DCS instance still fails to be created, contact customer service. + - There is the management plane and the tenant plane. The tenant plane is also called the pod zone. During the creation of a DCS instance, a VM is created in the pod zone. If the instance creation fails, the instance status changes to **Faulty**, and the error message "Failed to connect to the instance. Network exceptions may have occurred in the pod zone." is displayed, indicating that the management plane cannot be connected to the tenant plane. + +.. |image1| image:: /_static/images/en-us_image_0000001287445456.png diff --git a/umn/source/getting_started/index.rst b/umn/source/getting_started/index.rst new file mode 100644 index 0000000..a9979c3 --- /dev/null +++ b/umn/source/getting_started/index.rst @@ -0,0 +1,20 @@ +:original_name: en-us_topic_0054235809.html + +.. _en-us_topic_0054235809: + +Getting Started +=============== + +- :ref:`Setting Up Environments ` +- :ref:`Creating a DCS Instance ` +- :ref:`Accessing a DCS Redis Instance ` +- :ref:`Viewing Details of a DCS Instance ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + setting_up_environments + creating_a_dcs_instance + accessing_a_dcs_redis_instance + viewing_details_of_a_dcs_instance diff --git a/umn/source/getting_started/setting_up_environments.rst b/umn/source/getting_started/setting_up_environments.rst new file mode 100644 index 0000000..5eb1795 --- /dev/null +++ b/umn/source/getting_started/setting_up_environments.rst @@ -0,0 +1,45 @@ +:original_name: en-us_topic_0077665192.html + +.. _en-us_topic_0077665192: + +Setting Up Environments +======================= + +To access DCS instances through a VPC, create a VPC and configure security groups and subnets for it before using DCS. + +A VPC provides an isolated, user-configurable, and user-manageable virtual network environment for DCS. Using VPCs enhances resource security and simplifies network deployment. + +Once you have created a VPC, you can use it for all DCS instances you subsequently create. + +Procedure +--------- + +#. Log in to the management console. + +#. Click |image1| in the upper left corner of the management console and select a region and a project. + +#. Click **Service List**, and choose **Network** > **Virtual Private Cloud** to launch the VPC console. + +#. On the **Dashboard** page, click **Create VPC**. + +#. Create a VPC as prompted, retaining the default values unless otherwise required. For more information on how to create a VPC, see the *Virtual Private Cloud User Guide*. + + After a VPC is created, a subnet is also created in the subnet. If the VPC needs more subnets, go to :ref:`6 `. Otherwise, go to :ref:`7 `. + +#. .. _en-us_topic_0077665192__li10954228154518: + + In the navigation pane, choose **Virtual Private Cloud**. On the **Virtual Private Cloud** page, click the name of the VPC in which you intend to create a subnet. On the **Subnets** tab page, click **Create Subnet**. + + Create a subnet as guided by the VPC console, retaining the default values of the subnet parameters unless otherwise required. + + For more information on how to create a subnet, see the *Virtual Private Cloud User Guide*. + +#. .. _en-us_topic_0077665192__li1940024225812: + + In the navigation pane, choose **Security Group**. On the **Security Group** page, click **Create Security Group**. + + Create a security group for the VPC, retaining the default values of the security group parameters unless otherwise required. + + For more information on how to create a security group, see the *Virtual Private Cloud User Guide*. + +.. |image1| image:: /_static/images/en-us_image_0000001287605372.png diff --git a/umn/source/getting_started/viewing_details_of_a_dcs_instance.rst b/umn/source/getting_started/viewing_details_of_a_dcs_instance.rst new file mode 100644 index 0000000..88c490a --- /dev/null +++ b/umn/source/getting_started/viewing_details_of_a_dcs_instance.rst @@ -0,0 +1,87 @@ +:original_name: en-us_topic_0054235812.html + +.. _en-us_topic_0054235812: + +Viewing Details of a DCS Instance +================================= + +Scenario +-------- + +On the DCS console, you can view details about a DCS instance. + +Procedure +--------- + +#. Log in to the management console. + +#. Click |image1| in the upper left corner of the management console and select a region. + +#. Click **Service List**, and choose **Database** > **Distributed Cache Service** to launch the DCS console. + +#. In the navigation pane, choose **Cache Manager**. + +#. On the **Cache Manager** page, search for DCS instances using any of the following methods: + + - Search by keyword. + + Enter a keyword to search. + + - Select attributes and enter their keywords to search. + + Currently, you can search by name, ID, IP address, AZ, status, and instance type. + + For more information on how to search, click the question mark to the right of the search box. + +#. On the DCS instance list, click the name of the chosen DCS instance to display more details about it. + + .. table:: **Table 1** Parameters on the Basic Information page of a DCS instance + + +-----------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | Section | Parameter | Description | + +=======================+============================+==============================================================================================================================================+ + | Instance Information | Name | Name of the selected DCS instance. To modify the instance name, click the |image2| icon. | + +-----------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | | Status | State of the chosen instance. | + +-----------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | | ID | ID of the chosen instance. | + +-----------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | | Cache Engine | Cache engine used by the chosen instance. Currently, only Redis 3.0 is supported. | + +-----------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | | Instance Type | Type of the selected instance. Currently, supported types include single-node, master/standby, Proxy Cluster. | + +-----------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | | Cache Size (GB) | Specification of the chosen instance. | + +-----------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | | Used/Available Memory (MB) | The used memory space and maximum available memory space of the chosen instance. | + | | | | + | | | The used memory space includes: | + | | | | + | | | - Size of data stored on the DCS instance | + | | | - Size of Redis-server buffers (including client buffer and repl-backlog) and internal data structures | + +-----------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | | Created | Time at which the chosen instance started to be created. | + +-----------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | | Run | Time at which the instance was created. | + +-----------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | | Maintenance | Time range for any scheduled maintenance activities on cache nodes of this DCS instance. To modify the time window, click the |image3| icon. | + +-----------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | | Description | Description of the chosen DCS instance. To modify the description, click the |image4| icon. | + +-----------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | Connection | Password Protected | Currently, you must enable password-protected access. | + +-----------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | | Connection Address | IP address and port number of the chosen instance. | + +-----------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | Network | AZ | Availability zone in which the cache node running the selected DCS instance resides. | + +-----------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | | VPC | VPC in which the selected DCS instance resides. | + +-----------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | | Subnet | Subnet in which the selected DCS instance resides. | + +-----------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | | Security Group | Security group that controls access to the chosen instance. To modify the security group, click the |image5| icon. | + +-----------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + +.. |image1| image:: /_static/images/en-us_image_0000001287445456.png +.. |image2| image:: /_static/images/en-us_image_0000001340285317.jpg +.. |image3| image:: /_static/images/en-us_image_0000001340320673.jpg +.. |image4| image:: /_static/images/en-us_image_0000001287960790.jpg +.. |image5| image:: /_static/images/en-us_image_0000001340680421.jpg diff --git a/umn/source/glossary.rst b/umn/source/glossary.rst new file mode 100644 index 0000000..0338f13 --- /dev/null +++ b/umn/source/glossary.rst @@ -0,0 +1,8 @@ +:original_name: en-us_topic_0072429345.html + +.. _en-us_topic_0072429345: + +Glossary +======== + +For details about the terms involved in this document, see `Glossary `__. diff --git a/umn/source/index.rst b/umn/source/index.rst index 9112a17..536e919 100644 --- a/umn/source/index.rst +++ b/umn/source/index.rst @@ -2,3 +2,13 @@ Distributed Cache Service - User Guide ====================================== +.. toctree:: + :maxdepth: 1 + + introduction/index + getting_started/index + operation_guide/index + monitoring/index + faqs/index + glossary + change_history diff --git a/umn/source/introduction/accessing_dcs/how_to_access_dcs.rst b/umn/source/introduction/accessing_dcs/how_to_access_dcs.rst new file mode 100644 index 0000000..238cab1 --- /dev/null +++ b/umn/source/introduction/accessing_dcs/how_to_access_dcs.rst @@ -0,0 +1,16 @@ +:original_name: en-us_topic_0054235837.html + +.. _en-us_topic_0054235837: + +How to Access DCS +================= + +There are two ways to access DCS: + +- Using the management console + + The DCS provides a web-based management console. To launch the DCS console, create an account on the management console and log in, and then choose **Database** > **Distributed Cache Service** on the homepage. On the DCS console, you can create, restart, and delete DCS instances, and change their passwords. + +- Using APIs + + If you want to integrate DCS into a third-party system for secondary development, use APIs to access DCS. For more information about available APIs, see the *Distributed Cache Service API Reference*. diff --git a/umn/source/introduction/accessing_dcs/index.rst b/umn/source/introduction/accessing_dcs/index.rst new file mode 100644 index 0000000..e7c635a --- /dev/null +++ b/umn/source/introduction/accessing_dcs/index.rst @@ -0,0 +1,18 @@ +:original_name: en-us_topic_0054235836.html + +.. _en-us_topic_0054235836: + +Accessing DCS +============= + +- :ref:`How to Access DCS ` +- :ref:`Related Services ` +- :ref:`User Permissions ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + how_to_access_dcs + related_services + user_permissions diff --git a/umn/source/introduction/accessing_dcs/related_services.rst b/umn/source/introduction/accessing_dcs/related_services.rst new file mode 100644 index 0000000..1d6a76a --- /dev/null +++ b/umn/source/introduction/accessing_dcs/related_services.rst @@ -0,0 +1,40 @@ +:original_name: en-us_topic_0054235808.html + +.. _en-us_topic_0054235808: + +Related Services +================ + +Virtual Private Cloud (VPC) +--------------------------- + +The VPC service enables users to create private, isolated virtual networks. DCS instances run in VPCs and use the IP addresses and bandwidths of VPCs. VPCs are based on security groups. A security group is a set of access control rules that implements access control for mutually trusted ECSs with the same security protection requirements in the same VPC. + +Elastic Cloud Server (ECS) +-------------------------- + +The ECS service provides scalable, on-demand cloud servers for secure, flexible, and efficient application environments, ensuring service reliability. After you create DCS instances, you can connect to them through ECSs. + +Cloud Trace Service (CTS) +------------------------- + +CTS provides a history of operations performed on cloud service resources. With CTS, you can query, audit, and review operations. Traces include operation time, resource objects, resource IDs, requesters' IP addresses, resource operation requests, and responses. + +Currently, CTS records the following operations on DCS instances: + +- Creating, starting, restarting, and deleting DCS instances +- Configuring Redis-specific parameters +- Changing instance passwords +- Modifying basic information + +Identity and Access Management (IAM) +------------------------------------ + +IAM provides identity authentication and permission management. It is used to authenticate access to DCS. + +Cloud Eye +--------- + +Cloud Eye is a secure, scalable monitoring platform. It monitors DCS service metrics and sends notifications if alarms or events occur. + +For details about DCS metrics, see :ref:`DCS Metrics `. diff --git a/umn/source/introduction/accessing_dcs/user_permissions.rst b/umn/source/introduction/accessing_dcs/user_permissions.rst new file mode 100644 index 0000000..6eefaee --- /dev/null +++ b/umn/source/introduction/accessing_dcs/user_permissions.rst @@ -0,0 +1,14 @@ +:original_name: en-us_topic_0054247786.html + +.. _en-us_topic_0054247786: + +User Permissions +================ + +The public cloud system provides two types of user permissions by default: user management and resource management. + +User management refers to the management of users, user groups, and user group rights. + +Resource management refers to the control operations that can be performed by users on cloud service resources. + +For details, see `Permissions `__. diff --git a/umn/source/introduction/advantages.rst b/umn/source/introduction/advantages.rst new file mode 100644 index 0000000..7c5db17 --- /dev/null +++ b/umn/source/introduction/advantages.rst @@ -0,0 +1,24 @@ +:original_name: en-us_topic_0054235833.html + +.. _en-us_topic_0054235833: + +Advantages +========== + +The advantages of DCS include: + +- Usability off the shelf + + You can create DCS instances with just a few clicks on the DCS console or by calling application programming interfaces (APIs). DCS responds to instance creation commands without requiring you to deal with complex underlying software and hardware. + +- Customizable specifications + + DCS instance specifications range from 2 GB to 512 GB, increasing the flexibility of DCS. + +- Reliability + + Data persistence, support for master/standby and Proxy Cluster modes, and automatic failover between cache nodes ensure data reliability and service availability. + +- Ease of maintenance + + You can create, restart, and delete DCS instances with just a few clicks on the DCS console. DCS continuously monitors and maintains DCS instances so that you can focus on application development. Service monitoring metrics include keys, the number of client connections, and processed commands. System monitoring metrics include memory, CPU, and network usage. diff --git a/umn/source/introduction/application_scenarios.rst b/umn/source/introduction/application_scenarios.rst new file mode 100644 index 0000000..10efdd8 --- /dev/null +++ b/umn/source/introduction/application_scenarios.rst @@ -0,0 +1,26 @@ +:original_name: en-us_topic_0054235832.html + +.. _en-us_topic_0054235832: + +Application Scenarios +===================== + +For e-commerce, video sharing, gaming, and other data-intensive applications, it is essential to retrieve data fast. The primary purpose of DCS is to provide fast yet inexpensive data retrieval. With DCS, you can retrieve data from in-memory data stores instead of relying entirely on slower disk-based databases. + +DCS instances are also fully managed. You no longer need to perform management tasks such as hardware provisioning, software patching, monitoring, or failure recovery. Consider using DCS when you need to cache the following types of data: + +- Web pages + + Caching the content of web pages improves page load times. The cached content can include static data such as Hypertext Markup Language (HTML) pages, Cascading Style Sheets (CSS), and images. + +- Status + + DCS provides quick and simple queries of session status and application-scaling status, enabling easy sharing of status information. + +- Application objects + + DCS serves as a level-2 cache at the service layer and provides data storage and access for external entities. Storing frequently requested data in DCS instances can off load databases and reduce access latency. + +- Events + + DCS provides continuous event querying, allowing streams of events to be processed as they occur. diff --git a/umn/source/introduction/dcs.rst b/umn/source/introduction/dcs.rst new file mode 100644 index 0000000..ec6b371 --- /dev/null +++ b/umn/source/introduction/dcs.rst @@ -0,0 +1,49 @@ +:original_name: en-us_topic_0054235826.html + +.. _en-us_topic_0054235826: + +DCS +=== + +Distributed Cache Service (DCS) is an online, distributed, in-memory cache service compatible with Redis. It is reliable, scalable, usable out of the box, and easy to manage, meeting your requirements for high read/write performance and fast data access. + +Clients can access DCS instances only when they are installed on (ECSs) and belong to the same virtual private cloud (VPC) as the DCS instances. + + +.. figure:: /_static/images/en-us_image_0000001287445428.png + :alt: **Figure 1** Accessing DCS instances + + **Figure 1** Accessing DCS instances + +.. note:: + + Like clients, DCS instances are also run on ECSs. A client must belong to the same VPC and subnet as the DCS instance it is attempting to access. + +DCS Redis +--------- + +DCS uses Redis 3.0, a storage system that supports multiple types of datastructures, including key-value pairs. It can be used in scenarios such as caching, event pub/sub, and high-speed queuing. Redis is networked and written in ANSI C. It supports direct read/write of strings, hashes, lists, queues, and sets. Redis workswith in-memory datasets and provides persistence. For more information about Redis, visit https://redis.io/. + +There are three deployment modes for DCS Redis instances: + +- Single-node + + Each DCS instance runs on only one cache node. Such DCS instances are mainly used for temporary data storage but are not suitable for high-reliability service scenarios. + + Single-node DCS instances support intensive concurrent read/write operations, but do not implement data persistence. Data will be deleted after single-node DCS instances are restarted. + +- Master/Standby + + DCS instances run in master/standby mode, providing higher availability than single-node DCS instances. + + - Each DCS instance runs on two cache nodes (one master and one standby), and supports data persistence. + - The standby node is invisible to the client and does not provide data read/write services. It is kept synchronized with the master node through data synchronization. + - The standby node takes over automatically if the master node fails. + +- Proxy Cluster + + DCS instances run in Proxy Cluster mode, providing higher instance specifications and performance than master/standby DCS instances: + + - Each DCS instance has at least three master nodes. Compared with master/standby DCS instances, DCS instances in Proxy Cluster mode support higher instance specifications and concurrency. + - Each master node has a redundant node. If a master node is faulty, the redundant node becomes the master node and provides data read/write services for users. + - Each redundant node is invisible to Redis clients, and it is kept synchronized with its master node through data synchronization. diff --git a/umn/source/introduction/dcs_instance_specifications.rst b/umn/source/introduction/dcs_instance_specifications.rst new file mode 100644 index 0000000..6ee29b0 --- /dev/null +++ b/umn/source/introduction/dcs_instance_specifications.rst @@ -0,0 +1,72 @@ +:original_name: en-us_topic_0054235835.html + +.. _en-us_topic_0054235835: + +DCS Instance Specifications +=========================== + +For each single-node DCS Redis instance, the available memory is less than the total memory because some memory is reserved for system overhead, as shown in :ref:`Table 1 `. + +.. _en-us_topic_0054235835__table2399016819: + +.. table:: **Table 1** Specifications of single-node DCS Redis 3.0 instances + + +-----------------+------------------+-----------------------------+---------------------------+ + | Total Memory | Available Memory | Maximum Connections Allowed | Assured/Maximum Bandwidth | + | | | | | + | (GB) | (GB) | (Count) | (Mbit/s) | + +=================+==================+=============================+===========================+ + | 2 | 1.5 | 10,000 | 42/512 | + +-----------------+------------------+-----------------------------+---------------------------+ + | 4 | 3.2 | 10,000 | 64/1,536 | + +-----------------+------------------+-----------------------------+---------------------------+ + | 8 | 6.8 | 10,000 | 64/1,536 | + +-----------------+------------------+-----------------------------+---------------------------+ + | 16 | 13.6 | 10,000 | 85/3,072 | + +-----------------+------------------+-----------------------------+---------------------------+ + | 32 | 27.2 | 10,000 | 85/3,072 | + +-----------------+------------------+-----------------------------+---------------------------+ + | 64 | 58.2 | 12,000 | 128/5,120 | + +-----------------+------------------+-----------------------------+---------------------------+ + +For each master/standby DCS Redis instance, the available memory is less than that of a single-node DCS Redis instance because some memory is reserved for data persistence, as shown in :ref:`Table 2 `. The available memory of a master/standby instance can be adjusted to support background tasks such as data persistence and master/standby synchronization. + +.. _en-us_topic_0054235835__table1540218117813: + +.. table:: **Table 2** Specifications of master/standby DCS Redis 3.0 instances + + +-----------------+------------------+-----------------------------+---------------------------+ + | Total Memory | Available Memory | Maximum Connections Allowed | Assured/Maximum Bandwidth | + | | | | | + | (GB) | (GB) | (Count) | (Mbit/s) | + +=================+==================+=============================+===========================+ + | 2 | 1.5 | 10,000 | 42/512 | + +-----------------+------------------+-----------------------------+---------------------------+ + | 4 | 3.2 | 10,000 | 64/1,536 | + +-----------------+------------------+-----------------------------+---------------------------+ + | 8 | 6.4 | 10,000 | 64/1,536 | + +-----------------+------------------+-----------------------------+---------------------------+ + | 16 | 12.8 | 10,000 | 85/3,072 | + +-----------------+------------------+-----------------------------+---------------------------+ + | 32 | 25.6 | 10,000 | 85/3,072 | + +-----------------+------------------+-----------------------------+---------------------------+ + | 64 | 51.2 | 12,000 | 128/5,120 | + +-----------------+------------------+-----------------------------+---------------------------+ + +In addition to larger memory, Proxy Cluster instances feature more connections allowed and higher bandwidth allowed than single-node and master/standby instances. + +.. table:: **Table 3** Specifications of Proxy Cluster DCS Redis 3.0 instances + + +-----------------+------------------+-----------------------------+---------------------------+ + | Total Memory | Available Memory | Maximum Connections Allowed | Assured/Maximum Bandwidth | + | | | | | + | (GB) | (GB) | | (Mbit/s) | + +=================+==================+=============================+===========================+ + | 64 | 64 | 90,000 | 600/5,120 | + +-----------------+------------------+-----------------------------+---------------------------+ + | 128 | 128 | 180,000 | 600/5,120 | + +-----------------+------------------+-----------------------------+---------------------------+ + | 256 | 256 | 240,000 | 600/5,120 | + +-----------------+------------------+-----------------------------+---------------------------+ + | 512 | 512 | 480,000 | 600/5,120 | + +-----------------+------------------+-----------------------------+---------------------------+ diff --git a/umn/source/introduction/index.rst b/umn/source/introduction/index.rst new file mode 100644 index 0000000..2eb3ecf --- /dev/null +++ b/umn/source/introduction/index.rst @@ -0,0 +1,24 @@ +:original_name: en-us_topic_0054235816.html + +.. _en-us_topic_0054235816: + +Introduction +============ + +- :ref:`DCS ` +- :ref:`Application Scenarios ` +- :ref:`Advantages ` +- :ref:`Redis Command Compatibility ` +- :ref:`DCS Instance Specifications ` +- :ref:`Accessing DCS ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + dcs + application_scenarios + advantages + redis_command_compatibility + dcs_instance_specifications + accessing_dcs/index diff --git a/umn/source/introduction/redis_command_compatibility.rst b/umn/source/introduction/redis_command_compatibility.rst new file mode 100644 index 0000000..a98822f --- /dev/null +++ b/umn/source/introduction/redis_command_compatibility.rst @@ -0,0 +1,271 @@ +:original_name: dcs-ug-180522002.html + +.. _dcs-ug-180522002: + +Redis Command Compatibility +=========================== + +This section describes DCS's compatibility with Redis commands, including supported commands, disabled commands, unsupported scripts and commands of later Redis versions, and restrictions on command usage. + +For more information about the command syntax, visit the `Redis official website `__. + +DCS for Redis instances support most Redis commands. Any client compatible with the Redis protocol can access DCS. + +- For security purposes, some Redis commands are disabled in DCS. For details, see :ref:`Commands Disabled by DCS for Redis 3.0 `. +- Some Redis commands have usage restrictions, which are described in :ref:`Other Command Usage Restrictions `. +- Some Redis commands are supported by cluster DCS instances for multi-key operations in the same slot. For details, see :ref:`Table 4 `. + +Commands Supported by DCS for Redis 3.0 +--------------------------------------- + +The following lists commands supported by DCS for Redis 3.0. + +.. note:: + + Commands available since later Redis versions are not supported by earlier versions. Run a command on redis-cli to check whether it is supported by DCS for Redis. If the message "(error) ERR unknown command" is returned, the command is not supported. + +.. table:: **Table 1** Commands supported by DCS for Redis 3.0 + + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Category | Command | + +===================================+=====================================================================================================================================================================================================+ + | Key | DEL, DUMP, EXISTS, EXPIRE, MOVE, PERSISI, PTTL, RANDOMKEY, RENAME, RENAMENX, RESTORE, SORT, TTL, TYPE, SCAN, OBJIECT | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | String | APPEND, BITCOUNT, BITOP, BITPOS, DECR, DECRBY, GET, GETRANGE, GETSET, INCR, INCRBY, INCRBYFLOAT, MGET, MSET, MSETNX, PSETEX, SET, SETBIT, SETEX, SETNX, SETRANGE, STRLEN | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Hash | HDEL, HEXISTS, HGET, HGETALL, HINCRBY, HINCRBYFLOAT, HKEYS, HMGET, HMSET, HSET, HSETNX, HVALS, HSCAN | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | List | BLPOP, BRPOP, BRPOPLRUSH, LINDEX, LINSERT, LLEN, LPOP, LPUSHX, LRANGE, LREM, LSET, LTRIM, RPOP, RPOPLPU, RPOPLPUSH, RPUSH, RPUSHX | + | | | + | | .. note:: | + | | | + | | Proxy Cluster Redis 3.0 instances do not support **BLPOP**, **BRPOP**, and **BRPOPLRUSH** commands. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Set | SADD, SCARD, SDIFF, SDIFFSTORE, SINTER, SINTERSTORE, SISMEMBER, SMEMBERS, SMOVE, SPOP, SRANDMEMBER, SREM, SUNION, SUNIONSTORE, SSCAN | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Sorted set | ZADD, ZCARD, ZCOUNT, ZINCRBY, ZRANGE, ZRANGEBYSCORE, ZRANK, ZREMRANGEBYRANK, ZREMRANGEBYCORE, ZREVRANGE, ZREVRANGEBYSCORE, ZREVRANK, ZSCORE, ZUNIONSTORE, ZINTERSTORE, ZSCAN, ZRANGEBYLEX | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | HyperLogLog | PFADD, PFCOUNT, PFMERGE | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Pub/Sub | PSUBSCRIBE, PUBLISH, PUBSUB, PUNSUBSCRIBE, SUBSCRIBE, UNSUBSCRIBE | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Transaction | DISCARD, EXEC, MULTI, UNWATCH, WATCH | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Connection | AUTH, ECHO, PING, QUIT, SELECT | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Server | FLUSHALL, FLUSHDB, DBSIZE, TIME, INFO, KEYS, CLIENT KILL, CLIENT LIST, CLIENT GETNAME, CLIENT SETNAME, CONFIG GET, MONITOR, SLOWLOG, ROLE | + | | | + | | .. note:: | + | | | + | | - Proxy Cluster Redis 3.0 instances do not support CLIENT commands, including **CLIENT KILL**, **CLIENT GETNAME**, **CLIENT LIST**, **CLIENT SETNAME**, **CLIENT PAUSE**, and **CLIENT REPLY**. | + | | - Proxy Cluster Redis 3.0 instances do not support the **MONITOR** command. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Scripting | EVAL, EVALSHA, SCRIPT EXISTS, SCRIPT FLUSH, SCRIPT KILL, SCRIPT LOAD | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Geo | GEOADD, GEOHASH, GEOPOS, GEODIST, GEORADIUS, GEORADIUSBYMEMBER | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _dcs-ug-180522002__section0341135531914: + +Commands Disabled by DCS for Redis 3.0 +-------------------------------------- + +Redis APIs of single-node and master/standby DCS instances are compatible with open-source Redis for data access. For ease of use and security purposes, some management operations cannot be initiated from a Redis client. Related commands are listed in :ref:`Table 2 `. + +.. _dcs-ug-180522002__table31856418216: + +.. table:: **Table 2** Redis commands disabled in single-node and master/standby Redis 3.0 instances + + +----------------+------------------------------------------------------------------------------------------------------------------------------------------------+ + | Command | Description | + +================+================================================================================================================================================+ + | **Key** | | + +----------------+------------------------------------------------------------------------------------------------------------------------------------------------+ + | MIGRATE | Transfers a key from one Redis instance to another. | + +----------------+------------------------------------------------------------------------------------------------------------------------------------------------+ + | **Server** | | + +----------------+------------------------------------------------------------------------------------------------------------------------------------------------+ + | SLAVEOF | Changes the replication settings of a replica on the fly. | + +----------------+------------------------------------------------------------------------------------------------------------------------------------------------+ + | SHUTDOWN | Stops all the clients and quits the Redis process. | + +----------------+------------------------------------------------------------------------------------------------------------------------------------------------+ + | LASTSAVE | Returns the time of the last successful data persistence to disk. | + +----------------+------------------------------------------------------------------------------------------------------------------------------------------------+ + | DEBUG commands | Debugging command that should not be used by clients. | + +----------------+------------------------------------------------------------------------------------------------------------------------------------------------+ + | COMMAND | Returns array reply of details about all Redis commands. | + +----------------+------------------------------------------------------------------------------------------------------------------------------------------------+ + | SAVE | Performs a synchronous save on disk, producing a point in time snapshot of all the data inside the Redis instance, in the form of an RDB file. | + +----------------+------------------------------------------------------------------------------------------------------------------------------------------------+ + | BGSAVE | Asynchronously saves the database on disk. | + +----------------+------------------------------------------------------------------------------------------------------------------------------------------------+ + | BGREWRITEAOF | Starts an Append Only File (AOF) rewrite process. | + +----------------+------------------------------------------------------------------------------------------------------------------------------------------------+ + +In additional to these commands, Proxy Cluster Redis 3.0 instances do not support the commands listed in :ref:`Table 3 `. + +.. _dcs-ug-180522002__table122021410155210: + +.. table:: **Table 3** Redis commands disabled in Proxy Cluster Redis 3.0 instances + + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Command | Description | + +===================================+===========================================================================================================================================================================================================+ + | **Server** | | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | SYNC | An internal command used for full replication. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | PSYNC | An internal command used for partial replication. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | MONITOR | Streams back every command processed by the Redis server for debugging. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | CLIENT commands | CLIENT KILL, CLIENT GETNAME, CLIENT LIST, CLIENT SETNAME, CLIENT PAUSE, and CLIENT REPLY. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | OBJECT | Debugging command that should not be used by clients. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ROLE | Returns the role of the instance node. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **Transaction** | | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | DISCARD | Flushes all previously queued commands in a transaction. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | EXEC | Executes all previously queued commands in a transaction. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | MULTI | Marks the start of a transaction block. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | UNWATCH | Flushes all the previously watched keys for a transaction. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | WATCH | Marks the given key or keys to be watched. If the key or keys are modified by other commands before WATCH is executed, the transaction is interrupted. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **Connection** | | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | SELECT | Selects the Redis database. Note: Parameters of the **SELECT** command can only be set to **0**. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **Keys** | | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | MOVE | Moves *key* of the currently selected database to the specified destination database. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **Cluster** | | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | CLUSTER | Used for cluster management. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **codis** (Proxy Cluster) | | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | TIME | Returns the current server time. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | SLOTSINFO | Returns the number of slots and the size of each slot in Redis. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | SLOTSDEL | Deletes all key-value pairs in multiple slots in Redis. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | SLOTSMGRTSLOT | Randomly migrates a key-value pair in a slot to the destination. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | SLOTSMGRTONE | Migrates a specified key-value pair to the destination. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | SLOTSCHECK | Checks whether slots meet the following consistency requirements: | + | | | + | | - All the keys in the slots have a corresponding value in the database. | + | | - All the keys in the database have a value in the corresponding slot. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | SLOTSMGRTTAGSLOT | Migrates all key-value pairs with the same tag as a randomly selected key in a slot. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | SLOTSMGRTTAGONE | Migrates all key-value pairs with the same tag as a specified key. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **List** | | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | BLPOP | The blocking version of **LPOP** because it blocks the connection when there are no elements to pop from any of the given lists until the specified timeout has expired or a non-empty element is popped. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | BRPOP | The blocking version of **RPOP** because it blocks the connection when there are no elements to pop from any of the given lists until the specified timeout has expired or a non-empty element is popped. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | BRPOPLPUSH | The blocking variant of **RPOPLPUSH**. When *source* contains elements, this command behaves exactly like **RPOPLPUSH**. | + +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Restricted Redis Commands +------------------------- + +Some Redis commands are supported by cluster DCS instances for multi-key operations in the same slot. For details, see :ref:`Table 4 `. + +.. _dcs-ug-180522002__table7589193113396: + +.. table:: **Table 4** Redis commands restricted in cluster DCS instances. + + +-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Category | Description | + +=================+===================================================================================================================================================================+ + | **Set** | | + +-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | SINTER | Returns the members of the set resulting from the intersection of all the given sets. | + +-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | SINTERSTORE | Equal to **SINTER**, but instead of returning the result set, it is stored in *destination*. | + +-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | SUNION | Returns the members of the set resulting from the union of all the given sets. | + +-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | SUNIONSTORE | Equal to **SUNION**, but instead of returning the result set, it is stored in *destination*. | + +-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | SDIFF | Returns the members of the set resulting from the difference between the first set and all the successive sets. | + +-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | SDIFFSTORE | Equal to **SDIFF**, but instead of returning the result set, it is stored in *destination*. | + +-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | SMOVE | Moves **member** from the set at **source** to the set at *destination*. | + +-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **Sorted Set** | | + +-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ZUNIONSTORE | Computes the union of *numkeys* sorted sets given by the specified keys. | + +-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ZINTERSTORE | Computes the intersection of *numkeys* sorted sets given by the specified keys. | + +-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **HyperLogLog** | | + +-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | PFCOUNT | Returns the approximated cardinality computed by the HyperLogLog data structure stored at the specified variable. | + +-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | PFMERGE | Merges multiple HyperLogLog values into a unique value. | + +-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **Key** | | + +-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | RENAME | Renames *key* to *newkey*. | + +-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | RENAMENX | Renames *key* to *newkey* if *newkey* does not yet exist. | + +-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | BITOP | Performs a bitwise operation between multiple keys (containing string values) and stores the result in the destination key. | + +-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | RPOPLPUSH | Returns and removes the last element (tail) of the list stored at source, and pushes the element at the first element (head) of the list stored at *destination*. | + +-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | **String** | | + +-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | MSETNX | Sets the given keys to their respective values. | + +-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. note:: + + While running commands that take a long time to run, such as **FLUSHALL**, DCS instances may not respond to other commands and change to the faulty state. After the command finishes executing, the instance will return to normal. + +.. _dcs-ug-180522002__section834293511127: + +Other Command Usage Restrictions +-------------------------------- + +**Key commands:** + +In case of a large amount of cached data, running a **Keys** command may block the execution of other commands for a long time or occupy exceptionally large memory. Therefore, when running a **Keys** command, describe the exact pattern and do not use fuzzy **keys \***. **keys \*** can be used during commissioning or when the number of keys does not exceed 5 million. Otherwise, the service cannot run properly. + +**Server commands:** + +- While running commands that take a long time to run, such as **FLUSHALL**, DCS instances may not respond to other commands and change to the faulty state. After the command finishes executing, the instance will return to normal. +- When the **FLUSHDB** or **FLUSHALL** command is run, execution of other service commands may be blocked for a long time in case of a large amount of cached data. + +**EVAL and EVALSHA commands:** + +- When the **EVAL** or **EVALSHA** command is run, at least one key must be contained in the command parameter. Otherwise, the error message "ERR eval/evalsha numkeys must be bigger than zero in redis cluster mode" is displayed. +- When the **EVAL** or **EVALSHA** command is run, a cluster DCS Redis instance uses the first key to compute slots. Ensure that the keys to be operated in your code are in the same slot. For details, visit http://redis.io/commands. +- For the **EVAL** command: + + - You are advised to learn the Lua script features of Redis before running the **EVAL** command. For details, see https://redis.io/commands/eval. + - The execution timeout time of a Lua script is 5 seconds. Time-consuming statements such as long-time sleep and large loop statements should be avoided. + - When calling a Lua script, do not use random functions to specify keys. Otherwise, the execution results are inconsistent on the master and standby nodes. + +**Others:** + +- The time limit for executing a Redis command is 15 seconds. To prevent other services from failing, a master/replica switchover will be triggered after the command execution times out. + +- Proxy Cluster DCS Redis instances created before July 10, 2018 must be upgraded to support the following commands: + + SINTER, SDIFF, SUNION, PFCOUNT, PFMERGE, SINTERSTORE, SUNIONSTORE, SDIFFSTORE, SMOVE, ZUNIONSTORE, ZINTERSTORE, EVAL, EVALSHA, BITOP, RENAME, RENAMENX, RPOPLPUSH, MSETNX, SCRIPT LOAD, SCRIPT KILL, SCRIPT EXISTS, SCRIPT FLUSH. diff --git a/umn/source/monitoring/dcs_metrics.rst b/umn/source/monitoring/dcs_metrics.rst new file mode 100644 index 0000000..9d6cefa --- /dev/null +++ b/umn/source/monitoring/dcs_metrics.rst @@ -0,0 +1,258 @@ +:original_name: dcs-ug-0326019.html + +.. _dcs-ug-0326019: + +DCS Metrics +=========== + +Introduction +------------ + +This section describes DCS metrics reported to Cloud Eye as well as their namespaces and dimensions. You can use the Cloud Eye console or APIs to query the DCS metrics and alarms. + +Namespace +--------- + +SYS.DCS + +.. note:: + + **SYS.DCS** is the namespace of DCS. Cloud Eye determines which cloud service is reporting metric data based on the namespace. + +DCS Redis 3.0 Instance Metrics +------------------------------ + +.. note:: + + The **Monitored Objects and Dimensions** column lists instances and dimensions that support the corresponding metrics. + +.. table:: **Table 1** DCS Redis 3.0 instance metrics + + +----------------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------+------------------------------+ + | Metric ID | Metric | Description | Value Range | Monitored Object and Dimension | Monitoring Period (Raw Data) | + +============================+============================+========================================================================================================================================================================================+=============+==================================================================+==============================+ + | cpu_usage | CPU Usage | CPU consumed by the monitored object | 0-100% | Monitored object: | 1 minute | + | | | | | | | + | | | Unit: % | | Single-node, master/standby, or Proxy Cluster DCS Redis instance | | + | | | | | | | + | | | | | Dimension: | | + | | | | | | | + | | | | | dcs_instance_id | | + +----------------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------+------------------------------+ + | memory_usage | Memory Usage | Memory consumed by the monitored object | 0-100% | Monitored object: | 1 minute | + | | | | | | | + | | | Unit: % | | Single-node, master/standby, or Proxy Cluster DCS Redis instance | | + | | | | | | | + | | | | | Dimension: | | + | | | | | | | + | | | | | dcs_instance_id | | + +----------------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------+------------------------------+ + | net_in_throughput | Network Input Throughput | Inbound throughput per second on a port | >= 0 | Monitored object: | 1 minute | + | | | | | | | + | | | Unit: KB/s | | Single-node, master/standby, or Proxy Cluster DCS Redis instance | | + | | | | | | | + | | | | | Dimension: | | + | | | | | | | + | | | | | dcs_instance_id | | + +----------------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------+------------------------------+ + | net_out_throughput | Network Output Throughput | Outbound throughput per second on a port | >= 0 | Monitored object: | 1 minute | + | | | | | | | + | | | Unit: KB/s | | Single-node, master/standby, or Proxy Cluster DCS Redis instance | | + | | | | | | | + | | | | | Dimension: | | + | | | | | | | + | | | | | dcs_instance_id | | + +----------------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------+------------------------------+ + | connected_clients | Connected Clients | Number of connected clients (excluding those to standby nodes) | >= 0 | Monitored object: | 1 minute | + | | | | | | | + | | | | | Single-node, master/standby, or Proxy Cluster DCS Redis instance | | + | | | | | | | + | | | | | Dimension: | | + | | | | | | | + | | | | | dcs_instance_id | | + +----------------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------+------------------------------+ + | client_longest_out_list | Client Longest Output List | Longest output list among current client connections | >= 0 | Monitored object: | 1 minute | + | | | | | | | + | | | | | Single-node, master/standby, or Proxy Cluster DCS Redis instance | | + | | | | | | | + | | | | | Dimension: | | + | | | | | | | + | | | | | dcs_instance_id | | + +----------------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------+------------------------------+ + | client_biggest_in_buf | Client Biggest Input Buf | Maximum input data length among current client connections | >= 0 | Monitored object: | 1 minute | + | | | | | | | + | | | Unit: byte | | Single-node, master/standby, or Proxy Cluster DCS Redis instance | | + | | | | | | | + | | | | | Dimension: | | + | | | | | | | + | | | | | dcs_instance_id | | + +----------------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------+------------------------------+ + | blocked_clients | Blocked Clients | Number of clients suspended by block operations such as BLPOP, BRPOP, and BRPOPLPUSH | >= 0 | Monitored object: | 1 minute | + | | | | | | | + | | | | | Single-node, master/standby, or Proxy Cluster DCS Redis instance | | + | | | | | | | + | | | | | Dimension: | | + | | | | | | | + | | | | | dcs_instance_id | | + +----------------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------+------------------------------+ + | used_memory | Used Memory | Number of bytes used by the Redis server | >= 0 | Monitored object: | 1 minute | + | | | | | | | + | | | Unit: MB | | Single-node, master/standby, or Proxy Cluster DCS Redis instance | | + | | | | | | | + | | | | | Dimension: | | + | | | | | | | + | | | | | dcs_instance_id | | + +----------------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------+------------------------------+ + | used_memory_rss | Used Memory RSS | Resident set size (RSS) memory that the Redis server has used, which is the memory that actually resides in the memory, including all stack and heap memory but not swapped-out memory | >= 0 | Monitored object: | 1 minute | + | | | | | | | + | | | Unit: MB | | Single-node, master/standby, or Proxy Cluster DCS Redis instance | | + | | | | | | | + | | | | | Dimension: | | + | | | | | | | + | | | | | dcs_instance_id | | + +----------------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------+------------------------------+ + | used_memory_peak | Used Memory Peak | Peak memory consumed by Redis since the Redis server last started | >= 0 | Monitored object: | 1 minute | + | | | | | | | + | | | Unit: MB | | Single-node, master/standby, or Proxy Cluster DCS Redis instance | | + | | | | | | | + | | | | | Dimension: | | + | | | | | | | + | | | | | dcs_instance_id | | + +----------------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------+------------------------------+ + | used_memory_lua | Used Memory Lua | Number of bytes used by the Lua engine | >= 0 | Monitored object: | 1 minute | + | | | | | | | + | | | Unit: MB | | Single-node, master/standby, or Proxy Cluster DCS Redis instance | | + | | | | | | | + | | | | | Dimension: | | + | | | | | | | + | | | | | dcs_instance_id | | + +----------------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------+------------------------------+ + | memory_frag_ratio | Memory Fragmentation Ratio | Current memory fragmentation, which is the ratio between **used_memory_rss**/**used_memory**. | >= 0 | Monitored object: | 1 minute | + | | | | | | | + | | | | | Single-node, master/standby, or Proxy Cluster DCS Redis instance | | + | | | | | | | + | | | | | Dimension: | | + | | | | | | | + | | | | | dcs_instance_id | | + +----------------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------+------------------------------+ + | total_connections_received | New Connections | Number of connections received during the monitoring period | >= 0 | Monitored object: | 1 minute | + | | | | | | | + | | | | | Single-node, master/standby, or Proxy Cluster DCS Redis instance | | + | | | | | | | + | | | | | Dimension: | | + | | | | | | | + | | | | | dcs_instance_id | | + +----------------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------+------------------------------+ + | total_commands_processed | Commands Processed | Number of commands processed during the monitoring period | >= 0 | Monitored object: | 1 minute | + | | | | | | | + | | | | | Single-node, master/standby, or Proxy Cluster DCS Redis instance | | + | | | | | | | + | | | | | Dimension: | | + | | | | | | | + | | | | | dcs_instance_id | | + +----------------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------+------------------------------+ + | instantaneous_ops | Ops per Second | Number of commands processed per second | >= 0 | Monitored object: | 1 minute | + | | | | | | | + | | | | | Single-node, master/standby, or Proxy Cluster DCS Redis instance | | + | | | | | | | + | | | | | Dimension: | | + | | | | | | | + | | | | | dcs_instance_id | | + +----------------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------+------------------------------+ + | total_net_input_bytes | Network Input Bytes | Number of bytes received during the monitoring period | >= 0 | Monitored object: | 1 minute | + | | | | | | | + | | | Unit: KB | | Single-node, master/standby, or Proxy Cluster DCS Redis instance | | + | | | | | | | + | | | | | Dimension: | | + | | | | | | | + | | | | | dcs_instance_id | | + +----------------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------+------------------------------+ + | total_net_output_bytes | Network Output Bytes | Number of bytes sent during the monitoring period | >= 0 | Monitored object: | 1 minute | + | | | | | | | + | | | Unit: KB | | Single-node, master/standby, or Proxy Cluster DCS Redis instance | | + | | | | | | | + | | | | | Dimension: | | + | | | | | | | + | | | | | dcs_instance_id | | + +----------------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------+------------------------------+ + | instantaneous_input_kbps | Input Flow | Instantaneous input traffic | >= 0 KB/s | Monitored object: | 1 minute | + | | | | | | | + | | | Unit: KB/s | | Single-node, master/standby, or Proxy Cluster DCS Redis instance | | + | | | | | | | + | | | | | Dimension: | | + | | | | | | | + | | | | | dcs_instance_id | | + +----------------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------+------------------------------+ + | instantaneous_output_kbps | Output Flow | Instantaneous output traffic | >= 0 KB/s | Monitored object: | 1 minute | + | | | | | | | + | | | Unit: KB/s | | Single-node, master/standby, or Proxy Cluster DCS Redis instance | | + | | | | | | | + | | | | | Dimension: | | + | | | | | | | + | | | | | dcs_instance_id | | + +----------------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------+------------------------------+ + | rejected_connections | Rejected Connections | Number of connections that have exceeded maxclients and been rejected during the monitoring period | >= 0 | Monitored object: | 1 minute | + | | | | | | | + | | | | | Single-node, master/standby, or Proxy Cluster DCS Redis instance | | + | | | | | | | + | | | | | Dimension: | | + | | | | | | | + | | | | | dcs_instance_id | | + +----------------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------+------------------------------+ + | expired_keys | Expired Keys | Number of keys that have expired and been deleted during the monitoring period | >= 0 | Monitored object: | 1 minute | + | | | | | | | + | | | | | Single-node, master/standby, or Proxy Cluster DCS Redis instance | | + | | | | | | | + | | | | | Dimension: | | + | | | | | | | + | | | | | dcs_instance_id | | + +----------------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------+------------------------------+ + | evicted_keys | Evicted Keys | Number of keys that have been evicted and deleted during the monitoring period | >= 0 | Monitored object: | 1 minute | + | | | | | | | + | | | | | Single-node, master/standby, or Proxy Cluster DCS Redis instance | | + | | | | | | | + | | | | | Dimension: | | + | | | | | | | + | | | | | dcs_instance_id | | + +----------------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------+------------------------------+ + | keyspace_hits | Keyspace Hits | Number of successful lookups of keys in the main dictionary during the monitoring period | >= 0 | Monitored object: | 1 minute | + | | | | | | | + | | | | | Single-node, master/standby, or Proxy Cluster DCS Redis instance | | + | | | | | | | + | | | | | Dimension: | | + | | | | | | | + | | | | | dcs_instance_id | | + +----------------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------+------------------------------+ + | keyspace_misses | Keyspace Misses | Number of failed lookups of keys in the main dictionary during the monitoring period | >= 0 | Monitored object: | 1 minute | + | | | | | | | + | | | | | Single-node, master/standby, or Proxy Cluster DCS Redis instance | | + | | | | | | | + | | | | | Dimension: | | + | | | | | | | + | | | | | dcs_instance_id | | + +----------------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------+------------------------------+ + | pubsub_channels | PubSub Channels | Number of Pub/Sub channels | >= 0 | Monitored object: | 1 minute | + | | | | | | | + | | | | | Single-node, master/standby, or Proxy Cluster DCS Redis instance | | + | | | | | | | + | | | | | Dimension: | | + | | | | | | | + | | | | | dcs_instance_id | | + +----------------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------+------------------------------+ + | pubsub_patterns | PubSub Patterns | Number of Pub/Sub patterns | >= 0 | Monitored object: | 1 minute | + | | | | | | | + | | | | | Single-node, master/standby, or Proxy Cluster DCS Redis instance | | + | | | | | | | + | | | | | Dimension: | | + | | | | | | | + | | | | | dcs_instance_id | | + +----------------------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------+------------------------------+ + +Dimensions +---------- + +=============== ================== +Key Value +=============== ================== +dcs_instance_id DCS Redis instance +=============== ================== diff --git a/umn/source/monitoring/index.rst b/umn/source/monitoring/index.rst new file mode 100644 index 0000000..5925135 --- /dev/null +++ b/umn/source/monitoring/index.rst @@ -0,0 +1,20 @@ +:original_name: dcs-en-ug-180424001.html + +.. _dcs-en-ug-180424001: + +Monitoring +========== + +Cloud Eye is a secure, scalable monitoring platform. It monitors DCS metrics, and sends notifications if alarms are triggered or events occur. + +- :ref:`DCS Metrics ` +- :ref:`Viewing DCS Metrics ` +- :ref:`Setting Alarm Rules for Critical Metrics ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + dcs_metrics + viewing_dcs_metrics + setting_alarm_rules_for_critical_metrics diff --git a/umn/source/monitoring/setting_alarm_rules_for_critical_metrics.rst b/umn/source/monitoring/setting_alarm_rules_for_critical_metrics.rst new file mode 100644 index 0000000..1d434ca --- /dev/null +++ b/umn/source/monitoring/setting_alarm_rules_for_critical_metrics.rst @@ -0,0 +1,79 @@ +:original_name: dcs-ug-190905001.html + +.. _dcs-ug-190905001: + +Setting Alarm Rules for Critical Metrics +======================================== + +As listed in :ref:`DCS Metrics `, Cloud Eye monitors a wide variety of DCS metrics. + +Among all the metrics, the ones listed in the following table are of particular importance. Configure alarm rules for these metrics to be notified immediately after the set thresholds are reached. + +.. table:: **Table 1** Metrics to set alarm rules for + + +-------------------+-------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Metric ID | Metric | Recommended Threshold | Description | + +===================+===================+=======================+===============================================================================================================================================================================================+ + | cpu_usage | CPU Usage | 80 | CPU consumed by the monitored object | + | | | | | + | | | | The recommended threshold indicates that an alarm will be triggered when the CPU usage of the instance reaches 80% for the set number of consecutive periods during the monitoring period. | + | | | | | + | | | | For example, an alarm may be triggered if the average CPU usage >= 80% for 3 consecutive periods of 1 minute. | + +-------------------+-------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | memory_usage | Memory Usage | 80 | Memory consumed by the monitored object | + | | | | | + | | | | The recommended threshold indicates that an alarm will be triggered when the memory usage of the instance reaches 80% for the set number of consecutive periods during the monitoring period. | + | | | | | + | | | | For example, an alarm may be triggered if the average memory usage >= 80% for 3 consecutive periods of 1 minute. | + +-------------------+-------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | connected_clients | Connected Clients | 8,000 | Number of connected clients (excluding those to standby nodes) | + | | | | | + | | | | The minimum threshold is 8,000. Set the threshold to 80% of the maximum allowed connections indicated in the instance specifications. | + | | | | | + | | | | For example, an alarm may be triggered if the average number of connected clients >= 8,000 for 3 consecutive periods of 1 minute. | + +-------------------+-------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Procedure +--------- + +In the following example, an alarm rule is set for the **Connected Clients (connected_clients)** metric. + +#. Log in to the management console. + +#. Click |image1| in the upper left corner of the management console and select a region. + +#. Click **Service List**, and choose **Database** > **Distributed Cache Service** to launch the DCS console. + +#. In the same row as the DCS instance whose metrics you want to view, click **View Metric**. + + + .. figure:: /_static/images/en-us_image_0000001340709641.png + :alt: **Figure 1** Viewing instance metrics + + **Figure 1** Viewing instance metrics + +#. On the displayed page, locate the **Connected Clients** metric. Hover over the metric and click |image2| to create an alarm rule for the metric. + + The **Create Alarm Rule** page is displayed. + +#. Specify the alarm details. + + a. Specify the alarm policy and alarm severity. + + For example, the alarm policy shown in :ref:`Figure 2 ` indicates that an alarm will be triggered if the average number of clients connected to the instance exceeds the preset value for two consecutive periods and no actions are taken. + + .. _dcs-ug-190905001__fig18808134812416: + + .. figure:: /_static/images/en-us_image_0000001288469984.png + :alt: **Figure 2** Setting the alarm policy and alarm severity + + **Figure 2** Setting the alarm policy and alarm severity + + b. Set the alarm notification configurations. If you enable **Alarm Notification**, set the validity period, notification object, and trigger condition. + + c. Click **Next** to set the alarm name and description. + + d. Click **Finish**. + +.. |image1| image:: /_static/images/en-us_image_0000001287765296.png +.. |image2| image:: /_static/images/en-us_image_0000001340564653.png diff --git a/umn/source/monitoring/viewing_dcs_metrics.rst b/umn/source/monitoring/viewing_dcs_metrics.rst new file mode 100644 index 0000000..a3a2343 --- /dev/null +++ b/umn/source/monitoring/viewing_dcs_metrics.rst @@ -0,0 +1,29 @@ +:original_name: dcs-en-ug-180424004.html + +.. _dcs-en-ug-180424004: + +Viewing DCS Metrics +=================== + +The public cloud platform provides the Cloud Eye service, which monitors the running status of your DCS instances. + +Procedure +--------- + +#. Log in to the DCS console. + +#. Click |image1| in the upper left corner of the management console and select a region. + +#. Click **Service List**, and choose **Database** > **Distributed Cache Service** to launch the DCS console. + +#. In the navigation pane, choose **Cache Manager**. + +#. In the same row as the DCS instance whose metrics you want to view, click **View Metric**. + + On the displayed Cloud Eye console, you can view all the metrics of the instance. + + .. note:: + + You can also view the metrics on the **Performance Monitoring** page of the instance. + +.. |image1| image:: /_static/images/en-us_image_0000001287765320.png diff --git a/umn/source/operation_guide/backing_up_and_restoring_dcs_instances/configuring_a_backup_policy.rst b/umn/source/operation_guide/backing_up_and_restoring_dcs_instances/configuring_a_backup_policy.rst new file mode 100644 index 0000000..23b7bea --- /dev/null +++ b/umn/source/operation_guide/backing_up_and_restoring_dcs_instances/configuring_a_backup_policy.rst @@ -0,0 +1,58 @@ +:original_name: en-us_topic_0062866097.html + +.. _en-us_topic_0062866097: + +Configuring a Backup Policy +=========================== + +Scenario +-------- + +On the DCS console, you can configure an automatic backup policy. The system then backs up data in your instances according to the backup policy. + +If automatic backup is not required, disable the automatic backup function in the backup policy. + +.. note:: + + This function is supported only by master/standby and Proxy Cluster instances, but is not supported by single-node instances. + +Procedure +--------- + +#. Log in to the management console. +#. Click |image1| in the upper left corner of the management console and select a region. +#. Click **Service List**, and choose **Database** > **Distributed Cache Service** to launch the DCS console. +#. In the navigation pane, choose **Cache Manager**. +#. On the **Cache** **Manager** page, filter DCS instances by instance status and/or name to find the DCS instance for which you want to configure a backup policy. +#. Click the name of the chosen DCS instance to display more details about the DCS instance. +#. On the instance details page, click **Backups & Restorations**. +#. Slide |image2| to the right to enable automatic backup. Backup policies will be displayed. + + .. table:: **Table 1** Parameters in a backup policy + + +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | + +===================================+============================================================================================================================================================================================================================================+ + | Backup Schedule | Day of a week on which data in the chosen DCS instance is automatically backed up. | + | | | + | | You can select one or multiple days of a week. | + +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Retention Period (days) | The number of days that automatically backed up data is retained. | + | | | + | | Backup data will be permanently deleted at the end of retention period and cannot be restored. Value range: 1-7. | + +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Start Time | Time at which automatic backup starts. Value: the full hour between 00:00 to 23:00 | + | | | + | | The DCS checks backup policies once every hour. If the backup start time in a backup policy has arrived, data in the corresponding instance is backed up. | + | | | + | | .. note:: | + | | | + | | Instance backup takes 5 to 30 minutes. The data added or modified during the backup process will not be backed up. To reduce the impact of backup on services, it is recommended that data should be backed up during off-peak periods. | + | | | + | | Only instances in the **Running** state can be backed up. | + +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +#. Click **OK**. + +.. |image1| image:: /_static/images/en-us_image_0000001287924936.png +.. |image2| image:: /_static/images/en-us_image_0000001288301616.png diff --git a/umn/source/operation_guide/backing_up_and_restoring_dcs_instances/index.rst b/umn/source/operation_guide/backing_up_and_restoring_dcs_instances/index.rst new file mode 100644 index 0000000..569a0cf --- /dev/null +++ b/umn/source/operation_guide/backing_up_and_restoring_dcs_instances/index.rst @@ -0,0 +1,20 @@ +:original_name: en-us_topic_0062866096.html + +.. _en-us_topic_0062866096: + +Backing Up and Restoring DCS Instances +====================================== + +- :ref:`Overview ` +- :ref:`Configuring a Backup Policy ` +- :ref:`Manually Backing Up a DCS Instance ` +- :ref:`Restoring a DCS Instance ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + overview + configuring_a_backup_policy + manually_backing_up_a_dcs_instance + restoring_a_dcs_instance diff --git a/umn/source/operation_guide/backing_up_and_restoring_dcs_instances/manually_backing_up_a_dcs_instance.rst b/umn/source/operation_guide/backing_up_and_restoring_dcs_instances/manually_backing_up_a_dcs_instance.rst new file mode 100644 index 0000000..1431d67 --- /dev/null +++ b/umn/source/operation_guide/backing_up_and_restoring_dcs_instances/manually_backing_up_a_dcs_instance.rst @@ -0,0 +1,38 @@ +:original_name: en-us_topic_0062866098.html + +.. _en-us_topic_0062866098: + +Manually Backing Up a DCS Instance +================================== + +Scenario +-------- + +On the DCS console, you can manually back up data in instances. + +By default, manually backed up data is permanently retained. If backup data is no longer in use, you can delete it manually. + +Prerequisites +------------- + +At least one master/standby or Proxy Cluster DCS instance is in the **Running** state. + +Procedure +--------- + +#. Log in to the management console. +#. Click |image1| in the upper left corner of the management console and select a region. +#. Click **Service List**, and choose **Database** > **Distributed Cache Service** to launch the DCS console. +#. In the navigation pane, choose **Cache Manager**. +#. On the **Cache** **Manager** page, filter DCS instances by instance status and/or name to find the DCS instance you want to manually back up. +#. Click the name of the chosen DCS instance to display more details about the DCS instance. +#. On the instance details page, click **Backups & Restorations**. +#. On the **Backups & Restorations** page, click **Create Backup**. +#. In the **Create Backup** dialog box, click **OK** to start manual backup. + + .. note:: + + - Information in the **Description**\ text box cannot exceed 128 bytes. + - Instance backup takes 10 to 15 minutes. The data added or modified during the backup process will not be backed up. + +.. |image1| image:: /_static/images/en-us_image_0000001340704041.png diff --git a/umn/source/operation_guide/backing_up_and_restoring_dcs_instances/overview.rst b/umn/source/operation_guide/backing_up_and_restoring_dcs_instances/overview.rst new file mode 100644 index 0000000..563575f --- /dev/null +++ b/umn/source/operation_guide/backing_up_and_restoring_dcs_instances/overview.rst @@ -0,0 +1,97 @@ +:original_name: en-us_topic_0079835992.html + +.. _en-us_topic_0079835992: + +Overview +======== + +Need for DCS Instance Backup +---------------------------- + +There is a small chance that dirty data could exist in a DCS instance owing to service system exceptions or problems in loading data from persistence files. In addition, some systems demand not only high reliability but also data security, data restoration, and even permanent data storage. + +Currently, data in DCS instances can be backed up to OBS. If a DCS instance becomes faulty, data in the instance can be restored from backup so that service continuity is not affected. + +Backup Modes +------------ + +DCS instances support the following backup modes: + +- Scheduled backup + + You can create a scheduled backup policy on the DCS console. Then, data in the chosen DCS instances will be automatically backed up at the scheduled time. + + You can choose the days of the week on which scheduled backup will run. Backup data will be retained for a maximum of seven days. Backup data older than seven days will be automatically deleted. + + The primary purpose of scheduled backups is to create complete data replicas of DCS instances so that the instance can be quickly restored if necessary. + +- Manual backup + + Backup requests can also be issued manually. Then, data in the chosen DCS instances will be permanently backed up to OBS. Backup data can be deleted manually. + + Before performing high-risk operations, such as system maintenance or upgrade, DCS instance data needs to be backed up. + +Additional Information About Data Backup +---------------------------------------- + +- Instance type + + Currently, only master/standby and Proxy Cluster DCS instances can be backed up and restored. Single-node DCS instances do not support backup or restoration. + +- Working principle + + Instance data is persisted using the Redis Append Only Files (AOF) feature. + + Backup tasks are run on standby cache nodes. DCS instance data is backed up by compressing and storing the data persistence files from the standby cache node to OBS. + + DCS checks instance backup policies once an hour. If a backup policy is matched, DCS runs a backup task for the corresponding DCS instance. + +- Impact on DCS instances during backup + + DCS instances can continue to provide services during backup. + + In the event of full-data synchronization or heavy instance load, it takes a few minutes to complete data synchronization. If instance backup starts before data synchronization is complete, the backup data will be slightly behind the data in the master cache node. + + During instance backup, the standby cache node stops persisting the latest changes to disk files. If new data is written to the master cache node during backup, the backup file will not contain the new data. + +- Backup time + + It is advisable to back up instance data during off-peak periods. + +- Storage of backup files + + Backup files are stored to OBS. + + DCS provides the backup service free of charge, but OBS charges will be incurred for the amount and period that storage space is consumed. + +- Handling exceptions in scheduled backup + + If a scheduled backup task is triggered while the DCS instance is restarting or being scaled up, the scheduled backup task will be run in the next cycle. + + If backing up a DCS instance fails or the backup is postponed because another task is in progress, DCS will try to back up the instance in the next cycle. A maximum of three retries are allowed within a single day. + +- Retention period of backup data + + Scheduled backup files are retained for up to seven days. The retention period is user configurable. At the end of the retention period, most backup files of the DCS instance will be automatically deleted, but at least one backup file will be retained. + + Manual backup files are retained permanently and need to be manually deleted. + +Data Restoration +---------------- + +- Data restoration process + + #. A user initiates a data restoration request using the DCS console. + #. DCS obtains the backup file from OBS. + #. Read/write to the DCS instance is suspended. + #. The original data persistence file of the master cache node is replaced by the backup file. + #. The new data persistence file (that is, the backup file) is reloaded. + #. Data is restored, and the DCS instance starts to provide read/write service again. + +- Impact on service systems + + Data read/write is suspended during instance data restoration and resumed after data in the master cache node is restored. + +- Handling data restoration exceptions + + If a backup file is corrupted, DCS will try to fix the backup file while restoring instance data. If the backup file is successfully fixed, DCS proceeds to restore instance data. If the backup file cannot be fixed, the DCS instance (if the instance type is master/standby) or the cache node with an unrepairable backup file (if the instance type is Proxy Cluster) will be restored to the state in which it was before data restoration. diff --git a/umn/source/operation_guide/backing_up_and_restoring_dcs_instances/restoring_a_dcs_instance.rst b/umn/source/operation_guide/backing_up_and_restoring_dcs_instances/restoring_a_dcs_instance.rst new file mode 100644 index 0000000..ee55971 --- /dev/null +++ b/umn/source/operation_guide/backing_up_and_restoring_dcs_instances/restoring_a_dcs_instance.rst @@ -0,0 +1,39 @@ +:original_name: en-us_topic_0062866099.html + +.. _en-us_topic_0062866099: + +Restoring a DCS Instance +======================== + +Scenario +-------- + +On the DCS console, you can restore backup data to a chosen DCS instance. + +Prerequisites +------------- + +- At least one master/standby or Proxy Cluster DCS instance is in the **Running** state. +- A backup task has been run to back up data in the instance to be restored and the status of the backup task is **Successful**. + +Procedure +--------- + +#. Log in to the management console. +#. Click |image1| in the upper left corner of the management console and select a region. +#. Click **Service List**, and choose **Database** > **Distributed Cache Service** to launch the DCS console. +#. In the navigation pane, choose **Cache Manager**. +#. On the **Cache** **Manager** page, filter DCS instances by instance status and/or name to find the DCS instance you want to restore. +#. Click the name of the chosen DCS instance to display more details about the DCS instance. +#. On the instance details page, click **Backups & Restorations**. +#. Click **Restore** in the same row as the chosen backup task. +#. Click **Yes** to start instance restoration. + + .. note:: + + - Information in the **Description** text box cannot exceed 128 bytes. + - The **Restoration History** tab page displays the result of the instance restoration task. + - Instance restoration takes 5 to 30 minutes. + - While being restored, DCS instances do not accept data operation requests from clients because existing data is being overwritten by the backup data. + +.. |image1| image:: /_static/images/en-us_image_0000001340405149.png diff --git a/umn/source/operation_guide/changing_instance_passwords.rst b/umn/source/operation_guide/changing_instance_passwords.rst new file mode 100644 index 0000000..1bdc9c7 --- /dev/null +++ b/umn/source/operation_guide/changing_instance_passwords.rst @@ -0,0 +1,40 @@ +:original_name: en-us_topic_0054235820.html + +.. _en-us_topic_0054235820: + +Changing Instance Passwords +=========================== + +Scenario +-------- + +On the DCS console, you can change the password required for accessing your DCS instance. + +Prerequisites +------------- + +The DCS instance for which you want to change the password is in the **Running** state. + +Procedure +--------- + +#. Log in to the management console. +#. Click |image1| in the upper left corner of the management console and select a region. +#. Click **Service List**, and choose **Database** > **Distributed Cache Service** to launch the DCS console. +#. In the navigation pane, choose **Cache Manager**. +#. Choose **More** > **Change Password** in the same row as the chosen instance. +#. In the **Change Password** dialog box, enter the old password and new password. + + .. note:: + + After 5 consecutive incorrect password attempts, the account for accessing the chosen DCS instance will be locked for 5 minutes. Passwords cannot be changed during the lockout period. + + A DCS instance password cannot be left unspecified and must: + + - Consist of 8 to 32 characters. + - Be different from the old password. + - Contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (:literal:`\`~!@#$^&*()-_=+\\|{}:,<.>/?`). + +#. Click **OK** to confirm the password change. + +.. |image1| image:: /_static/images/en-us_image_0000001287605360.png diff --git a/umn/source/operation_guide/configuring_redis-specific_parameters.rst b/umn/source/operation_guide/configuring_redis-specific_parameters.rst new file mode 100644 index 0000000..1d8f6d8 --- /dev/null +++ b/umn/source/operation_guide/configuring_redis-specific_parameters.rst @@ -0,0 +1,161 @@ +:original_name: en-us_topic_0054235814.html + +.. _en-us_topic_0054235814: + +Configuring Redis-Specific Parameters +===================================== + +On the DCS console, you can configure Redis-specific parameters to keep DCS instances performing optimally. + +.. note:: + + The default values are already optimized for typical use cases. Reconfiguring parameters is recommended only when necessary. + +Prerequisites +------------- + +The DCS instance you want to configure is in the **Running** state, and the instance type is single-node or master/standby (Redis parameters of DCS instances in Proxy Cluster mode are not modifiable). + +Procedure +--------- + +#. Log in to the management console. + +#. Click |image1| in the upper left corner of the management console and select a region. + +#. Click **Service List**, and choose **Database** > **Distributed Cache Service** to launch the DCS console. + +#. In the navigation pane, choose **Cache Manager**. + +#. On the **Cache Manager** page, click the name of the DCS instance you want to configure. + + A page with details of the DCS instance is displayed. + +#. On the instance details page, click the **Parameters** tab. + +#. On the **Parameters** tab page, click **Modify**. + +#. Modify Redis-specific parameters based on your requirements. + + .. note:: + + The Redis parameters supported by single-node and master/standby instances are different. The following parameters are only supported by master/standby instances, but are not supported by single-node instances: + + - appendfsync + - appendonly + - repl-backlog-size + - repl-backlog-ttl + + .. table:: **Table 1** Redis-specific parameters + + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+ + | Parameter | Description | Value Range | Default Value | + +===========================+=========================================================================================================================================================================================================================================================================================+=====================================================================================================================================================================================================+=================+ + | appendfsync | Controls how often fsync() transfers cached data to the disk. Note that some OSs will perform a complete data transfer but some others only make a "best-effort" attempt. | - no | everysec | + | | | - always | | + | | There are three settings: | - everysec | | + | | | | | + | | **no**: fsync() is never called. The OS will flush data when it is ready. This mode offers the highest performance. | | | + | | | | | + | | **always**: fsync() is called after every write to the AOF. This mode is very slow, but also very safe. | | | + | | | | | + | | **everysec**: fsync() is called once per second. This mode provides a compromise between safety and performance. | | | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+ + | repl-backlog-size | The replication backlog size (bytes). The backlog is a buffer that accumulates replica data when replicas are disconnected from the master. When a replica reconnects, a partial synchronization is performed to synchronize the data that was missed while replicas were disconnected. | 16,384-1,073,741,824 | 1,048,576 | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+ + | repl-backlog-ttl | The amount of time, in seconds, before the backlog buffer is released, starting from the last a replica was disconnected. The value **0** indicates that the backlog is never released. | 0-604,800 | 3,600 | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+ + | appendonly | Indicates whether to log each modification of the instance. By default, data is written to disks asynchronously in Redis. If this function is disabled, recently-generated data might be lost in the event of a power failure. Options: | - yes | yes | + | | | - no | | + | | **yes**: enabled | | | + | | | | | + | | **no**: disabled | | | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+ + | maxmemory-policy | How DCS will select what to remove when maxmemory is reached. | volatile-lru | noeviction | + | | | | | + | | For more information about this parameter, see :ref:`What Is the Default Data Eviction Policy? `. | allkeys-lru | | + | | | | | + | | | volatile-random | | + | | | | | + | | | allkeys-random | | + | | | | | + | | | volatile-ttl | | + | | | | | + | | | noeviction | | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+ + | hash-max-ziplist-entries | When the number of entries in hashes is less than the value of this parameter, hashes are encoded using a memory efficient data structure. | 1 to 10000 | 512 | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+ + | hash-max-ziplist-value | When the biggest entry in hashes does not exceed the length threshold indicated by this parameter, hashes are encoded using a memory efficient data structure. | 1 to 10000 | 64 | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+ + | list-max-ziplist-entries | When the number of entries in lists is less than the value of this parameter, lists are encoded using a memory efficient data structure. | 1 to 10000 | 512 | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+ + | list-max-ziplist-value | When the biggest entry in lists does not exceed the length threshold indicated by this parameter, lists are encoded using a memory efficient data structure. | 1 to 10000 | 64 | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+ + | set-max-intset-entries | When a set is composed entirely of strings that happen to be integers in radix 10 in the range of 64 bit signed integers, sets are encoded using a memory efficient data structure. | 1 to 10000 | 512 | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+ + | zset-max-ziplist-entries | When the number of entries in sorted sets is less than the value of this parameter, sorted sets are encoded using a memory efficient data structure. | 1 to 10000 | 128 | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+ + | zset-max-ziplist-value | When the biggest entry in sorted sets does not exceed the length threshold indicated by this parameter, sorted sets are encoded using a memory efficient data structure. | 1 to 10000 | 64 | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+ + | latency-monitor-threshold | Only events that run in more time than the configured latency-monitor-threshold will be logged as latency spikes. | 0 to 86,400,000 ms | 0 | + | | | | | + | | - If the latency-monitor-threshold is set to 0, latency monitoring is disabled. | | | + | | - If the latency-monitor-threshold is set to a value greater than 0, all events blocking the server for a time equal to or greater than the configured latency-monitor-threshold will be logged. | | | + | | | | | + | | By running the LATENCY command, you can perform operations related to latency monitoring, such as enabling latency monitoring, reporting the latest latency events logged, and obtaining statistical data. | | | + | | | | | + | | For more information about the latency-monitor-threshold, visit https://redis.io/docs/reference/optimization/latency-monitor/. | | | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+ + | reserved-memory-percent | Percentage of the maximum available memory reserved for background processes, such as data persistence and replication. | 0-80 | 0 | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+ + | timeout | Connection between the client and server (DCS instance) will be closed if the client is idle for the timeout period (measured in seconds). A timeout period of 0 seconds indicates that the timeout function is disabled. | 0 to 7200 seconds | 0 | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+ + | notify-keyspace-events | Keyspace event notification. If this parameter is configured, the Redis Sub/Pub feature will allow clients to receive an event when a Redis data set is modified. | If the parameter value is an empty character string, keyspace event notification is disabled. | "" | + | | | | | + | | | If the parameter value is a string of multiple characters, keyspace event notification is enabled and each character identifies a class of keyspace events for which Redis will send notifications. | | + | | | | | + | | | .. note:: | | + | | | | | + | | | - The parameter value must contain either K or E. | | + | | | - A is an alias for "g$lshzxe"and cannot be used together with any of the characters "g$lshzxe". | | + | | | - For example, the value Kl means that Redis will notify Pub/Sub clients about keyspace events and list commands. The value AKE means Redis will notify Pub/Sub clients about all events. | | + | | | | | + | | | K: Keyspace events, published with the \__keyspace@_\_ prefix | | + | | | | | + | | | E: Keyevent events, published with \__keyevent@_\_ prefix | | + | | | | | + | | | g: Generic commands (non-type specific) such as DEL, EXPIRE, and RENAME | | + | | | | | + | | | $: String commands | | + | | | | | + | | | l: List commands | | + | | | | | + | | | s: Set commands | | + | | | | | + | | | h: Hash commands | | + | | | | | + | | | z: Sorted set commands | | + | | | | | + | | | x: Expired events (events generated every time a key expires) | | + | | | | | + | | | e: Evicted events (events generated when a key is evicted for maxmemory) | | + | | | | | + | | | A: Alias for "g$lshzxe", so that the "AKE" string means all the events. | | + | | | | | + | | | Note that the parameter value must contain either K or E. | | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+ + | slowlog-log-slower-than | The maximum amount of time allowed, in microseconds, for command execution. If this threshold is exceeded, Redis Slow Log will record the command. | 0-1,000,000 | 10,000 | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+ + | slowlog-max-len | The maximum allowed length of the Redis Slow Log logs. Slow Log consumes memory, but you can reclaim this memory by running the SLOWLOG RESET command. | 0-1,000 | 128 | + +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+ + + .. note:: + + - For more information about Redis-specific parameters, visit https://redis.io/topics/memory-optimization. + - The latency-monitor-threshold parameter is usually used for fault location. After locating faults based on the latency information collected, change the value of **latency-monitor-threshold** to **0** to avoid unnecessary latency. + +#. After you have finished setting parameters, click **Save**. + +#. Click **Yes** to confirm. + +.. |image1| image:: /_static/images/en-us_image_0000001340285305.png diff --git a/umn/source/operation_guide/deleting_dcs_instances.rst b/umn/source/operation_guide/deleting_dcs_instances.rst new file mode 100644 index 0000000..2c7c396 --- /dev/null +++ b/umn/source/operation_guide/deleting_dcs_instances.rst @@ -0,0 +1,70 @@ +:original_name: en-us_topic_0054235819.html + +.. _en-us_topic_0054235819: + +Deleting DCS Instances +====================== + +Scenario +-------- + +On the DCS console, you can delete one or multiple DCS instances at a time. You can also delete all instance creation tasks that have failed to run. + +.. important:: + + After a DCS instance is deleted, data from the instance will also be deleted without backup. + +Prerequisites +------------- + +- The DCS instances you want to delete have been created. +- The DCS instances you want to delete are in the **Running**, **Faulty**, or **Stopped** state. + +Procedure +--------- + +**Deleting DCS Instances** + +#. Log in to the management console. + +#. Click |image1| in the upper left corner of the management console and select a region. + +#. In the navigation pane, choose **Cache Manager**. + +#. On the **Cache Manager** page, select one or more DCS instances you want to delete. + + DCS instances in the **Creating**, **Starting**, **Stopping**, or **Restarting** state cannot be deleted. + +#. Choose **More** > **Delete** above the instance list. + +#. Click **Yes** to confirm that you want to delete the instances. + + It takes 1 to 30 minutes to delete DCS instances. + + .. note:: + + To delete a single instance, choose **Operation** > **More** > **Delete** in the same row as the instance. + +**Deleting Instance Creation Tasks That Have Failed to Run** + +#. Log in to the management console. + +#. Click |image2| in the upper left corner of the management console and select a region. + +#. Click **Service List**, and choose **Database** > **Distributed Cache Service** to launch the DCS console. + +#. In the navigation pane, choose **Cache Manager**. + + If there are DCS instances that have failed to be created, **Instance Creation Failures** is displayed above the instance list. + +#. Click the icon or the number of failed tasks next to **Instance Creation Failures**. + + The **Instance Creation Failures** dialog box is displayed. + +#. Choose failed instance creation tasks to delete. + + - To delete a single failed task, click **Delete** in the same row as the task. + - To delete all failed tasks, click **Delete All** above the task list. + +.. |image1| image:: /_static/images/en-us_image_0000001340405153.png +.. |image2| image:: /_static/images/en-us_image_0000001340285301.png diff --git a/umn/source/operation_guide/index.rst b/umn/source/operation_guide/index.rst new file mode 100644 index 0000000..d3ec41d --- /dev/null +++ b/umn/source/operation_guide/index.rst @@ -0,0 +1,32 @@ +:original_name: en-us_topic_0054235813.html + +.. _en-us_topic_0054235813: + +Operation Guide +=============== + +- :ref:`Configuring Redis-Specific Parameters ` +- :ref:`Starting DCS Instances ` +- :ref:`Restarting DCS Instances ` +- :ref:`Deleting DCS Instances ` +- :ref:`Modifying DCS Instance Specifications ` +- :ref:`Changing Instance Passwords ` +- :ref:`Modifying an Instance's Maintenance Time Window ` +- :ref:`Modifying an Instance's Security Group ` +- :ref:`Backing Up and Restoring DCS Instances ` +- :ref:`Managing Background Tasks ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + configuring_redis-specific_parameters + starting_dcs_instances + restarting_dcs_instances + deleting_dcs_instances + modifying_dcs_instance_specifications + changing_instance_passwords + modifying_an_instances_maintenance_time_window + modifying_an_instances_security_group + backing_up_and_restoring_dcs_instances/index + managing_background_tasks diff --git a/umn/source/operation_guide/managing_background_tasks.rst b/umn/source/operation_guide/managing_background_tasks.rst new file mode 100644 index 0000000..ffc9b41 --- /dev/null +++ b/umn/source/operation_guide/managing_background_tasks.rst @@ -0,0 +1,45 @@ +:original_name: dcs-en-ug-180312009.html + +.. _dcs-en-ug-180312009: + +Managing Background Tasks +========================= + +Scenario +-------- + +After you initiate certain instance operations such as scaling up instances, and changing a password, a background task will start for each operation. On the DCS console, you can view the background task status and clear task information by deleting task records. + +Prerequisites +------------- + +At least one DCS instance has been created. + +Procedure +--------- + +#. Log in to the management console. + +#. Click |image1| in the upper left corner of the management console and select a region. + +#. Click **Service List**, and choose **Database** > **Distributed Cache Service** to launch the DCS console. + +#. In the navigation pane, choose **Cache Manager**. + +#. Click the name of the DCS instance whose background task you want to view. + +#. Click the **Background Tasks** tab. + + A list of background tasks is displayed. + +#. Filter background tasks, refresh task status, or delete task records. + + - To filter background tasks by date, click |image2| on top of the background task list, specify **Start Date** and **End Date**, and click **OK**. + - To delete the record of a background task, choose **Operation** > **Delete** in the same row as the task + + .. note:: + + Only tasks whose status is **Successful** or **Failed** can have their records deleted. + +.. |image1| image:: /_static/images/en-us_image_0000001287445440.png +.. |image2| image:: /_static/images/en-us_image_0000001288144356.png diff --git a/umn/source/operation_guide/modifying_an_instances_maintenance_time_window.rst b/umn/source/operation_guide/modifying_an_instances_maintenance_time_window.rst new file mode 100644 index 0000000..e47c431 --- /dev/null +++ b/umn/source/operation_guide/modifying_an_instances_maintenance_time_window.rst @@ -0,0 +1,42 @@ +:original_name: en-us_topic_0090713825.html + +.. _en-us_topic_0090713825: + +Modifying an Instance's Maintenance Time Window +=============================================== + +Scenario +-------- + +On the DCS console, after creating a DCS instance, you can modify the maintenance time window of the DCS instance on the instance's \ **Basic Information**\ tab. + +Prerequisite +------------ + +At least one DCS instance has been created. + +Procedure +--------- + +#. Log in to the management console. + +#. Click |image1| in the upper left corner of the management console and select a region. + +#. Click **Service List**, and choose **Database** > **Distributed Cache Service** to launch the DCS console. + +#. In the navigation pane, choose **Cache Manager**. + + A list of DCS instances is displayed on the \ **Cache Manager**\ page. + +#. Click the name of the DCS instance for which you want to modify the maintenance time window. + +#. In the **Instance Details** area, click the |image2| icon next to the **Maintenance** parameter. + +#. Select a new maintenance time window from the drop-down list. Click |image3| to save the modification or |image4| to discard the modification. + + The modification will take effect immediately, that is, the new maintenance time window will appear on the **Basic Information** tab page immediately. + +.. |image1| image:: /_static/images/en-us_image_0000001340285285.png +.. |image2| image:: /_static/images/en-us_image_0000001287445460.jpg +.. |image3| image:: /_static/images/en-us_image_0000001287765328.jpg +.. |image4| image:: /_static/images/en-us_image_0000001340205085.jpg diff --git a/umn/source/operation_guide/modifying_an_instances_security_group.rst b/umn/source/operation_guide/modifying_an_instances_security_group.rst new file mode 100644 index 0000000..8f24a84 --- /dev/null +++ b/umn/source/operation_guide/modifying_an_instances_security_group.rst @@ -0,0 +1,42 @@ +:original_name: en-us_topic_0090713826.html + +.. _en-us_topic_0090713826: + +Modifying an Instance's Security Group +====================================== + +Scenario +-------- + +On the DCS console, after creating a DCS instance, you can modify the security group of the DCS instance on the instance's \ **Summary**\ page. + +Prerequisites +------------- + +At least one DCS instance has been created. + +Procedure +--------- + +#. Log in to the management console. + +#. Click |image1| in the upper left corner of the management console and select a region. + +#. Click **Service List**, and choose **Database** > **Distributed Cache Service** to launch the DCS console. + +#. In the navigation pane, choose **Cache Manager**. + + A list of DCS instances is displayed on the \ **Cache Manager**\ page. + +#. Click the name of the DCS instance for which you want to modify the security group. + +#. On the **Basic Information** page, click the |image2| icon next to the **Security Group** parameter. + +#. Select a new security group from the drop-down list. Click |image3| to save the modification or |image4| to discard the modification. + + The modification will take effect immediately, that is, the new security group will appear on the **Basic Information** tab page immediately. + +.. |image1| image:: /_static/images/en-us_image_0000001287445448.png +.. |image2| image:: /_static/images/en-us_image_0000001340285313.png +.. |image3| image:: /_static/images/en-us_image_0000001287765328.jpg +.. |image4| image:: /_static/images/en-us_image_0000001340205085.jpg diff --git a/umn/source/operation_guide/modifying_dcs_instance_specifications.rst b/umn/source/operation_guide/modifying_dcs_instance_specifications.rst new file mode 100644 index 0000000..ddb7bcd --- /dev/null +++ b/umn/source/operation_guide/modifying_dcs_instance_specifications.rst @@ -0,0 +1,55 @@ +:original_name: en-us_topic_0063519673.html + +.. _en-us_topic_0063519673: + +Modifying DCS Instance Specifications +===================================== + +Scenario +-------- + +On the DCS console, you can modify a DCS Redis instance to the desired specification. + +.. important:: + + - After you change the specifications of a Proxy Cluster DCS instance, you cannot restore the files backed up before the modification. You are advised to back up your data as soon as possible after changing the specifications. + - It takes 5 to 30 minutes to change the specifications of single-node or master/standby DCS instances. Changing the specifications of a Proxy Cluster DCS instance takes a longer time because data must be redistributed in the cluster. During the specification modification, services are interrupted for seconds. You are advised to modify the specifications during off-peak hours. + - Normally during the specification modification, single-node, master/standby, and Proxy Cluster DCS instances can be read from and written into. However, writing data into single-node or master/standby instances may be temporarily unsupported until the specification modification is completed. + +Prerequisites +------------- + +The DCS instance you want to change the specification for is in the **Running** state. + +Procedure +--------- + +#. Log in to the management console. + +#. Click |image1| in the upper left corner of the management console and select a region. + +#. Click **Service List**, and choose **Database** > **Distributed Cache Service** to launch the DCS console. + +#. In the navigation pane, choose **Cache Manager**. + +#. Choose **More** > **Modify Specifications** in the same row as the DCS instance. + +#. On the **Modify Specifications** page, select the desired specification. + + The maximum storage space is 64 GB for single-node and master/standby instances, and 512 GB for Proxy Cluster instances. + +#. Click **Next**. + +#. Click **Submit**. + + It takes 5 to 30 minutes to scale up a DCS instance. After scale-up is successful, the DCS instance enters the **Running** state. + + The **Background Tasks** page then appears. On this page, you can view the scale-up status. For more information, see :ref:`Managing Background Tasks `. + + .. note:: + + - If the specification modification of a single-node DCS instance fails, the instance is temporarily unavailable for use. The specification remains unchanged. Some management operations (such as parameter configuration and specification modification) are temporarily not supported. After the specification modification is completed in the backend, the instance changes to the new specification and becomes available for use again. + - If the specification modification of a master/standby or Proxy Cluster DCS instance fails, the instance is still available for use with its original specifications. Some management operations (such as parameter configuration, backup, restoration, and specification modification) are temporarily not supported. Remember not to read or write more data than allowed by the original specifications; otherwise, data loss may occur. + - After the specification modification is successful, the new specification of the instance takes effect. + +.. |image1| image:: /_static/images/en-us_image_0000001340205081.png diff --git a/umn/source/operation_guide/restarting_dcs_instances.rst b/umn/source/operation_guide/restarting_dcs_instances.rst new file mode 100644 index 0000000..f53b62c --- /dev/null +++ b/umn/source/operation_guide/restarting_dcs_instances.rst @@ -0,0 +1,48 @@ +:original_name: en-us_topic_0054235818.html + +.. _en-us_topic_0054235818: + +Restarting DCS Instances +======================== + +Scenario +-------- + +On the DCS console, you can restart one or multiple DCS instances at a time. + +.. warning:: + + - While a DCS instance is restarting, it cannot be read from or written to. + - If the DCS instance is a single-node instance, data will also be deleted from it when it is restarted. + - An attempt to restart a DCS instance while it is being backed up may result in a failure. + +Prerequisites +------------- + +The DCS instances you want to restart are in the **Running** or **Faulty** state. + +Procedure +--------- + +#. Log in to the management console. + +#. Click |image1| in the upper left corner of the management console and select a region. + +#. Click **Service List**, and choose **Database** > **Distributed Cache Service** to launch the DCS console. + +#. In the navigation pane, choose **Cache Manager**. + +#. Choose instances to restart. + + - To restart a single instance, choose **Restart** in the same row as the instance. + - To restart multiple instances, select the instances to restart and click **Restart** above the instance list. + +#. In the displayed dialog box, click **Yes**. + + It takes 1 to 30 minutes to restart DCS instances. After DCS instances are restarted, their status changes to **Running**. + + .. note:: + + By default, only the instance process will restart. However, selecting **Force restart** will restart the VM on which the chosen DCS instance runs. + +.. |image1| image:: /_static/images/en-us_image_0000001340405157.png diff --git a/umn/source/operation_guide/starting_dcs_instances.rst b/umn/source/operation_guide/starting_dcs_instances.rst new file mode 100644 index 0000000..13a5f32 --- /dev/null +++ b/umn/source/operation_guide/starting_dcs_instances.rst @@ -0,0 +1,36 @@ +:original_name: en-us_topic_0054235817.html + +.. _en-us_topic_0054235817: + +Starting DCS Instances +====================== + +Scenario +-------- + +On the DCS console, you can start one or multiple DCS instances at a time. + +.. note:: + + This function is not supported by recent instances. You can only start old instances that have been stopped. Once started, these instances can only be restarted and can no longer be stopped or started. + +Procedure +--------- + +#. Log in to the management console. + +#. Click |image1| in the upper left corner of the management console and select a region and a project. + +#. Click **Service List**, and choose **Database** > **Distributed Cache Service** to launch the DCS console. + +#. In the navigation pane, choose **Cache Manager**. + +#. On the **Cache Manager** page, select one or more DCS instances you want to start. + +#. Click **Start** in the same row as the instance. + +#. In the **Start** dialog box, click **OK** to confirm that you want to start the instances. + + It takes 1 to 30 minutes to start DCS instances. After DCS instances are started, their status changes from **Stopped** to **Running**. + +.. |image1| image:: /_static/images/en-us_image_0000001287445456.png