s3-operator

Kubernetes operator to manage s3 buckets

Description

Example:

apiVersion: s3.onestein.nl/v1
kind: Bucket
metadata:
  name: bucket-sample
spec:
  name: s3-operator-test-bucket
  secret: "s3-credentials"
  accessKey: "a-key-in-secret"
  secretKey: "a-key-in-secret"
  endpointKey: "a-key-in-secret"
  deletionPolicy: Always
status:
  available: true
  hash: "sha1-hash"

• spec.name: The name of bucket
• spec.secret: Secret containing the S3 credentials
• spec.accessKey: The key within the secret that contains the access key (default: "accessKey")
• spec.secretKey: The key within the secret that contains the secret key (default: "secretKey")
• spec.endpointKey: The key within the secret that contains the endpoint (default: "endpointKey")
• spec.deletionPolicy: Determines what should happen with the bucket if the resource is deleted Valid values are:
  • "Always" (default): Deletes the bucket even if it contains objects;
  • "OnlyIfEmpty": Only delete bucket if is has no objects
  • "Preserve": Never delete the bucket
• status.available: true if the bucket is present
• status.hash: used to check if a bucket is the same

N.B. When a bucket (CR) is deleted, it checks whether the bucket is used somewhere else before proceeding with the deletion.

Environment variables

• DEFAULT_S3_ENDPOINT: Default endpoint applied when no secret (spec.secret) is specified
• DEFAULT_S3_ACCESS_KEY: Default access key applied when no secret (spec.secret) is specified
• DEFAULT_S3_SECRET_KEY: Default secret key applied when no secret (spec.secret) is specified
• DEFAULT_S3_REGION: Default region applied when no region is specified

Getting Started

Prerequisites

• go version v1.22.0+
• docker version 17.03+.
• kubectl version v1.11.3+.
• Access to a Kubernetes v1.11.3+ cluster.

To Deploy on the cluster

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

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

NOTE: This image ought to be published in the personal registry you specified. And it is required to have access to pull the image from the working environment. Make sure you have the proper permission to the registry if the above commands don’t work.

Install the CRDs into the cluster:

make install

Deploy the Manager to the cluster with the image specified by IMG:

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

NOTE: If you encounter RBAC errors, you may need to grant yourself cluster-admin privileges or be logged in as admin.

Create instances of your solution You can apply the samples (examples) from the config/sample:

kubectl apply -k config/samples/

NOTE: Ensure that the samples has default values to test it out.

To Uninstall

Delete the instances (CRs) from the cluster:

kubectl delete -k config/samples/

Delete the APIs(CRDs) from the cluster:

make uninstall

UnDeploy the controller from the cluster:

make undeploy

Project Distribution

Following are the steps to build the installer and distribute this project to users.

1. Build the installer for the image built and published in the registry:

make build-installer IMG=<some-registry>/s3-operator:tag

NOTE: The makefile target mentioned above generates an 'install.yaml' file in the dist directory. This file contains all the resources built with Kustomize, which are necessary to install this project without its dependencies.

2. Using the installer

Users can just run kubectl apply -f to install the project, i.e.:

kubectl apply -f https://raw.githubusercontent.com/<org>/s3-operator/<tag or branch>/dist/install.yaml

Contributing

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

More information can be found via the Kubebuilder Documentation

License

Copyright 2024.

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.