Overview
Guance Cloud is a unified, real-time monitoring platform with observability capabilities. As the first SaaS-based observability product in China, it enables customers to quickly achieve system observability and provides end-to-end, data-driven assurance for uninterrupted business services. This topic describes how to deploy a Guance Cloud service instance.
Server resources
Before you deploy a service instance, prepare the server resources that are listed in the following table.
-
You must create these ECS instances after the main installation is complete to deploy DataWay.
-
The minimum configuration is only for Proof of Concept (POC) deployments and functional validation. Do not use it in a production environment.
-
The recommended configuration is suitable for scenarios with fewer than 150,000 time series in InfluxDB and fewer than 7 billion documents in Alibaba Cloud Elasticsearch (including logs, traces, user access monitoring, events, and other documents).
-
Higher data ingestion volumes require increased storage and higher specifications for InfluxDB and Alibaba Cloud Elasticsearch.
|
Resource |
Specifications (minimum) |
Specifications (recommended) |
Quantity |
Description |
|
ACK |
Standard managed cluster |
Standard managed cluster |
1 |
N/A |
|
NAS |
200 GB (Capacity) |
200 GB (Capacity) |
1 |
For ACK cluster data persistence |
|
NAT Gateway |
Small |
Small |
1 |
For outbound traffic from the ACK cluster |
|
SLB |
Performance-guaranteed |
Performance-guaranteed |
2 |
Acts as the frontend for Kubernetes Ingress |
|
ECS |
4 vCPU, 8 GB RAM (single 80 GB system disk) |
8 vCPU, 16 GB RAM (single 120 GB system disk) |
4 |
Hosts the worker nodes for the managed ACK cluster. |
|
ECS |
2 vCPU, 4 GB RAM (single 80 GB system disk) |
4 vCPU, 8 GB RAM (single 120 GB system disk) |
2 |
To deploy DataWay |
|
RDS |
1 vCPU, 2 GB RAM, 20 GB storage |
2 vCPU, 4 GB RAM, 50 GB storage (three-node Enterprise Edition) |
1 |
MySQL 5.7 |
|
ApsaraDB for Redis |
2 GB |
4 GB (Standard Master-Replica Edition, dual-replica) |
1 |
Version: 4.0 |
|
InfluxDB |
4 vCPU, 16 GB RAM, 200 GB storage |
8 vCPU, 32 GB RAM, 1 TB storage (Cluster Edition) |
1 |
Version: 1.7.x |
|
Alibaba Cloud Elasticsearch |
4 vCPU, 16 GB RAM, 500 GB storage (2 nodes) |
16 vCPU, 64 GB RAM, 2 TB storage (3 nodes) |
1 |
Version: 7.4+ (7.10 recommended) |
|
DirectMail |
N/A |
N/A |
1 |
For email services |
|
Domain name |
N/A |
N/A |
1 |
The primary domain name must have an ICP filing. The deployment requires eight subdomains under this primary domain. |
|
SSL certificate |
Wildcard domain certificate |
Wildcard domain certificate |
1 |
Optional |
Required RAM user permissions
The Guance Cloud service needs to access and create resources such as Elastic Compute Service (ECS), Container Service for Kubernetes (ACK), and Server Load Balancer (SLB). If you use a RAM user to create the service instance, you must grant the required permissions to that RAM user beforehand. For detailed instructions on how to grant permissions to a RAM user, see Grant permissions to a RAM user.
|
Policy name |
Description |
|
AliyunCSFullAccess |
Permissions to manage Container Service for Kubernetes (ACK) |
|
AliyunNATGatewayFullAccess |
Permissions to manage NAT Gateway |
|
AliyunNASFullAccess |
Permissions to manage Apsara File Storage NAS (NAS) |
|
AliyunSLBFullAccess |
Permissions to manage Server Load Balancer (SLB) |
|
AliyunECSFullAccess |
Permissions to manage Elastic Compute Service (ECS) |
|
AliyunVPCFullAccess |
Permissions to manage Virtual Private Cloud (VPC) |
|
AliyunRDSFullAccess |
Permissions to manage ApsaraDB for RDS |
|
AliyunKvstoreFullAccess |
Permissions to manage Tair |
|
AliyunHiTSDBFullAccess |
Permissions to manage Time Series Database (TSDB) |
|
AliyunElasticsearchFullAccess |
Permissions to manage Alibaba Cloud Elasticsearch |
Deployment procedure
Deployment steps
Click the deployment link to open the service instance deployment page and complete the deployment.
Deployment parameters
When you create a Guance Cloud service instance, you must configure several parameters. For detailed steps, see Create a private deployment service instance. This section describes these parameters and provides important notes.
The Guance Cloud Launcher installation requires the usernames and passwords for the hosts and middleware that you configured when creating the service instance. Be sure to record these credentials during the creation process.
-
Region and availability zone
Select the region where you want to deploy Guance Cloud based on your needs. For example, you can deploy it in the same region as your monitored applications to reduce cross-region network latency.
-
Guance Primary Domain Name
Configure the primary domain name used to access Guance Cloud after deployment. The deployment requires eight subdomains under this primary domain name. You will configure these specific subdomains later in the installation wizard.
NoteIn the following configurations, my-guance.com is used as the example primary domain name.
-
Kubernetes Cluster Configuration
A minimum of four Kubernetes worker nodes are required. For specific configuration details, see Server resources.
-
ECS Bastion Host Configuration
This is a pay-as-you-go bastion host used to run deployment commands. You can release it after the deployment is complete.
-
Database and Middleware Configurations
The Guance Cloud platform depends on the following database and middleware services. During the configuration, record the account and password for each database. You will need them for the subsequent installation wizard.
-
MySQL
Select an instance specification according to the resource list. You can typically use the default specification. For details about instance specifications, see Primary ApsaraDB RDS for MySQL instance types.
-
Redis
Select an instance specification according to the resource list. Do not select the Cluster Edition of ApsaraDB for Redis. For details about instance specifications, see Instance types and FAQ.
-
InfluxDB
Select an instance specification according to the resource list.
-
Elasticsearch
Select an instance specification according to the resource list. For details about instance specifications, see Alibaba Cloud Elasticsearch instance types.
-
Bind a domain for the Launcher wizard
-
On your local machine, add an entry to the hosts file to map the Launcher domain name to the public IP address of the Kubernetes Ingress SLB. To find this IP address, go to the SLB instance list page on the console. Locate the SLB instance with a name prefixed with
Kubernetes.do.not.deleteand obtain its public IP address.We recommend that you do not resolve the Launcher installation wizard's domain name over the public internet. Instead, bind it locally on your machine for access. The entry in the hosts file should be as follows:
<SLB_public_IP> launcher.my-guance.com -
Bind all other subsystem domain names
The other required default subdomains are listed below. You can modify the default domain names during installation.
-
dataflux.my-guance.com
-
df-api.my-guance.com
-
df-management.my-guance.com
-
df-management-api.my-guance.com
-
df-func.my-guance.com
-
df-openapi.my-guance.com
-
df-static-res.my-guance.com
-
df-kodo.my-guance.com (Do not resolve this domain name over the public internet.)
-
Install Guance Cloud
-
Installation wizard
Access http://launcher.my-guance.com to open the installation wizard and follow the guided steps to complete the installation. For details about the installation wizard steps, see Application Installation Wizard Steps.
On the Environment Check page, confirm that the Kubernetes cluster information (control plane, metrics-server, and KubeDNS) is running correctly. Review the diagnostic results for the shared storage and database configurations. After you confirm that everything is correct, click the New Installation button.
During the installation, on the Application Image page, select alicloud-nas for Shared Storage.
On this page, the default Image Registry Address is
pubrepo.jiagouyun.com, the Image Version Directory isdataflux/, the Image Pull Policy isIfNotPresent, and the default namespace isforethought-core. -
The installation is complete.
Next steps
After installing Guance Cloud, you must install a DataWay data gateway to allow DataKit to ingest data. For detailed instructions on how to install DataWay, see How to get started with Guance Cloud.
After the installation, you can access the following URLs:
-
User frontend: http://dataflux.my-guance.com
-
Management backend: http://df-management.my-guance.com
-
Func platform: http://df-func.my-guance.com