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

merge community and enterprise #2314

Merged
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
19 changes: 19 additions & 0 deletions .github/workflows/deploy-all.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: deploy-all

on:
push:
paths-ignore:
- 'docs-2.0-zh/**'
- 'docs-2.0-en/**'
branches:
# Remember to add v before the following version number unless the version is master.
- v3.6.0

jobs:
deploy-zh:
uses: ./.github/workflows/deploy-zh.yml
secrets:
ZHSITE_PASSWORD: ${{ secrets.ZHSITE_PASSWORD }}

deploy-en:
uses: ./.github/workflows/deploy-en.yml
24 changes: 14 additions & 10 deletions .github/workflows/deploy.yml → .github/workflows/deploy-en.yml
Original file line number Diff line number Diff line change
@@ -1,37 +1,41 @@
name: Publish docs via GitHub Pages
name: Publish English docs via GitHub Pages
env:
ACTIONTEST: 3.6.0 # no need to add v before the version number
on:
workflow_call:
push:
branches:
# Remember to add v before the following version number unless the version is master.
- v3.6.0
paths:
- 'docs-2.0-en/**'

jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3
with:
fetch-depth: 0 # fetch all commits/branches for gitversion

- name: Setup Python
uses: actions/setup-python@v1
uses: actions/setup-python@v4
with:
python-version: '3.8'
architecture: 'x64'

- name : prepare
run: sh ./prepare.sh
run: sh ./prepare.sh

- name: Git Config
run: git config user.name whitewum && git config user.email min.wu@vesoft.com
run: git config user.name ChrisChen2023 && git config user.email chris.chen@vesoft.com

- name: Mike Deploy 3.6.0
- name: Mike Deploy
run: |
# mike delete 3.6.0 -p
python ./scripts/render_english_only.py
git fetch origin gh-pages --depth=1 # fix mike's CI update
mike list
mike deploy 3.6.0 -p --rebase
mike set-default 3.6.0 -p --rebase
mike deploy ${{ env.ACTIONTEST }} -p --rebase
mike set-default ${{ env.ACTIONTEST }} -p --rebase
mike list

# - name: Deploy
Expand Down
99 changes: 99 additions & 0 deletions .github/workflows/deploy-zh.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
name: Publish Chinese docs via GitHub Pages and upload to server
env:
# Remember to add v before the following version number unless the version is master.
ACTIONTEST: 3.6.0
on:
workflow_call:
secrets:
ZHSITE_PASSWORD:
required: true
push:
branches:
- v3.6.0
paths:
- 'docs-2.0-zh/**'

jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 1 # fetch all commits/branches for gitversion

- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: '3.8'

- name : prepare
run: sh ./prepare.sh

- name: Git Config
run: git config user.name ChrisChen2023 && git config user.email chris.chen@vesoft.com

- name: save tmp file
run: |
cp -f *versions.json /tmp/
ls /tmp/ -ltr

- name: Mike Deploy
run: |
python ./scripts/render_chinese_only.py
git fetch origin gh-pages-zh --depth=1 # fix mike's CI update
mike list
mike deploy ${{ env.ACTIONTEST }} -b gh-pages-zh -p --rebase
mike set-default ${{ env.ACTIONTEST }} -b gh-pages-zh -p --rebase
mike list

- name: show Chinese git branches
run: |
git branch
git checkout .
git checkout gh-pages-zh

- name: add existing version
run: |
import yaml, json
new_content = {"version": "${{ env.ACTIONTEST }}", "title": "${{ env.ACTIONTEST }}", "aliases": []}
filename = "/tmp/community_versions.json"
with open(filename, 'r') as infile:
json_data = json.load(infile)
found = False
for item in json_data:
if item['version'] == new_content['version']: # in case duplicate master branch
found = True
break
if not found:
json_data.append(new_content)
json_data = sorted(json_data, key=lambda x: x['version'], reverse=True)
with open('./versions.json', 'w') as outfile:
json.dump(json_data, outfile, indent=2)
shell: python

- name: Compress
run: |
tar -vczf nebula-docs.tar.gz ${{ env.ACTIONTEST }} versions.json *.html

- name: Transfer
uses: appleboy/scp-action@master
with:
host: 47.99.143.59
username: root
password: ${{ secrets.ZHSITE_PASSWORD }}
port: 404
source: nebula-docs.tar.gz
target: /usr/web/

- name: UnCompress
uses: appleboy/ssh-action@master
with:
host: 47.99.143.59
username: root
password: ${{ secrets.ZHSITE_PASSWORD }}
port: 404
script: |
mkdir -p /usr/web/nebula-docs/
tar -xzf /usr/web/nebula-docs.tar.gz -C /usr/web/nebula-docs/
# mkdir -p /usr/web/nebula-docs/site/pdf/
# cp -f /var/www/ent-docs/${{ env.ACTIONTEST }}/pdf/NebulaGraph-CN.pdf /var/www/ent-docs/site/pdf/NebulaGraph-CN.pdf
1 change: 1 addition & 0 deletions community_versions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[{"version": "3.6.0", "title": "3.6.0", "aliases": []},{"version": "3.5.0", "title": "3.5.0", "aliases": []},{"version": "3.4.3", "title": "3.4.3", "aliases": []},{"version": "3.4.2", "title": "3.4.2", "aliases": []},{"version": "3.4.1", "title": "3.4.1", "aliases": []}, {"version": "3.4.0", "title": "3.4.0", "aliases": []}, {"version": "3.3.0", "title": "3.3.0", "aliases": []}, {"version": "3.2.1", "title": "3.2.1", "aliases": []}, {"version": "3.1.3", "title": "3.1.3", "aliases": []}, {"version": "3.0.2", "title": "3.0.2", "aliases": []}, {"version": "2.6.2", "title": "2.6.2", "aliases": []}, {"version": "master", "title": "master", "aliases": []}]
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# What is NebulaGraph

NebulaGraph is an open-source, distributed, easily scalable, and native graph database. It is capable of hosting graphs with hundreds of billions of vertices and trillions of edges, and serving queries with millisecond-latency.
NebulaGraph is an open-source, distributed, easily scalable, and native graph database. It is capable of hosting graphs with hundreds of billions of vertices and trillions of edges, and serving queries with millisecond-latency.

![NebulaGraph birdview](https://docs-cdn.nebula-graph.com.cn/figures/architecture_map_2022-08-08_17-37-15.png)

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,6 @@ You can quickly get started with NebulaGraph by deploying NebulaGraph with Docke
* You have started the Docker service on your host.

* If you have already deployed another version of NebulaGraph with Docker Compose on your host, to avoid compatibility issues, you need to delete the `nebula-docker-compose/data` directory.

* 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).


## Deploy NebulaGraph

Expand All @@ -73,47 +70,13 @@ You can quickly get started with NebulaGraph by deploying NebulaGraph with Docke

The `x.y` version of Docker Compose aligns to the `x.y` version of NebulaGraph. For the NebulaGraph `z` version, Docker Compose does not publish the corresponding `z` version, but pulls the `z` version of the NebulaGraph image.

!!! note
For installation of the NebulaGraph enterprise version, [contact us](https://www.nebula-graph.io/contact).

2. Go to the `nebula-docker-compose` directory.

```bash
$ cd nebula-docker-compose/
```

3. Configure License Manager address.

!!! enterpriseonly

Skip this step if you are using the community version.

1. Edit the `docker-compose.yml` file.

```bash
$ cd nebula-docker-compose/
$ vim docker-compose.yml
```

2. Add the `license_manager_url` field under all `services.metad{number}.command` and set its value to the access address of LM.

```yaml
...
services:
metad0:
command:
- --license_manager_url=<LM_ADDR>:<LM_PORT> // <LM_ADDR> is the address of the LM service, and <LM_PORT> is the port of the LM service, which is 9119 by default.
metad1:
command:
- --license_manager_url=<LM_ADDR>:<LM_PORT>
...
```

3. Save and exit.



4. Run the following command to start all the NebulaGraph services.
3. Run the following command to start all the NebulaGraph services.


!!! Note
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,21 +27,6 @@ You have [connected to NebulaGraph](3.connect-to-nebula-graph.md).
nebula> ADD HOSTS 192.168.10.100:9779, 192.168.10.101:9779, 192.168.10.102:9779;
```

{{ent.ent_begin}}

If enabling the [Zone](../../4.deployment-and-installation/5.zone.md) feature, you still need to specify `INTO ZONE <zone_name>` to add Storage hosts, otherwise the Storage hosts will fail to be added.

```ngql
ADD HOSTS <ip>:<port> [,<ip>:<port> ...] INTO ZONE <zone_name>;
```

Example:

```ngql
nebula> ADD HOSTS 192.168.8.111:9779,192.168.8.112:9779 INTO ZONE az1;
```
{{ent.ent_end}}

!!! caution

Make sure that the IP you added is the same as the IP configured for `local_ip` in the `nebula-storaged.conf` file. Otherwise, the Storage service will fail to start. For information about configurations, see [Configurations](../5.configurations-and-logs/1.configurations/1.configurations.md).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -435,10 +435,6 @@
|Syntax|Description|
|-|-|
|`BALANCE LEADER`| Starts a job to balance the distribution of all the storage leaders in graph spaces. It returns the job ID.|
|`BALANCE DATA`| Starts a job to balance the distribution of all the storage partitions in graph spaces. It returns the job ID. **For enterprise edition only.**|
|`BALANCE DATA REMOVE <ip:port> [,<ip>:<port> ...]`| Starts a job to migrate the specified storage partitions. The default port is `9779`. **For enterprise edition only.**|
|`BALANCE DATA IN ZONE [REMOVE <ip>:<port> [,<ip>:<port> ...]]`| Starts a job to balance the distribution of storage partitions in each zone in the current graph space. It returns the job ID. You can use the `REMOVE` option to specify the partitions of storage services that you want to migrate to other storage services. **For enterprise edition only.**|


* [Job statements](../3.ngql-guide/4.job-statements.md)

Expand All @@ -447,7 +443,6 @@
| `SUBMIT JOB COMPACT` | Triggers the long-term RocksDB `compact` operation. |
| `SUBMIT JOB FLUSH` | Writes the RocksDB memfile in the memory to the hard disk. |
| `SUBMIT JOB STATS` | Starts a job that makes the statistics of the current graph space. Once this job succeeds, you can use the `SHOW STATS` statement to list the statistics. |
| `SUBMIT JOB BALANCE DATA IN ZONE`| Starts a job to balance partition replicas within each Zone. **For enterprise edition only.**|
| `SHOW JOB <job_id>` | Shows the information about a specific job and all its tasks in the current graph space. The Meta Service parses a `SUBMIT JOB` request into multiple tasks and assigns them to the nebula-storaged processes. |
| `SHOW JOBS` | Lists all the unexpired jobs in the current graph space. |
| `STOP JOB` | Stops jobs that are not finished in the current graph space. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ NebulaGraph is still under development. Its behavior changes from time to time.

Neubla Graph {{ nebula.release }} is **not compatible** with NebulaGraph 1.x nor 2.0-RC in both data formats and RPC-protocols, and **vice versa**. The service process may **quit** if using an **lower version** client to connect to a **higher version** server.

To upgrade data formats, see [Upgrade NebulaGraph to the current version](../4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-graph-to-latest.md).
To upgrade data formats, see [Upgrade NebulaGraph to the current version](../4.deployment-and-installation/3.upgrade-nebula-graph/upgrade-nebula-comm.md).
Users must upgrade [all clients](../20.appendix/6.eco-tool-version.md).

<!--
Expand Down Expand Up @@ -350,7 +350,7 @@ $ ./nebula-graphd --version

### "How to scale my cluster up/down or out/in?"

!!! enterpriseonly
!!! warning

The cluster scaling function has not been officially released in the community edition. The operations involving `SUBMIT JOB BALANCE DATA REMOVE` and `SUBMIT JOB BALANCE DATA` are experimental features in the community edition and the functionality is not stable. Before using it in the community edition, make sure to back up your data first and set `enable_experimental_feature` and `enable_data_balance` to `true` in the [Graph configuration file](../5.configurations-and-logs/1.configurations/3.graph-config.md).

Expand Down Expand Up @@ -380,12 +380,6 @@ NebulaGraph {{ nebula.release }} does not provide any commands or tools to suppo

You also need to run [Balance Data and Balance leader](../8.service-tuning/load-balance.md) after scaling in/out storaged.

{{ent.ent_begin}}
You can scale Graph and Storage services with Dashboard Enterprise Edition. For details, see [Scale](../nebula-dashboard-ent/4.cluster-operator/operator/scale.md).

You can also use NebulaGraph Operator to scale Graph and Storage services. For details, see [Deploy NebulaGraph clusters with Kubectl](../nebula-operator/3.deploy-nebula-graph-cluster/3.1create-cluster-with-kubectl.md) and [Deploy NebulaGraph clusters with Helm](../nebula-operator/3.deploy-nebula-graph-cluster/3.2create-cluster-with-helm.md).
{{ent.ent_end}}

#### Add or remove disks in the Storage nodes

Currently, Storage cannot dynamically recognize new added disks. You can add or remove disks in the Storage nodes of the distributed cluster by following these steps:
Expand Down
Loading