fix doc for v2.5.0 (#71)

* update doc (#52) * Update README.md (#53) * change note for openkruise the original note for openkruise didn't indicate the link between nebula-graph and openkruise. it's all about the nebula graph instead of openkruise. * fix doc for v2.5.0 Co-authored-by: kevin.qiao <[email protected]> Co-authored-by: Dashuang Li <[email protected]> Co-authored-by: Abby <[email protected]>
vesoft-inc · Sep 22, 2021 · e81dc23 · e81dc23
1 parent a87d229
commit e81dc23
Show file tree

Hide file tree

Showing 14 changed files with 37 additions and 30 deletions.
diff --git a/README.md b/README.md
@@ -63,7 +63,7 @@ Modify the file and change `replicas` from 3 to 5.
         memory: "1Gi"
     replicas: 5
     image: vesoft/nebula-storaged
-    version: v2.0.0
+    version: v2.5.0
     storageClaim:
       resources:
         requests:
@@ -101,7 +101,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.0.0
+    version: v2.5.0
     storageClaim:
       resources:
         requests:
@@ -155,7 +155,7 @@ Please refer to [FAQ.md](FAQ.md)
 ## Community
 Feel free to reach out if you have any questions. The maintainers of this project are reachable via:
 
-- [Filing an issue](https://github.com/vesoft-inc/nebula-operator/issue) against this repo
+- [Filing an issue](https://github.com/vesoft-inc/nebula-operator/issues) against this repo
 
 ## Contributing
 
@@ -169,4 +169,4 @@ nebula-operator refers to [tidb-operator](https://github.com/pingcap/tidb-operat
 
 ## License
 
-NebulaGraph is under the Apache 2.0 license. See the [LICENSE](./LICENSE) file for details.
+NebulaGraph is under the Apache 2.0 license. See the [LICENSE](./LICENSE) file for details.
diff --git a/charts/index.yaml b/charts/index.yaml
@@ -2,10 +2,10 @@ apiVersion: v1
 entries:
   nebula-cluster:
   - apiVersion: v2
-    appVersion: 0.1.0
-    created: "2021-09-16T16:19:58.816993896+08:00"
+    appVersion: 0.8.0
+    created: "2021-09-22T12:01:46.067787+08:00"
     description: Nebula Cluster Helm chart for Kubernetes
-    digest: edf2f840b19fc03b93b8a3c11bbe609a0be981062f205c23f02528ef8dd0372b
+    digest: 08f8f836ea930f798ecda9faab8133734fb6735d56e38a8b862424fc20c64149
     home: https://nebula-graph.io
     keywords:
     - kubernetes
@@ -24,14 +24,14 @@ entries:
     - https://github.com/vesoft-inc/nebula-storage
     - https://github.com/vesoft-inc/nebula-operator
     urls:
-    - https://vesoft-inc.github.io/nebula-operator/charts/nebula-cluster-0.1.0.tgz
-    version: 0.1.0
+    - https://vesoft-inc.github.io/nebula-operator/charts/nebula-cluster-0.8.0.tgz
+    version: 0.8.0
   nebula-operator:
   - apiVersion: v2
-    appVersion: 0.1.0
-    created: "2021-09-16T16:19:58.818392237+08:00"
+    appVersion: 0.8.0
+    created: "2021-09-22T12:01:46.068321+08:00"
     description: Nebula Operator Helm chart for Kubernetes
-    digest: 6d4a55fe209d7274e8625bef9a5c22a6063c8706839db9954003c8df06417271
+    digest: 088c9e02bc3051ff8acf338411d4978c389939c9e445cdd06ff2cf5cdfb91554
     home: https://nebula-graph.io
     keywords:
     - kubernetes
@@ -48,6 +48,6 @@ entries:
     sources:
     - https://github.com/vesoft-inc/nebula-operator
     urls:
-    - https://vesoft-inc.github.io/nebula-operator/charts/nebula-operator-0.1.0.tgz
-    version: 0.1.0
-generated: "2021-09-16T16:19:58.81598799+08:00"
+    - https://vesoft-inc.github.io/nebula-operator/charts/nebula-operator-0.8.0.tgz
+    version: 0.8.0
+generated: "2021-09-22T12:01:46.06719+08:00"
diff --git a/charts/nebula-cluster-0.1.0.tgz b/charts/nebula-cluster-0.1.0.tgz
diff --git a/charts/nebula-cluster-0.8.0.tgz b/charts/nebula-cluster-0.8.0.tgz
diff --git a/charts/nebula-cluster/Chart.yaml b/charts/nebula-cluster/Chart.yaml
@@ -1,8 +1,8 @@
 apiVersion: v2
 name: nebula-cluster
 description: Nebula Cluster Helm chart for Kubernetes
-version: 0.1.0
-appVersion: 0.1.0
+version: 0.8.0
+appVersion: 0.8.0
 home: https://nebula-graph.io
 sources:
 - https://github.com/vesoft-inc/nebula-graph

diff --git a/charts/nebula-operator-0.1.0.tgz b/charts/nebula-operator-0.1.0.tgz
diff --git a/charts/nebula-operator-0.8.0.tgz b/charts/nebula-operator-0.8.0.tgz
diff --git a/charts/nebula-operator/Chart.yaml b/charts/nebula-operator/Chart.yaml
@@ -1,8 +1,8 @@
 apiVersion: v2
 name: nebula-operator
 description: Nebula Operator Helm chart for Kubernetes
-version: 0.1.0
-appVersion: 0.1.0
+version: 0.8.0
+appVersion: 0.8.0
 home: https://nebula-graph.io
 sources:
 - https://github.com/vesoft-inc/nebula-operator

diff --git a/config/samples/apps_v1alpha1_nebulacluster.yaml b/config/samples/apps_v1alpha1_nebulacluster.yaml
@@ -13,7 +13,7 @@ spec:
         memory: "1Gi"
     replicas: 1
     image: vesoft/nebula-graphd
-    version: v2.0.0
+    version: v2.5.0
     service:
       type: NodePort
       externalTrafficPolicy: Local
@@ -32,7 +32,7 @@ spec:
         memory: "1Gi"
     replicas: 1
     image: vesoft/nebula-metad
-    version: v2.0.0
+    version: v2.5.0
     storageClaim:
       resources:
         requests:
@@ -48,7 +48,7 @@ spec:
         memory: "1Gi"
     replicas: 3
     image: vesoft/nebula-storaged
-    version: v2.0.0
+    version: v2.5.0
     storageClaim:
       resources:
         requests:

diff --git a/doc/user/add-ons.md b/doc/user/add-ons.md
@@ -6,22 +6,29 @@ This section links to third party projects that provide functionality required b
 ## coredns
 [CoreDNS](https://coredns.io/) is a flexible, extensible DNS server which can be [installed](https://github.com/coredns/deployment/tree/master/kubernetes) as the in-cluster DNS for pods.
 
+NebulaGraph each component can communicate via DNS like _x.default.svc.cluster.local_, coredns is used for address resolution.
+
 ## cert-manager
+**Note:**
+If you set helm chart nebula-operator _.Values.admissionWebhook.create_ to false, the cert-manager is not needed. 
+
 [cert-manager](https://cert-manager.io/) is a tool that automates certificate management. It makes use of extending the Kubernetes API server using a Webhook server to provide dynamic admission control over cert-manager resources. 
 
 Consult the [cert-manager installation documentation](https://cert-manager.io/docs/installation/kubernetes/) to get started.
 
+cert-manager is used for validating NebulaGraph each component replicas, if you run it in production environment and care high availability, you should set  _.Values.admissionWebhook.create_ to true and install cert-manager.
+
 ## openkruise
 **Note:**
-nebula-operator need advanced features for StatefulSet when it starts.
+Openkruise provides advanced features for StatefulSet which are needed for nebula-operator when nebula-operator starts. nebula-operator will update nebula cluster pod in-place instead of destroying it.
 
 [openkruise](https://openkruise.io/en-us/)  is a full set of standard extensions for Kubernetes. It works well with original Kubernetes and provides more powerful and efficient features for managing applications Pods, sidecar containers, and even images on Node.
 
 Consult the [openkruise installation documentation](https://openkruise.io/en-us/docs/installation.html) to get started.
 
 ## sig-storage-local-static-provisioner
 **Note:**
-Only you deploy NebulaGraph with local storage when it is required.
+It is required in the scenario that you deploy NebulaGraph with local storage.
 
 [local-static-provisioner](https://github.com/kubernetes-sigs/sig-storage-local-static-provisioner) manages the PersistentVolume lifecycle for pre-allocated disks by detecting and creating PVs for each local disk on the host, and cleaning up the disks when released. It does not support dynamic provisioning.
 

diff --git a/doc/user/custom_config.md b/doc/user/custom_config.md
@@ -24,7 +24,7 @@ spec:
         memory: "1Gi"
     replicas: 1
     image: vesoft/nebula-graphd
-    version: v2.0.0
+    version: v2.5.0
     storageClaim:
       resources:
         requests:

diff --git a/doc/user/install_guide.md b/doc/user/install_guide.md
@@ -36,7 +36,7 @@ $ helm install nebula-operator nebula-operator/nebula-operator --namespace=nebul
 Note:   
 If the corresponding nebula-system namespace does not exist, you can create the namespace first by running the _kubectl create namespace nebula-operator-system_ command.
 
-${chart_version} represents the chart version of Nebula Operator. For example, v0.1.0. You can view the currently supported versions by running the _helm search repo -l nebula-operator_ command.
+${chart_version} represents the chart version of Nebula Operator. For example, v0.8.0. You can view the currently supported versions by running the _helm search repo -l nebula-operator_ command.
 
 _See [configuration](#configure-operator) below._
 

diff --git a/doc/user/nebula_cluster_helm_guide.md b/doc/user/nebula_cluster_helm_guide.md
@@ -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.0.0` |
+| `nebula.version` | Nebula version | `v2.5.0` |
 | `nebula.imagePullPolicy` | Nebula image pull policy | `IfNotPresent` |
 | `nebula.storageClassName` | PersistentVolume class, default to use the default StorageClass | `nil` |
 | `nebula.schedulerName` | Scheduler for nebula component | `default-scheduler` |

diff --git a/pkg/controller/nebulacluster/nebula_cluster_control_test.go b/pkg/controller/nebulacluster/nebula_cluster_control_test.go
@@ -173,7 +173,7 @@ func newNebulaCluster() *v1alpha1.NebulaCluster {
 						},
 					},
 					Image:   "vesoft/graphd",
-					Version: "v2.0.0",
+					Version: "v2.5.0",
 				},
 			},
 			Metad: &v1alpha1.MetadSpec{
@@ -186,7 +186,7 @@ func newNebulaCluster() *v1alpha1.NebulaCluster {
 						},
 					},
 					Image:   "vesoft/metad",
-					Version: "v2.0.0",
+					Version: "v2.5.0",
 				},
 			},
 			Storaged: &v1alpha1.StoragedSpec{
@@ -199,7 +199,7 @@ func newNebulaCluster() *v1alpha1.NebulaCluster {
 						},
 					},
 					Image:   "vesoft/storaged",
-					Version: "v2.0.0",
+					Version: "v2.5.0",
 				},
 			},
 		},