docs(): add docs for vm image values and workarround (#30)

Author: EZ4BRUCE

README.md

@@ -139,6 +139,20 @@ kubectl get secret -n ${OBNS} grafana-admin-secret  -o jsonpath="{.data['admin-p
 # 进阶配置
 
 
+## mo-ob-opensource 从 1.0.8 升级到 1.0.9+
+
+从 1.0.9 开始引入了 victoria-metrics-k8s-stack 组件，如果需要从现有的 mo-ob 升级，则为了避免 [#4699](https://github.com/matrixorigin/MO-Cloud/issues/4699) 的问题，在 upgrade 前需要先手动 apply vm 的 crd
+
+
+![alt text](docs/chart/images/image.png)
+
+etc/crds/vm-crd.yaml 来自 victoria-metrics-operator 0.40.1 内，且已经以在 namespace=mo-ob，release=mo-ob-opensource 下设置好了相应的 annotate 和 label，可以直接 apply，如上图所示，如果有定制需求，需要修改上图中的 namespace 和 release 的值
+
+
+```
+kubectl apply -f etc/crds/vm-crd.yaml
+```
+
 ## 需要替换的镜像源
 
 如果部署的时候发现 image pull failed 等错误，需要替换镜像源（如阿里云），这些被替换的镜像都已经显示的写在了 chart 的 values.yaml 下，如 `charts/mo-ob-opensource/values.yaml` 下

charts/mo-ob-opensource/values.yaml

@@ -382,6 +382,10 @@ victoria-metrics-k8s-stack:
   # -- VictoriaMetrics Operator dependency chart configuration. More values can be found [here](https://docs.victoriametrics.com/helm/victoriametrics-operator#parameters). Also checkout [here](https://docs.victoriametrics.com/operator/vars) possible ENV variables to configure operator behaviour
   victoria-metrics-operator:
     enabled: true
+    image:
+      registry: ""
+      repository: victoriametrics/operator
+      tag: "v0.51.1"
     crds:
       plain: true
       cleanup:
@@ -433,13 +437,17 @@ victoria-metrics-k8s-stack:
     enabled: true
     # -- Full spec for VMSingle CRD. Allowed values describe [here](https://docs.victoriametrics.com/operator/api#vmsinglespec)
     spec:
+      image:
+        repository: victoriametrics/victoria-metrics
+        tag: "v1.108.1"
       port: "8429"
       # -- Data retention period. Possible units character: h(ours), d(ays), w(eeks), y(ears), if no unit character specified - month. The minimum retention period is 24h. See these [docs](https://docs.victoriametrics.com/single-server-victoriametrics/#retention)
       retentionPeriod: "5d"
       replicaCount: 1
       storage:
         accessModes:
           - ReadWriteOnce
+        storageClassName:
         resources:
           requests:
             storage: 40Gi      
@@ -458,7 +466,11 @@ victoria-metrics-k8s-stack:
     remoteWriteVMAgent: false
     # -- (object) Full spec for VMAlert CRD. Allowed values described [here](https://docs.victoriametrics.com/operator/api#vmalertspec)
     spec:
+      image:
+        repository: victoriametrics/vmalert
+        tag: "v1.108.1"
       port: "8080"
+      configReloaderImageTag: jimmidyson/configmap-reload:v0.3.0
       selectAllByDefault: true
       evaluationInterval: 15s
       extraArgs:
@@ -473,7 +485,8 @@ victoria-metrics-k8s-stack:
             key: password
             name: alertmanager-auth-secret 
       # External labels to add to all generated recording rules and alerts
-      externalLabels: {}
+      externalLabels: 
+        clusterDetail: dev-controlplane
 
   vmagent:
     # -- Create VMAgent CR
@@ -482,7 +495,11 @@ victoria-metrics-k8s-stack:
     annotations: {}
     # -- (object) Full spec for VMAgent CRD. Allowed values described [here](https://docs.victoriametrics.com/operator/api#vmagentspec)
     spec:
+      image:
+        repository: victoriametrics/vmagent
+        tag: "v1.108.1"
       port: "8429"
+      configReloaderImageTag: quay.io/prometheus-operator/prometheus-config-reloader:v0.68.0
       selectAllByDefault: true
       additionalScrapeConfigs:
         name: vm-additional-scrape-configs

docs/chart/images/image.png

@@ -0,0 +1,3 @@
+## vm-crd.yaml
+
+请见根目录 [README](../../README.md) 的 “进阶配置-mo-ob-opensource 从 1.0.8 升级到 1.0.9+” 章节