Distributed Cache Service. User Guide. Issue 06 Date

Transcription

1 Issue 06 Date

2 Contents Contents 1 Introduction DCS Application Scenarios Advantages Compatibility with Redis Commands DCS Instance Specifications Accessing DCS How to Access DCS Related Services User Permissions Related Concepts Getting Started Setting Up Environments Creating a DCS Instance Accessing a DCS Instance Viewing Details of a DCS Instance Operation Guide Configuring Redis-Specific Parameters Stopping DCS Instances Starting DCS Instances Restarting DCS Instances Deleting DCS Instances Scaling Up DCS Instances Changing Instance Password Modifying an Instance's Maintenance Time Window Modifying an Instance's Security Group Backing Up and Restoring DCS Instances Overview Configuring a Backup Policy Manually Backing Up a DCS Instance Restoring a DCS Instance FAQs...39 Issue 06 ( ) ii

3 Contents 4.1 Does DCS Support Common Redis Clients Such as Jedis? Should I Install Redis If I Already Have a DCS Instance? Should I 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 and Why Is Memory Usage of Unused DCS Instances Greater Than Zero? Does DCS Support Data Read/Write in Multiple Databases? Why Can't I Back Up or Scale Up My DCS Instances? Do DCS Instances in the 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 Available Instance Memory? How to Select and Configure a Security Group? Do DCS Instances Support Cross-VPC Access?...45 A Glossary...47 B Change History...48 Issue 06 ( ) iii

4 1 Introduction 1 Introduction 1.1 DCS 1.2 Application Scenarios 1.3 Advantages 1.4 Compatibility with Redis Commands 1.5 DCS Instance Specifications 1.6 Accessing DCS 1.7 Related Concepts 1.1 DCS Distributed Cache Service (DCS) is an online, distributed, in-memory cache service. It is reliable, scalable, usable out of the box, and easy to manage. DCS makes it easy to deploy, operate, and scale in-memory data caches in the cloud. DCS uses Redis 3.0.7, an open-source, in-memory, log-structured key-value store written in ANSI C. It is networked and provides a range of data persistence options. For more information about Redis, visit Clients used to access DCS instances can only be accessed by clients running on Elastic Cloud Servers (ECSs) within the same VPC. Figure 1-1 Client accessing DCS instances Issue 06 ( ) 1

5 1 Introduction NOTE Like clients, DCS instances are also run on ECSs. A client must belong to the same virtual private cloud (VPC) and subnet as the DCS instance it is attempting to access. There are three deployment modes for DCS 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 or stopped. Master/standby DCS instances run in master/standby mode, providing higher availability than singlenode 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. Cluster 1.2 Application Scenarios DCS instances run in the 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 the 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. 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. Issue 06 ( ) 2

6 1 Introduction 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 1.3 Advantages DCS provides continuous event querying, allowing streams of events to be processed as they occur. 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 1 GB to 512 GB, increasing the flexibility of the DCS. Reliability Data persistence, support for master/standby and cluster modes, and automatic failover between cache nodes ensure data reliability and service availability. Ease of maintenance You can create, start, stop, 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. 1.4 Compatibility with Redis Commands DCS is built on the Redis engine and supports the majority of Redis commands. Any clients that support Redis can access DCS. For security purposes, certain Redis commands are disabled in DCS. For more information about Redis commands, visit commands. NOTE Some Redis commands, such as FLUSHALL, take a long time to run. While running these commands, DCS instances may not respond to other commands and change to the Faulty state. However, after the command finishes executing, the instance will return to normal. Issue 06 ( ) 3

7 1 Introduction DCS Instances in Single-Node or Master/Standby Mode Table 1-1 Redis commands disabled in single-node and master/standby DCS instances Category Keys Script Server Commands MIGRATE EVAL, EVALSHA, SCRIPT EXISTS, SCRIPT FLUSH, SCRIPT KILL, SCRIPT LOAD SLOWLOG, SLAVEOF, SHUTDOWN, SAVE, ROLE, MONITOR, LASTSAVE, DEBUG SEGFAULT, DEBUG OBJECT, CONFIG SET, CONFIG REWRITE, CONFIG RESETSTAT, CONFIG GET, COMMAND INFO, COMMAND GETKEYS, COMMAND COUNT, COMMAND, CLIENT SETNAME, CLIENT LIST, CLIENT KILL, CLIENT GETNAME, BGSAVE, BGREWRITEAOF NOTICE Redis clients receive "(error) ERR unknown command" from DCS and probably exhibit unpredictable behavior after running the disabled commands. DCS cannot control their behavior. For example, if the MONITOR command is run, redis-cli will keep waiting for monitoring results even after receiving "(error) ERR unknown command" from DCS and refuse to run other commands during the wait period. DCS Instances in Cluster Mode DCS instances in cluster mode do not support the following commands: Redis commands disabled in single-node and master/standby DCS instances Commands listed in Table 1-2 Table 1-2 Commands disabled for DCS instances in the cluster mode Category String List Set SortedSet HyperLogLog Transaction Connection Commands MSETNX RPOPLPUSH SINTERSTORE, SINTER, SUNIONSTORE, SUNION, SDIFFSTORE, SDIFF, SMOVE ZUNIONSTORE, ZINTERSTORE PFMERGE, PFCOUNT DISCARD, EXEC, MULTI, UNWATCH, WATCH SELECT Issue 06 ( ) 4

8 1 Introduction Category Keys List Cluster codis Commands MOVE, SCAN BLPOP, BRPOP, BRPOPLPUSH CLUSTER PSUBSCRIBE(), PUBLISH, PUNSUBSCRIBE, SUBSCRIBE, RANDOMKEY, UNSUBSCRIBE, DBSIZE, FLUSHALL, FLUSHDB, TIME, SLOTSINFO, SLOTSDEL, SLOTSMGRTSLOT, SLOTSMGRTONE, SLOTSCHECK, SLOTSMGRTTAGSLOT, SLOTSMGRTTAGONE NOTICE Redis clients receive "(error) ERR unknown command" from DCS and probably exhibit unpredictable behavior after running the disabled commands. DCS cannot control their behavior. For example, if the PSUBSCRIBE, SUBSCRIBE, or MONITOR command is run, redis-cli will keep waiting for responses from DCS even after receiving "(error) ERR unknown command" from DCS and refuse to run other commands during the wait period. 1.5 DCS Instance Specifications For each single-node DCS instance, the available memory is less than the total memory because some memory is reserved for system overhead. For each master/standby DCS instance, the available memory is less than the total memory because some memory is reserved for data persistence. If the DCS instances are deployed in master/standby mode, only the master cache node contributes to the available memory. Table 1-3 Specifications of single-node and master/standby DCS instances Memory (GB) Total Available (Single Node) Available (Master/ Standby) Maximum Number of Connections Allowed Maximum Intranet Bandwidth (Mbit/s) Issue 06 ( ) 5

9 1 Introduction Table 1-4 Specifications of DCS instances in the cluster mode Total Memory (GB) Available Memory (GB) Maximum Number of Connections Allowed Maximum Intranet Bandwidth (Mbit/s) NOTE The maximum intranet bandwidth is the sum of maximum inbound and outbound intranet bandwidths. Usually, DCS instances are read more frequently than they are written. Therefore, it is recommended that the maximum inbound intranet bandwidth be one third of the maximum intranet bandwidth and the maximum outbound intranet bandwidth be two thirds of the maximum intranet bandwidth. 1.6 Accessing DCS How to Access DCS There are two ways to access DCS: Using the management console The public cloud provides a web-based management console. If you have created an account on the management console, choose Database > Distributed Cache Service on the homepage after login to launch the DCS console. On the DCS console, you can create, start, stop, restart, delete, and change passwords for DCS instances. Using APIs Related Services If you want to integrate DCS into a third-party system for secondary development, use APIs to access DCS. For more information about the available APIs, see the Distributed Cache Service API Reference. Virtual Private Cloud (VPC) DCS instances run in VPCs and use the IP addresses and bandwidths of VPCs. Security groups in VPCs control access to DCS instances. Elastic Cloud Server (ECS) After you create DCS instances, you can connect to them through ECSs. Issue 06 ( ) 6

10 1 Introduction Cloud Eye CloudEye Service is a secure, scalable monitoring platform in the public cloud. It monitors DCS service metrics and sends notifications if alarms or events occur. Table 1-5 DCS monitoring metrics displayed on the Cloud Eye console Metric Description Value Range Monitored Object CPU Usage Memory Usage CPU consumed by monitored objects Memory consumed by monitored objects 0% to 100% ECS 0% to 100% ECS Network Input Throughput Inbound throughput per second on a port 0 bytes/s ECS Network Output Throughput Outbound throughput per second on a port 0 bytes/s ECS Connected Clients Number of connected clients, including connections established by the DCS server (a management service in the background) to monitor DCS instances and excluding connections from standby nodes 0 DCS Client Longest Output List Longest output list among current client connections 0 DCS Client Biggest Input Buf Maximum input data length among current client connections 0 bytes/s DCS Blocked Clients Number of clients suspended by block operations, such as BLPOP, BRPOP, and BRPOPLPUSH 0 DCS Used Memory Total number of bytes allocated by Redis using its allocator 0 bytes/s DCS Used Memory RSS Number of bytes that Redis allocates as seen by the operating system (a.k.a resident set size). It includes all stack and heap memory but not swapped-out memory. 0 bytes/s DCS Issue 06 ( ) 7

11 1 Introduction Metric Description Value Range Monitored Object Used Memory Peak Peak memory consumed by Redis since the Redis server last started 0 bytes/s DCS Used Memory Lua Number of bytes used by the Lua engine 0 bytes/s DCS Memory Fragmentation Ratio Ratio between Used Memory RSS and Used Memory. Ideally, the Used Memory RSS should be only slightly higher than Used Memory. When Used Memory RSS is much greater than Used Memory, there is memory fragmentation (internal or external), which can be evaluated by checking Memory Fragmentation Ratio. When Used Memory is much greater than Used Memory RSS, part of Redis memory has been swapped out by the operating system. In this case, significant latency can be expected. Because Redis does not have control over how its allocations are mapped to memory pages, high Used Memory RSS is often the result of a spike in memory usage. 0 DCS Total Connections Received Total number of connections the Redis server has received since it last started, including connections established by the DCS server (a management service in the background) to monitor DCS instances 0 DCS Total Commands Processed Total number of commands the Redis server has processed since it last started, including commands issued by the DCS server (a management service in the background) to monitor DCS instances 0 DCS Issue 06 ( ) 8

12 1 Introduction Metric Description Value Range Monitored Object Instantaneous Ops Per Second Number of commands processed per second 0 DCS Total Net Input Bytes Total number of bytes the Redis server has received since it last started 0 bytes/s DCS Total Net Output Bytes Total number of bytes the Redis server has sent since it last started 0 bytes/s DCS Instantaneous Input Kbps Instantaneous Output Kbps Instantaneous input traffic 0 Kbit/s DCS Instantaneous output traffic 0 Kbit/s DCS Rejected Connections Number of connections that have exceeded maxclients and been rejected by the Redis server since it last started 0 DCS Sync Full Total number of full synchronizations since the Redis server is started 0 DCS Sync Partial OK Total number of incremental synchronizations since the Redis server last started 0 DCS Sync Partial Err Total number of failed incremental synchronizations since the Redis server last started 0 DCS Expired Keys Total number of keys that have expired since the Redis server last started 0 DCS Evicted Keys Number of keys that have been evicted due to insufficient memory since the Redis server last started 0 DCS Keyspace Hits Total number of query hits in the master dictionary since the Redis server last started 0 DCS Keyspace Misses Total number of query misses in the master dictionary since the Redis server last started 0 DCS Issue 06 ( ) 9

13 1 Introduction Metric Description Value Range Monitored Object PubSub Channels PubSub Patterns Aof Current Size Number of Pub/Sub channels 0 DCS Number of Pub/Sub patterns 0 DCS AOF file size 0 DCS Latest Fork usec Duration of the latest fork operation 0 ms DCS Cloud Trace Service (CTS) User Permissions CTS provides a history of operations performed on cloud service resources. With CTS, you can query, audit, and track back through 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, stopping, restarting, and deleting DCS instances Configuring Redis-specific parameters Changing instance passwords Modifying basic information Identity and Access Management (IAM) The IAM service authenticates access to DCS. 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 further details, see Permissions. 1.7 Related Concepts Region A region is a geographic area where DCS is located. DCS services in the same region can communicate with each other over an intranet, but those in different regions cannot. Public cloud data centers are deployed worldwide in places such as North America, Europe, and Asia. DCS is therefore available in different regions. For example, applications can be Issue 06 ( ) 10

14 1 Introduction Availability Zone Project designed to meet user requirements in specific regions or comply with local laws or regulations. Each region contains many availability zones (AZs) where power and networks are physically isolated. AZs in the same region can communicate with each other over an intranet. Each AZ provides cost-effective and low-latency network connections that are unaffected by faults that may occur in other AZs. Using DCS deployed in an independent AZ protects your applications against failures in a single place. Projects are used to group and isolate OpenStack resources (computing, storage, and network resources). A project can be a department or a project team. Multiple projects can be created for one account. Issue 06 ( ) 11

15 2 Getting Started 2 Getting Started 2.1 Setting Up Environments 2.2 Creating a DCS Instance 2.3 Accessing a DCS Instance 2.4 Viewing Details of a DCS Instance 2.1 Setting Up Environments Before using DCS, create a VPC and configure a security group and subnet. A VPC provides an isolated, user-configurable, and user-manageable virtual network environment for DCS. Using VPCs enhances public cloud resource security and simplifies network deployment. If you have already created a VPC, you will never need to create it again. Procedure Step 1 Log in to the management console. Step 2 Click in the upper-left corner of the management console and select Region and Project. Step 3 Step 4 Step 5 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 guided by the VPC console. Unless otherwise required, VPC parameters retain their default values. For more information on how to create a VPC, see Virtual Private Cloud. After a VPC is created, a subnet is also created in the subnet. If the VPC needs more subnets, go to Step 6. Issue 06 ( ) 12

16 2 Getting Started Step 6 In the navigation pane, choose Virtual Private Cloud. On the Virtual Private Cloud page, click the name of the VPC in which a new subnet will be created. On the Subnet tab page, click Create Subnet. Create a subnet as guided by the VPC console. Unless otherwise required, subnet parameters retain their default values. For more information on how to create a subnet, see Virtual Private Cloud. Step 7 In the navigation pane, choose Security Group. On the Security Group page, click Create Security Group to create a security group for the VPC. Unless otherwise required, security group parameters retain their default values. For more information on how to create a security group, see Virtual Private Cloud User Guide. ----End 2.2 Creating a DCS Instance Scenario DCS can be used only after DCS instances are created. Currently, DCS supports three types of DCS instances: single-node, master/standby, and cluster. NOTICE 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 Procedure The VPC where the DCS instances will be created is available. Security groups and subnets have been configured for the VPC. For details on how to create VPCs, security groups, and subnets, see 2.1 Setting Up Environments or Virtual Private Cloud. Step 1 Log in to the management console. Step 2 Click in the upper-left corner of the management console and select Region and Project. Step 3 Step 4 Step 5 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 Create Cache Instance. The Specify Details tab page of Create Cache Instance page is then displayed. Issue 06 ( ) 13

17 2 Getting Started Step 6 On the Specify Details tab page, specify DCS instance parameters, such as the name, availability zone (AZ), VPC, security group, and subnet. Table 2-1 DCS instance parameters Parameter Region Name Description AZ Cache Engine Engine Version Instance Type Instance Specifications VPC Description Region in which DCS is located. You can change your region from the drop-down list in the upper-left corner of the DCS console. Name of the new DCS instance. A DCS instance name cannot be left unspecified and must: Be 4 to 64 characters long. Only uppercase or lowercase letters, digits, and hyphens (-) are allowed. Start with an uppercase or lowercase letter. Description of the new DCS instance. Availability zone (AZ) in which the new DCS instance resides. Cache engine used. Currently, only Redis is supported. Cache engine version. Currently, only Redis is supported. Type of the DCS instance being created. Currently, three types are supported: single-node, master/standby, and cluster. Select an instance type based on the actual service scenario. For more information, see DCS Instance Type. NOTE DCS instances of the cluster type do not support cross-vpc access through VPC peering connections. Total memory of the new DCS instance. Value: 64, 128, 256, or 512 GB if the DCS instance is in the cluster mode 1, 2, 4, 8, 16, 32, or 64 GB if the DCS instance is a single-node or master/standby instance By default, each tenant can create a maximum of five DCS instances and use a maximum of 400 GB memory. When creating a DCS instance on the DCS console, available free memory is listed below the Instance Specifications field. If more memory is needed, click Increase Quota below the Instance Specifications field and contact customer service. For more information, see How Can I Apply for a Higher Quota?. VPC in which the new DCS instance resides. A VPC provides an isolated, user-configurable, and user-manageable virtual network environment for your DCS instances. Click View VPC to show more details of the chosen VPC, including security group rules. Issue 06 ( ) 14

18 2 Getting Started Parameter Subnet Security Group Password Time Window Backup Policy Description Name and IP address range of the subnet in which the new DCS instance resides. Security group that controls access to the new DCS instance. A security group is a set of access control rules. It implements access control for ECSs in the same VPC that trust each other and have the same security protection requirements. Password required for accessing the new DCS instance. NOTE For security purposes, the DCS prompts you to enter an instance-specific password when you are connecting to the DCS instance. Keep your instance password secure and change it periodically. Passwords cannot be left unspecified. They must: Be 8 to 32 characters long Contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters `~!@#$%^&*()- _=+\ [{}]:'",<.>/? Time range for any scheduled maintenance activities to occur for cache nodes of this DCS instance. Values: 22:00-02:00 02:00-06:00 06:00-10:00 10:00-14:00 14:00-18:00 18:00-22:00 Data backup policy. This parameter is displayed when you create a DCS instance of master/standby or cluster type. For details about how to configure a backup policy, see Configuring a Backup Policy. Step 7 On the Specify Details tab page, click Create Now. The Confirm Specifications tab page is then displayed, providing information about the new DCS instance, including the instance name, cache engine version, and instance specifications. Step 8 Step 9 On the Confirm Specifications tab page, review 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 usually takes about 5 to 15 minutes to create a DCS instance. However, the time will be up to approximately 30 minutes if the DCS instance is in the cluster mode. After a DCS instance has been successfully created, it enters the Running state by default. Issue 06 ( ) 15

19 2 Getting Started NOTE ----End If the new DCS instance failed to be created, delete the unsuccessful instance creation task by following the procedure in Deleting Instance Creation Tasks That Failed to Run and then create the DCS instance again. If the DCS instance failed to be re-created, contact customer service. 2.3 Accessing a DCS Instance You can access the created DCS instances through your Redis client. DCS works with multiple types of Redis clients. This section uses redis-cli and Redis Java (Jedis) client as an example. For details about how to use other Redis clients, visit redis.io/clients. Prerequisites The DCS instance you will access is in the Running state. An ECS has been created to serve as your Redis client. For details about how to create ECSs, see Elastic Cloud Server. 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 must have network connectivity. Procedure Step 1 Log in to the management console. Step 2 Click in the upper-left corner of the management console and select Region and Project. Step 3 Step 4 Step 5 Step 6 Click Service List, and choose Database > Distributed Cache Service to launch the DCS console. In the navigation pane, choose Cache Manager. Obtain the IP address:port number of the DCS instance. 1. On the Cache Manager page, click the name of the DCS instance you will access. A page with details of the DCS instance is then displayed. 2. On the Summary tab page of instance details page, view the Connection Address (IP address:port number) of the DCS instance. Access the chosen DCS instance. By using redis-cli a. Download the source code package of your Redis client from download.redis.io/releases/redis tar.gz. b. Upload the source code package of your Redis client to the ECS serving as your Redis client. Issue 06 ( ) 16

20 2 Getting Started c. Log in to the ECS that serves as your Redis client. d. Run the following command to decompress the redis directory from the source code package of your Redis client: tar -xzf redis tar.gz e. Run the following commands to go to the redis directory and compile the source code of your Redis client: cd redis make f. Run the following commands to access the chosen DCS instance: cd src./redis-cli -h p 6379./redis-cli -h ip-address -p port-number In the second command, use the DCS instance IP address and port number obtained in Step 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 at DCS instance creation time. 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: ~]#./redis-cli -h p :6379> auth ****** OK :6379> In this example command output: is an example IP address of DCS instance, which is obtained in Step is an example port number of DCS instance, which is obtained in Step 5. By using a Jedis client a. Obtain the source code of the Jedis client from b. Write code. i. Example code for a single Jedis connection //Create a connection String host = " "; int port = 6379; String pwd = "passwd"; ii. 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) ); Example code for a Jedis connection pool //Generate configuration information of a Jedis connection pool String ip = " "; int port = 6379; Issue 06 ( ) 17

21 2 Getting Started ----End 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, , 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. 2.4 Viewing Details of a DCS Instance Scenario Procedure This section describes how to view details about a DCS instance using the DCS console. Step 1 Log in to the management console. Step 2 Click in the upper-left corner of the management console and select Region and Project. Step 3 Step 4 Step 5 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 desired DCS instance. Issue 06 ( ) 18

22 2 Getting Started Table 2-2 DCS instance statuses State Creating Running Faulty Starting Restarting Stopping Stopped Scaling up Description The instance is being created. The instance is running properly. Only instances in the Running state can provide in-memory cache service. The instance is not running properly. The instance is being started. The instance is being restarted. The instance is being stopped. The instance has been stopped gracefully. Instances in the Stopped state no longer provide in-memory cache service. The instance is being scaled up. Step 6 On the DCS instance list, click the name of the chosen DCS instance to display more details about it. Table 2-3 Parameters on the DCS instance details page Category Parameter Description Basic information Name Instance Type Instance Specifications (GB) Used/Available Memory (MB) Status Time Window Name of the chosen instance. To modify the instance name, click the icon. Type of the chosen instance. Currently, three types are supported: single-node, master/standby, and cluster. Specifications of the chosen instance. The used memory space and maximum allowed 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 repli-backlog) and internal data structures Status of the chosen DCS instance. For details, see Table 2-2. Time range for any scheduled maintenance activities to occur for cache nodes of this DCS instance. To modify the maintenance time window, click the Time Window. icon next to Issue 06 ( ) 19

23 2 Getting Started Category Parameter Description ID Connection Address Created Description Monitoring metrics ID of the chosen instance. IP address and port number of the chosen instance. Time at which the chosen instance was created. Description of the selected instance. To modify the description, click the icon. Monitoring metrics of the chosen instance. Click the View icon to switch to the Cloud Eye console on which monitoring metrics of the selected DCS instance are displayed. Network AZ Availability zone in which the cache node of the chosen instance resides. Security Group VPC Subnet Security group that controls access to the chosen instance. To modify the security group, click the next to Security Group. VPC in which the chosen instance resides. Subnet in which the chosen instance resides. icon ----End Issue 06 ( ) 20

24 3 Operation Guide 3 Operation Guide This chapter describes how to manage DCS instances. NOTICE In the event that some cache nodes of DCS instance is faulty: The instance is still in the Running state and you can continue to read and write data from and into the instance. This is achieved thanks to high availability of DCS. Cache nodes recover from internal faults automatically. Manual fault recovery is also supported. Certain operations (such as backup, restoration, parameter configuration, and scaling) in the management zone are not supported during fault recovery. You can contact customer service or perform these operations after the cache nodes recover from faults. 3.1 Configuring Redis-Specific Parameters 3.2 Stopping DCS Instances 3.3 Starting DCS Instances 3.4 Restarting DCS Instances 3.5 Deleting DCS Instances 3.6 Scaling Up DCS Instances 3.7 Changing Instance Password 3.8 Modifying an Instance's Maintenance Time Window 3.9 Modifying an Instance's Security Group 3.10 Backing Up and Restoring DCS Instances 3.1 Configuring Redis-Specific Parameters Configure Redis-specific parameters to keep DCS instances performing optimally. Issue 06 ( ) 21

25 3 Operation Guide NOTE The default values are already optimized for typical use cases. Reconfiguring parameters is recommended only when necessary. Prerequisites The DCS instance you will configure is in the Running state, and the instance type is singlenode or master/standby (Redis parameters of DCS instances in the cluster mode are not modifiable). Procedure Step 1 Log in to the management console. Step 2 Click in the upper-left corner of the management console and select Region and Project. Step 3 Step 4 Step 5 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 DCS instance you will configure. A page with details of the chosen DCS instance is displayed. Step 6 Step 7 Step 8 On the instance details page, click the Configuration Parameters tab. On the Configuration Parameters tab page, click Modify. Modify Redis-specific parameters based on your requirements. Table 3-1 Redis-specific parameters Parame ter Description Possible Values Default Value maxme morypolicy How Redis will select what to remove when maxmemory is reached. For more information about this parameter, see 4.9 What Is the Default Data Eviction Policy? volatile-lru allkeys-lru volatile-random allkeys-random volatile-ttl noeviction noeviction hashmaxziplistentries Hashes are encoded using the memory efficient data structure ziplist when the number of entries in hashes is less than the value of this parameter. 1 to Issue 06 ( ) 22

26 3 Operation Guide Parame ter Description Possible Values Default Value hashmaxziplistvalue listmaxziplistentries listmaxziplistvalue set-maxintsetentries zsetmaxziplistentries zsetmaxziplistvalue Hashes are encoded using the memory efficient data structure ziplist when the biggest entry in hashes does not exceed the length threshold indicated by this parameter. Lists are encoded using the memory efficient data structure ziplist when the number of entries in lists is less than the value of this parameter. Lists are encoded using the memory efficient data structure ziplist when the biggest entry in lists does not exceed the length threshold indicated by this parameter. When a set is composed of just strings that happen to be integers in radix 10 in the range of 64 bit signed integers and the number of integral strings is less than the value of this parameter, sets are encoded using the memory efficient data structure intset. Sorted sets are encoded using the memory efficient data structure ziplist when the number of entries in sorted sets is less than the value of this parameter. Sorted sets are encoded using the memory efficient data structure ziplist when the biggest entry in sorted sets does not exceed the length threshold indicated by this parameter. 1 to to to to to to Issue 06 ( ) 23

27 3 Operation Guide Parame ter Description Possible Values Default Value latencymonitorthreshol d Only events that run in more time than the configured latencymonitor-threshold will be logged as latency spikes. If latency-monitor-threshold is set to 0, latency monitoring is disabled. If latency-monitor-threshold is set to a value greater than 0, all events blocking the server for a time greater than or equal to the configured latency-monitorthreshold 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 latency-monitor-threshold, visit 0 to ms 0 reserved - memory The number of megabytes reserved for the backend to perform internal processing such as persistence and master/standby replication. This parameter is configurable only for master/standby instances. 0% to 50% of maximum memory space initially available to the instance and below the current free memory space NOTE: For more information about maximum available memory of each instance type, see Table timeout Period for which a Redis client can be idle before the connection between the Redis client and server (DCS instance) is closed. A timeout period of 0 indicates that the connection is permanently open. 0 to 7200 seconds 0 Issue 06 ( ) 24

28 3 Operation Guide Parame ter Description Possible Values Default Value notifykeyspac e-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 that Redis will notify. "" 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 (nontype 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) Issue 06 ( ) 25

29 3 Operation Guide Parame ter Description Possible Values Default Value 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. NOTE For more information about Redis-specific parameters, visit 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. Step 9 Step 10 After you have finished setting parameters, click Save. Click OK to confirm. ----End 3.2 Stopping DCS Instances Scenario On the DCS console, you can stop one or multiple DCS instances at a time. NOTICE After a DCS instance is stopped, it can no longer be read from or written to. If it is a single-node instance, data will also be deleted from it when it is stopped. The attempt to stop a DCS instance while it is being backed up may end up with a failure. Prerequisites Procedure The DCS instances you will stop are in the Running state. Step 1 Log in to the management console. Step 2 Click in the upper-left corner of the management console and select Region and Project. Step 3 Click Service List, and choose Database > Distributed Cache Service to launch the DCS console. Issue 06 ( ) 26

30 3 Operation Guide Step 4 Step 5 Step 6 In the navigation pane, choose Cache Manager. Choose instances to stop. To stop a single instance, click Stop in the same row as the instance. To stop multiple instances, select the instances to stop and click Stop above the instance list. In the Stop dialog box, click OK to confirm that you want to proceed with the stop operation. It takes about 1 to 30 minutes to stop DCS instances. After DCS instances are stopped, their status changes from Running to Stopped. ----End 3.3 Starting DCS Instances Scenario Prerequisites Procedure On the DCS console, you can start one or multiple DCS instances at a time. The DCS instances you will start are in the Stopped state. Step 1 Log in to the management console. Step 2 Click in the upper-left corner of the management console and select Region and Project. Step 3 Step 4 Step 5 Step 6 Click Service List, and choose Database > Distributed Cache Service to launch the DCS console. In the navigation pane, choose Cache Manager. Choose instances to start. To start a single instance, click Start in the same row as the instance. To start multiple instances, select the instances to start and click Start above the instance list. In the Start dialog box, click OK to confirm that you want to proceed with the start operation. It takes about 1 to 30 minutes to start DCS instances. After DCS instances are started, their status changes from Stopped to Running. ----End 3.4 Restarting DCS Instances Scenario On the DCS console, you can restart one or multiple DCS instances at a time. Issue 06 ( ) 27

31 3 Operation Guide NOTICE 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. The attempt to restart a DCS instance while it is being backed up may end up with a failure. Prerequisites The DCS instances you will restart are in the Running or Faulty state. Procedure Step 1 Log in to the management console. Step 2 Click in the upper-left corner of the management console and select Region and Project. Step 3 Step 4 Step 5 Step 6 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 More > 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 Restart dialog box, click OK to confirm that you want to proceed with the restart operation. By default, only instance process will restart. However, selecting Forced Restart will restart the VM on which the chosen DCS instance runs. It takes about 1 to 30 minutes to restart DCS instances. After DCS instances are restarted, their status changes to Running. ----End 3.5 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 failed to run. NOTICE After a DCS instance is deleted, data from the instance will also be deleted without backup. Issue 06 ( ) 28

32 3 Operation Guide Prerequisites The DCS instance you will delete has been created. The DCS instances you will delete are in the Running, Faulty, or Stopped state. Deleting DCS Instances Step 1 Log in to the management console. Step 2 Click in the upper-left corner of the management console and select Region and Project. Step 3 Step 4 Step 5 Click Service List, and choose Database > Distributed Cache Service to launch the DCS console. In the navigation pane, choose Cache Manager. Choose instances to delete. To delete a single instance, choose Operation > More > Delete in the same row as the instance. To delete multiple instances, select the instances to delete and click Delete above the instance list. DCS instances in the Creating, Starting, Stopped, or Restarting state cannot be deleted. Step 6 In the Delete dialog box, click OK to confirm that you want to proceed with the deletion. It takes about 1 to 30 minutes to delete a DCS instance. ----End Deleting Instance Creation Tasks That Failed to Run Step 1 Log in to the management console. Step 2 Click in the upper-left corner of the management console and select Region and Project. Step 3 Step 4 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 failed to be created, Creation Failure Tasks is displayed above the instance list. Step 5 Click the red-cross icon or the number of failed tasks next to Creation Failure Tasks. The Creation Failure Tasks dialog box is then displayed. Step 6 Choose failed instance creation tasks to delete. To delete a single failed task, click Delete Task in the same row as the task. To delete all failed tasks, click Delete All Failed Tasks above the task list. ----End Issue 06 ( ) 29

33 3 Operation Guide 3.6 Scaling Up DCS Instances Scenario On the DCS console, you can scale DCS instances up to desired specifications. NOTICE DCS instances in the cluster mode do not support scale-ups. It takes 5 to 30 minutes to scale up a DCS instance. To minimize the impact of any unexpected results, we recommend scaling up your instance during off-peak periods. During scale-up, single-node DCS instances do not support data read/write, but master/ standby DCS instances support data read/write. Scaling DCS instances up will incur a cost change. That is, after scale-up is successful, the scaled DCS instances are charged based on new specifications. Prerequisites Procedure The DCS instance you will scale up is in the Running state. Step 1 Log in to the management console. Step 2 Click in the upper-left corner of the management console and select Region and Project. Step 3 Step 4 Step 5 Step 6 Click Service List, and choose Database > Distributed Cache Service to launch the DCS console. In the navigation pane, choose Cache Manager. Choose More > Scale up in the same row as the DCS instance you will scale up. In the Scale Up DCS Instance dialog box, select the specifications to which the chosen DCS instance will scale up. For both single-node and master/standby instances, the maximum specifications are 64 GB. Step 7 In the Scale Up DCS Instance dialog box, click OK. The Apply for Instance Scale-Up page is then displayed. This page displays instance information such as the instance name, cache engine version, and new specifications. Step 8 Review instance information. Click Submit on the Specify Details tab page. It takes 5 to 30 minutes to scale up a DCS instance. After scale-up is successful, the DCS instance enters the Running state. Issue 06 ( ) 30

34 3 Operation Guide NOTE ----End If scaling up a single-node DCS instance fails The instance continues to use the original specifications. In addition, the instance is temporarily unavailable for use and does not support operations (such as parameter configuration and scale-up) in the management zone. However, after O&M personnel click Retry Scale-Up on the DCS OM console, the instance will be forcibly scaled to the new specifications and become available for use again. If scaling up a master/standby DCS instance fails Operations (such as backup, restoration, scale up, and parameter configuration) in the management zone are temporarily unsupported. The instance continues to be available for use but comes with the original specifications. Remember not to read or write more data than allowed by the original specifications; otherwise, data loss may occur. After scale up is successful, the instance comes with new specifications. 3.7 Changing Instance Password Scenario Prerequisites Procedure On the DCS console, you can change the password required for accessing your DCS instance. The DCS instance for which you will change password is in the Running state. Step 1 Log in to the management console. Step 2 Click in the upper-left corner of the management console and select Region and Project. Step 3 Step 4 Step 5 Step 6 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. It must: Be different from the old password Be 8 to 32 characters long Contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters `~!@#$%^&*()-_=+\ [{}]:'",<.>/? Step 7 In the Change Password dialog box, click OK to confirm the password change. ----End Issue 06 ( ) 31

35 3 Operation Guide 3.8 Modifying an Instance's Maintenance Time Window Scenario After creating a DCS instance, you can modify the maintenance time window of the DCS instance on the instance's Summary page on the DCS console. Prerequisite At least one DCS instance has been created. Procedure Step 1 Log in to the management console. Step 2 Click in the upper-left corner of the management console and select Region and Project. Step 3 Step 4 Click Service List, and choose Database > Distributed Cache Service to launch the DCS console. In the navigation pane, choose Cache Manager. The Cache Manager page with a list of DCS instances is displayed. Step 5 Click the name of the DCS instance for which you will modify the maintenance time window. Step 6 Click the Summary tab. In the Basic Information area, click the icon next to the Time Window parameter. Step 7 Select a new maintenance time window from the drop-down list. Click to save the modification or to cancel the modification. The modification will take effect immediately, that is, the new maintenance time window will appear on the Summary tab page immediately. ----End 3.9 Modifying an Instance's Security Group Scenario After creating a DCS instance, you can modify the instance's security group on the instance's Summary page on the DCS console. Prerequisites At least one DCS instance has been created. Issue 06 ( ) 32

36 3 Operation Guide Procedure Step 1 Log in to the management console. Step 2 Click in the upper-left corner of the management console and select Region and Project. Step 3 Step 4 Click Service List, and choose Database > Distributed Cache Service to launch the DCS console. In the navigation pane, choose Cache Manager. The Cache Manager page with a list of DCS instances is displayed. Step 5 Click the name of the DCS instance for which you will modify the security group. Step 6 Click the Summary tab. In the Network area, click the icon next to the Security Group parameter. Step 7 Select a new security group from the drop-down list. Click to save the modification or to cancel the modification. The modification will take effect immediately, that is, the new security group will appear on the Summary tab page immediately. NOTE ----End Only the security groups that have been created can be selected from the drop-down list. If you need to create a new security group, follow the procedure in 4.17 How to Select and Configure a Security Group? Backing Up and Restoring DCS Instances Overview Need for DCS Instance Backup Backup Modes There is a small chance that dirty data could exist in a DCS instance owing to service system exceptions or problems 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. 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. Issue 06 ( ) 33

37 3 Operation Guide 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 if necessary, the instance can be quickly restored. 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 DCS instances can be backed up and restored. 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 and pricing 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. Issue 06 ( ) 34

38 3 Operation Guide Data Restoration Data restoration process a. A user initiates a data restoration request using the DCS console. b. DCS obtains the backup file from OBS. c. Read/write to the DCS instance is suspended. d. The original data persistence file of the master cache node is replaced by the backup file. e. The new data persistence file (that is, the backup file) is reloaded. f. 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, DCS will restore the DCS instance to the state in which it was before data restoration Configuring a Backup Policy Scenario Prerequisites Procedure This section describes how to configure an automatic backup policy on the DCS console. 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. At least one master/standby DCS instance has been created. Step 1 Log in to the management console. Step 2 Click in the upper-left corner of the management console and select Region and Project. Step 3 Step 4 Step 5 Step 6 Step 7 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 will 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 Backup and Restore. Issue 06 ( ) 35

39 3 Operation Guide Step 8 Step 9 On the Backup and Restore page, click Backup Policy. In the Backup Policy dialog box, set the Auto Backup parameter to On and specify other backup parameters. Click OK to complete setting the backup policy. Table 3-2 Parameters in a backup policy Parameter Auto Backup Backup Schedule Retention Period (days) Start Time Description An indicator of whether automatic backup is enabled. Day of week on which data in the chosen DCS instance is automatically backed up. You can select one or multiple days of week. 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: 1 to 7 days 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 arrives, data in the corresponding instance starts to be backed up. NOTE Instance backup takes approximately 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. ----End Manually Backing Up a DCS Instance Scenario This section describes how to manually back up data in instances using the DCS console. By default, manually backed up data is permanently retained. If backup data is no longer in use, delete it manually. Prerequisites At least one master/standby DCS instance is in the Running state. Issue 06 ( ) 36

40 3 Operation Guide Procedure Step 1 Log in to the management console. Step 2 Click in the upper-left corner of the management console and select Region and Project. Step 3 Step 4 Step 5 Step 6 Step 7 Step 8 Step 9 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 will 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 Backup and Restore. On the Backup and Restore page, click Manual Backup. In the Manual Backup dialog box, click OK to start manual backup. NOTE ----End Information in the Remarks text box cannot exceed 128 bytes. Instance backup takes approximately 10 to 15 minutes. The data added or modified during the backup process will not be backed up Restoring a DCS Instance Scenario This section describes how to restore backup data to a chosen DCS instance. Prerequisites At least one DCS instance of master/standby is in the Running state. A backup task has been run to back up data in the instance to be restored and the backup task is in the Succeeded state. Procedure Step 1 Log in to the management console. Step 2 Click in the upper-left corner of the management console and select Region and Project. Step 3 Step 4 Step 5 Step 6 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. Issue 06 ( ) 37

41 3 Operation Guide Step 7 Step 8 Step 9 On the instance details page, click Backup and Restore. Click Restore in the same row as the chosen backup task. In the Restore Cache Instance dialog box, click OK to start instance restoration. NOTE ----End 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 approximately 5 to 30 minutes. DCS instances being restored do not accept data operation requests from clients because existing data is being overwritten by the backup data. Issue 06 ( ) 38

42 4 FAQs 4 FAQs 4.1 Does DCS Support Common Redis Clients Such as Jedis? 4.2 Should I Install Redis If I Already Have a DCS Instance? 4.3 Should I Enter a Password When Accessing a DCS Instance? Where Can I Obtain the Password? 4.4 Does Standby Cache Node Remain Synchronized With Master Cache Node? 4.5 Does DCS Support Data Persistence? 4.6 Can DCS Be Accessed over Public Networks? 4.7 Can I Modify Configuration Parameters of DCS Instances? 4.8 Can I Recover Data from Deleted DCS Instances? 4.9 What Is the Default Data Eviction Policy? 4.10 What Should I Do If the Connection Between My Redis Client and the DCS Instance Times Out? 4.11 Why Is Available Memory of Unused DCS Instances Less Than Total Memory and Why Is Memory Usage of Unused DCS Instances Greater Than Zero? 4.12 Does DCS Support Data Read/Write in Multiple Databases? 4.13 Why Can't I Back Up or Scale Up My DCS Instances? 4.14 Do DCS Instances in the Cluster Mode Support Native Redis Clusters? 4.15 Why Do My DCS Instances Sometimes Become Unavailable While They Are in Running State? 4.16 Why Is the Used Instance Memory Displayed on Cloud Eye Console Slightly Higher than the Available Instance Memory? 4.17 How to Select and Configure a Security Group? 4.18 Do DCS Instances Support Cross-VPC Access? Issue 06 ( ) 39

43 4 FAQs 4.1 Does DCS Support Common Redis Clients Such as Jedis? DCS supports all clients compatible with Redis, including Jedis. You can download Redis clients from 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. 4.3 Should I 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. 4.4 Does Standby Cache Node Remain Synchronized With Master Cache Node? Usually, 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. 4.5 Does DCS Support Data Persistence? Only master/standby and cluster DCS instances support data persistence. 4.6 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 will access must belong to the same VPC. Issue 06 ( ) 40

44 4 FAQs 4.7 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 the cluster mode are not modifiable. 4.8 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. 4.9 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. Issue 06 ( ) 41

45 4 FAQs 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 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 Why Is Available Memory of Unused DCS Instances Less Than Total Memory and 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 instance specifications, see 1.5 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 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 16 databases (databases 0 15). DCS instances in the cluster mode do not support data read/write in multiple databases Why Can't I Back Up or Scale Up My DCS Instances? Only single-node DCS instances and master/standby DCS instances support specification scale-ups, while DCS instances in the cluster mode do not. Only master/standby DCS instances support backup and restore, while single-node DCS instances and DCS instances in the cluster mode do not. 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. Issue 06 ( ) 42

46 4 FAQs 4.14 Do DCS Instances in the Cluster Mode Support Native Redis Clusters? DCS instances in the 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: Why Do My DCS Instances Sometimes Become Unavailable While They Are in Running State? The possible cause is network faults. To locate the fault, perform the following steps: Step 1 Log in to the management console. Step 2 Click in the upper-left corner of the management console and select Region and Project. Step 3 Step 4 Step 5 Step 6 Click Service List, and choose Database > Distributed Cache Service to launch the DCS console. In the navigation pane of DCS console, choose Cache Manager. Click the name of the unavailable DCS instance. On the Summary tab page, click View next to Monitoring Metrics. View monitoring metrics of the DCS instance. If monitoring metrics change sharply over a certain period of time, a network fault has occurred. After the network administrator recovers the network, 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. ----End 4.16 Why Is the Used Instance Memory Displayed on Cloud Eye Console Slightly Higher than the Available Instance 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 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, it is a normal phenomenon that the used instance memory is slightly higher than the available instance memory. Issue 06 ( ) 43

47 4 FAQs 4.17 How to Select and Configure a Security Group? To allow a client to access a DCS instance, the ECS on which the client runs and the DCS instance must belong to the same VPC and same subnet, and have correct security group rules. 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 the security group sg-ecs, and the DCS instance that the client will access belongs to the security group sg-dcs. The port number of the DCS instance s The remote end can be a security group or an IP address. Figure 4-1 Security group rules allowing the ECS to access the DCS instance Issue 06 ( ) 44

48 4 FAQs Figure 4-2 Security group rules making the DCS instance accessible to the ECS 4.18 Do DCS Instances Support Cross-VPC Access? Generally, VPCs are isolated from each other and ECSs in a VPC cannot access the DCS instances that belong to another VPC. However, by establishing VPC peering connections between VPCs, ECSs can access singlenode and master/standby DCS instances across VPCs. When you use VPC peering connections to access DCS instances across VPCs, the IP address ranges configured for clients have the following constraints: IP Address Ranges of DCS Instances IP Address Ranges Not Allowed for Clients /12 to / / / / /16 to / /8 to / / / /24 Issue 06 ( ) 45