Launcher Service Installation Configuration¶
Product Overview¶
Used for deploying the Guance WEB application, complete the installation and upgrade of Guance according to the guidance steps of the Launcher service.
Keywords¶
| Term | Description |
|---|---|
| Launcher | Used for deploying the Guance WEB application, complete the installation and upgrade of Guance according to the guidance steps of the Launcher service. |
| Operations Machine | A machine with kubectl installed, in the same network as the target Kubernetes cluster. |
| Installation Machine | The machine that accesses 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 has been completed.
1. Launcher Installation¶
Note
To deploy Launcher, ensure your rbac permission is cluster-admin, otherwise the deployment of Launcher will result in an error.
If it's an offline network environment, refer to Guance Offline Package Download, Import for deployment.
- 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.
- Uninstalling Launcher
Note
Do not uninstall Launcher unless under abnormal circumstances after successful installation.
- YAML Installation
Launcher YAML download: https://static.guance.com/launcher/launcher.yaml
Save the above YAML content as the launcher.yaml file, place it on the operations machine, then replace the variable parts within the document:
- {{ launcher_image }} should be replaced with the latest image address of the Launcher application, which can be found in the Deployment Image documentation.
- {{ domain }} should be replaced with the main domain, such as using dataflux.cn.
- {{ storageClassName }} should be replaced with the storage class name, such as alicloud-nas.
Resources configured with the default storage class will display defalut; see the reference diagram below:
Execute the following kubectl command on the operations machine to import the Launcher service:
- YAML Uninstallation
Note
Do not uninstall Launcher unless under abnormal circumstances after successful installation.
2. Resolve 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, the domain name should not be resolved on the public network. Instead, you can bind the host on the installation machine to simulate domain name resolution by adding launcher.dataflux.cn to the /etc/hosts file.
3. Application Installation Guidance Steps¶
Access launcher.dataflux.cn in the browser on the installation machine, and follow the guidance steps one by one 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 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, please fill in the Redis connection address, supporting single-instance mode, proxy mode, and master-slave mode of the Redis cluster version.
3.3 Time Series Engine Configuration¶
- Enter GuanceDB’s insert and select
- The InfluxDB link 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 link address must use an internal network address.
- The account must be an administrator account.
- The link 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 the cluster node (will be automatically acquired, needs confirmation if correct).
- Main domain 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 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 choose whether to use the internal SLB. If DataWay and kodo are in the same internal network, the installation can choose to use the internal network.
- Fill in TLS domain certificate.
3.6 Installation Information¶
Summarizes the information filled out earlier. If there are any errors, return to the previous step 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, but it is still necessary to check all application templates individually and modify personalized application configurations. For detailed configuration instructions, see the installation interface.
After confirming no issues, submit to create the configuration files.
3.8 Application Images¶
- Select the correct shared storage, i.e., the storage class name created in the previous steps.
- The application images will be automatically filled in based on the selected Launcher version, no modification is required. Confirm no issues and 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 over ten minutes. Once all services have successfully started, it indicates that the installation is successful.
Note: During the service startup process, you must remain on this page without closing it until you see the prompt “version information written successfully” and no error windows pop up, indicating the installation was successful!
3.10 Domain Resolution¶
Resolve all subdomains except df-kodo.dataflux.cn to the public SLB IP address or 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. Install DataWay (Optional)¶
You can install a DataWay after successful deployment. Click settings at the top right corner and select [Install Data Gateway].
Fill in the DataWay name and binding address, click [One-click Install], and a prompt will appear upon successful installation.
You can also use other methods to Install DataWay.
5. After Installation¶
After successful deployment, you can refer to the manual How to Start Using.
If problems occur during installation and reinstallation is needed, refer to the manual Maintenance Manual.
6. Very Important Step!!!¶
After completing 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. On the operations machine, execute the following command to set the pod replica count of the launcher service to 0: