file-controller

An operator to make sure a given list of file in given directory exists (create them when not exists).

Description

This operator watches filekeepers.files.felinae98.cn resource, and track files in dir and create file in files. For example,

apiVersion: file.felinae98.cn/v1
kind: FileKeeper
metadata:
  name: filekeeper-sample
spec:
  dir: /tmp/a
  files:
    - file1
    - file4

the operator will track files in /tmp/a, and make sure /tmp/a/file1 and /tmp/a/file2 exists. And the status of this resource shows the files in /tmp/a of each node.

Assume that you have a cluster with two nodes, the status of filekeeper resource will show as follows:

Status:
  Exsiting Files:
    k8s-node1: # <- node name
      file1 # <- file name of files in `/tmp/a` in k8s-node1
      file4
    k8s-node2:
      file1
      file4
      t1 # additional file in k8s-node2

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 Chart using helm

helm install <deploy name> ./helm

2. Apply your FileKeeper CR

kubectl apply -f config/samples

3. Uninstall this operator

helm uninstall <deploy name>

Devlopment

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

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.