Prerequisites for Deployment¶
Deployment Steps¶
You can start installing Guance by following the steps below:
1. Resource Planning and Preparation¶
2. Deploy Infrastructure¶
3. Deploy Guance¶
4. Start Using the Features¶
- 4.1 Get Started
Important Notes¶
About the Domain¶
Deployment requires a domain name. If you have a real domain, it needs DNS resolution, or you can use local hosts binding.
Using dataflux.cn as an example, the following table describes the function of each subdomain:
| Domain Prefix | Example Domain | Points to | Function | Required |
|---|---|---|---|---|
| dataflux | dataflux.dataflux.cn | Ingress-Nginx | Guance Console Frontend | Yes |
| df-api | df-api.dataflux.cn | Ingress-Nginx | Guance Console API | Yes |
| df-docs | df-docs.dataflux.cn | Ingress-Nginx | Help Documentation | No |
| df-func | df-func.dataflux.cn | Ingress-Nginx | Guance Compute Service | No |
| df-kodo | df-kodo.dataflux.cn | kodo-nginx | Metric Data Entry Service | Yes |
| df-management | df-management.dataflux.cn | Ingress-Nginx | Guance Management Backend Frontend | Yes |
| df-management-api | df-management-api.dataflux.cn | Ingress-Nginx | Guance Management Backend API | Yes |
| df-openapi | df-openapi.dataflux.cn | Ingress-Nginx | Guance Data API | No |
| df-static-res | df-static-res.dataflux.cn | Ingress-Nginx | Guance Template Resource Service | Yes |
For more information about Guance components, see Component Description.
About Cluster Storage Classes¶
Note
Guance software deployment must use nfs-subdir-external-provisioner.
The deployment of Guance involves two parts: the deployment of foundational components and the deployment of Guance software. The storage classes used for these two deployments differ, as shown in the comparison below:
| Name | nfs-subdir-external-provisioner | OpenEBS |
|---|---|---|
| Requires Third-Party | Needs NFS | No, local disks are sufficient |
| Performance | Network storage, poor IO performance | Local storage, high IO performance |
| Access Modes | ReadWriteMany, ReadOnlyMany, ReadWriteOnce | ReadWriteOnce |
| Pros & Cons | Pros: Data sharing, multi-node mounting. Cons: Poor IO. | Pros: High IO. Cons: Cannot be shared across pods on different nodes, does not support dynamic scheduling. |
| Supported Environments | Foundational component deployment, Guance software deployment | Foundational component deployment |
| Remarks | If the customer environment is a POC environment, you can use this storage class to deploy foundational components and Guance software. For production environments, it is not recommended to use this storage class for foundational component deployment. | This storage class is not suitable for deploying Guance software. |