Quick Start

# Overview

# Introduction

Apusic In-Memory Data Cache（AMDC）V2.0.1 is a fully self-developed, high-performance, highly stable, secure, and controllable distributed caching software. It provides reliable caching support for large-scale, high-concurrency, and highly available critical applications. It is compatible with the Redis protocol and persistent data files, enabling simple, quick, and smooth replacement of Redis.

# Concepts

Some concepts unique to this product or components that the product relies on and need to be explained to the user are described below

Concept	Meaning	Usage Instructions
Cache Core	The main body of the caching service, providing caching services to business systems; other components are merely related tools unrelated to caching services.	Most systems can start using the service directly after configuring just the bind and port parameters.

# Quick Start

# About Quick Start

This quick start guide primarily introduces the basic operations of the AMDC's Cache Core and Control Console, providing guidance for users to quickly utilize this product.

# Basic Concepts

Before using the Apusic Distributed Cache, you should understand the following basic concepts:

AMDC：Apusic In-Memory Data Cache, a domestically developed, high-performance, highly available, and scalable native distributed caching system
master-slave:A deployment model where the master and slave are installed on separate servers. When the master server writes data, it synchronizes to the slave server. Typically, the master server handles writes and the slave server handles reads
Sentinel：A sentinel mode, an AMDC cache service end program that automatically monitors and handles the transfer of failed nodes among AMDC cache services. It does not provide data storage services but manages AMDC node monitoring
Cluster：A mode that brings elasticity to AMDC nodes, allowing expansion or reduction of nodes to change the amount of usable memory in AMDC, making usage more flexible. It also supports the transfer of failed nodes, achieving high availability in the cluster.

# Quick Use of AMDC Cache Core

# Using the Shell Client (amdc-cli) for Connection

Follow these steps:

Use ./amdc-cli -h [ip] -p [port] [-a passsword].
Use set [key_name] [key_value] to set a key in the cache.
Use get [key_name] to retrieve the value of this key.

# Available Commands

Refer to the Cache Core section of the User Manual

# Quick Use of the Control Console

The primary users of the Control Console fall into two roles: 1. Administrator; 2. Tenant Accounts.

Administrator：A role dedicated to implementation and maintenance, responsible for deploying, scaling up or down caching services for tenants, and providing operational support.

Tenant Account：Only responsible for managing existing caching services, sharing data with accounts under the same tenant.

# Administrator Role

# Deploying Nodes

Follow these steps:

Enter the [Machine Management] page, click the "+" button next to the machine group, add a machine group, then click the [Add] button to add the target server information to the console.
Enter the [Installation Package Management] page, click the [Upload] button to upload the installation package to the console.
Enter the [License] page, click the [Upload] button to upload the License file to the console.
Enter the [Tenant List] page, select the tenant that needs caching service deployment, click [Tenant Details] to enter the service list page, click the [Automatic Deployment] button to jump to the automatic deployment interface, fill in the relevant form, and click [Execute Task].
Enter the [Deployment Task] page to view the deployment stages of the service. When it reaches the "Completed" stage, you can view the service on the corresponding tenant's [Tenant Details] page.

# Importing Nodes

Follow these steps:

Enter the [Tenant Details] page, click the "+" in the list, fill in the node information (Note: must include the master node, can exclude the slave node and sentinel node).
After completion, you can view the imported caching service on the current page.

# Tenant Account Role

# Managing Nodes

Follow these steps:

Enter the [Service List] page, view the service list, click [Settings], enter the node list of the caching service to manage the service, including node startup/shutdown, data backup and restoration, dynamic/static configuration, and command-line functions.

# Node Monitoring

Follow these steps:

Enter the [Service List] page, view the service list, click [Monitoring] to view the monitoring information of the caching service.

# Node Monitoring Alerts

Follow these steps:

Enter the [Alert Channel] page, add recipient information.
Enter the [Alert Rules] page, add alert rules.
If global rules, they apply to all services under the tenant; otherwise, enter the [Service List] page, click the [Alert] button of the caching service that needs alerts, enter the [Alert] page.
Select the [Alert Rules] tab, click [Add] to add configured alert rules to the current service; click [Alert Channel] to add configured alert channels to the current service.
When the caching service triggers conditions, it will display in the [Alert Records] tab of the service's [Alert] page, and receive alert information via the configured alert channel (e.g., email).

For more information, visit theApusic Official Website (opens new window).