environments-api

module
v0.3.7 Latest Latest
Warning

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

Go to latest
Published: Nov 11, 2026 License: Apache-2.0

README

BlanketOps Environments API

Overview

BlanketOps Environments API defines the canonical Kubernetes API contracts for BlanketOps Environments.

This repository contains versioned Custom Resource Definitions (CRDs) and their corresponding Go types. It is the source of truth for all environment, build, event, and source APIs used by BlanketOps Environments components.


API Groups and Versions

Currently supported API groups:

  • environments.blanketops.dev/v1alpha1
  • events.blanketops.dev/v1alpha1
  • networks.blanketops.dev/v1alpha1
  • sources.blanketops.dev/v1alpha1

All APIs are currently alpha and may change in backward-incompatible ways until stabilized.


Versioning Policy

This repository follows semantic versioning at the contract level.

  • v1alpha1 — experimental, breaking changes allowed
  • v1beta1 — feature complete, limited breaking changes
  • v1 — stable, backward-compatible

Once an API version is stabilized, it is append-only.

Breaking changes require a new API version.


Code Generation

CRDs and deepcopy code are generated using controller-gen, invoked via mage.

To generate all artifacts:

mage generate
mage manifests

License

Apache License 2.0 — see LICENSE for details.

Directories

Path Synopsis
api
environments/v1alpha1
+k8s:openapi-gen=true
+k8s:openapi-gen=true
events/v1alpha1
+k8s:openapi-gen=true
+k8s:openapi-gen=true
networks/v1alpha1
+k8s:openapi-gen=true
+k8s:openapi-gen=true
sources/v1alpha1
+k8s:openapi-gen=true
+k8s:openapi-gen=true
pkg
generated/openapi
Code generated manually.
Code generated manually.

Jump to

Keyboard shortcuts

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