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 console to 3.8 #2570

Merged
merged 1 commit into from
May 23, 2024
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
18 changes: 12 additions & 6 deletions docs-2.0-en/nebula-console.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,18 +31,24 @@ To connect to NebulaGraph with the `nebula-console` file, use the following synt

For example:

- Direct link to NebulaGraph
- Connect to NebulaGraph over HTTP/1.1

```bash
./nebula-console -addr 192.168.8.100 -port 9669 -u root -p nebula
```

- Enable SSL encryption and require two-way authentication
- Enable SSL encryption with a private CA certificate

```bash
./nebula-console -addr 192.168.8.100 -port 9669 -u root -p nebula -enable_ssl -ssl_root_ca_path /home/xxx/cert/root.crt -ssl_cert_path /home/xxx/cert/client.crt -ssl_private_key_path /home/xxx/cert/client.key
```

- Enable SSL encryption with a trusted CA certificate

```bash
./nebula-console -addr nebula-graph-ncnj7ss1ssfnnb4eqq88g.aws.dev.cloud.nebula-graph.io -port 9669 -u root -p nebula -enable_ssl
```

Parameter descriptions are as follows:

| Parameter | Description |
Expand All @@ -51,14 +57,14 @@ Parameter descriptions are as follows:
| `-addr/-address` | Sets the IP or hostname of the Graph service. The default address is 127.0.0.1. <!--If NebulaGraph is deployed on [NebulaGraph Cloud](https://docs.nebula-graph.io/3.1.0/nebula-cloud/1.what-is-cloud/), you need to create a Private Link and set the IP or hostname of the Private Endpoint as the parameter value.--> |
| `-P/-port` | Sets the port number of the graphd service. The default port number is 9669. |
| `-u/-user` | Sets the username of your NebulaGraph account. Before enabling authentication, you can use any existing username. The default username is `root`. |
| `-p/-password` | Sets the password of your NebulaGraph account. Before enabling authentication, you can use any characters as the password. |
| `-p/-password` | Sets the password of your NebulaGraph account. Before enabling authentication, you can use any characters as the password. If not specified, a prompt appears requesting the password.|
| `-t/-timeout` | Sets an integer-type timeout threshold of the connection. The unit is millisecond. The default value is 120. |
| `-e/-eval` | Sets a string-type nGQL statement. The nGQL statement is executed once the connection succeeds. The connection stops after the result is returned. |
| `-f/-file` | Sets the path of an nGQL file. The nGQL statements in the file are executed once the connection succeeds. The result will be returned and the connection stops then. |
| `-enable_ssl` | Enables SSL encryption when connecting to NebulaGraph. |
| `-ssl_root_ca_path` | Sets the storage path of the certification authority file. |
| `-ssl_cert_path` | Sets the storage path of the certificate file. |
| `-ssl_private_key_path` | Sets the storage path of the private key file. |
| `-ssl_root_ca_path` | Sets the path to the root cerificate signed by a private Certifcate Authority (CA). |
| `-ssl_cert_path` | Sets the path to the certificate of the client. |
| `-ssl_private_key_path` | Sets the path to the private key of the client. |
|`-ssl_insecure_skip_verify`| Specifies whether the client skips verifying the server's certificate chain and hostname. The default is `false`. If set to `true`, any certificate chain and hostname provided by the server is accepted.|

For information on more parameters, see the [project repository](https://github.com/vesoft-inc/nebula-console/tree/{{console.branch}}).
Expand Down
17 changes: 11 additions & 6 deletions docs-2.0-zh/nebula-console.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,17 +31,22 @@ NebulaGraph Console 的获取方式如下:

示例如下:

- 直接连接 {{nebula.name}}
- 通过 HTTP/1.1 连接 {{nebula.name}}

```bash
./nebula-console -addr 192.168.8.100 -port 9669 -u root -p nebula
```

- 开启 SSL 加密且需要双向认证
- 开启 SSL 加密且使用私有 CA 证书连接

```bash
./nebula-console -addr 192.168.8.100 -port 9669 -u root -p nebula -enable_ssl -ssl_root_ca_path /home/xxx/cert/root.crt -ssl_cert_path /home/xxx/cert/client.crt -ssl_private_key_path /home/xxx/cert/client.key
```
- 开启 SSL 加密且使用受信任的 CA 证书连接

```bash
./nebula-console -addr nebula-graph-ncnj7ss1ssfnnb4eqq88g.aws.dev.cloud.nebula-graph.io -port 9669 -u root -p nebula -enable_ssl
```

常用参数的说明如下。

Expand All @@ -51,14 +56,14 @@ NebulaGraph Console 的获取方式如下:
| `-addr/-address` | 设置要连接的 Graph 服务的 IP 或主机名。默认地址为 127.0.0.1。<!--如果 {{nebula.name}} 部署在 [Nebula Cloud](https://docs.nebula-graph.com.cn/{{cloud.azureLatestRelease}}/nebula-cloud/1.what-is-cloud/) 上,需要创建 [Private Link](https://docs.nebula-graph.com.cn/{{cloud.azureLatestRelease}}/nebula-cloud/nebula-cloud-on-azure/5.solution/5.2.connection-configuration-and-use),并设置该参数的值为专用终结点的 IP 地址。--> |
| `-P/-port` | 设置要连接的 Graph 服务的端口。默认端口为 9669。|
| `-u/-user` | 设置 {{nebula.name}} 账号的用户名。未启用身份认证时,可以使用任意已存在的用户名(默认为`root`)。 |
| `-p/-password` | 设置用户名对应的密码。未启用身份认证时,密码可以填写任意字符。 |
| `-p/-password` | 设置用户名对应的密码。未启用身份认证时,密码可以填写任意字符。若不指定,会弹出密码输入提醒。|
| `-t/-timeout` | 设置整数类型的连接超时时间。单位为毫秒,默认值为 120。 |
| `-e/-eval` | 设置字符串类型的 nGQL 语句。连接成功后会执行一次该语句并返回结果,然后自动断开连接。 |
| `-f/-file` | 设置存储 nGQL 语句的文件的路径。连接成功后会执行该文件内的 nGQL 语句并返回结果,执行完毕后自动断开连接。 |
| `-enable_ssl` | 连接 {{nebula.name}} 时使用 SSL 加密双向认证。 |
| `-ssl_root_ca_path` | 指定 CA 根证书的存储路径。 |
| `-ssl_cert_path` | 指定 SSL 公钥证书的存储路径。 |
| `-ssl_private_key_path` | 指定 SSL 密钥的存储路径。 |
| `-ssl_root_ca_path` | 指定私有 CA 颁布的根证书的存储路径。 |
| `-ssl_cert_path` | 指定 SSL 客户端证书存储路径。 |
| `-ssl_private_key_path` | 指定 SSL 客户端密钥的存储路径。 |
|`-ssl_insecure_skip_verify`|指定客户端是否跳过验证服务端的证书链和主机名。默认为`false`。如果设置为`true`,则接受服务端提供的任何证书链和主机名。|

更多参数参见[项目仓库](https://github.com/vesoft-inc/nebula-console/tree/{{console.branch}})。
Expand Down
6 changes: 3 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -317,9 +317,9 @@ extra:
base100: 1.0.0
branch: release-3.4
console:
release: 3.6.0
branch: release-3.6
tag: v3.6.0
release: 3.8.0
branch: release-3.8
tag: v3.8.0
br:
release: 3.6.0
branch: release-3.6
Expand Down