Skip to content

Commit

Permalink
Update AWS docs (#1796)
Browse files Browse the repository at this point in the history
* Update AWS docs

* Update AWS docs

* update architecture
  • Loading branch information
randomJoe211 authored Dec 14, 2022
1 parent f869ad0 commit 66444eb
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 14 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Creating a NebulaGraph service cluster using the CloudFormation template allows

A typical cluster architecture in a production environment is shown in the following figure.

![NebulaGraph on AWS deployment architecture](https://docs-cdn.nebula-graph.com.cn/figures/aws-architecture_2022.08.12.png)
![NebulaGraph on AWS deployment architecture](https://docs-cdn.nebula-graph.com.cn/figures/aws-architecture_2022.12.06.png)

The preceding architecture sets up the following:

Expand All @@ -20,9 +20,9 @@ In the public subnets:

In the private subnets:

- A Linux workbench host, where NebulaGraph ecosystem tools such as Explorer, Dashboard, Analytics, and Exchange are deployed together.
- NebulaGraph Graph Service supported by graphd processes. Each graphd process runs in one subnet.
- NebulaGraph Meta Service supported by metad processes. Each metad process runs in one subnet.
- NebulaGraph Storage Service supported by storaged processes. The storaged processes are distributed in different subnets automatically.
- NebulaGraph Storage Service supported by storaged processes. Each storaged process runs in one subnet.
- An Amazon Elastic Block Store (Amazon EBS) volume in each subnet.*

!!! note
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,16 @@ Before the deployment starts, check the resource quota in the [Service Quotas co
| Resource | This deployment uses |
| - | - |
| VPCs | 1 |
| Elastic IP addresses | 5 to 15 (Depending on the host number) |
| Elastic IP addresses | 1 (bastion) |
| Security groups | 2 |
| IAM roles | 2 |
| Network Load Balancers | 1 |
| EC2 instances (bastion host) | 1 |
| EC2 instances (Nebula Explorer hosts) | 1 |
| EC2 instances (graphd hosts) | 1 to 3 |
| EC2 instances (metad hosts) | 1 or 3 |
| EC2 instances (storaged hosts) | 1 or 3 or 5 or 7 |
| EC2 instances (workbench) | 1 |
| EC2 instances (graphd) | 1 to 3 |
| EC2 instances (storaged) | 1 or 3 or 5 or 7 |

The number of Elastic IP addresses and EC2 instances used depends on the actual deployment architecture.
The number of EC2 instances used depends on the actual deployment architecture.

If the required resource quota is insufficient, request service quota increases first.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,14 @@ After finishing the preparation, you can start the deployment. The deployment co

6. Review the parameters for the template. Provide values for the parameters that require input. For all other parameters, review the default settings and customize them as necessary. When you finish reviewing and customizing the parameters, choose **Next**.

!!! note

To connect to the NebulaGraph service cluster from the Internet, set the **Permitted IP range** to the public IP address of the client side. It is recommended to connect from the VPC to prevent network security issues.

7. On the **Configure stack options** page, you can specify tags (key-value pairs) for resources in your stack and set [advanced options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-console-add-tags.html). When you finish, choose **Next**.

8. On the **Review** page, review and confirm the template settings. Under **Capabilities**, select the two checkboxes to acknowledge that the template creates IAM resources and might require the ability to automatically expand macros.
8. On the **Review** page, review and confirm the template settings. Under **Capabilities**, select the two checkboxes to acknowledge that the template creates IAM resources and might require specific capabilities.

9. Click **Create stack** to deploy the stack.

10. In the **Events** tab, monitor the **Status** of the stack. When the status is **CREATE_COMPLETE**, the NebulaGraph deployment is ready.
10. In the **Events** tab, monitor the **Status** of the stack. When the status is **CREATE_COMPLETE**, the NebulaGraph deployment is ready.
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,12 @@ After deploying the NebulaGraph service cluster, you can view the connection inf

The connection information includes:

- BastionIP: The Elastic IP address of the Bastion host.
- ExplorerPortal: The connection address of the Nebula Explorer server.
- GraphPrivateIP: The private subnet IP address of the Graph service.
- The Elastic IP address of the Bastion host.
- The web portal link and default login information of the NebulaGraph Dashboard service.
- The web portal link of the NebulaGraph Explorer service.
- The private subnet IP address and the port number of the Graph service.

For how to connect to NebulaGraph with NebulaGraph Dashboard, see [Connect to Dashboard](../../../nebula-dashboard-ent/2.deploy-connect-dashboard-ent/#dashboard_2).

For how to connect to NebulaGraph with Nebula Explorer, see [Connect to the database](../../nebula-explorer/deploy-connect/ex-ug-connect.md).

Expand Down

0 comments on commit 66444eb

Please sign in to comment.