Launcher Service Installation and Configuration¶
Product Introduction¶
Used to deploy and install the WEB application of Guance. Follow the guided steps of the Launcher service to complete the installation and upgrade of Guance.
Keywords¶
| Term | Description |
|---|---|
| Launcher | Used to deploy and install the WEB application of Guance. Follow the guided steps of the Launcher service to complete the installation and upgrade of Guance. |
| Operations Machine | A machine with kubectl installed, on the same network as the target Kubernetes cluster. |
| Installation Machine | The machine used to access the Launcher service via a browser to complete the guided installation of Guance. |
| Hosts File | The hosts file is a system file without an extension. Its main function is to store the mapping between domain names and IP addresses. |
Prerequisites¶
Infrastructure Deployment has been completed.
1. Launcher Installation¶
Note
To deploy Launcher, ensure your rbac permissions are cluster-admin, otherwise, deploying Launcher will result in an error.
If you are in an offline network environment, you can refer to Guance Offline Package Download and Import for deployment.
The GuanceDB engine now supports simultaneous writes to GuanceDB 2.0 or GuanceDB 3.0 and GuanceDB for Metrics.
- Installation
helm install launcher launcher --repo https://pubrepo.guance.com/chartrepo/launcher -n launcher \
--create-namespace \
--set ingress.hostName=<Hostname>,storageClassName=<Stroageclass>
Note
<Hostname> is the Launcher ingress domain name, <Stroageclass> is the storage class name, which can be obtained by executing kubectl get sc.
- Launcher Uninstallation
Note
Once Launcher is successfully installed, do not uninstall it unless under abnormal circumstances.
- YAML Installation
Download Launcher YAML: https://static.guance.com/launcher/launcher.yaml
Save the above YAML content as a launcher.yaml file and place it on the Operations Machine, then replace the variables in the document:
- {{ launcher_image }} Replace with the latest Launcher application image address, which can be obtained from the Deployment Image document.
- {{ domain }} Replace with the main domain name, such as dataflux.cn.
- {{ storageClassName }} Replace with the storage class name, such as alicloud-nas.
Resources with default storageclass configured will display as default. Refer to the image below:
Execute the following kubectl command on the Operations Machine to import the Launcher service:
- YAML Uninstallation
Note
Once Launcher is successfully installed, do not uninstall it unless under abnormal circumstances.
2. Resolve Launcher Domain to Launcher Service¶
Since the Launcher service is used for deploying and upgrading Guance, it does not need to be publicly accessible. Therefore, the domain name should not be resolved on the public internet. You can simulate domain resolution by binding the host on the Installation Machine. Add the domain binding for poc-launcher.dataflux.cn in /etc/hosts.
3. Application Installation Guided Steps¶
Access poc-launcher.dataflux.cn in the browser of the Installation Machine and follow the guided steps to complete the installation configuration.
3.1 Database Configuration¶
- The database connection address must use the internal network address.
- The account must use an administrator account, as this account is needed to initialize the databases and database access accounts for multiple sub-applications.
3.2 Cache Service Configuration¶
- You can choose not to enable it. If not enabled, the default cache service will be used.
- If enabled, fill in the Redis connection address. It supports single-node mode, proxy mode, and master-slave mode Redis cluster.
3.3 Time Series Engine Configuration¶
- Enter the insert and select for GuanceDB.
3.4 Log Engine Configuration¶
- Enter the insert and select for GuanceDB.
- Enter the insert and select for GuanceDB.
- The connection address must use the internal network address.
- The account must use an administrator account.
3.5 Other Settings¶
- The initial administrator account name and email for the Guance management backend.
- Internal IPs of the cluster nodes (automatically obtained, need to confirm if correct).
- Main domain and subdomain configurations for each sub-application. Default subdomains are as follows and can be modified as needed:
- dataflux 【User Frontend】
- df-api 【User Frontend API】
- df-management 【Management Backend】
- df-management-api 【Management Backend API】
- df-websocket 【Websocket Service】
- df-func 【Func Platform】
- df-openapi 【API Service】
- df-external-api Configuration API】
- df-urls Domain List Service】
- df-static-res 【Static Resource Site】
- df-kodo 【kodo】（Used for DataWay host deployment, do not resolve for container deployment of DataWay）
3.6 Installation Information¶
Summarizes the information filled in previously. If there are errors, you can go back to the previous steps to modify.
3.7 Application Configuration Files¶
The installation program will automatically initialize the application configuration templates based on the installation information provided in the previous steps. However, you still need to check each application template and modify personalized application configurations. Specific configuration instructions are provided in the installation interface.
After confirming everything is correct, submit to create the configuration files.
3.8 Application Images¶
- Select the correct Shared Storage, which is the storage class name you created in the previous steps.
- The application images will be automatically filled based on the Launcher version you selected and do not need to be modified. After confirming everything is correct, start Creating Applications.
3.9 Application Status¶
This section lists the startup status of all application services. This process involves downloading all images and may take a few minutes to over ten minutes. Once all services have successfully started, the installation is complete.
Note: During the service startup process, you must stay on this page and do not close it. Only when you see the "Version information written successfully" prompt and no error window pops up, does it indicate a successful installation!
3.10 Domain Resolution¶
Resolve all subdomains except df-kodo.dataflux.cn to the SLB public IP address or the edge node ingress address:
- dataflux.dataflux.cn
- df-api.dataflux.cn
- df-management.dataflux.cn
- df-management-api.dataflux.cn
- df-openapi.dataflux.cn
- df-func.dataflux.cn
- df-external-api.dataflux.cn
- df-static-res.dataflux.cn
4. Install DataWay (Optional)¶
You can install a DataWay after successful deployment. Click the settings icon in the upper right corner and select 【Install Data Gateway】.
Fill in the DataWay name and binding address, then click 【One-click Installation】. A prompt will appear upon successful installation.
You can also use other methods to Install DataWay.
5. After Installation¶
After successful deployment, activation is required. Refer to the manual How to Start
If issues occur during installation and a reinstallation is needed, refer to the manual Maintenance Manual
6. Very Important Step!!!¶
After the above steps, Guance is fully installed and can be verified. After verification, a very important step is to take the Launcher service offline to prevent accidental access that could disrupt the application configuration. Execute the following command on the Operations Machine to set the Launcher service pod replicas to 0: