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.

Sign up for GitHub

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 4.ssl.md #2260

Merged
merged 1 commit into from
Sep 20, 2023
Merged

Update 4.ssl.md #2260

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 16 additions & 6 deletions docs-2.0/7.data-security/4.ssl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,13 @@ To use SSL encryption, SSL certificates are required. NebulaGraph supports two c

- Policies for the NebulaGraph community edition.

|-| External device access to Graph | Graph access Meta/Storage |External device access to Graph</br>Graph access Meta/Storage|
|:---|:---|:---|:---|
|TLS| Modify the Graph configuration file to add the following parameters:</br>`--enable_graph_ssl = true`</br> `--ca_path=xxxxxx`</br>`--cert_path=xxxxxx`</br>`--key_path=xxxxxx`|In the Graph/Meta/Storage configuration file, add the following parameters:</br>`--enable_meta_ssl = true`</br>`--ca_path=xxxxxx`</br>`--cert_path=xxxxxx`</br>`--key_path=xxxxxx`|In the Graph/Meta/Storage configuration file, add the following parameters:</br>`--enable_ssl = true`</br>`--ca_path=xxxxxx`</br>`--cert_path=xxxxxx`</br>`--key_path=xxxxxx`|
|Scenes | TLS |
|:---|:---|
|External device access to Graph| Modify the Graph configuration file to add the following parameters:</br>`--enable_graph_ssl = true`</br> `--ca_path=xxxxxx`</br>`--cert_path=xxxxxx`</br>`--key_path=xxxxxx`|
|Graph access Meta |In the Graph/Meta configuration file, add the following parameters:</br>`--enable_meta_ssl = true`</br>`--ca_path=xxxxxx`</br>`--cert_path=xxxxxx`</br>`--key_path=xxxxxx` |
|Graph access Storage</br>Meta access Storage |In the Graph/Meta/Storage configuration file, add the following parameters:</br>`--enable_storage_ssl = true`</br>`--ca_path=xxxxxx`</br>`--cert_path=xxxxxx`</br>`--key_path=xxxxxx` |
|Graph access Meta/Storage</br>Meta access Storage |In the Graph/Meta/Storage configuration file, add the following parameters:</br>`--enable_meta_ssl = true`</br>`--enable_storage_ssl = true`</br>`--ca_path=xxxxxx`</br>`--cert_path=xxxxxx`</br>`--key_path=xxxxxx` |
|External device access to Graph</br>Graph access Meta/Storage</br>Meta access Storage |In the Graph/Meta/Storage configuration file, add the following parameters:</br>`--enable_ssl = true`</br>`--ca_path=xxxxxx`</br>`--cert_path=xxxxxx`</br>`--key_path=xxxxxx` |

The parameters are described below.

Expand All @@ -45,14 +49,19 @@ To use SSL encryption, SSL certificates are required. NebulaGraph supports two c
| `enable_ssl` | `false` | Whether to enable SSL encryption in all services. only. |
| `enable_graph_ssl` | `false` | Whether to enable SSL encryption in the Graph service only. |
| `enable_meta_ssl` | `false` | Whether to enable SSL encryption in the Meta service only. |
| `enable_storage_ssl` | `false` | Whether to enable SSL encryption in the Storage service only. |

{{ent.ent_begin}}

- Policies for the NebulaGraph enterprise edition.

|-| External device access to Graph | Graph access Meta/Storage |External device access to Graph</br>Graph access Meta/Storage|
|:---|:---|:---|:---|
|mTLS|Modify the Graph configuration file to add the following parameters:</br>`--enable_graph_ssl = true`</br> `--ca_path=xxxxxx`</br>`--cert_path=xxxxxx`</br>`--key_path=xxxxxx`</br>`--ca_client_path=xxxxxx`|In the Graph/Meta/Storage configuration file, add the following parameters:</br>`--enable_meta_ssl = true`</br> `--ca_path=xxxxxx`</br>`--cert_path=xxxxxx`</br>`--key_path=xxxxxx`</br>`--ca_client_path=xxxxxx`|In the Graph/Meta/Storage configuration file, add the following parameters:</br>`--enable_ssl = true`</br> `--ca_path=xxxxxx`</br>`--cert_path=xxxxxx`</br>`--key_path=xxxxxx`</br>`--ca_client_path=xxxxxx`|
|Scenes | mTLS |
|:---|:---|
|External device access to Graph| Modify the Graph configuration file to add the following parameters:</br>`--enable_graph_ssl = true`</br> `--ca_path=xxxxxx`</br>`--cert_path=xxxxxx`</br>`--key_path=xxxxxx`</br>`--ca_client_path=xxxxxx`|
|Graph access Meta |In the Graph/Meta configuration file, add the following parameters:</br>`--enable_meta_ssl = true`</br>`--ca_path=xxxxxx`</br>`--cert_path=xxxxxx`</br>`--key_path=xxxxxx`</br>`--ca_client_path=xxxxxx` |
|Graph access Storage</br>Meta access Storage |In the Graph/Meta/Storage configuration file, add the following parameters:</br>`--enable_storage_ssl = true`</br>`--ca_path=xxxxxx`</br>`--cert_path=xxxxxx`</br>`--key_path=xxxxxx`</br>`--ca_client_path=xxxxxx` |
|Graph access Meta/Storage</br>Meta access Storage |In the Graph/Meta/Storage configuration file, add the following parameters:</br>`--enable_meta_ssl = true`</br>`--enable_storage_ssl = true`</br>`--ca_path=xxxxxx`</br>`--cert_path=xxxxxx`</br>`--key_path=xxxxxx`</br>`--ca_client_path=xxxxxx` |
|External device access to Graph</br>Graph access Meta/Storage</br>Meta access Storage |In the Graph/Meta/Storage configuration file, add the following parameters:</br>`--enable_ssl = true`</br>`--ca_path=xxxxxx`</br>`--cert_path=xxxxxx`</br>`--key_path=xxxxxx`</br>`--ca_client_path=xxxxxx` |

!!! note

Expand All @@ -70,6 +79,7 @@ To use SSL encryption, SSL certificates are required. NebulaGraph supports two c
| `enable_ssl` | `false` | Whether to enable SSL encryption in all services. only. |
| `enable_graph_ssl` | `false` | Whether to enable SSL encryption in the Graph service only. |
| `enable_meta_ssl` | `false` | Whether to enable SSL encryption in the Meta service only. |
| `enable_storage_ssl` | `false` | Whether to enable SSL encryption in the Storage service only. |

{{ent.ent_end}}

Expand Down