diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index ed11cb977d..3a4b2a3ba0 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -78,7 +78,7 @@ nav: - IPAM of SpiderIPPool: usage/spider-ippool.md - IPAM of IPPool Affinity: usage/spider-affinity.md - IPAM of SpiderSubnet: usage/spider-subnet.md - - IPAM for custom controllers: usage/third-party-controller.md + - IPAM for operator: usage/operator.md - IPAM for StatefulSet: usage/statefulset.md - IPAM of Reserved IP: usage/reserved-ip.md - MultipleInterfaces: usage/multi-interfaces-annotation.md diff --git a/docs/usage/operator-zh_CN.md b/docs/usage/operator-zh_CN.md new file mode 100644 index 0000000000..54cbc1d249 --- /dev/null +++ b/docs/usage/operator-zh_CN.md @@ -0,0 +1,3 @@ +# IPAM 对 operator 支持 + +**简体中文** ｜ [**English**](./operator.md) diff --git a/docs/usage/third-party-controller.md b/docs/usage/operator.md similarity index 97% rename from docs/usage/third-party-controller.md rename to docs/usage/operator.md index 64e765bc25..5a909e66ad 100644 --- a/docs/usage/third-party-controller.md +++ b/docs/usage/operator.md @@ -1,6 +1,6 @@ -# IPAM for third-party controllers +# IPAM for operator -**简体中文** | [**English**](./third-party-controller-zh_CN.md) +**English** | [**简体中文**](./operator-zh_CN.md) ## Description @@ -29,7 +29,7 @@ So Spiderpool treats them as `stateless` Pod like `Deployment`, this means Pods ## Get Started -It will use [OpenKruise](https://openkruise.io/zh/docs/) to demonstrate how Spiderpool supports third-party controllers. +It will use [OpenKruise](https://openkruise.io/zh/docs/) to demonstrate how Spiderpool supports operator. ### Set up Spiderpool diff --git a/docs/usage/readme-zh_CN.md b/docs/usage/readme-zh_CN.md index 215186c809..3f8b544dab 100644 --- a/docs/usage/readme-zh_CN.md +++ b/docs/usage/readme-zh_CN.md @@ -86,7 +86,7 @@ 这能够减少大量的运维负担，可参考[例子](./spider-subnet-zh_CN.md)。 该功能除了支持 K8S 原生的应用控制器，同时支持基于 operator 实现的第三方应用控制器。 - 可参考[例子](./third-party-controller-zh_CN.md)。 + 可参考[例子](./operator-zh_CN.md)。 - 可以设置集群级别的默认 IP 池，也可租户级别的默认 IP 池。同时，IP 池既可以被整个集群共享， 也可被限定为被一个租户使用。可参考[例子](./spider-affinity-zh_CN.md)。 diff --git a/docs/usage/readme.md b/docs/usage/readme.md index e9fb92db7d..76e581ce17 100644 --- a/docs/usage/readme.md +++ b/docs/usage/readme.md @@ -87,7 +87,7 @@ For instructions on how to upgrade Spiderpool, please refer to the [upgrade guid It automates IP pool management for applications with fixed IP requirements, enabling automatic creation, scaling, and deletion of fixed IP pools. This greatly reduces operational burden. See the [example](./spider-subnet.md) for practical use cases. - In addition to supporting native Kubernetes application controllers, Spiderpool's Subnet feature complements third-party application controllers implemented using operators. Refer to the [example](./third-party-controller.md) for more details. + In addition to supporting native Kubernetes application controllers, Spiderpool's Subnet feature complements third-party application controllers implemented using operators. Refer to the [example](./operator.md) for more details. - Default IP pools can be set at either the cluster-level or tenant-level. IP pools can be shared throughout the entire cluster or restricted to specific tenants. Check out the [example](./spider-affinity.md) for details. diff --git a/docs/usage/spider-subnet-zh_CN.md b/docs/usage/spider-subnet-zh_CN.md index 664aa03ef5..e021f19f26 100644 --- a/docs/usage/spider-subnet-zh_CN.md +++ b/docs/usage/spider-subnet-zh_CN.md @@ -16,7 +16,7 @@ SpiderSubnet 资源代表 IP 地址的集合，当需要为应用分配固定的 - 自动创建 IPPool : 应用管理员可在 Pod annotation 中注明使用的 Subnet 实例名，在应用创建时，Spiderpool 会自动根据 Subnet 实例中的可用 IP 地址来创建固定 IP 的 IPPool 实例，从中分配 IP 地址给 Pod。并且 Spiderpool 能够自动监控应用的扩缩容和删除事件，自动完成 IPPool 中的 IP 地址扩缩容和删除。 -SpiderSubnet 功能还支持众多的控制器，如：ReplicaSet、Deployment、Statefulset、Daemonset、Job、Cronjob，第三方控制器等。对于第三方控制器，您可以参考[示例](./third-party-controller.md) +SpiderSubnet 功能还支持众多的控制器，如：ReplicaSet、Deployment、Statefulset、Daemonset、Job、Cronjob，第三方控制器等。对于第三方控制器，您可以参考[示例](./operator.md) > 注意：在 v0.7.0 版本之前，在启动 SpiderSubnet 功能下你必须得先创建一个 SpiderSubnet 资源才可以创建 SpiderIPPool 资源。在v0.7.0版本开始，支持创建一个独立的 SpiderIPPool 资源而不依赖于 SpiderSubnet 资源。 diff --git a/docs/usage/spider-subnet.md b/docs/usage/spider-subnet.md index 381ada6faf..76cee878d2 100644 --- a/docs/usage/spider-subnet.md +++ b/docs/usage/spider-subnet.md @@ -17,7 +17,7 @@ To allocate fixed IP addresses for applications and decouple the roles of applic - Automatically create IPPool: application administrators can specify the name of the Subnet instance in the Pod annotation. Spiderpool automatically creates an IPPool instance with fixed IP addresses coming from the Subnet instance. The IP addresses in the instance are then allocated to Pods. Spiderpool also monitors application scaling and deletion events, automatically adjusting the IP pool size or removing IPs as needed. -SpiderSubnet also supports several controllers, including ReplicaSet, Deployment, StatefulSet, DaemonSet, Job, CronJob, and third-party controllers. If you need to use a third-party controller, you can refer to the doc [Spiderpool supports third-party controllers](./third-party-controller.md). +SpiderSubnet also supports several controllers, including ReplicaSet, Deployment, StatefulSet, DaemonSet, Job, CronJob, and k8s extended operator. If you need to use a third-party controller, you can refer to the doc [Spiderpool supports operator](./operator.md). > Notice: Before v0.7.0 version, you have to create a SpiderSubnet resource before you create a SpiderIPPool resource with SpiderSubnet feature enabled. Since v0.7.0 version, you can create an orphan SpiderIPPool without a SpiderSubnet resource. diff --git a/docs/usage/third-party-controller-zh_CN.md b/docs/usage/third-party-controller-zh_CN.md deleted file mode 100644 index 2f591a9ec4..0000000000 --- a/docs/usage/third-party-controller-zh_CN.md +++ /dev/null @@ -1,3 +0,0 @@ -# IPAM for third-party controllers - -**English** ｜ [**简体中文**](./third-party-controller.md) diff --git a/test/Makefile b/test/Makefile index d61af4487e..412ddf1e64 100644 --- a/test/Makefile +++ b/test/Makefile @@ -83,7 +83,7 @@ endif E2E_SPIDERPOOL_ENABLE_SUBNET=${E2E_SPIDERPOOL_ENABLE_SUBNET} \ scripts/install-multus.sh $(E2E_CLUSTER_NAME) $(E2E_KUBECONFIG) ifeq ($(INSTALL_KRUISE),true) - @echo -e "\033[35m [Step 9] Install third-party controllers: kurise \033[0m" + @echo -e "\033[35m [Step 9] Install operator: kurise \033[0m" @ make setup_kurise endif ifeq ($(INSTALL_KDOCTOR),true)