install.md

Installation

English | 简体中文

usage

It could have two kinds of scenes to install spiderpool:

• spiderpool for underlay NICs

  For this use case, the cluster could use one or more underlay CNI to run pods.

  When one or more underlay NIC in a pod, spiderpool could help assign IP address, tune routes, connect the pod and local node, detect IP conflict etc.

• spiderpool for overlay and underlay NICs

  For this use case, the cluster could use one overlay CNI and other underlay CNI to run pods.

  When one or more NIC of different NIC in a pod, spiderpool could help assign IP address, tune routes, connect the pod and local node, detect IP conflict etc.

Install Spiderpool in Underlay NICs

Any CNI project compatible with third-party IPAM plugins, can work well with spiderpool, such as: macvlan CNI, vlan CNI, ipvlan CNI, sriov CNI, ovs CNI, Multus CNI, calico CNI, weave CNI

The following examples are guides to install spiderpool:

• macvlan in Kind

• SRIOV CNI, this is suitable for scenes like bare metal host.

• calico CNI

• weave CNI

• ovs CNI, this is suitable for scenes like bare metal host.

Installation for underlay CNI on Cloud infrastruct

• alibaba cloud

• vmware vsphere

• openstack

• aws cloud

Installation for adding an auxiliary underlay CNI NIC for overlay CNI

The following examples are guides to install spiderpool:

• calico and macvlan CNI

• cilium and macvlan CNI

Uninstall

Generally, you can uninstall Spiderpool release in this way:

helm uninstall spiderpool -n kube-system

However, there are finalizers in some CRs of Spiderpool, the helm uninstall cmd may not clean up all relevant CRs. Get this cleanup script and execute it to ensure that unexpected errors will not occur when deploying Spiderpool next time.

wget https://raw.githubusercontent.com/spidernet-io/spiderpool/main/tools/scripts/cleanCRD.sh
chmod +x cleanCRD.sh && ./cleanCRD.sh