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