README
¶
Gardener Extension for K3OS
⚠ WARNING: THIS EXTENSION IS IN A PRELIMINARY STATE ⚠
It is more meant as an idea for an extension than productive software
If you are interested in this topic, feel free to contact us
This controller operates on the OperatingSystemConfig resource in the extensions.gardener.cloud/v1alpha1 API group. It manages those objects that are requesting K3OS configuration (.spec.type=k3os):
---
apiVersion: extensions.gardener.cloud/v1alpha1
kind: OperatingSystemConfig
metadata:
name: pool-01-original
namespace: default
spec:
type: k3os
units:
...
files:
...
Please find a concrete example in the example folder.
After reconciliation the resulting data will be stored in a secret within the same namespace (as the config itself might contain confidential data). The name of the secret will be written into the resource's .status field:
...
status:
...
cloudConfig:
secretRef:
name: osc-result-pool-01-original
namespace: default
command: /usr/bin/env bash <path>
units:
- docker-monitor.service
- kubelet-monitor.service
- kubelet.service
The secret has one data key cloud_config that stores the generation.
An example for a ControllerRegistration resource that can be used to register this controller to Gardener can be found here.
This controller is based on revision cb4cbfc4 of gardener-extension-os-gardenlinux. Its implementation is using the oscommon library for operating system configuration controllers.
Please find more information regarding the extensibility concepts and a detailed proposal here.
How to start using or developing this extension controller locally
You can run the controller locally on your machine by executing make start. Please make sure to have the kubeconfig to the cluster you want to connect to ready in the ./dev/kubeconfig file.
Static code checks and tests can be executed by running VERIFY=true make all. 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:
Directories
¶
| Path | Synopsis |
|---|---|
|
charts
|
|
|
gardener-extension-os-k3os
Package chart enables go:generate support for generating the correct controller registration.
|
Package chart enables go:generate support for generating the correct controller registration. |
|
cmd
|
|
|
pkg
|
|