Skip to content

Commit 060e699

Browse files
authored
Update index.md
Initial version
1 parent 68f7918 commit 060e699

File tree

1 file changed

+47
-96
lines changed

1 file changed

+47
-96
lines changed

docs/index.md

Lines changed: 47 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -1,131 +1,82 @@
1-
# Demo服务实例部署文档
1+
# SubQuery Network Node Operators Deployment Guide
22

3-
## 概述
3+
This tutorial provides a step-by-step guide to deploy SubQuery Network Node Operators using Alibaba Cloud Compute Nest and ECS.
44

5-
`(服务概述内容)`
5+
## Introduction
66

7-
```
8-
eg:
9-
10-
Demo服务是计算巢提供的示例。
11-
本文向您介绍如何开通计算巢上的`Demo`服务,以及部署流程和使用说明。
12-
```
13-
14-
## 计费说明
15-
16-
`(计费说明内容)`
17-
18-
```
19-
eg:
20-
21-
Demo在计算巢上的费用主要涉及:
7+
## Prerequisites
8+
Before starting, ensure you have:
229

23-
- 所选vCPU与内存规格
24-
- 系统盘类型及容量
25-
- 公网带宽
10+
An active Alibaba Cloud account.
11+
Familiarity with cloud services.
2612

27-
计费方式包括:
13+
## Step 1: Alibaba Cloud Account Setup
14+
If you haven't already, sign up for an Alibaba Cloud account: Sign up (https://www.alibabacloud.com).
2815

29-
- 按量付费(小时)
30-
- 包年包月
16+
## Step 2: Access Compute Nest
17+
Navigate to Compute Nest and locate the service for SubQuery Network Node Operators
3118

32-
目前提供如下实例:
19+
## Step 3: Set Up an Instance and Its Parameters
20+
Configure the necessary parameters for the instance
3321

34-
| 规格族 | vCPU与内存 | 系统盘 | 公网带宽 |
35-
| --- | --- | --- | --- |
36-
| ecs.r6.xlarge | 内存型r6,4vCPU 32GiB | ESSD云盘 200GiB PL0 | 固定带宽1Mbps |
22+
Service Instance Name: Provide a meaningful name for the instance.
23+
Instance Password: Create a secure password for the instance.
3724

38-
预估费用在创建实例时可实时看到。
39-
如需更多规格、其他服务(如集群高可用性要求、企业级支持服务等),请联系我们 [mailto:[email protected]](mailto:[email protected])。
40-
41-
```
42-
43-
## 部署架构
44-
45-
`(部署概述内容)`
46-
47-
## RAM账号所需权限
48-
49-
`(权限策略内容)`
50-
51-
```
52-
eg:
25+
## Step 4: Deploy Your Service
26+
Review all configurations and accept the Terms of Service. Click Create Now to deploy your service.
5327

54-
Demo服务需要对ECS、VPC等资源进行访问和创建操作,若您使用RAM用户创建服务实例,需要在创建服务实例前,对使用的RAM用户的账号添加相应资源的权限。添加RAM权限的详细操作,请参见[为RAM用户授权](https://help.aliyun.com/document_detail/121945.html)。所需权限如下表所示。
28+
## Step 5: What to do after creating the ECS instance
5529

30+
### 1. Log in to the server
5631

57-
| 权限策略名称 | 备注 |
58-
| --- | --- |
59-
| AliyunECSFullAccess | 管理云服务器服务(ECS)的权限 |
32+
The node operator services are already configured to start automatically along with the server. You can log in to the server with the following command:
6033

34+
```shell
35+
ssh username@ip_address -L 8000:localhost:8000
6136
```
6237

63-
## 部署流程
38+
And then you can access the subquery node operator coordinator by opening a browser and going to `http://localhost:8000`.
6439

65-
### 部署步骤
40+
### 2. Register new node operator
6641

67-
`(部署步骤内容)`
42+
On the coordinator page, you can register as a new node operator by following the instructions and start to behave as a node operator.
6843

69-
```
70-
eg:
71-
72-
1. 单击部署链接,进入服务实例部署界面,根据界面提示,填写参数完成部署。
73-
2. 补充示意图。
74-
```
75-
### 部署参数说明
76-
77-
`(部署参数说明内容)`
44+
> Refer to the [Register in the Node Operator Admin App](https://academy.subquery.network/subquery_network/node_operators/setup/becoming-a-node-operator.html#_3-register-in-the-node-operator-admin-app) and the steps after that for more information.
7845
79-
```
80-
eg:
46+
## What to consider in docker-compose.yml [v2]
8147

82-
您在创建服务实例的过程中,需要配置服务实例信息。下文介绍云XR实时渲染平台服务实例输入参数的详细信息。
48+
The `/home/subquery-indexer/docker-compose.yml` file is pre-configured for immediate use. However, you may need to adjust some settings like secret key, network endpoint, and other configurations.
8349

84-
| 参数组 | 参数项 | 示例 | 说明 |
85-
| --- | --- | --- | --- |
86-
| 服务实例名称 | | test | 实例的名称 |
87-
| 地域 | | 华北2(北京) | 选中服务实例的地域,建议就近选中,以获取更好的网络延时。 |
88-
```
50+
> Refer to the [Port configurations](https://academy.subquery.network/subquery_network/node_operators/setup/becoming-a-node-operator.html#port-configurations) and [Running Node Operator Services](https://academy.subquery.network/subquery_network/node_operators/setup/becoming-a-node-operator.html#running-node-operator-services) for more information.
8951
90-
### 验证结果
52+
## What to consider in docker-compose.yml [v1]
9153

92-
`(验证结果内容)`
54+
The `/home/subquery-indexer/docker-compose.yml` file is pre-configured for immediate use. However, you may need to adjust the following settings:
9355

94-
```
95-
eg:
56+
**Coordinator and Proxy Services:**
9657

97-
1. 查看服务实例。服务实例创建成功后,部署时间大约需要2分钟。部署完成后,页面上可以看到对应的服务实例。
98-
2. 通过服务实例访问TuGraph。进入到对应的服务实例后,可以在页面上获取到web、rpc、ssh共3种使用方式。
99-
```
58+
- `--secret-key`: Replace with a secure secret key. Ensure it is the same for both the coordinator and proxy services.
59+
- `--network-endpoint`: Update to a higher rate-limited endpoint if necessary.
10060

101-
### 使用Demo
61+
**Coordinator Service:**
10262

103-
`(服务使用说明内容)`
63+
- `ports:` Ensure the coordinator service is not exposed to the public network. This can be managed through Docker Compose configuration or firewall settings.
10464

105-
```
106-
eg:
65+
**Proxy Service:**
10766

108-
请访问Demo官网了解如何使用:[使用文档](https://www.aliyun.com)
109-
```
67+
- `ports:` Ensure the proxy service is exposed to the public network. This requires configuration in both Docker Compose and firewall settings.
68+
- SSL Support: Consider adding a reverse proxy service like Nginx to support SSL.
11069

111-
## 问题排查
70+
**Postgres Service:**
11271

113-
`(服务使用说明内容)`
72+
- `POSTGRES_PASSWORD`: Replace with a secure password. Ensure it matches the `--postgres-password` in the coordinator service.
11473

115-
```
116-
eg:
74+
Remember to restart the services after making any changes:
11775

118-
请访问[Demo的问题排查链接](https://www.aliyun.com)获取帮助。
76+
```shell
77+
cd /home/subquery-indexer
78+
docker compose up -d
11979
```
12080

121-
## 联系我们
122-
123-
欢迎访问Demo官网([https://www.aliyun.com](https://www.aliyun.com))了解更多信息。
124-
125-
联系邮箱:[https://www.aliyun.com](mailto:https://www.aliyun.com)
126-
127-
社区版开源地址:[https://github.com/](https://github.com/)
128-
129-
扫码关注微信公众号,技术博客、活动通知不容错过:
130-
131-
`(添加二维码图片)`
81+
## Conclusion
82+
This tutorial has guided you through the comprehensive process of building a SubQuery Network Node Operators service using Alibaba Cloud Compute Nest and ECS. Following these steps will help you to quickly deploy SubQuery Network Node Operators services on Alibaba Cloud.

0 commit comments

Comments
 (0)