Launcher Service Installation and Configuration¶

Product Introduction¶

A web application used for deploying and installing Guance. Follow the guided steps in the Launcher service to complete the installation and upgrade of Guance.

Keywords¶

Prerequisites¶

Infrastructure Deployment has been completed.

1. Launcher Installation¶

helm install launcher launcher  --repo https://pubrepo.guance.com/chartrepo/launcher -n launcher \
  --create-namespace  \
  --set ingress.hostName=<Hostname>,storageClassName=<Stroageclass>

helm install launcher launcher  --repo https://pubrepo.guance.com/chartrepo/launcher -n launcher \
   --create-namespace  \
   --set ingress.hostName="poc-launcher.dataflux.cn",storageClassName=df-nfs-storage        

helm uninstall launcher -n launcher

kubectl apply -f ./launcher.yaml

kubectl delete -f ./launcher.yaml

2. Resolve the launcher Domain to the launcher Service¶

Because the launcher service is used for deploying and upgrading Guance and does not need to be openly accessible to users, do not resolve the domain on the public network. On the Installation Machine, you can bind the host to simulate domain resolution by adding the domain mapping for poc-launcher.dataflux.cn in /etc/hosts.

8.XX.176.XX  poc-launcher.dataflux.cn

192.168.100.104   poc-launcher.dataflux.cn

3. Guided Application Installation Steps¶

Access poc-launcher.dataflux.cn in a browser on the Installation Machine and complete the installation configuration step by step following the guided steps.

3.1 Database Configuration¶

• The database connection address must use an internal network address.
• The account must be an administrator account, because this account is needed to initialize the databases and database access accounts of 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, enter the Redis connection address. Redis cluster versions in standalone mode, proxy mode, and master-slave mode are supported.

3.3 Time-Series Engine Configuration¶

• Enter the GuanceDB insert and select addresses.

3.4 Log Engine Configuration¶

3.5 Other Settings¶

• The initial administrator account name and email for the Guance management console
• Internal IP addresses of cluster nodes (obtained automatically; confirm that they are correct)
• Configuration of the primary domain and the subdomains of each sub-application. The default subdomains are as follows and can be modified as needed:
• dataflux [User Frontend]
• df-api [User Frontend API]
• df-management [Management Console]
• df-management-api [Management Console 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 it when DataWay is deployed in containers)

3.6 Installation Information¶

Displays a summary of the information you filled in. If any information is incorrect, you can return to the previous step to modify it.

3.7 Application Configuration Files¶

The installation program automatically initializes the application configuration templates based on the installation information provided in the previous steps, but you still need to check all application templates one by one and modify personalized application configurations. For specific configuration instructions, see the installation interface.

After confirming that everything is correct, submit to create the configuration files.

3.8 Application Images¶

• Select the correct shared storage, that is, the storage class name you created in the previous steps.
• The application images are automatically filled in based on the Launcher version you selected and do not need to be modified. After confirming that everything is correct, click Create Application.

3.9 Application Status¶

All application services and their startup status are listed here. This process requires downloading all images and may take from a few minutes to more than ten minutes. When all services have started successfully, the installation is complete.

Note: During service startup, you must stay on this page and do not close it. The installation is successful only when you see the "Version information written successfully" message and no error window pops up!

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 a successful deployment. Click Settings in the upper-right corner and select Install DataWay. Enter the DataWay name and binding address, then click One-Click Install. A prompt will appear when the installation succeeds. You can also install DataWay in other ways.

5. After Installation¶

After a successful deployment, you need to activate the product. Refer to the manual How to Get Started.

If a problem occurs during installation and you need to reinstall, refer to the Maintenance Manual.

6. Very Important Step!!!¶

After completing the steps above, Guance is fully installed and can be verified. Once verification passes, there is a very important step: take the launcher service offline to prevent it from being accidentally accessed and corrupting the application configuration. On the Operations Machine, run the following command to set the pod replica count of the launcher service to 0:

kubectl patch deployment launcher \
-p '{"spec": {"replicas": 0}}' \
-n launcher