On-Premises Deployment Guide¶
1 Introduction¶
1.1 About This Document¶
This document provides a comprehensive guide for deploying Guance in an on-premises environment (including but not limited to physical servers and IDC data centers), covering resource planning, configuration, deployment, and operation.
Note:
- This document uses dataflux.cn as the primary domain example. In actual deployment, replace it with your own domain.
1.2 Keywords¶
| Term | Description |
|---|---|
| Launcher | A web application used to deploy and install Guance. Follow the guided steps in the Launcher service to complete the installation and upgrade of Guance. |
| Operation Machine | A machine with kubectl installed, connected to the same network as the target Kubernetes cluster. |
| Deployment Machine | A machine that accesses the Launcher service via a browser to guide, install, and debug Guance. |
| kubectl | The command-line client tool for Kubernetes, installed on the Operation Machine. |
1.3 Deployment Step Architecture¶
2 Resource Preparation¶
On-Premises Resource Checklist
3 Infrastructure Deployment¶
3.1 Step 1: Create a Kubernetes Cluster¶
3.2 Step 2: Kubernetes Ingress Component¶
Kubernetes Ingress Component Deployment
3.3 Step 3: Proxy Deployment¶
3.4 Step 4: NFS Deployment¶
3.5 Step 5: Kubernetes Storage Component¶
Kubernetes Storage Component Deployment
3.6 Step 6: Redis Deployment¶
3.7 Step 7: GuanceDB for Metrics Deployment¶
3.8 Step 8: Log Engine Deployment¶
3.9 Step 9: MySQL Deployment¶
4 Installing and Configuring kubectl¶
4.1 Install kubectl¶
kubectl is a command-line client tool for Kubernetes, used to deploy applications, inspect and manage cluster resources, and more. Our Launcher uses this tool to deploy applications. For detailed installation instructions, refer to the official documentation:
https://kubernetes.io/docs/tasks/tools/install-kubectl/
4.2 Configure kubeconfig¶
To enable kubectl to manage the cluster, you need to configure the kubeconfig. After deploying the cluster using kubeadm, the default kubeconfig file is /etc/kubernetes/admin.conf. Copy its contents to the client user's **$HOME/.kube/config** file.
5 Installing Guance¶
After the operations above, refer to the guide Getting Started with Installation.