How to Get Started¶
After the Guance deployment is completed, it needs to be configured and activated before it can be used.
Prerequisites¶
You can refer to the documents Cloud Deployment or Offline Environment Deployment or Alibaba Cloud Computing Nest Deployment for online or offline deployment. After the deployment is completed, you will obtain login methods for the following Guance related platforms.
- dataflux 【User Frontend (Guance)】
- df-management 【Management Backend】
- df-openapi 【OpenAPI】
Methods and Steps¶
Step1: Deploy DataWay¶
After Guance deployment is completed, DataWay must be deployed first so that data can be reported to the Guance workspace via DataWay. During this time, we will have a DataWay data gateway address which is used to activate the Deployment Plan.
Create DataWay¶
Using an administrator account, go to the "Data Gateway" menu in the "Guance Management Backend" and click "Create DataWay" to add a data gateway DataWay.
- Name: You can use a custom name.
- Binding Address: The access address of DataWay, used for data integration in DataKit. You can use
http://ip+port.
Note: When configuring the binding address for DataWay, ensure that the DataKit host has connectivity with this DataWay address, and can report data through this DataWay address.
Install DataWay¶
After adding DataWay, you can obtain an installation script for DataWay, copy the installation script, and run it on the host where DataWay is deployed.
Note: Ensure that the host where DataWay is deployed can access the previously configured kodo address. It is recommended that DataWay connects to kodo via an internal network!
After the installation is complete, wait a moment and refresh the "Data Gateway" page. If you see a version number in the "Version Information" column of the newly added data gateway, it means that this DataWay has successfully connected with the Guance center, and frontend users can start integrating data through it.
Step2: Activate Deployment Plan¶
Register Deployment Plan Account¶
Open the registration URL for the Deployment Plan (https://boss.guance.com/index.html#/signup?type=private) and register a Deployment Plan account according to the prompts.
After registration is completed, enter the Guance Deployment Plan Billing Center.
Obtain AK/SK¶
In the "AK Management" section of the Guance Deployment Plan Billing Center, click "Create AK".
Obtain License¶
In the "License Management" section of the Guance Deployment Plan Billing Center, click "Create License".
Activate Deployment Plan¶
Open Guance Launcher, go to the settings in the upper-right corner, and click "License Activation and AK/SK Configuration".
In the "Guance Activation" dialog box of Guance Launcher, fill in the AK/SK, License, and Data Gateway address to complete the activation of the Deployment Plan. Note: You can scan the QR code to follow the Guance service account to get more official information about Guance.
Step3: Start Using Guance¶
Create Users¶
The Guance Deployment Plan does not provide user registration functionality. You need to log into the "Guance Management Backend" under the "Users" menu, and click "Add User" to add users.
Create Workspaces¶
After adding users, go to the "Workspace List" menu in the "Guance Management Backend", click "Create Workspace", and continue to create a workspace. Note: Do not use the default "System Workspace" for regular business monitoring!
Add Workspace Members¶
After creating the workspace, click "View Members", enter the corresponding workspace member page, and you can view basic information about all members within the space.
In the workspace member list, click "Add User" in the upper-right corner, select the newly added user and set their permissions, then click "Confirm" to add a new user to this space.
Log In to Guance¶
Open the Guance Deployment Plan access address, and you can log in with the users created above to start using all Guance features in the corresponding workspace. For detailed feature usage instructions, refer to the Guance Help Manual.
