github.com/ironcore-dev/gardener-extension-provider-ironcore@v0.3.2-0.20240314231816-8336447fb9a0/README.md (about)

     1  # [Gardener Extension for IronCore provider](https://gardener.cloud)
     2  
     3  [![REUSE status](https://api.reuse.software/badge/github.com/ironcore-dev/gardener-extension-provider-ironcore)](https://api.reuse.software/info/github.com/ironcore-dev/gardener-extension-provider-ironcore)
     4  [![Go Report Card](https://goreportcard.com/badge/github.com/ironcore-dev/gardener-extension-provider-ironcore)](https://goreportcard.com/report/github.com/ironcore-dev/gardener-extension-provider-ironcore)
     5  [![GitHub License](https://img.shields.io/static/v1?label=License&message=Apache-2.0&color=blue)](LICENSE)
     6  [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://makeapullrequest.com)
     7  
     8  Project Gardener implements the automated management and operation of [Kubernetes](https://kubernetes.io/) clusters as a service.
     9  Its main principle is to leverage Kubernetes concepts for all of its tasks.
    10  
    11  Recently, most of the vendor specific logic has been developed [in-tree](https://github.com/gardener/gardener).
    12  However, the project has grown to a size where it is very hard to extend, maintain, and test.
    13  With [GEP-1](https://github.com/gardener/gardener/blob/master/docs/proposals/01-extensibility.md) we have proposed how the architecture can be changed in a way to support external controllers that contain their very own vendor specifics.
    14  This way, we can keep Gardener core clean and independent.
    15  
    16  This controller implements Gardener's extension contract for the IronCore provider.
    17  
    18  An example for a `ControllerRegistration` resource that can be used to register this controller to Gardener can be found [here](example/controller-registration.yaml).
    19  
    20  Please find more information regarding the extensibility concepts and a detailed proposal [here](https://github.com/gardener/gardener/blob/master/docs/proposals/01-extensibility.md).
    21  
    22  ## Supported Kubernetes versions
    23  
    24  This extension controller supports the following Kubernetes versions:
    25  
    26  | Version         | Support | Conformance test results |
    27  |-----------------|---------|--------------------------|
    28  | Kubernetes 1.26 | 1.26.0+ | N/A                      |
    29  
    30  
    31  Please take a look [here](https://github.com/gardener/gardener/blob/master/docs/usage/supported_k8s_versions.md) to see which versions are supported by Gardener in general.
    32  
    33  ----
    34  
    35  ## How to start using or developing this extension controller locally
    36  
    37  You can run the controller locally on your machine by executing `make start`.
    38  
    39  Static code checks and tests can be executed by running `make verify`. We are using Go modules for Golang package dependency management and [Ginkgo](https://github.com/onsi/ginkgo)/[Gomega](https://github.com/onsi/gomega) for testing.
    40  
    41  ## Feedback and Support
    42  
    43  Feedback and contributions are always welcome. Please report bugs or suggestions as [GitHub issues](https://github.com/ironcore-dev/gardener-extension-provider-ironcore/issues) or join our [Slack channel #gardener](https://kubernetes.slack.com/messages/gardener) (please invite yourself to the Kubernetes workspace [here](http://slack.k8s.io)).
    44  
    45  ## Learn more!
    46  
    47  Please find further resources about out project here:
    48  
    49  * [Our landing page gardener.cloud](https://gardener.cloud/)
    50  * ["Gardener, the Kubernetes Botanist" blog on kubernetes.io](https://kubernetes.io/blog/2018/05/17/gardener/)
    51  * ["Gardener Project Update" blog on kubernetes.io](https://kubernetes.io/blog/2019/12/02/gardener-project-update/)
    52  * [GEP-1 (Gardener Enhancement Proposal) on extensibility](https://github.com/gardener/gardener/blob/master/docs/proposals/01-extensibility.md)
    53  * [GEP-4 (New `core.gardener.cloud/v1beta1` API)](https://github.com/gardener/gardener/blob/master/docs/proposals/04-new-core-gardener-cloud-apis.md)
    54  * [Extensibility API documentation](https://github.com/gardener/gardener/tree/master/docs/extensions)
    55  * [Gardener Extensions Golang library](https://godoc.org/github.com/gardener/gardener/extensions/pkg)
    56  * [Gardener API Reference](https://gardener.cloud/api-reference/)