Home

Awesome

<!-- SPDX-License-Identifier: MIT -->

Go Report Card GitHub release (latest SemVer) build OpenSSF Scorecard

garm-operator

<!-- toc --> <!-- /toc -->

✨ What is the garm-operator?

garm-operator is a Kubernetes® operator that manages the lifecycle of garm objects by creating/updating/deleting corresponding objects in the Kubernetes cluster.

garm components overview

🔀 Versioning

Garm Version

garm-operator is tightly coupled with the garm server. Therefore, the compatibility between garm-operator and garm is crucial.

garm-operatorgarmcompatible
0.4.x0.1.5:white_check_mark:
0.4.x0.1.4:x:
0.3.x0.1.4:white_check_mark:
0.3.x0.1.5:warning: It is not recommended to operate during a longer time period. This state mostly exists when you update the garm-operator from 0.3.x to 0.4.x

[!NOTE] please also read the operator update guide when you want to update the garm-operator.

Kubernetes Version

garm-operator uses client-go to talk with Kubernetes clusters. The supported Kubernetes cluster version is determined by client-go. The compatibility matrix for client-go and Kubernetes cluster can be found here.

🚀 Installation

Prerequisites

  1. A Kubernetes cluster you want to deploy the garm-operator.
  2. As we use ValidatingWebhooks for validation, cert-manager must be installed. (You can find the installation instructions here).
  3. You need to have a garm server up and running and reachable from within the Kubernetes cluster you want to deploy the garm-operator.

Deployment

garm-operator

We are releasing the garm-operator as container image together with the corresponding Kubernetes manifests. You can find the latest release here.

This manifests can be used to deploy the garm-operator into your Kubernetes cluster.

export GARM_OPERATOR_VERSION=<garm-operator-version>
export GARM_SERVER_URL=<garm-server-url> 
export GARM_SERVER_USERNAME=<garm-server-username>
export GARM_SERVER_PASSWORD=<garm-server-password>
export OPERATOR_WATCH_NAMESPACE=<operator-watch-namespace>
curl -L https://github.com/mercedes-benz/garm-operator/releases/download/${GARM_OPERATOR_VERSION}/garm-operator-all.yaml | envsubst | kubectl apply -f -

The full configuration parsing documentation can be found in the configuration parsing guide

Custom Resources

The CRD documentation can be also seen via docs.crds.dev.

Folder config/samples contains few basic examples of Pools, Images and corresponding Repositories, Organizations or Enterprises.

💻 Development

For local development, please read the development guide.

📋 ADRs

To make some assumptions and corresponding decisions transparent, we use ADRs (Architecture Decision Records) to document them.

All ADRs can be found here.

Contributing

We welcome any contributions. If you want to contribute to this project, please read the contributing guide.

Code of Conduct

Please read our Code of Conduct as it is our base for interaction.

License

This project is licensed under the MIT LICENSE.

Provider Information

Please visit https://www.mercedes-benz-techinnovation.com/en/imprint/ for information on the provider.

Notice: Before you use the program in productive use, please take all necessary precautions, e.g. testing and verifying the program with regard to your specific use. The program was tested solely for our own use cases, which might differ from yours.