k8soperator

README

k8soperator

// TODO(user): Add simple overview of use/purpose

Description

// TODO(user): An in-depth paragraph about your project and overview of use

Getting Started

You’ll need a Kubernetes cluster to run against. You can use KIND to get a local cluster for testing, or run against a remote cluster. Note: Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster kubectl cluster-info shows).

Running on the cluster

1. Install Instances of Custom Resources:

kubectl apply -f config/samples/

1. Build and push your image to the location specified by IMG:

make docker-build docker-push IMG=<some-registry>/k8soperator:tag

1. Deploy the controller to the cluster with the image specified by IMG:

make deploy IMG=<some-registry>/k8soperator:tag

Uninstall CRDs

To delete the CRDs from the cluster:

make uninstall

Undeploy controller

UnDeploy the controller to the cluster:

make undeploy

Contributing

// TODO(user): Add detailed information on how you would like others to contribute to this project

How it works

This project aims to follow the Kubernetes Operator pattern

It uses Controllers which provides a reconcile function responsible for synchronizing resources untile the desired state is reached on the cluster

Test It Out

1. Install the CRDs into the cluster:

make install

1. Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):

make run

NOTE: You can also run this in one step by running: make install run

Modifying the API definitions

If you are editing the API definitions, generate the manifests such as CRs or CRDs using:

make manifests

NOTE: Run make --help for more information on all potential make targets

More information can be found via the Kubebuilder Documentation

License

Copyright 2022.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

收到指定生成对应的 type文件

修改下版本: makefile

CONTROLLER_TOOLS_VERSION ?= v0.8.0
清理掉/bin下的2个文件

创建CRD

$ kubectl.exe apply -f config/samples/traefik_v1_service.yaml 
service.traefik.magedu.go8/service-sample created

获取 CRD实例

$ kubectl.exe get services.traefik.magedu.go8
NAME             AGE
service-sample   2m32s

查询CRD资源详情

kubectl.exe describe services.traefik.magedu.go8 service-sample

CRD + Controller 调试

1. 启动我们的Controller(本地)

make run

1. 创建CRD

$ kubectl.exe apply -f config/samples/traefik_v1_service.yaml

1. 查看Controller 有没有修改状态:

 kubectl.exe describe service.traefik.magedu.go8/service-sample