Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/astarte-platform/astarte-kubernetes-operator

Astarte Kubernetes Operator
https://github.com/astarte-platform/astarte-kubernetes-operator

hacktoberfest iot iot-platform kubernetes-operator

Last synced: about 3 hours ago
JSON representation

Astarte Kubernetes Operator

Host: GitHub
URL: https://github.com/astarte-platform/astarte-kubernetes-operator
Owner: astarte-platform
License: apache-2.0
Created: 2019-03-18T16:00:15.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-11-12T15:34:06.000Z (5 days ago)
Last Synced: 2024-11-12T16:36:10.987Z (5 days ago)
Topics: hacktoberfest, iot, iot-platform, kubernetes-operator
Language: Go
Homepage: http://astarte-platform.org
Size: 3.98 MB
Stars: 22
Watchers: 5
Forks: 9
Open Issues: 11
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: SECURITY.md
- Authors: AUTHORS.md

Awesome Lists containing this project

README

# Astarte Kubernetes Operator

![CI](https://github.com/astarte-platform/astarte-kubernetes-operator/workflows/Operator%20e2e%20tests/badge.svg?branch=master)
[![Go Report Card](https://goreportcard.com/badge/github.com/astarte-platform/astarte-kubernetes-operator)](https://goreportcard.com/report/github.com/astarte-platform/astarte-kubernetes-operator)
[![License](http://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)
![Docker Pulls](https://img.shields.io/docker/pulls/astarte/astarte-kubernetes-operator)

Astarte Kubernetes Operator runs and manages an Astarte Cluster in a Kubernetes Cluster. It is meant
to work on any Managed Kubernetes installation, and leverages a number of Kubernetes features to
ensure Astarte runs as smooth as possible. It also handles upgrades, monitoring, and more.

Astarte Operator is the foundation of any Astarte installation, and you can find more information
about it and how to use it once installed in the
[Astarte Operator
guide](https://docs.astarte-platform.org/astarte-kubernetes-operator/snapshot/001-intro_administrator.html).

## Getting started

The preferred way to install and manage Astarte Operator leverages its [Helm
chart](https://artifacthub.io/packages/helm/astarte/astarte-operator).

Astarte Operator requires [`cert-manager`](https://cert-manager.io/) (`v1.7+`) to be installed in
the cluster in its default configuration. If you are using `cert-manager` in your cluster already
you don't need to take any action - otherwise, you will need to install it. A complete overview on
prerequisites can be found
[here](https://docs.astarte-platform.org/astarte-kubernetes-operator/snapshot/020-prerequisites.html).

To install `cert-manager` simply run:
```bash
helm repo add jetstack https://charts.jetstack.io
helm repo update
kubectl create namespace cert-manager
helm install \
cert-manager jetstack/cert-manager \
--namespace cert-manager \
--version v1.13.3 \
--set installCRDs=true
```

Installing the operator is as simple as:
```bash
helm repo add astarte https://helm.astarte-platform.org
helm repo update
helm install astarte-operator astarte/astarte-operator
```

These instructions will take care of installing all needed components for the Operator to run. This
includes all the RBAC roles, Custom Resource Definitions, Webhooks, and the Operator itself.

Moreover, Helm is responsible for upgrading the Astarte Operator. To do so, run:
```bash
helm upgrade astarte-operator astarte/astarte-operator
```

If you are interested in having a deeper understanding on how the Astarte Operator works you should
follow the [Astarte Operator Administration
guide](https://docs.astarte-platform.org/astarte-kubernetes-operator/snapshot/001-intro_administrator.html).

### What's next?

Once your Astarte Operator is up and running in your cluster, it will be time to deploy your Astarte
instance! All you have to do is [Setting up the
Cluster](https://docs.astarte-platform.org/astarte-kubernetes-operator/snapshot/060-setup_cluster.html).

## Kubernetes support

| Kubernetes Version | Supported | Tested by CI |
|--------------------|------------------------|--------------------|
| v1.25.x | :large_orange_diamond: | :x: |
| v1.26.x | :white_check_mark: | :white_check_mark: |
| v1.27.x | :white_check_mark: | :white_check_mark: |
| v1.28.x | :white_check_mark: | :white_check_mark: |
| v1.29.x | :white_check_mark: | :white_check_mark: |
| v1.30.x | :white_check_mark: | :white_check_mark: |

Key:

* :white_check_mark: : Supported and stable.
* :large_orange_diamond: : Partially supported / known to run in production, but not being targeted
by the release.
* :x: : Not supported. Run at your own risk.

## Compatibility Matrix

| Astarte Operator Version | Astarte Version | Kubernetes Version |
|:------------------------:|:---------------:|:------------------:|
| v22.11 | v1.0+ | v1.22+ |
| v23.5 | v1.0+ | v1.22+ |
| v24.5 | v1.0+ | v1.24+ |

## Development

Astarte's Operator is written in Go and built upon [Operator
SDK](https://github.com/operator-framework/operator-sdk). It depends on Go 1.19, requires Go
Modules and Kubernetes v1.24+.

The project is built with kustomize v3.8.7, controller-gen v0.10.0 and conversion-gen v0.19.16.