Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update 5.0.introduce-solution.md #993

Merged
merged 14 commits into from
Dec 31, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions docs-2.0/nebula-cloud/5.solution/5.0.introduce-solution.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Solution

On the **Solution** page, the sidebars are different based on roles and privileges. For more information, see [Roles and privileges in Cloud](../4.user-role-description.md).

## Solution Info

On the homepage of Cloud, click on the Solution's name to enter the **Solution Info** page. The Solution Info page consists of the following parts: Basic Info, Instance Info, Price Info, Getting Started. You can view the information on this page in detail.

## Application

In the sidebar, click **Applications** to enter the page of ecosystem tools(Dashboard/Studio/Explorer). Different roles see different ecosystem tools. For more information, see [Accessory applications](../5.solution/5.1.supporting-application.md).

## Connectivity

In the sidebar, click **Connectivity** to enter Private Link page. On this page, you can create a Private Link endpoint that enables you to access Nebula Graph databases through a private IP address in a virtual network. For more information, see [Private Link](../5.solution/5.2.connection-configuration-and-use.md).

## Root Management

In the sidebar, click **Root Management** to enter the root account management page. For more information, see [Role and User Management](../5.solution/5.3.role-and-authority-management.md).

## User Mangement
foesa-yang marked this conversation as resolved.
Show resolved Hide resolved

In the sidebar, click **User Management** to enter the user account management page. For more information, see [Role and User Management](../5.solution/5.3.role-and-authority-management.md).

## Audit Log

In the sidebar, click **Audit Log** to enter the operation history page. You can select the time period according to the operation information such as `Create Solution`, `Start Solution`, `Stop Solution`, and filter results by operator and operation record.

## Settings

In the sidebar, click **Settings** to enter the settings page, and you can `Stop Solution` or `Transfer Solution` in this page.
23 changes: 23 additions & 0 deletions docs-2.0/nebula-cloud/5.solution/5.1.supporting-application.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Accessory applications(Dashboard/Studio/Explorer)

Nebula Graph Cloud integrates with Nebula Graph Studio, Nebula Dashboard, and Nebula Explorer.

On the **Applications** page, ecosystem tools are different based on roles and privileges. The correspondence between different roles and privileges is as follows. The first column means the tools that the role can use, **Y** means the role has the corresponding privileges, and **N** means the role has no privileges.

|Tools|OWNER|ROOT|USER|
|:---|:---|:---|:---|
|Dashboard|Y|Y|N|
|Studio|N|Y|Y|
|Explorer|N|Y|Y|

## Dashboard

Nebula Dashboard (Dashboard for short) is a visualization tool that monitors and manages the status of machines and services in Nebula Graph clusters. Currently Dashboard in Cloud only supports [Cluster monitoring](../../nebula-dashboard-ent/4.cluster-operator/2.monitor.md) page.

## Studio
foesa-yang marked this conversation as resolved.
Show resolved Hide resolved

Nebula Graph Studio (Studio in short) is a browser-based visualization tool to manage Nebula Graph. It provides you with a graphical user interface to manipulate graph schemas, import data, explore graph data, and run nGQL statements to retrieve data. With Studio, you can quickly become a graph exploration expert from scratch. For more information, see [What is Nebula Graph Studio](../../nebula-studio/about-studio/st-ug-what-is-graph-studio.md).

## Explorer

Nebula Explorer (Explorer in short) is a browser-based visualization tool. It is used with the Nebula Graph core to visualize interaction with graph data. Even without any experience in a graph database, you can quickly become a graph exploration expert. For more information, see [What is Nebula Explorer](../../nebula-explorer/about-explorer/ex-ug-what-is-explorer.md).
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
# Private Link

You can create a Private Link endpoint in **Connectivity** to allow users to access Nebula Graph databases through a private IP in a virtual network, without exposing your traffic to the public internet. For more information about Private Link, see [What is Azure Private Link?](https://docs.microsoft.com/en-us/azure/private-link/private-link-overview).

## Configure Private Link

1. Enter your subscription ID, click **Create**. The creation time takes about 2 minutes.

!!! note

The subscription ID on the **Subscription** page of Azure Portal. You can click on the [Subscriptions] (https://portal.azure.com/?l=en.en-us#blade/Microsoft_Azure_Billing/SubscriptionsBlade) page for quick access.

2. After the creation, you can use **Alias** to connect to Azure resources and create a private endpoint in Azure.

1. Navigate to the Azure portal. Search for Private Link and click **Private endpoint**.
2. Click **+ add**.
3. In the **Basics** section, fill in the following plan details:

- Project details

|Field|Description|
|:---|:---|
|Subscription|Select the subscription.|
|Resource group|Select an existing resource group or create a new resource group.|

- Instance details

|Field|Description|
|:---|:---|
|Name| Set the name of the private endpoint.|
|Region| Select the region. |

!!! caution

The region of the database you select should be in the same area as that of your business to avoid performance and speed problems.

4. At the bottom of the **Basics** page, click **Next: Resource**.
5. In the **Resource** section, fill in the following plan details:

|Field|Description|
|:----|:---|
|Connection method|Click **Connect to an Azure resource by resource ID or alias.**|
|Resource ID or alias|Set the alias.|
|Request message|Set the message, this message will be sent to the resource owner.|

!!! note

The alias is on the **Connectivity** page of Nebula Graph Cloud, click ![copy](../figs/copy.png) to copy it.

6. At the bottom of the **Resource** page, click **Next: Configuration**.
7. In the **Configuration** section, select the following plan details:

- Networking

|Field|Description|
|:---|:---|
|Virtual network|Set virtual networks.|
|Subnet|Set the subnet in the selected virtual network.|

!!! note

Private DNS integration is currently not supported.

8. At the bottom of the **Configuration** page, click **Next: Tags**.
9. (optional)In the **Tags** section, enter **Name:Values**.
10. At the bottom of the **Tags** page, click **Next: Review + create**.
11. At the bottom of the **Review + create** page, click **Create**.

3. After creating the **private endpoint**, copy the **Private IP address** in **Network interface** to the **Connectivity** page in Cloud. Click the **Create**.

!!! note

Private Link Endpoint IP information is stored in the Cloud, and you can click ![edit](../figs/edit.png) to modify.

## Connect to Nebula Graph with Private Link

You can use Private link endpoint IP to connect to Nebula Graph. For more information, see [Connect to Nebula Graph](../../reuse/source_connect-to-nebula-graph.md).
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Roles and authority management

Nebula Graph Cloud roles are different from roles in Nebula Graph. For more information, see [Roles in Cloud Solution](../4.user-role-description.md).

|Roles in Cloud|Roles in Nebula Graph|
|:---|:---|
|OWNER|-|
|ROOT|ROOT|
|USER|ADMIN/DBA/GUEST/USER|

## Root Management

Only users with **OWNER** authority can manage **ROOT** users.
foesa-yang marked this conversation as resolved.
Show resolved Hide resolved

On the **Root Management** page, **OWNER** can reset **ROOT** users.

1. Click **Reset**, enter the email address of the ROOT user to be updated, and click **Send Email** to send the email.
2. After the **ROOT** user receives the confirmation email, click **Confirm**.

## User Management

Only users with **ROOT** authority can manage **USER** users.
foesa-yang marked this conversation as resolved.
Show resolved Hide resolved

On the **User Management** page, the **ROOT** user can grant roles in graph spaces to other users. Available roles are `ADMIN`, `DBA`, `GUEST`, and `USER`.

1. Select the graph space, click **Add User**, enter the specified user email and select the management authority of the user.
2. Click **Send Email** to send the email.
3. After the **USER** user receives the confirmation email, click **Confirm**.