-
Notifications
You must be signed in to change notification settings - Fork 217
Nebula #1265
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
base: main
Are you sure you want to change the base?
Nebula #1265
Changes from 46 commits
3270982
0011a66
fee5ffe
e7868fd
296f3ed
5ceb03b
8701aab
fb7658f
9c2ba3b
aaa6d95
4076e21
d3b7003
a20e914
67b2da9
a00e886
23f1ab4
ea733b3
62a70d8
cf0e0c1
55942e5
320d11e
0a45ece
b097d2b
c56a3c5
f35edea
2f01606
079e1ec
af60a1c
109451c
c4ff066
3113700
413fbc6
16b9569
e0e408d
cf278b0
1cae41e
e7673c9
d84ed29
c56f9b7
9be528a
af58635
0876d6e
f957a4d
332ac41
916fbf2
a22e11f
bc47599
aa9f52b
7df8202
23c3996
4c5a0a8
36ce2ad
3fb2f89
1edb31f
6286026
03530ff
0ff8e39
7a640b1
82df762
fe04811
b167636
c0215e3
4702499
7fbc25a
e79a742
442e659
afbb45f
cb1535e
ec70edb
6b7e24f
3dcba86
aa4c672
20480e4
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| # Deploy NebulaGraph cluster (with Kubectl) | ||
|
|
||
| ## 1. Install cert-manager | ||
|
|
||
| ```bash | ||
| kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.9.1/cert-manager.yaml | ||
|
||
| ``` | ||
|
|
||
| ## 2. Install Nebula Operator | ||
|
|
||
| ```bash | ||
| helm repo add nebula-operator https://vesoft-inc.github.io/nebula-operator/charts | ||
| helm repo update | ||
| helm install nebula-operator nebula-operator/nebula-operator --namespace=<namespace_name> --version=${chart_version} | ||
|
||
| ``` | ||
|
|
||
| ## 3. Install and start NebulaGraph cluster | ||
|
|
||
| Choose between the Enterprise and Community configuration files base on your license. Edit the config with the proper storageClassName and run the command below: | ||
|
|
||
| ```bash | ||
| kubectl create -f enterprise_edition.yaml | ||
| or | ||
| kubectl create -f community_edition.yaml | ||
| ``` | ||
|
|
||
| ## 4. Connect to NebulaGraph databases | ||
|
|
||
| Once you've set up a NebulaGraph cluster using Nebula Operator on Kubernetes, you can connect to NebulaGraph databases both from inside the cluster and from external sources. | ||
|
|
||
| ### 4.1. Connect to NebulaGraph databases from within a NebulaGraph cluster | ||
|
|
||
| Run the following command to check the IP of the Service: | ||
|
|
||
| ```bash | ||
| $ kubectl get service -l app.kubernetes.io/cluster=<nebula> #<nebula> is a variable value. Replace it with the desired name. | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. what should be? Replace it by what value?
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This can be any desired name. |
||
| NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE | ||
| nebula-graphd-svc ClusterIP 10.98.213.34 <none> 9669/TCP,19669/TCP,19670/TCP 23h | ||
| nebula-metad-headless ClusterIP None <none> 9559/TCP,19559/TCP,19560/TCP 23h | ||
| nebula-storaged-headless ClusterIP None <none> 9779/TCP,19779/TCP,19780/TCP,9778/TCP | ||
| ``` | ||
|
|
||
| Run the following command to connect to the NebulaGraph database using the IP of the <cluster-name>-graphd-svc Service above: | ||
|
|
||
| ```bash | ||
| kubectl run -ti --image vesoft/nebula-console --restart=Never -- <nebula_console_name> -addr <cluster_ip> -port <service_port> -u <username> -p <password> | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It'd be better to give users direct bash commands to get <cluster_ip>, <service_port> .
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Added the bash commands to find <cluster_ip>, <service_port> in README. |
||
| ``` | ||
|
|
||
| For example: | ||
|
|
||
| ```bash | ||
| kubectl run -ti --image vesoft/nebula-console --restart=Never -- nebula-console -addr 10.98.213.34 -port 9669 -u root -p vesoft | ||
|
|
||
| ``` | ||
|
|
||
| A successful connection to the database is indicated if the following is returned: | ||
|
|
||
| If you don't see a command prompt, try pressing enter. | ||
|
|
||
| (root@nebula) [(none)]> | ||
|
|
||
| ### 4.2. Connect to NebulaGraph databases from outside a NebulaGraph cluster | ||
|
|
||
| Refer to the [NebulaGraph Database Manual](https://docs.nebula-graph.io/3.1.3/nebula-operator/4.connect-to-nebula-graph-service/) for more information. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| # Copyright (C) 2025 Intel Corporation | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| apiVersion: apps.nebula-graph.io/v1alpha1 | ||
| kind: NebulaCluster | ||
| metadata: | ||
| name: nebula | ||
| spec: | ||
| graphd: | ||
| resources: | ||
| requests: | ||
| cpu: "500m" | ||
| memory: "500Mi" | ||
| limits: | ||
| cpu: "1" | ||
| memory: "1Gi" | ||
| replicas: 1 | ||
| image: vesoft/nebula-graphd | ||
|
||
| #version: v3.1.3 | ||
| service: | ||
| type: NodePort | ||
| externalTrafficPolicy: Local | ||
| logVolumeClaim: | ||
| resources: | ||
| requests: | ||
| storage: 2Gi | ||
| storageClassName: "csi-wekafs-fs" | ||
| metad: | ||
| resources: | ||
| requests: | ||
| cpu: "500m" | ||
| memory: "500Mi" | ||
| limits: | ||
| cpu: "1" | ||
| memory: "1Gi" | ||
| replicas: 1 | ||
| image: vesoft/nebula-metad | ||
| #version: v3.1.3 | ||
| dataVolumeClaim: | ||
| resources: | ||
| requests: | ||
| storage: 2Gi | ||
| storageClassName: "csi-wekafs-fs" | ||
| logVolumeClaim: | ||
| resources: | ||
| requests: | ||
| storage: 2Gi | ||
| storageClassName: "csi-wekafs-fs" | ||
| storaged: | ||
| resources: | ||
| requests: | ||
| cpu: "500m" | ||
| memory: "500Mi" | ||
| limits: | ||
| cpu: "1" | ||
| memory: "1Gi" | ||
| replicas: 3 | ||
| image: vesoft/nebula-storaged | ||
| #version: v3.1.3 | ||
| dataVolumeClaim: | ||
| resources: | ||
| requests: | ||
| storage: 2Gi | ||
| storageClassName: "csi-wekafs-fs" | ||
| logVolumeClaim: | ||
| resources: | ||
| requests: | ||
| storage: 2Gi | ||
| storageClassName: "csi-wekafs-fs" | ||
| reference: | ||
| name: statefulsets.apps | ||
| version: v1 | ||
| schedulerName: default-scheduler | ||
| imagePullPolicy: Always | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| # Copyright (C) 2025 Intel Corporation | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| apiVersion: apps.nebula-graph.io/v1alpha1 | ||
| kind: NebulaCluster | ||
| metadata: | ||
| annotations: | ||
| nebula-graph.io/owner: test | ||
| name: nebula | ||
| spec: | ||
| enablePVReclaim: true | ||
| graphd: | ||
| readinessProbe: | ||
| failureThreshold: 3 | ||
| httpGet: | ||
| path: /status | ||
| port: 19669 | ||
| scheme: HTTP | ||
| initialDelaySeconds: 40 | ||
| periodSeconds: 10 | ||
| successThreshold: 1 | ||
| timeoutSeconds: 10 | ||
| image: reg.vesoft-inc.com/vesoft-ent/nebula-graphd | ||
| logVolumeClaim: | ||
| resources: | ||
| requests: | ||
| storage: 2Gi | ||
| storageClassName: fast-disks | ||
| replicas: 1 | ||
| resources: | ||
| limits: | ||
| cpu: "1" | ||
| memory: 1Gi | ||
| requests: | ||
| cpu: 500m | ||
| memory: 500Mi | ||
| version: v3.1.3 | ||
| imagePullPolicy: Always | ||
| imagePullSecrets: | ||
| - name: vesoft | ||
| metad: | ||
| license: | ||
| secretName: nebula-license | ||
| licenseKey: nebula.license | ||
| readinessProbe: | ||
| failureThreshold: 3 | ||
| httpGet: | ||
| path: /status | ||
| port: 19559 | ||
| scheme: HTTP | ||
| initialDelaySeconds: 5 | ||
| periodSeconds: 5 | ||
| successThreshold: 1 | ||
| timeoutSeconds: 5 | ||
| image: reg.vesoft-inc.com/vesoft-ent/nebula-metad | ||
| logVolumeClaim: | ||
| resources: | ||
| requests: | ||
| storage: 2Gi | ||
| storageClassName: fast-disks | ||
| dataVolumeClaim: | ||
| resources: | ||
| requests: | ||
| storage: 2Gi | ||
| storageClassName: fast-disks | ||
| replicas: 1 | ||
| resources: | ||
| limits: | ||
| cpu: "1" | ||
| memory: 1Gi | ||
| requests: | ||
| cpu: 500m | ||
| memory: 500Mi | ||
| version: v3.1.3 | ||
| reference: | ||
| name: statefulsets.apps | ||
| version: v1 | ||
| schedulerName: default-scheduler | ||
| storaged: | ||
| readinessProbe: | ||
| failureThreshold: 3 | ||
| httpGet: | ||
| path: /status | ||
| port: 19779 | ||
| scheme: HTTP | ||
| initialDelaySeconds: 40 | ||
| periodSeconds: 10 | ||
| successThreshold: 1 | ||
| timeoutSeconds: 5 | ||
| image: reg.vesoft-inc.com/vesoft-ent/nebula-storaged | ||
| logVolumeClaim: | ||
| resources: | ||
| requests: | ||
| storage: 2Gi | ||
| storageClassName: fast-disks | ||
| dataVolumeClaim: | ||
| resources: | ||
| requests: | ||
| storage: 2Gi | ||
| storageClassName: fast-disks | ||
| replicas: 3 | ||
| resources: | ||
| limits: | ||
| cpu: "1" | ||
| memory: 1Gi | ||
| requests: | ||
| cpu: 500m | ||
| memory: 500Mi | ||
| version: v3.1.3 | ||
| enableAutoBalance: true |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| # Copyright (C) 2024 Intel Corporation | ||
| # SPDX-License-Identifier: Apache-2.0 |
Uh oh!
There was an error while loading. Please reload this page.