docs: add 0.9.1 upgrade guides and update related commands in 0.9.0 #8262

michelle-0808 · 2024-10-11T02:41:51Z

No description provided.

codecov · 2024-10-11T02:50:34Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 62.85%. Comparing base (00ad81b) to head (0a474c2).
Report is 19 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #8262      +/-   ##
==========================================
+ Coverage   61.32%   62.85%   +1.53%     
==========================================
  Files         348      353       +5     
  Lines       40357    42568    +2211     
==========================================
+ Hits        24749    26757    +2008     
- Misses      13371    13504     +133     
- Partials     2237     2307      +70

Flag	Coverage Δ
unittests	`62.85% <ø> (+1.53%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

zjx20 · 2024-10-11T03:21:12Z

docs/user_docs/upgrade/upgrade with helm/upgrade-kubeblocks-to-0.9.1.md

+
+## Upgrade from KubeBlocks v0.9.0
+
+1. Set keepAddons.


How about "Preserve Addon resources during upgrade"?

How about "Preserve Addon resources during upgrade"?

Great suggestion! I've added this sentence as the purpose of step 1 in the section "Upgrade from KubeBlocks v0.8" and adjusted related contents in the upgrade guide for v0.9.0.
For the section "Upgrade from v0.9.0", the description is a little different since keepAddon is set as true by default in Helm. Users just need to check its value. But crd.enabled should be set as false to avoid automatic CRD installation.

crd.enabled can be set when upgrade kubeblocks. For preserve addon resource, recommend to run follow command:

kubectl annotate addons.extensions.kubeblocks.io -l app.kubernetes.io/name=kubeblocks helm.sh/resource-policy=keep

docs/user_docs/upgrade/upgrade with helm/upgrade-kubeblocks-to-0.9.md

docs/user_docs/upgrade/upgrade with helm/upgrade-kubeblocks-to-0.9.1.md

docs/user_docs/upgrade/upgrade-with-helm/upgrade-kubeblocks-to-0.9.1.md

zjx20 · 2024-10-17T08:06:08Z

docs/user_docs/upgrade/faq.md

+If you want to add the annotation for a specified Addon, replace `{addonName}` with the actual Addon name and run the command below.
+
+```bash
+kubectl annotate http://addons.extensions.kubeblocks.io {addonName} helm.sh/resource-policy=keep


http?

Fixed.

zjx20 · 2024-10-17T08:07:09Z

docs/user_docs/upgrade/faq.md

+kubectl annotate http://addons.extensions.kubeblocks.io {addonName} helm.sh/resource-policy=keep
+```
+
+If you want to check whether the annotation for an Addon was added succeddfully, replace `{addonName}` with the actual Addon name and run the command below.


"succeddfully"

"succeddfully"

Fixed.

zjx20 · 2024-10-17T08:09:50Z

docs/user_docs/upgrade/faq.md

+kubectl get addon -o json | jq '.items[] | {name: .metadata.name, annotations: .metadata.annotations}'
+```
+
+### Manually add an annotation for an Addon


Maybe "for Addons"

Maybe "for Addons"

Fixed.

zjx20 · 2024-10-17T08:31:50Z

docs/user_docs/upgrade/upgrade-with-helm/upgrade-kubeblocks-to-0.9.md

-    ```shell
-    kubectl replace -f https://github.com/apecloud/kubeblocks/releases/download/v0.9.0/kubeblocks_crds.yaml
+    ```bash
+    kubectl create -f https://github.com/apecloud/kubeblocks/releases/download/v0.9.0/dataprotection.kubeblocks.io_storageproviders.yaml


Why install this CRD only?

Why install this CRD only?

The upgrade process only requires installing this CRD and the process will handle the others.

zjx20 · 2024-10-17T08:36:19Z

docs/user_docs/upgrade/upgrade-with-kbcli/upgrade-kubeblocks-to-0.9.md

 kbcli addon index update kubeblocks

-kbcli addon upgrade xxx --force
+#Search available Addon versions


"# Search"

Fixed.

…8262) (cherry picked from commit 99c14f5)

ldming · 2024-10-18T03:09:59Z

docs/user_docs/upgrade/faq.md

+```bash
+kubectl get addon -o json | jq '.items[] | {name: .metadata.name, annotations: .metadata.annotations}'
+```
+


Recommend to use the following command for a more concise output

kubectl get addon -o json | jq '.items[] | {name: .metadata.name, resource_policy: .metadata.annotations["helm.sh/resource-policy"]}'

ldming · 2024-10-18T03:13:03Z

docs/user_docs/upgrade/faq.md

+If you want to check whether the annotation for an Addon was added successfully, replace `{addonName}` with the actual Addon name and run the command below.
+
+```bash
+kubectl get addon {addonName} -o json | jq '{name: .metadata.name, annotations: .metadata.annotations}'


kubectl get addon {addonName} -o json | jq '{name: .metadata.name, resource_policy: .metadata.annotations["helm.sh/resource-policy"]}'

ldming · 2024-10-18T03:19:24Z

docs/user_docs/upgrade/upgrade-with-helm/upgrade-kubeblocks-to-0.9.1.md

+
+# Update helm repo
+helm repo update
+


better to add command to search the addon available versions:

helm search repo kubeblocks-addons/{addon-name} --versions --devel

follow update command will specify the chart version x.y.z.

michelle-0808 added 2 commits October 10, 2024 19:19

docs: add 0.9.1 upgrade tutorials

1432cfa

docs: fix bugs

0f0b638

michelle-0808 self-assigned this Oct 11, 2024

michelle-0808 requested review from shanshanying and a team as code owners October 11, 2024 02:41

github-actions bot added the size/L Denotes a PR that changes 100-499 lines. label Oct 11, 2024

zjx20 reviewed Oct 11, 2024

View reviewed changes

michelle-0808 added 2 commits October 11, 2024 13:58

docs: update docs description

0ff0971

docs: add 0.9.1 upgrade guide

93ae3dc

zjx20 reviewed Oct 16, 2024

View reviewed changes

docs/user_docs/upgrade/upgrade-with-helm/upgrade-kubeblocks-to-0.9.1.md Outdated Show resolved Hide resolved

michelle-0808 added 3 commits October 17, 2024 15:54

docs: update 0.9.1 and 0.9.0 upgrade guides

0cecc84

docs: delete doris addon

e93d49f

docs: fix typos

820fb6b

zjx20 reviewed Oct 17, 2024

View reviewed changes

docs: update docs

023fd56

shanshanying approved these changes Oct 18, 2024

View reviewed changes

apecloud-bot added the approved PR Approved Test label Oct 18, 2024

docs: update docs

843f49b

github-actions bot removed the size/L Denotes a PR that changes 100-499 lines. label Oct 18, 2024

apecloud-bot removed the approved PR Approved Test label Oct 18, 2024

github-actions bot added the size/XL Denotes a PR that changes 500-999 lines. label Oct 18, 2024

docs: fix typos

0a474c2

zjx20 approved these changes Oct 18, 2024

View reviewed changes

apecloud-bot added the approved PR Approved Test label Oct 18, 2024

michelle-0808 merged commit 99c14f5 into main Oct 18, 2024
35 checks passed

michelle-0808 deleted the support/add-0.9.0-upgrade-guide branch October 18, 2024 03:55

github-actions bot added this to the Release 0.9.2 milestone Oct 18, 2024

michelle-0808 added a commit that referenced this pull request Oct 18, 2024

docs: add 0.9.1 upgrade guides and update related commands in 0.9.0 (#…

3cb36d7

…8262) (cherry picked from commit 99c14f5)

ldming reviewed Oct 18, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add 0.9.1 upgrade guides and update related commands in 0.9.0 #8262

docs: add 0.9.1 upgrade guides and update related commands in 0.9.0 #8262

michelle-0808 commented Oct 11, 2024

codecov bot commented Oct 11, 2024 •

edited

Loading

zjx20 Oct 11, 2024

michelle-0808 Oct 11, 2024 •

edited

Loading

ldming Oct 11, 2024 •

edited

Loading

zjx20 Oct 17, 2024

michelle-0808 Oct 17, 2024

zjx20 Oct 17, 2024

michelle-0808 Oct 17, 2024

zjx20 Oct 17, 2024

michelle-0808 Oct 17, 2024

zjx20 Oct 17, 2024

michelle-0808 Oct 17, 2024

zjx20 Oct 17, 2024

michelle-0808 Oct 17, 2024

ldming Oct 18, 2024

ldming Oct 18, 2024

ldming Oct 18, 2024

docs: add 0.9.1 upgrade guides and update related commands in 0.9.0 #8262

docs: add 0.9.1 upgrade guides and update related commands in 0.9.0 #8262

Conversation

michelle-0808 commented Oct 11, 2024

codecov bot commented Oct 11, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

michelle-0808 Oct 11, 2024 • edited Loading

Choose a reason for hiding this comment

ldming Oct 11, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Oct 11, 2024 •

edited

Loading

michelle-0808 Oct 11, 2024 •

edited

Loading

ldming Oct 11, 2024 •

edited

Loading