Deploying Rsyslog Relp Extension in Gardener’s Remote Setup

Prerequisites

• Make sure that you have a running Gardener remote setup. The steps to complete this can be found in the Deploying Gardener Remotely guide.

TIP

Ensure that the locally used Gardener version matches the version specified by the github.com/gardener/gardener dependency. The extension’s remote setup must run successfully against a Gardener remote setup at the version referenced by this dependency.

NOTE

The location of the Gardener project is expected to be under the same root (e.g. ~/go/src/github.com/gardener/). If this is not the case, the location of Gardener project should be specified in GARDENER_REPO_ROOT environment variable:

export GARDENER_REPO_ROOT="<path_to_gardener_project>"

Setting up the Rsyslog Relp Extension

make remote-extension-up

The corresponding make target will build the shoot-rsyslog-relp, shoot-rsyslog-relp-admission container images, OCI artifacts for the admission runtime and application charts, and the extension chart. Then, the container images and the OCI artifacts are pushed into the container registry in the remote Gardener cluster. Next, the shoot-rsyslog-relp Extension.operator.gardener.cloud resource is deployed into the Gardener runtime cluster. Based on this resource the gardener-operator will deploy the shoot-rsyslog-relp admission component in the Gardener runtime cluster, as well as the shoot-rsyslog-relp ControllerDeployment and ControllerRegistration resources in the virtual Gardener cluster.

Creating a Shoot Cluster

NOTE

Make sure that your KUBECONFIG environment variable is targeting the virtual Garden cluster (i.e. <path_to_gardener_project>/dev-setup/kubeconfigs/virtual-garden/kubeconfig).

Once the above step is completed, you can create a Shoot cluster. In order to create a Shoot cluster, please create your own Shoot definition depending on providers on your Seed cluster.

Configuring the Shoot Cluster and deploying the Rsyslog Relp Echo Server

To be able to properly test the rsyslog relp extension you need a running rsyslog relp echo server to which logs from the Shoot nodes can be sent. To deploy the server and configure the rsyslog relp extension on your Shoot cluster you can run:

make configure-shoot SHOOT_NAME=<shoot-name> SHOOT_NAMESPACE=<shoot-namespace>

This command will deploy an rsyslog relp echo server in your Shoot cluster in the rsyslog-relp-echo-server namespace. It will also add configuration for the shoot-rsyslog-relp extension to your Shoot spec by patching it with ./example/extension/<shoot-name>--<shoot-namespace>--extension-config-patch.yaml. This file is automatically copied from extension-config-patch.yaml.tmpl in the same directory when you run make configure-shoot for the first time. The file also includes explanations of the properties you should set or change. The command will also deploy the rsyslog-relp-tls secret in case you wish to enable tls.

Tearing Down the Development Environment

To tear down the development environment, delete the Shoot cluster or disable the shoot-rsyslog-relp extension in the Shoot’s specification. When the extension is not used by the Shoot anymore, you can run:

make remote-extension-down

The corresponding make target will delete the Extension.operator.gardener.cloud resource. Consequently, the gardener-operator will delete the shoot-rsyslog-relp admission component and shoot-rsyslog-relp ControllerDeployment and ControllerRegistration resources.