v1alpha1

package
v0.14.2 Latest Latest
Warning

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

 Go to latest Published: Dec 2, 2024 License: AGPL-3.0 Imports: 9 Imported by: 0

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the config.tempo v1alpha1 API group. +kubebuilder:object:generate=true +groupName=config.tempo.grafana.com

Package v1alpha1 contains API Schema definitions for the config.tempo v1alpha1 API group. +kubebuilder:object:generate=true +groupName=config.tempo.grafana.com

Index

Constants

View Source 
const (
	// EnvRelatedImageTempo contains the name of the environment variable where the tempo image location is stored.
	EnvRelatedImageTempo = "RELATED_IMAGE_TEMPO"

	// EnvRelatedImageJaegerQuery contains the name of the environment variable where the jaegerQuery image location is stored.
	EnvRelatedImageJaegerQuery = "RELATED_IMAGE_JAEGER_QUERY"

	// EnvRelatedImageTempoQuery contains the name of the environment variable where the tempoQuery image location is stored.
	EnvRelatedImageTempoQuery = "RELATED_IMAGE_TEMPO_QUERY"

	// EnvRelatedImageTempoGateway contains the name of the environment variable where the tempoGateway image location is stored.
	EnvRelatedImageTempoGateway = "RELATED_IMAGE_TEMPO_GATEWAY"

	// EnvRelatedImageTempoGatewayOpa contains the name of the environment variable where the tempoGatewayOpa image location is stored.
	EnvRelatedImageTempoGatewayOpa = "RELATED_IMAGE_TEMPO_GATEWAY_OPA"

	// EnvRelatedImageOauthProxy contains the name of the environment variable where the oauth-proxy image location is stored.
	EnvRelatedImageOauthProxy = "RELATED_IMAGE_OAUTH_PROXY"
)

Variables

View Source 
var (
	// GroupVersion is group version used to register these objects.
	GroupVersion = schema.GroupVersion{Group: "config.tempo.grafana.com", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme.
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

This section is empty.

Types

type BuiltInCertManagement 

type BuiltInCertManagement struct {
	// CACertValidity defines the total duration of the CA certificate validity.
	CACertValidity metav1.Duration `json:"caValidity,omitempty"`
	// CACertRefresh defines the duration of the CA certificate validity until a rotation
	// should happen. It can be set up to 80% of CA certificate validity or equal to the
	// CA certificate validity. Latter should be used only for rotating only when expired.
	CACertRefresh metav1.Duration `json:"caRefresh,omitempty"`
	// CertValidity defines the total duration of the validity for all Tempo certificates.
	CertValidity metav1.Duration `json:"certValidity,omitempty"`
	// CertRefresh defines the duration of the certificate validity until a rotation
	// should happen. It can be set up to 80% of certificate validity or equal to the
	// certificate validity. Latter should be used only for rotating only when expired.
	// The refresh is applied to all Tempo certificates at once.
	CertRefresh metav1.Duration `json:"certRefresh,omitempty"`
	// Enabled defines to flag to enable/disable built-in certificate management feature gate.
	Enabled bool `json:"enabled,omitempty"`
}

BuiltInCertManagement is the configuration for the built-in facility to generate and rotate TLS client and serving certificates for all Tempo services and internal clients. All necessary secrets and configmaps for protecting the internal components will be created if this option is enabled.

func (*BuiltInCertManagement) DeepCopy 

func (in *BuiltInCertManagement) DeepCopy() *BuiltInCertManagement

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BuiltInCertManagement.

func (*BuiltInCertManagement) DeepCopyInto 

func (in *BuiltInCertManagement) DeepCopyInto(out *BuiltInCertManagement)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type FeatureGates 

type FeatureGates struct {
	// OpenShift contains a set of feature gates supported only on OpenShift.
	OpenShift OpenShiftFeatureGates `json:"openshift,omitempty"`

	// BuiltInCertManagement enables the built-in facility for generating and rotating
	// TLS client and serving certificates for the communication between ingesters and distributors and also between
	// query and query-frontend, In detail all internal Tempo HTTP and GRPC communication is lifted
	// to require mTLS.
	// In addition each service requires a configmap named as the MicroService CR with the
	// suffix `-ca-bundle`, e.g. `tempo-dev-ca-bundle` and the following data:
	// - `service-ca.crt`: The CA signing the service certificate in `tls.crt`.
	// All necessary secrets and configmaps for protecting the internal components will be created if this
	// option is enabled.
	BuiltInCertManagement BuiltInCertManagement `json:"builtInCertManagement,omitempty"`
	// HTTPEncryption enables TLS encryption for all HTTP TempoStack components.
	// Each HTTP component requires a secret, the name should be the name of the component with the
	// suffix `-mtls` and prefix by the TempoStack name e.g `tempo-dev-distributor-mtls`.
	// It should contains the following data:
	// - `tls.crt`: The TLS server side certificate.
	// - `tls.key`: The TLS key for server-side encryption.
	// In addition each service requires a configmap named as the TempoStack CR with the
	// suffix `-ca-bundle`, e.g. `tempo-dev-ca-bundle` and the following data:
	// - `service-ca.crt`: The CA signing the service certificate in `tls.crt`.
	// This will protect all internal communication between the distributors and ingestors and also
	// between ingestor and queriers, and between the queriers and the query-frontend component
	//
	// If BuiltInCertManagement is enabled, you don't need to create this secrets manually.
	//
	// Some considerations when enable mTLS:
	// - If JaegerUI is enabled, it won't be protected by mTLS as it will be considered a public facing
	// component.
	// - If JaegerUI is not enabled, HTTP Tempo API won´t be protected, this will be considered
	// public faced component.
	// - If Gateway is enabled, all comunications between the gateway and the tempo components will be protected
	// by mTLS, and the Gateway itself won´t be, as it will be the only public face component.
	HTTPEncryption bool `json:"httpEncryption,omitempty"`
	// GRPCEncryption enables TLS encryption for all GRPC TempoStack services.
	// Each GRPC component requires a secret, the name should be the name of the component with the
	// suffix `-mtls` and prefix by the TempoStack name e.g `tempo-dev-distributor-mtls`.
	// It should contains the following data:
	// - `tls.crt`: The TLS server side certificate.
	// - `tls.key`: The TLS key for server-side encryption.
	// In addition each service requires a configmap named as the TempoStack CR with the
	// suffix `-ca-bundle`, e.g. `tempo-dev-ca-bundle` and the following data:
	// - `service-ca.crt`: The CA signing the service certificate in `tls.crt`.
	// This will protect all internal communication between the distributors and ingestors and also
	// between ingestor and queriers, and between the queriers and the query-frontend component.
	//
	//
	// If BuiltInCertManagement is enabled, you don't need to create this secrets manually.
	//
	// Some considerations when enable mTLS:
	// - If JaegerUI is enabled, it won´t be protected by mTLS as it will be considered a public face
	// component.
	// - If Gateway is enabled, all comunications between the gateway and the tempo components will be protected
	// by mTLS, and the Gateway itself won´t be, as it will be the only public face component.
	GRPCEncryption bool `json:"grpcEncryption,omitempty"`

	// TLSProfile allows to chose a TLS security profile. Enforced
	// when using HTTPEncryption or GRPCEncryption.
	TLSProfile string `json:"tlsProfile,omitempty"`

	// PrometheusOperator defines whether the Prometheus Operator CRD exists in the cluster.
	// This CRD is part of prometheus-operator.
	PrometheusOperator bool `json:"prometheusOperator,omitempty"`

	// Observability configures observability features of the operator.
	Observability ObservabilityFeatureGates `json:"observability,omitempty"`

	// GrafanaOperator defines whether the Grafana Operator CRD exists in the cluster.
	// This CRD is part of grafana-operator.
	GrafanaOperator bool `json:"grafanaOperator,omitempty"`
}

FeatureGates is the supported set of all operator feature gates.

func (*FeatureGates) DeepCopy 

func (in *FeatureGates) DeepCopy() *FeatureGates

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FeatureGates.

func (*FeatureGates) DeepCopyInto 

func (in *FeatureGates) DeepCopyInto(out *FeatureGates)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ImagesSpec 

type ImagesSpec struct {
	// Tempo defines the tempo container image.
	//
	// +optional
	Tempo string `json:"tempo,omitempty"`

	// TempoQuery defines the tempo-query container image.
	//
	// +optional
	TempoQuery string `json:"tempoQuery,omitempty"`

	// JaegerQuery defines the tempo-query container image.
	//
	// +optional
	JaegerQuery string `json:"jaegerQuery,omitempty"`

	// TempoGateway defines the tempo-gateway container image.
	//
	// +optional
	TempoGateway string `json:"tempoGateway,omitempty"`

	// TempoGatewayOpa defines the OPA sidecar container for TempoGateway.
	//
	// +optional
	TempoGatewayOpa string `json:"tempoGatewayOpa,omitempty"`

	// OauthProxy defines the oauth proxy image used to protect the jaegerUI on single tenant.
	//
	// +optional
	OauthProxy string `json:"oauthProxy,omitempty"`
}

ImagesSpec defines the image for each container.

func (*ImagesSpec) DeepCopy 

func (in *ImagesSpec) DeepCopy() *ImagesSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ImagesSpec.

func (*ImagesSpec) DeepCopyInto 

func (in *ImagesSpec) DeepCopyInto(out *ImagesSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type MetricsFeatureGates 

type MetricsFeatureGates struct {
	// CreateServiceMonitors defines whether the operator should install ServiceMonitors
	// to scrape metrics of the operator.
	CreateServiceMonitors bool `json:"createServiceMonitors,omitempty"`

	// CreatePrometheusRules defines whether the operator should install PrometheusRules
	// to receive alerts about the operator.
	CreatePrometheusRules bool `json:"createPrometheusRules,omitempty"`
}

MetricsFeatureGates configures metrics and alerts of the operator.

func (*MetricsFeatureGates) DeepCopy 

func (in *MetricsFeatureGates) DeepCopy() *MetricsFeatureGates

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetricsFeatureGates.

func (*MetricsFeatureGates) DeepCopyInto 

func (in *MetricsFeatureGates) DeepCopyInto(out *MetricsFeatureGates)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type OauthProxyFeatureGates added in v0.11.0 

type OauthProxyFeatureGates struct {
	// OAuthProxyEnabled is used internally for enable by default the oauth proxy for the UI when multi-tenancy is disabled.
	DefaultEnabled bool `json:"defaultEnabled,omitempty"`
}

OauthProxyFeatureGates configures oauth proxy options.

func (*OauthProxyFeatureGates) DeepCopy added in v0.11.0 

func (in *OauthProxyFeatureGates) DeepCopy() *OauthProxyFeatureGates

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OauthProxyFeatureGates.

func (*OauthProxyFeatureGates) DeepCopyInto added in v0.11.0 

func (in *OauthProxyFeatureGates) DeepCopyInto(out *OauthProxyFeatureGates)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ObservabilityFeatureGates 

type ObservabilityFeatureGates struct {
	// Metrics configures metrics of the operator.
	Metrics MetricsFeatureGates `json:"metrics,omitempty"`
}

ObservabilityFeatureGates configures observability of the operator.

func (*ObservabilityFeatureGates) DeepCopy 

func (in *ObservabilityFeatureGates) DeepCopy() *ObservabilityFeatureGates

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ObservabilityFeatureGates.

func (*ObservabilityFeatureGates) DeepCopyInto 

func (in *ObservabilityFeatureGates) DeepCopyInto(out *ObservabilityFeatureGates)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type OpenShiftFeatureGates 

type OpenShiftFeatureGates struct {
	// ServingCertsService enables OpenShift service-ca annotations on the TempoStack
	// to use the in-platform CA and generate a TLS cert/key pair per service for
	// in-cluster data-in-transit encryption.
	// More details: https://docs.openshift.com/container-platform/latest/security/certificate_types_descriptions/service-ca-certificates.html
	//
	// Currently is only used in two cases:
	//   - If gateway is enabled, it will be used by the gateway component
	//   - If the gateway is disabled and TLS is enabled on the distributor but no caName and certName are specified
	ServingCertsService bool `json:"servingCertsService,omitempty"`

	// OpenShiftRoute enables creating OpenShift Route objects.
	// More details: https://docs.openshift.com/container-platform/latest/networking/understanding-networking.html
	OpenShiftRoute bool `json:"openshiftRoute,omitempty"`

	// BaseDomain is used internally for redirect URL in gateway OpenShift auth mode.
	// If empty the operator automatically derives the domain from the cluster.
	BaseDomain string `json:"baseDomain,omitempty"`

	// ClusterTLSPolicy enables usage of TLS policies set in the API Server.
	// More details: https://docs.openshift.com/container-platform/4.11/security/tls-security-profiles.html
	ClusterTLSPolicy bool

	// OauthProxy define options for the oauth proxy feature.
	OauthProxy OauthProxyFeatureGates `json:"oAuthProxy,omitempty"`
}

OpenShiftFeatureGates is the supported set of all operator features gates on OpenShift.

func (*OpenShiftFeatureGates) DeepCopy 

func (in *OpenShiftFeatureGates) DeepCopy() *OpenShiftFeatureGates

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OpenShiftFeatureGates.

func (*OpenShiftFeatureGates) DeepCopyInto 

func (in *OpenShiftFeatureGates) DeepCopyInto(out *OpenShiftFeatureGates)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ProjectConfig 

type ProjectConfig struct {
	metav1.TypeMeta `json:",inline"`
	// ControllerManagerConfigurationSpec returns the configurations for controllers
	cfg.ControllerManagerConfigurationSpec `json:",inline"`

	// The images are read from environment variables and not from the configuration file
	DefaultImages ImagesSpec

	Gates FeatureGates `json:"featureGates,omitempty"`

	// Distribution defines the operator distribution name.
	Distribution string `json:"distribution"`
}

ProjectConfig is the Schema for the projectconfigs API.

func DefaultProjectConfig added in v0.10.0 

func DefaultProjectConfig() ProjectConfig

DefaultProjectConfig returns the default operator config.

func (*ProjectConfig) DeepCopy 

func (in *ProjectConfig) DeepCopy() *ProjectConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProjectConfig.

func (*ProjectConfig) DeepCopyInto 

func (in *ProjectConfig) DeepCopyInto(out *ProjectConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ProjectConfig) DeepCopyObject 

func (in *ProjectConfig) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*ProjectConfig) Validate 

func (c *ProjectConfig) Validate() error

Validate validates the controller configuration (ProjectConfig).

type TLSProfileType 

type TLSProfileType string

TLSProfileType is a TLS security profile based on the Mozilla definitions: https://wiki.mozilla.org/Security/Server_Side_TLS 

const (
	// TLSProfileOldType is a TLS security profile based on:
	// https://wiki.mozilla.org/Security/Server_Side_TLS#Old_backward_compatibility
	TLSProfileOldType TLSProfileType = "Old"
	// TLSProfileIntermediateType is a TLS security profile based on:
	// https://wiki.mozilla.org/Security/Server_Side_TLS#Intermediate_compatibility_.28default.29
	TLSProfileIntermediateType TLSProfileType = "Intermediate"
	// TLSProfileModernType is a TLS security profile based on:
	// https://wiki.mozilla.org/Security/Server_Side_TLS#Modern_compatibility
	TLSProfileModernType TLSProfileType = "Modern"
)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.