provider-cortex

module
v0.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 12, 2024 License: Apache-2.0

README

provider-cortex

provider-cortex is a minimal Crossplane Provider for the Cortex HTTP API. It comes with the following features:

  • A ProviderConfig type which allows setting the X-Scope-OrgID header which is required for Cortex' tenant model
  • A RuleGroup resource type which implements the RuleGroup API
  • An AlertManagerConfig resource type which implements the Alertmanager API

Developing

  1. Run make submodules to initialize the "build" Make submodule we use for CI/CD.
  2. Add your new type by running the following command:
make provider.addtype provider=cortex group=alerts kind=AlertManagerConfiguration
  1. Implement types and controller
  2. Run make reviewable to run code generation, linters, and tests.
  3. Run make build to build the provider.

Refer to Crossplane's CONTRIBUTING.md file for more information on how the Crossplane community prefers to work. The Provider Development guide may also be of use.

Directories

Path Synopsis
Package apis contains Kubernetes API for the cortex provider.
Package apis contains Kubernetes API for the cortex provider.
alerts
Package alerts contains alertmanager API versions
Package alerts contains alertmanager API versions
alerts/v1alpha1
Package v1alpha1 contains the v1alpha1 group Sample resources of the cortex provider.
Package v1alpha1 contains the v1alpha1 group Sample resources of the cortex provider.
rules
Package rules contains group rules API versions
Package rules contains group rules API versions
rules/v1alpha1
Package v1alpha1 contains the v1alpha1 group Sample resources of the cortex provider.
Package v1alpha1 contains the v1alpha1 group Sample resources of the cortex provider.
v1alpha1
Package v1alpha1 contains the core resources of the cortex provider.
Package v1alpha1 contains the core resources of the cortex provider.
cmd
internal

Jump to

Keyboard shortcuts

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