Skip to content

Latest commit

 

History

History
27 lines (20 loc) · 1.39 KB

README.md

File metadata and controls

27 lines (20 loc) · 1.39 KB
Raw

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.