Skip to content

Commit

Permalink
Update 4.ssl.md (#2260)
Browse files Browse the repository at this point in the history
added enable_storage_ssl
  • Loading branch information
cooper-lzy authored Sep 20, 2023
1 parent 6445de2 commit b59d9c5
Showing 1 changed file with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions docs-2.0/7.data-security/4.ssl.md
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

0 comments on commit b59d9c5

Please sign in to comment.