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

update doc #123

Merged
merged 1 commit into from
Mar 31, 2022
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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 19 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Modify the file and change `replicas` from 3 to 5.
memory: "1Gi"
replicas: 5
image: vesoft/nebula-storaged
version: v2.6.2
version: v3.0.2
storageClaim:
resources:
requests:
Expand Down Expand Up @@ -102,7 +102,7 @@ Similarly we can decrease the size of the cluster from 5 back to 3 by changing t
memory: "1Gi"
replicas: 3
image: vesoft/nebula-storaged
version: v2.6.2
version: v3.0.2
storageClaim:
resources:
requests:
Expand All @@ -125,7 +125,7 @@ nebula-storaged-2 1/1 Running 0 10m
In addition, you can [Install Nebula Cluster with helm](doc/user/nebula_cluster_helm_guide.md).

### Upgrade a nebula cluster
Create a nebula cluster with the version specified (v2.5.1):
Create a nebula cluster with the version specified (v3.0.0):

```bash
$ kubectl apply -f config/samples/apps_v1alpha1_nebulacluster.yaml
Expand All @@ -138,30 +138,30 @@ nebula-storaged-1 1/1 Running 0 24m
nebula-storaged-2 1/1 Running 0 25m
```

The container image version should be v2.5.1:
The container image version should be v3.0.0:

```
$ kubectl get pods -l app.kubernetes.io/cluster=nebula -o jsonpath="{.items[*].spec.containers[*].image}" |tr -s '[[:space:]]' '\n' |sort |uniq -c
1 vesoft/nebula-graphd:v2.5.1
1 vesoft/nebula-metad:v2.5.1
3 vesoft/nebula-storaged:v2.5.1
1 vesoft/nebula-graphd:v3.0.0
1 vesoft/nebula-metad:v3.0.0
3 vesoft/nebula-storaged:v3.0.0
```

Now modify the file `apps_v1alpha1_nebulacluster.yaml` and change the `version` from v2.5.1 to v2.6.2:
Now modify the file `apps_v1alpha1_nebulacluster.yaml` and change the `version` from v3.0.0 to v3.0.2:

Apply the version change to the cluster CR:

```
$ kubectl apply -f config/samples/apps_v1alpha1_nebulacluster.yaml
```

Wait 2 minutes. The container image version should be updated to v2.6.2:
Wait 2 minutes. The container image version should be updated to v3.0.2:

```
$ kubectl get pods -l app.kubernetes.io/cluster=nebula -o jsonpath="{.items[*].spec.containers[*].image}" |tr -s '[[:space:]]' '\n' |sort |uniq -c
1 vesoft/nebula-graphd:v2.6.2
1 vesoft/nebula-metad:v2.6.2
3 vesoft/nebula-storaged:v2.6.2
1 vesoft/nebula-graphd:v3.0.2
1 vesoft/nebula-metad:v3.0.2
3 vesoft/nebula-storaged:v3.0.2
```

### Failover
Expand Down Expand Up @@ -194,16 +194,19 @@ nebula-storaged-2 1/1 Running 0 19s

Nebula Operator <-> NebulaGraph

| | NebulaGraph v2.5 | NebulaGraph v2.6 |
|----------------------- |------------------|------------------|
| `v0.8.0` | ✓ | - |
| `v0.9.0`* | ✓ | ✓ |
| | NebulaGraph v2.5 | NebulaGraph v2.6 | NebulaGraph v3.0 |
|----------------------- |------------------|------------------|------------------|
| `v0.8.0` | ✓ | - | - |
| `v0.9.0`* | ✓ | ✓ | - |
| `v1.0.0`* | - | - | ✓ |

Key:

* `✓` Compatible.
* `-` Not Compatible.
* `*` Please notice that the StorageClaim is split into LogVolumeClaim and DataVolumeClaim in crd. v0.9.0 can't forward compatible.
* v1.0.0 does not support storage scaling in nebula community version.
* v1.0.0 does not support upgrading from v2.x to v3.x.

## FAQ

Expand Down
2 changes: 1 addition & 1 deletion charts/nebula-cluster/values.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
nebula:
version: v2.6.2
version: v3.0.2
imagePullPolicy: Always
storageClassName: ""
schedulerName: default-scheduler # nebula-scheduler
Expand Down
6 changes: 3 additions & 3 deletions config/samples/apps_v1alpha1_nebulacluster.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ spec:
memory: "1Gi"
replicas: 1
image: vesoft/nebula-graphd
version: v2.6.2
version: v3.0.2
service:
type: NodePort
externalTrafficPolicy: Local
Expand All @@ -32,7 +32,7 @@ spec:
memory: "1Gi"
replicas: 1
image: vesoft/nebula-metad
version: v2.6.2
version: v3.0.2
dataVolumeClaim:
resources:
requests:
Expand All @@ -53,7 +53,7 @@ spec:
memory: "1Gi"
replicas: 3
image: vesoft/nebula-storaged
version: v2.6.2
version: v3.0.2
dataVolumeClaim:
resources:
requests:
Expand Down
2 changes: 1 addition & 1 deletion doc/user/custom_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ spec:
memory: "1Gi"
replicas: 1
image: vesoft/nebula-graphd
version: v2.6.2
version: v3.0.2
storageClaim:
resources:
requests:
Expand Down
2 changes: 1 addition & 1 deletion doc/user/nebula_cluster_helm_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ The following table lists is the configurable parameters of the chart and their
| Parameter | Description | Default |
|:---------|:-----------|:-------|
| `nameOverride` | Override the name of the chart | `nil` |
| `nebula.version` | Nebula version | `v2.6.2` |
| `nebula.version` | Nebula version | `v3.0.2` |
| `nebula.imagePullPolicy` | Nebula image pull policy | `Always` |
| `nebula.storageClassName` | PersistentVolume class, default to use the default StorageClass | `nil` |
| `nebula.schedulerName` | Scheduler for nebula component | `default-scheduler` |
Expand Down
6 changes: 3 additions & 3 deletions pkg/controller/nebulacluster/nebula_cluster_control_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ func newNebulaCluster() *v1alpha1.NebulaCluster {
},
},
Image: "vesoft/graphd",
Version: "v2.6.2",
Version: "v3.0.2",
},
},
Metad: &v1alpha1.MetadSpec{
Expand All @@ -185,7 +185,7 @@ func newNebulaCluster() *v1alpha1.NebulaCluster {
},
},
Image: "vesoft/metad",
Version: "v2.6.2",
Version: "v3.0.2",
},
},
Storaged: &v1alpha1.StoragedSpec{
Expand All @@ -198,7 +198,7 @@ func newNebulaCluster() *v1alpha1.NebulaCluster {
},
},
Image: "vesoft/storaged",
Version: "v2.6.2",
Version: "v3.0.2",
},
},
},
Expand Down