Launcher Service Installation and Configuration¶

Product Overview¶

Used for deploying and installing the WEB application of Guance. Follow the guided steps of the Launcher service to complete the installation and upgrade of Guance.

Keywords¶

Prerequisites¶

Infrastructure deployment must be 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¶

Since the Launcher service is used for deploying and upgrading Guance and does not need to be publicly accessible, do not resolve the domain on the public network. On the Installation Machine, you can bind the host to simulate domain resolution. Add the domain binding 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. Application Installation Guided Steps¶

On the Installation Machine, access poc-launcher.dataflux.cn in a browser 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 be an administrator account, as this account is required 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, fill in the Redis connection address. Supports standalone mode, proxy mode, and master-slave mode Redis cluster versions.

3.3 Time Series Engine Configuration¶

• Enter the GuanceDB insert and select addresses.

3.4 Log Engine Configuration¶

3.5 Other Settings¶

• Guance Management Console administrator account initial username and email.
• Cluster node internal network IP (will be automatically obtained; confirm correctness).
• Primary domain name and subdomain configurations for each sub-application. Default subdomains are as follows, which 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 if DataWay is container-deployed)

3.6 Installation Information¶

Summarizes the information just filled in. If any information is incorrect, you can return to the previous step to modify it.

3.7 Application Configuration Files¶

The installer will automatically initialize the application configuration templates based on the installation information provided in the previous steps. However, 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 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 in based on the Launcher version you selected; no modification is needed. After confirming, click Create Application.

3.9 Application Status¶

This section lists the startup status of all application services. During this process, all images need to be downloaded, which may take several 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 not close it. Only when you see the "Version Information Written Successfully" prompt and no error window appears, is the installation successful!

3.10 Domain Name 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)¶

After successful deployment, you can install a DataWay. Click on the settings icon in the upper right corner and select Install Data Gateway. Enter the DataWay name and binding address, then click One-click Install. A prompt will appear upon successful installation. You can also use other methods to install DataWay.

5. After Installation¶

After successful deployment, you need to activate it. Refer to the guide How to Start Using.

If issues occur during installation and a reinstallation is needed, refer to the Maintenance Guide.

6. Very Important Step!!!¶

After completing the above steps, Guance is fully installed. You can proceed with verification. Once verified, a very important step is to take the Launcher service offline to prevent accidental access that could damage the application configuration. Execute the following command on the Operations Machine to set the Launcher service's pod replica count to 0:

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