Categorygithub.com/AustrianDataLAB/execDAT-operator
modulepackage
0.2.0
Repository: https://github.com/austriandatalab/execdat-operator.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
11
Dependents
0
Files
89 SLOC

# README

execdat-operator

This operator is used to deploy execDAT instances on Kubernetes.

Description

ExecDAT is a tool to execute data analysis tasks on Kubernetes. It is designed to be used in a CI/CD pipeline to execute data analysis tasks on Kubernetes. It is based on the execDAT project.

Getting Started

Prerequisites

  • operator-sdk
  • container engine (docker, podman, ...)
  • kubernetes cluster (minikube, k3d, ...)

Test out the operator

make install
make run

Run using OLM

operator-sdk olm install
operator-sdk run bundle-upgrade ghcr.io/austriandatalab/execdat-operator-bundle:v0.2.0

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>/execdat-operator:tag
  1. Deploy the controller to the cluster with the image specified by IMG:
make deploy IMG=<some-registry>/execdat-operator:tag

Uninstall CRDs

To delete the CRDs from the cluster:

make uninstall

Undeploy controller

UnDeploy the controller to the cluster:

make undeploy

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 2023 Thomas Weber.

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.

# Packages

No description provided by the author
No description provided by the author
No description provided by the author