acumino / gardener-extension-shoot-rsyslog-relp

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

reuse compliant

Project Gardener implements the automated management and operation of Kubernetes clusters as a service. Its main principle is to leverage Kubernetes concepts for all of its tasks.

Recently, most of the vendor specific logic has been developed in-tree. However, the project has grown to a size where it is very hard to extend, maintain, and test. With GEP-1 we have proposed how the architecture can be changed in a way to support external controllers that contain their very own vendor specifics. This way, we can keep Gardener core clean and independent.

This controller implements Gardener's extension contract for the shoot-rsyslog-relp extension.

An example for a ControllerRegistration resource that can be used to register this controller to Gardener can be found here.

Please find more information regarding the extensibility concepts and a detailed proposal here.

Configuration

Example configuration for this extension controller:

apiVersion: rsyslog-relp.extensions.config.gardener.cloud/v1alpha1
kind: RsyslogRelpConfig
target: relp-server.foo.bar
port: 1520
tls:
  enabled: true
  authMode: name
  permittedPeer: rsyslog-server-peer
  secretReferenceName: rsyslog-relep-tls

Extension Resources

Example extension resource:

apiVersion: extensions.gardener.cloud/v1alpha1
kind: Extension
metadata:
  name: extension-shoot-rsyslog-relp
  namespace: shoot--project--abc
spec:
  type: shoot-rsyslog-relp

When an extension resource is reconciled, the extension controller will create a daemonset in the Shoot cluster which will configure rsyslog that is already installed on gardenlinux and suse-chost nodes. It will take care of provisioning any secrets and custom filters required by rsyslog on the nodes. If the Shoot workers do not run gardenlinux or suse-chost the daemonset is still created, however it will have no effect. The daemonset will also configure auditd rules so that audit logs can be forwarded to rsyslog.

Please note, this extension controller relies on the Gardener-Resource-Manager to deploy k8s resources to seed and shoot clusters.

How to start using or developing this extension controller locally

You can run the controller locally on your machine by executing make start.

We are using Go modules for Golang package dependency management and Ginkgo/Gomega for testing.

Feedback and Support

Feedback and contributions are always welcome. Please report bugs or suggestions as GitHub issues or join our Slack channel #gardener (please invite yourself to the Kubernetes workspace here).

Learn more!

Please find further resources about out project here:

About

License:Other


Languages

Language:Go 86.8%Language:Shell 6.7%Language:Makefile 4.7%Language:Smarty 1.0%Language:Dockerfile 0.9%