styra-controller

module

v0.13.0 Latest Latest Go to latest Published: Apr 2, 2024 License: Apache-2.0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/bankdata/styra-controller

Links

Open Source Insights

README ¶

styra-controller

styra-controller is a Kubernetes controller designed to automate configuration of Styra DAS. With the use of CustomResourceDefinitions, styra-controller enables systems and datasources to be configured, without having to do it through the GUI. By doing this we can gurantee that no changes are done to Styra DAS manually, which makes change management and compliance easier.

In order to ease configuration of OPA and Styra Local Plane (SLP), the controller automatically creates ConfigMaps and Secrets which contain the configuration and connection details for these components.

Arcitectural overview

styra-controller sits in a Kubernetes cluster and ensures that systems and datasources are created in Styra DAS. It then creates ConfigMaps and Secrets where relevant configuration and connection details can be read.

diagram over the controller architecture

CustomResourceDefinitions

A core feature of the styra-controller is to monitor the Kubernetes API server for changes to specific objects and ensure that the current Styra DAS resources match these objects. The controller acts on the following custom resource definitions (CRDs).

System, which defines a Styra DAS system configuration, its datasources and users with access.
GlobalDatasource, which defines a global datasource resource in Styra DAS.
Library, which defines a Library resource in Styra DAS.

For more information about these resources see the design document or the full api reference.

Installation

For a guide on how to install styra-controller see the installation instructions.

Limitations

The styra-controller is a rather new project made to accomodate the needs we have in Bankdata. This means that the feature set currently has some limitations. The following is a few of the most important ones.

Only supported datasource category for datasources added to systems is JSON
Git ssh auth is not supported
Only supported system type is custom
Stacks are currently unsupported

These limitations merely reflect the current state, and we might change them and add new features when the need for them arises. If you want to help removing any of these limitations feel free to open an issue or submit a pull request.

Contributing

For a guide on how to contribute to the styra-controller project as well as how to deploy the styra-controller for testing purposes see CONTRIBUTING.md.

Security

For more information about the security policy of the project see SECURITY.md

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
api
config/v2alpha2 Package v2alpha2 contains API Schema definitions for the config v2alpha2 API group +kubebuilder:object:generate=true +kubebuilder:skip +groupName=config.bankdata.dk	Package v2alpha2 contains API Schema definitions for the config v2alpha2 API group +kubebuilder:object:generate=true +kubebuilder:skip +groupName=config.bankdata.dk
styra/v1alpha1 Package v1alpha1 contains API Schema definitions for the styra v1alpha1 API group.	Package v1alpha1 contains API Schema definitions for the styra v1alpha1 API group.
styra/v1beta1 Package v1beta1 contains API Schema definitions for the styra v1beta1 API group.	Package v1beta1 contains API Schema definitions for the styra v1beta1 API group.
test/v1 Package v1 contains API Schema definitions for the test v1 API group.	Package v1 contains API Schema definitions for the test v1 API group.
cmd Package main is the main entrypoint used when running the controller.	Package main is the main entrypoint used when running the controller.
internal
config Package config provides utilities for reading configfiles	Package config provides utilities for reading configfiles
controller/styra Package styra holds controllers for the styra API group.	Package styra holds controllers for the styra API group.
errors Package errors contains errors.	Package errors contains errors.
fields Package fields contains helpers for working with fields in the CRDs.	Package fields contains helpers for working with fields in the CRDs.
finalizer Package finalizer contains helpers for working with the controller finalizer.	Package finalizer contains helpers for working with the controller finalizer.
k8sconv Package k8sconv contains helpers related to converting data to Kubernetes resources.	Package k8sconv contains helpers related to converting data to Kubernetes resources.
labels Package labels contains helpers for working with labels.	Package labels contains helpers for working with labels.
predicate Package predicate contains predicates used by the controllers.	Package predicate contains predicates used by the controllers.
sentry Package sentry contains a reconciler middleware which sends errors to Sentry.	Package sentry contains a reconciler middleware which sends errors to Sentry.
template Package template is a placeholder file to make Go vendor this directory properly.	Package template is a placeholder file to make Go vendor this directory properly.
webhook Package webhook contains helpers for the notifaction webhooks of the controller.	Package webhook contains helpers for the notifaction webhooks of the controller.
webhook/mocks
pkg
ptr Package ptr contains helpers for creating pointers to built-in types.	Package ptr contains helpers for creating pointers to built-in types.
styra Package styra holds a client and helpers for interacting with the Styra APIs.	Package styra holds a client and helpers for interacting with the Styra APIs.
styra/mocks