zz_api-ref.adoc

Custom Resource API Reference

Packages

• korrel8r.openshift.io/v1alpha1

korrel8r.openshift.io/v1alpha1

Package v1alpha1 contains API Schema definitions for the korrel8r v1alpha1 API group.

Resource Types

• Korrel8r

DebugSpec

Appears In:

• Korrel8rSpec

Field	Description
verbose integer	Verbose sets the numeric logging verbosity for the KORREL8R_VERBOSE environment variable.

Korrel8r

Korrel8r is a service that correlates observabililty signals in the cluster.

Field	Description
apiVersion string	korrel8r.openshift.io/v1alpha1
kind string	Korrel8r
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec Korrel8rSpec

Korrel8rSpec

Korrel8rSpec defines the desired state of Korrel8r

Appears In:

• Korrel8r

Field	Description
serviceAccountName string	ServiceAccountName for the korrel8r deployment, use 'default' if missing.
configMap LocalObjectReference	ConfigMap containing optional custom configuration for Korrel8r. If specified, the map must contain the key 'korrel8r.yaml'. This will be used as the primary configuration file. The entire ConfigMap is mounted in the same directory, so korrel8r.yaml can include other files from the same ConfigMap. The default korrel8r configuration files can also be included, they are available under /etc/korrel8r in the image. See https://korrel8r.github.io/korrel8r/#configuration for more about configuring Korrel8r.
debug DebugSpec	Debug provides optional settings intended to help with debugging problems.