Launcher Service Installation and Configuration¶
Product Introduction¶
Used to deploy the Guance WEB application. Follow the steps guided by the Launcher service to complete the installation and upgrade of Guance.
Keywords¶
| Term | Description |
|---|---|
| Launcher | Used to deploy the Guance WEB application. Follow the steps guided by the Launcher service to complete the installation and upgrade of Guance. |
| Operations Machine | A machine that has kubectl installed and is on the same network as the target Kubernetes cluster. |
| Installation Machine | A 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 save the mapping relationship between domain names and IPs. |
Prerequisites¶
Infrastructure Deployment must be completed.
1. Launcher Installation¶
Note
To deploy Launcher, ensure your rbac permission is cluster-admin, otherwise, deploying Launcher will result in errors.
If you are in an offline network environment, refer to Guance Offline Package Download and Import for deployment.
- Installation
helm install launcher launcher --repo https://pubrepo.guance.com/chartrepo/launcher -n launcher \
--create-namespace \
--set ingress.hostName=<Hostname>,storageClassName=<StorageClass>
Note
<Hostname> is the Launcher ingress domain name, <StorageClass> is the storage class name. You can get it by executing kubectl get sc.
- Uninstalling Launcher
Note
Do not uninstall Launcher unless there is an abnormal situation after successful installation.
- YAML Installation
Download Launcher YAML from: https://static.guance.com/launcher/launcher.yaml
Save the above YAML content as launcher.yaml and place it on the Operations Machine, then replace the variable parts within the document:
- Replace {{ launcher_image }} with the latest Launcher application image address, which can be obtained from the Deployment Image documentation.
- Replace {{ domain }} with the main domain, e.g., dataflux.cn.
- Replace {{ storageClassName }} with the storage class name, e.g., alicloud-nas.
Resources configured with a default storage class will display default. Refer to the following figure:
Execute the following kubectl command on the Operations Machine to import the Launcher service:
- YAML Uninstallation
Note
Do not uninstall Launcher unless there is an abnormal situation after successful installation.
2. Resolving Launcher Domain Name to Launcher Service¶
Since the Launcher service is used for deploying and upgrading Guance, it does not need to be publicly accessible. Therefore, do not resolve the domain name to the public network. Instead, simulate domain name resolution by binding hosts on the Installation Machine in /etc/hosts and add the domain name binding for launcher.dataflux.cn
3. Application Installation Guide¶
Access launcher.dataflux.cn in the browser on the Installation Machine and follow the guided steps to complete the installation configuration.
3.1 Database Configuration¶
- The database connection address must use an internal network address.
- The account must be an administrator account because it needs to initialize multiple sub-application databases and database access accounts.
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, supporting standalone mode, proxy mode, and master-slave mode of Redis clusters.
3.3 Time Series Engine Configuration¶
- Input GuanceDB's insert and select
- The InfluxDB connection address must use an internal network address.
- The account must be an administrator account because it needs to initialize DB and RP information.
- The account must be an administrator account because it needs to initialize DB and RP information.
3.4 Log Engine Configuration¶
- The connection address must use an internal network address.
- The account must be an administrator account.
- The connection address must use an internal network address.
- The account must be an administrator account.
3.5 Other Settings¶
- Initial admin account name and email for the Guance management backend (default password is admin, it is recommended to change the default password immediately after login).
- Internal network IP of cluster nodes (automatically retrieved, verify if correct).
- Main domain and subdomain configurations for each sub-application. Default subdomains are as follows, modify according to needs:
- 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 【OpenAPI】
- df-static-res 【Static Resource Site】
- df-kodo 【kodo】
Note
The df-kodo service can optionally use an internal SLB. If DataWay and kodo are on the same internal network, choose to use the internal network during installation.
- TLS domain certificate configuration
3.6 Installation Information¶
Summarize and display the information entered previously. If any information is incorrect, return to the previous step to make changes.
3.7 Application Configuration File¶
The installation program will automatically initialize the application configuration template based on the provided installation information. However, you still need to check all application templates individually and modify personalized application configurations. Specific configuration instructions can be found on the installation interface.
Confirm everything is correct, then submit to create the configuration file.
3.8 Application Image¶
- Select the correct shared storage, i.e., the storage class name created in the previous steps.
- The application image will be automatically filled based on the selected Launcher version, no modification is needed. Confirm everything is correct, then start creating the application.
3.9 Application Status¶
This section lists the startup status of all application services. This process requires downloading all images, which may take several minutes to tens of minutes. Once all services have successfully started, it indicates that the installation is complete.
Note: During the service startup process, you must stay on this page without closing it until you see the prompt "version information written successfully" and no error window pops up, indicating a successful installation!
3.10 Domain Resolution¶
Resolve all subdomains except df-kodo.dataflux.cn to the public IP address of the SLB 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-static-res.dataflux.cn
4. Installing DataWay (Optional)¶
After successful deployment, you can install a DataWay by clicking the settings icon in the top-right corner and selecting 【Install Data Gateway】.
Enter the DataWay name and binding address, click 【One-click Install】, and a success message will appear after installation.
You can also use other methods to install DataWay.
5. Post-Installation¶
After successful deployment, refer to the manual How to Start Using.
If issues occur during installation and you need to reinstall, refer to the manual Maintenance Manual.
6. Very Important Step!!!¶
After completing the above steps, Guance is fully installed. Verify everything is correct, and perform a very important step: take the Launcher service offline to prevent accidental access that could disrupt application configuration. On the Operations Machine, execute the following command to set the number of replicas for the Launcher service pod to 0: