annotations

Documentation

Index

• Constants
• type Annotation
• type AnnotationSupportRelease
• type CRDAnnotationSupport
  • func Collect(startPath string) ([]CRDAnnotationSupport, error)
  • func FilterForCRD(annotations []CRDAnnotationSupport, crdName string, version string) []CRDAnnotationSupport
  • func Sort(annotations []CRDAnnotationSupport) []CRDAnnotationSupport

Constants

const CRD_DOCS_GENERATOR = "CRD_DOCS_GENERATOR"

Types

type Annotation

type Annotation struct {
	Documentation string
	Support       []AnnotationSupportRelease
}

type AnnotationSupportRelease

type AnnotationSupportRelease struct {
	Release    string
	APIVersion string
	CRD        string
}

type CRDAnnotationSupport

type CRDAnnotationSupport struct {
	Annotation    string
	CRDName       string
	CRDVersion    string
	Release       string
	Documentation string
}

CRDAnnotationSupport is a flattened combination of annotation details and the CRD they are applicable to.

func Collect

func Collect(startPath string) ([]CRDAnnotationSupport, error)

Collect finds all annotations in a folder and returns them.

func FilterForCRD

func FilterForCRD(annotations []CRDAnnotationSupport, crdName string, version string) []CRDAnnotationSupport

func Sort

func Sort(annotations []CRDAnnotationSupport) []CRDAnnotationSupport