Skip to content

Commit

Permalink
Fix&updates 3.5.0en (#2197)
Browse files Browse the repository at this point in the history
* fixes&updates for sc

* Update mkdocs.yml
  • Loading branch information
abby-cyber authored Jul 27, 2023
1 parent d3e404e commit da7e282
Show file tree
Hide file tree
Showing 11 changed files with 75 additions and 56 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
- Support deploying License Manager (LM) through Dashboard. For more detail, see [Activate Dashboard](../../nebula-dashboard-ent/3.connect-dashboard.md).
- [Back up and restore](../../nebula-dashboard-ent/4.cluster-operator/operator/backup-and-restore.md) support full backup to local.
- Add [Slow query analyst](../../nebula-dashboard-ent/4.cluster-operator/analysis-diagnosis/slow-query-analyst.md) function.
- The [Cluster diagnostics](../../nebula-dashboard-ent/4.cluster-operator/cluster-information/cluster-diagnosis.md) formula supports configuration.
- The [Cluster diagnostics](../../nebula-dashboard-ent/4.cluster-operator/analysis-diagnosis/cluster-diagnosis.md) formula supports configuration.
- [Config Management](../../nebula-dashboard-ent/4.cluster-operator/operator/config-management.md) support **Add Config**, view the **Effective value** of the current configuration, and **View inconsistent configurations**.
- In the [Notification endpoint](../../nebula-dashboard-ent/system-settings/notification-endpoint.md), the webhook supports configuring the **Webhook request body**.
- Support [custom monitoring panel](../../nebula-dashboard-ent/4.cluster-operator/2.monitor.md).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ This topic takes the enterprise edition of NebulaGraph v3.1.0 as an example and

Please ensure that the number of storage paths set for the `--data_path` parameter in the Meta and Storage service configuration files of the {{nebula.release}} cluster is the same as that for the `--data_path` parameter in the configuration files of the 3.x cluster. Otherwise, the upgraded cluster will not start.

2. Stop the enterprise edition of v3.x services. For details see [Manage NebulaGraph services](../../2.quick-start/3.quick-start-on-premise/5.start-stop-service.md).
1. Stop the enterprise edition of v3.x services. For details see [Manage NebulaGraph services](https://docs.nebula-graph.io/3.5.0-sc/4.deployment-and-installation/manage-service/).

Run the `nebula.service status all` command to confirm that all services have been stopped after running the command.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ The following describes how to quickly bind the LMID:
If you skip the quick binding, you can still bind the LMID on the license information page.

1. On the targeted license details page, click **Bind License Manager ID**.
2. In the pop-up panel, enter the ID of your LM. For how to view LMID, see [LM](3.license_manager.md).
2. In the pop-up panel, enter the ID of your LM. For how to view LMID, see [LM](3.license-manager.md).
3. Select **Online** or **Offline**, and then click **CONFIRM** to bind the LMID.

- Select **Online** to generate an online license key, so that LM can get the latest license information from LC every 1 ~ 2 hours.
Expand Down
2 changes: 1 addition & 1 deletion docs-2.0/9.about-license/4.manage-license.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This article provides instructions on managing licenses, including license renew

- For licenses purchased through Vesoft's sales team, you need to contact the sales team to renew them.
- For licenses purchased on the cloud marketplace platform, follow these steps for renewal:
1. On the [LC](2.license-management-suite/2.license-center.m) homepage, navigate to the **LICENSES LIST** section, and find the target license card.
1. On the [LC](2.license-management-suite/2.license-center.md) homepage, navigate to the **LICENSES LIST** section, and find the target license card.
2. Click **RENEW** to enter the cloud marketplace renewal page.
3. Click **Modify renewal terms** and select the renewal period, which can be either 1 month or 1 year.
4. Click **Modify renewal**.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Clicking the ![watch](https://docs-cdn.nebula-graph.com.cn/figures/watch.png) bu

!!! Caution

Before using Graph Space Metrics, users need to set `enable_space_level_metrics` to `true` in the Graph service. For specific operations, please refer to [Update config](./operator/update-config.md).
Before using Graph Space Metrics, users need to set `enable_space_level_metrics` to `true` in the Graph service. For specific operations, see [Update config](operator/config-management.md).

### Managing Monitoring

Expand Down
4 changes: 2 additions & 2 deletions docs-2.0/nebula-operator/10.backup-restore-using-operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ spec:
- /bin/sh
- -ecx
- 'exec /usr/local/bin/br-ent backup full
--meta nebula-metad-0.nebula-metad-headless.<namespace>.svc.cluster.local:9559 # The address of the Metad service. Replace <namespace> with the actual namespace of the cluster.
--meta nebula-metad-0.nebula-metad-headless.nebula.svc.cluster.local:9559 # The address of the Metad service.
--storage s3://BUCKET # The storage location of the backup file.
--s3.access_key ACCESS_KEY # The AccessKey for accessing the S3 protocol-compatible storage service.
--s3.secret_key SECRET_KEY # The SecretKey for accessing the S3 protocol-compatible storage service.
Expand Down Expand Up @@ -121,7 +121,7 @@ spec:
- /bin/sh
- -ecx
- 'exec /usr/local/bin/br-ent backup incr
--meta nebula-metad-0.nebula-metad-headless.<namespace>.svc.cluster.local:9559 # The address of the Metad service. Replace <namespace> with the actual namespace of the cluster.
--meta nebula-metad-0.nebula-metad-headless.nebula.svc.cluster.local:9559 # The address of the Metad service.
--storage s3://BUCKET # The storage location of the backup file.
--s3.access_key ACCESS_KEY # The AccessKey for accessing the S3 protocol-compatible storage service.
--s3.secret_key SECRET_KEY # The SecretKey for accessing the S3 protocol-compatible storage service.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ For information on how to deploy LM on a machine outside the K8s cluster, see [L

If LM is deployed outside the K8s cluster, make sure that the port of the LM service (default is `9119`) can be accessed by all nodes in the K8s cluster.

## Deploy LM in K8s using statefulSet
## Deploy LM in K8s using StatefulSet

### Prerequisites

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ The following example shows how to create a NebulaGraph cluster by creating a cl
{{ent.ent_begin}}
2. Create a Secret for pulling the NebulaGraph Enterprise image from a private repository.

!!! note
Skip this step if you are using NebulaGraph Community Edition.

```bash
kubectl -n <nebula> create secret docker-registry <image-pull-secret> \
--docker-server=DOCKER_REGISTRY_SERVER \
Expand All @@ -41,7 +44,7 @@ The following example shows how to create a NebulaGraph cluster by creating a cl
- `DOCKER_REGISTRY_SERVER`: Specify the server address of the private repository from which the image will be pulled, such as `reg.example-inc.com`.
- `DOCKER_USER`: The username for the image repository.
- `DOCKER_PASSWORD`: The password for the image repository.

{{ent.ent_end}}

3. Create a file named `apps_v1alpha1_nebulacluster.yaml`.
Expand Down Expand Up @@ -83,6 +86,10 @@ The following example shows how to create a NebulaGraph cluster by creating a cl

- For a NebulaGraph Enterprise cluster

!!! enterpriseonly

Make sure that you have access to NebulaGraph Enterprise Edition images before pulling the image.

Create a file named `apps_v1alpha1_nebulacluster.yaml`. Contact our sales team to get a complete NebulaGraph Enterprise Edition cluster YAML example. You must customize and modify the following parameters, and other parameters can be changed as needed.

- `spec.metad.licenseManagerURL`
Expand All @@ -98,13 +105,10 @@ The following example shows how to create a NebulaGraph cluster by creating a cl
|`spec.enableBR`|`false`|Specifies whether to enable the BR tool. For more information, see [Backup and restore](../10.backup-restore-using-operator.md).|
|`spec.imagePullSecrets`| - |Specifies the Secret for pulling the NebulaGraph Enterprise service images from a private repository.|

!!! enterpriseonly

Make sure that you have access to NebulaGraph Enterprise Edition images before pulling the image.

{{ ent.ent_end }}

4. Create a NebulaGraph cluster.
1. Create a NebulaGraph cluster.

```bash
kubectl create -f apps_v1alpha1_nebulacluster.yaml
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,22 +60,10 @@
- `DOCKER_USER`: The username for the image repository.
- `DOCKER_PASSWORD`: The password for the image repository.

{{ent.ent_end}}}

6. Apply the variables to the Helm chart to create a NebulaGraph cluster.

```bash
helm install "${NEBULA_CLUSTER_NAME}" nebula-operator/nebula-cluster \
{{ ent.ent_begin }}
# Configure the access address and port (default port is '9119') that points to the LM. You must configure this parameter in order to obtain the license information. Only for NebulaGraph Enterprise Edition clusters.
--set nebula.metad.licenseManagerURL=`192.168.8.XXX:9119` \
# Configure the image addresses for each service in the cluster.
--set nebula.graphd.image=<reg.example-inc.com/test/graphd-ent> \
--set nebula.metad.image=<reg.example-inc.com/test/metad-ent> \
--set nebula.storaged.image=<reg.example-inc.com/test/storaged-ent> \
# Configure the Secret for pulling images from a private repository.
--set nebula.imagePullSecrets=<image-pull-secret> \
{{ ent.ent_end }}
--set nameOverride=${NEBULA_CLUSTER_NAME} \
--set nebula.storageClassName="${STORAGE_CLASS_NAME}" \
# Specify the version of the NebulaGraph cluster.
Expand All @@ -85,6 +73,31 @@
--namespace="${NEBULA_CLUSTER_NAMESPACE}" \
```

{{ent.ent_begin}}
!!! enterpriseonly

For NebulaGraph Enterprise, run the following command to create a NebulaGraph cluster:

```bash
helm install "${NEBULA_CLUSTER_NAME}" nebula-operator/nebula-cluster \
# Configure the access address and port (default port is '9119') that points to the LM. You must configure this parameter in order to obtain the license information. Only for NebulaGraph Enterprise Edition clusters.
--set nebula.metad.licenseManagerURL=`192.168.8.XXX:9119` \
# Configure the image addresses for each service in the cluster.
--set nebula.graphd.image=<reg.example-inc.com/test/graphd-ent> \
--set nebula.metad.image=<reg.example-inc.com/test/metad-ent> \
--set nebula.storaged.image=<reg.example-inc.com/test/storaged-ent> \
# Configure the Secret for pulling images from a private repository.
--set nebula.imagePullSecrets=<image-pull-secret> \
--set nameOverride=${NEBULA_CLUSTER_NAME} \
--set nebula.storageClassName="${STORAGE_CLASS_NAME}" \
# Specify the version of the NebulaGraph cluster.
--set nebula.version=v{{nebula.release}} \
# Specify the version of the nebula-cluster chart. If not specified, the latest version of the chart is installed by default.
--version={{operator.release}}
--namespace="${NEBULA_CLUSTER_NAMESPACE}" \
```
{{ent.ent_end}}

7. Check the status of the NebulaGraph cluster you created.

```bash
Expand Down Expand Up @@ -150,10 +163,6 @@ Or use variable values to delete a NebulaGraph cluster with Helm:
helm uninstall nebula --namespace=nebula
```

## What's next

[Connect to NebulaGraph Databases](../4.connect-to-nebula-graph-service.md)

## Configuration parameters of the nebula-cluster Helm chart

| Parameter | Default value | Description |
Expand Down Expand Up @@ -208,3 +217,8 @@ helm uninstall nebula --namespace=nebula
| `nebula.storaged.sidecarVolumes` | `{}` | Sidecar volumes for the Metad pod. |
|`nebula.agent`|`{}`| Configuration of the Agent service. This is used for backup and recovery as well as log cleanup functions. If you do not customize this configuration, the default configuration will be used.|
| `imagePullSecrets` | `[]` | The Secret to pull the NebulaGraph Enterprise cluster image. |


## What's next

[Connect to NebulaGraph Databases](../4.connect-to-nebula-graph-service.md)
Original file line number Diff line number Diff line change
Expand Up @@ -197,36 +197,36 @@ After setting up the encryption policy, when an external [client](../../14.clien

4. Verify that the values of `serverCert`, `serverKey`, `clientCert`, `clientKey`, `caCert` under the `sslCerts` field in the cluster configuration match the key names of the certificates and private keys stored in the created Secret.

```bash
# Check the key names of the certificate and private key stored in the Secret. For example, check the key name of the CA certificate stored in the Secret.
kubectl get secret ca-cert -o yaml
```
```bash
# Check the key names of the certificate and private key stored in the Secret. For example, check the key name of the CA certificate stored in the Secret.
kubectl get secret ca-cert -o yaml
```

```bash
# Check the cluster configuration file.
kubectl get nebulacluster nebula -o yaml
```
```bash
# Check the cluster configuration file.
kubectl get nebulacluster nebula -o yaml
```

Example output:
Example output:

```
...
spec:
sslCerts:
serverSecret: server-cert
serverCert: tls.crt
serverKey: tls.key
clientSecret: client-cert
clientCert: tls.crt
clientKey: tls.key
caSecret: ca-cert
caCert: ca.crt
...
```
```
...
spec:
sslCerts:
serverSecret: server-cert
serverCert: tls.crt
serverKey: tls.key
clientSecret: client-cert
clientCert: tls.crt
clientKey: tls.key
caSecret: ca-cert
caCert: ca.crt
...
```

If the key names of the certificates and private keys stored in the Secret are different from the values of `serverCert`, `serverKey`, `clientCert`, `clientKey`, `caCert` under the `sslCerts` field in the cluster configuration, you need to execute `kubectl edit nebulacluster <cluster_name>` to manually modify the cluster configuration file.
If the key names of the certificates and private keys stored in the Secret are different from the values of `serverCert`, `serverKey`, `clientCert`, `clientKey`, `caCert` under the `sslCerts` field in the cluster configuration, you need to execute `kubectl edit nebulacluster <cluster_name>` to manually modify the cluster configuration file.

In the example output, the key name of the CA certificate in the TLS-type Secret is `tls.crt`, so you need to change the value of caCert from `ca.crt` to `tls.crt`.
In the example output, the key name of the CA certificate in the TLS-type Secret is `tls.crt`, so you need to change the value of caCert from `ca.crt` to `tls.crt`.

5. Use NebulaGraph Console to connect to the Graph service and establish a secure TLS connection.

Expand All @@ -235,6 +235,7 @@ In the example output, the key name of the CA certificate in the TLS-type Secret
```
kubectl run -ti --image vesoft/nebula-console:v{{console.release}} --restart=Never -- nebula-console -addr 10.98.xxx.xx -port 9669 -u root -p nebula -enable_ssl -ssl_root_ca_path /path/to/cert/root.crt -ssl_cert_path /path/to/cert/client.crt -ssl_private_key_path /path/to/cert/client.key
```

- `-enable_ssl`: Use mTLS when connecting to NebulaGraph.
- `-ssl_root_ca_path`: Specify the storage path of the CA root certificate.
- `-ssl_cert_path`: Specify the storage path of the TLS public key certificate.
Expand Down
4 changes: 2 additions & 2 deletions docs-2.0/reuse/source_install-nebula-graph-by-rpm-or-deb.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ RPM and DEB are common package formats on Linux systems. This topic shows how to
- The tool `wget` is installed.

{{ ent.ent_begin }}
- For NebulaGraph Enterprise, you must have the [license key](../9.about-license/1.license-overview.md#licensing-process) loaded in [LM](../9.about-license/2.license-management-suite/3.license-manager.md).
- For NebulaGraph Enterprise, you must have the [license key](https://docs.nebula-graph.io/3.5.0-sc/9.about-license/1.license-overview/#license_key) loaded in [LM](https://docs.nebula-graph.io/3.5.0-sc/9.about-license/2.license-management-suite/3.license-manager/).
{{ ent.ent_end }}

## Step 1: Download the package from cloud service
Expand Down Expand Up @@ -144,7 +144,7 @@ RPM and DEB are common package formats on Linux systems. This topic shows how to

This step is required only for NebulaGraph Enterprise.

In the Meta service configuration file (`nebula-metad.conf`) of NebulaGraph, set the value of `license_manager_url` to the host IP and port number `9119` where the License Manager ([LM](../9.about-license/2.license-management-suite/3.license-manager.md)) is located, e.g. `192.168.8.100:9119`.
In the Meta service configuration file (`nebula-metad.conf`) of NebulaGraph, set the value of `license_manager_url` to the host IP and port number `9119` where the [License Manager (LM)](https://docs.nebula-graph.io/3.5.0-sc/9.about-license/2.license-management-suite/3.license-manager/) is located, e.g. `192.168.8.100:9119`.
{{ ent.ent_end }}

## Next to do
Expand Down

0 comments on commit da7e282

Please sign in to comment.