Upgrading Spiderpool Versions

This document describes breaking changes, as well as how to fix them, that have occurred at given releases. Please consult the segments from your current release until now before upgrading your spiderpool.

Upgrade to 0.3.6 from (<=0.3.5)

Description

There's a design flaw for SpiderSubnet feature in auto-created IPPool label. The previous label ipam.spidernet.io/owner-application corresponding value uses '-' as separative sign. For example, we have deployment ns398-174835790/deploy398-82311862 and the corresponding label value is Deployment-ns398-174835790-deploy398-82311862. It's very hard to unpack it to trace back what the application namespace and name is.
Now, we use '_' rather than '-' as slash for SpiderSubnet feature label ipam.spidernet.io/owner-application, and the upper case will be like Deployment_ns398-174835790_deploy398-82311862.
Reference PR: #1162
In order to support multiple interfaces with SpiderSubnet feature, we also add one more label for auto-created IPPool. The key is ipam.spidernet.io/interface, and the value is the corresponding interface name.

Operation steps

Find all auto-created IPPools, their name format is auto-${appKind}-${appNS}-${appName}-v${ipVersion}-${uid} such as auto-deployment-default-demo-deploy-subnet-v4-69d041b98b41.

Replace their label, just like this:

kubectl patch sp ${auto-pool} --type merge --patch '{"metadata": {"labels": {"ipam.spidernet.io/owner-application": ${AppLabelValue}}}}'

Add one more label

kubectl patch sp ${auto-pool} --type merge --patch '{"metadata": {"labels": {"ipam.spidernet.io/interface": "eth0"}}}}'

Update your Spiderpool components version and restart them all.

Upgrade to 0.4.0 from (<0.4.0)

Description

Due to the architecture adjustment, the SpiderEndpoint.Status.OwnerControllerType property is changed from None to Pod.

Operation steps

Find all SpiderEndpoint objects that their Status OwnerControllerType is None
Replace the subresource SpiderEndpoint.Status.OwnerControllerType property from None to Pod

Upgrade

This upgrade guide is intended for Spiderpool running on Kubernetes. If you have questions, feel free to ping us on the Slack channel.

NOTE: Read the full upgrade guide to understand all the necessary steps before performing them.

Upgrade steps

The following steps will describe how to upgrade all of the components from one stable release to a later stable release.

Setup the Helm repository and update:

~# helm repo add spiderpool https://spidernet-io.github.io/spiderpool
~# helm repo update spiderpool
...Successfully got an update from the "spiderpool" chart repository
Update Complete. ⎈Happy Helming!⎈

If the spiderpool-init pod exists it needs to be removed

Spiderpool-init Pod will help us initialize some environment information. It is very useful to delete it before upgrading.

~# kubectl get po -n kube-system spiderpool-init
NAME              READY   STATUS      RESTARTS   AGE
spiderpool-init   0/1     Completed   0          49m
~# kubectl delete po -n kube-system spiderpool-init
pod "spiderpool-init" deleted

Update version via helm

(Optional) Spiderpool chart version has changed, you can get the latest stable version with the following command, unzip the chart package and apply all crds.
```
~# helm search repo spiderpool --versions
...
~# helm fetch spiderpool/spiderpool --version <upgraded-version>
...
~# tar -xvf spiderpool-<upgraded-version>.tgz && cd spiderpool/crds
~# ls | grep '\.yaml$' | xargs -I {} kubectl apply -f {}
```
To upgrade spiderpool using Helm, you can change <upgraded-version> to any stable version.
```
helm upgrade --install spiderpool spiderpool/spiderpool --wait --debug --version <upgraded-version> \
    -n kube-system \
```
Running the previous command will overwrite the existing cluster's ConfigMap, so it is important to retain any existing options, either by setting them on the command line or storing them in a YAML file, similar to:
```
~# kubectl get cm -n kube-system spiderpool-conf -oyaml > my-config.yaml
```
The --reuse-values flag may only be safely used if the Spiderpool chart version remains unchanged, for example when helm upgrade is used to apply configuration changes without upgrading Spiderpool. Instead, if you want to reuse the values from your existing installation, save the old values in a values file, check the file for any renamed or deprecated values, and then pass it to the helm upgrade command as described above. You can retrieve and save the values from an existing installation with the following command:
```
helm get values spiderpool --namespace=kube-system -o yaml > old-values.yaml
```
Helm Optional:
Spider v0.7.0 brings some changes. Can be adapted through --set
1. In version 0.7.0, spiderpool integrates multus. If you have installed multus, pass --set multus.multusCNI.install=false to disable the installation when upgrading.
2. In version 0.7.0, the ipam.enableIPv6 value is changed to true by default. Determine the status of this value in your cluster configuration. If it is false, please change it through --set ipam.enableIPv6=false.
3. In version 0.7.0, the default value of ipam.enableSpiderSubnet was changed to false. Determine the status of this value in your cluster configuration. If it is true, change it with --set ipam.enableSpiderSubnet=true.

verify

You can verify that the upgraded version matches by running the following command.

~# helm list -A
NAME        NAMESPACE   REVISION    UPDATED                                 STATUS      CHART                           APP VERSION
spiderpool  kube-system 3           2023-08-31 23:29:28.884386053 +0800 CST deployed    spiderpool-<upgraded-version>   <upgraded-version>

~# kubectl get po -n kube-system | grep spiderpool
spiderpool-agent-22z7f                 1/1     Running     0                3m
spiderpool-agent-cjps5                 1/1     Running     0                3m
spiderpool-agent-mwpsp                 1/1     Running     0                3m
spiderpool-controller-647888ff-g5q4n   1/1     Running     0                3m
spiderpool-init                        0/1     Completed   0                3m

~# kubectl get po -n kube-system spiderpool-controller-647888ff-g5q4n -oyaml |grep image

~# kubectl get po -n kube-system spiderpool-agent-cjps5 -oyaml |grep image