v1alpha1

package
v0.1.12 Latest Latest
Warning

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

Go to latest
Published: May 28, 2025 License: Apache-2.0 Imports: 10 Imported by: 2

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the v1alpha1 API group +kubebuilder:object:generate=true +groupName=perses.dev

Index

Constants

This section is empty.

Variables

View Source
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "perses.dev", 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 BasicAuth added in v0.1.11

type BasicAuth struct {
	SecretSource `json:",inline"`
	// Username for basic auth
	Username string `json:"username"`
	// Path to password
	PasswordPath string `json:"password_path"`
}

func (*BasicAuth) DeepCopy added in v0.1.11

func (in *BasicAuth) DeepCopy() *BasicAuth

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

func (*BasicAuth) DeepCopyInto added in v0.1.11

func (in *BasicAuth) DeepCopyInto(out *BasicAuth)

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

type Certificate added in v0.1.2

type Certificate struct {
	SecretSource `json:",inline"`
	// Path to Certificate
	CertPath string `json:"certPath"`
	// Path to Private key certificate
	// +optional
	PrivateKeyPath string `json:"privateKeyPath,omitempty"`
}

func (*Certificate) DeepCopy added in v0.1.2

func (in *Certificate) DeepCopy() *Certificate

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

func (*Certificate) DeepCopyInto added in v0.1.2

func (in *Certificate) DeepCopyInto(out *Certificate)

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

type Client added in v0.1.2

type Client struct {
	// BasicAuth basic auth config for perses client
	// +optional
	BasicAuth *BasicAuth `json:"basicAuth,omitempty"`
	// OAuth configuration for perses client
	// +optional
	OAuth *OAuth `json:"oauth,omitempty"`
	// TLS the equivalent to the tls_config for perses client
	// +optional
	TLS *TLS `json:"tls,omitempty"`

	// KubernetesAuth configuration for perses client
	// +optional
	KubernetesAuth *KubernetesAuth `json:"kubernetesAuth,omitempty"`
}

func (*Client) DeepCopy added in v0.1.2

func (in *Client) DeepCopy() *Client

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

func (*Client) DeepCopyInto added in v0.1.2

func (in *Client) DeepCopyInto(out *Client)

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

type Dashboard

type Dashboard struct {
	persesv1.DashboardSpec `json:",inline"`
}

func (*Dashboard) DeepCopy

func (in *Dashboard) DeepCopy() *Dashboard

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

func (*Dashboard) DeepCopyInto

func (in *Dashboard) DeepCopyInto(out *Dashboard)

type Datasource

type Datasource struct {
	persesv1.DatasourceSpec `json:",inline"`
}

func (*Datasource) DeepCopy

func (in *Datasource) DeepCopy() *Datasource

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

func (*Datasource) DeepCopyInto

func (in *Datasource) DeepCopyInto(out *Datasource)

type DatasourceSpec added in v0.1.10

type DatasourceSpec struct {
	// +operator-sdk:csv:customresourcedefinitions:type=spec
	Config Datasource `json:"config,omitempty"`
	// +operator-sdk:csv:customresourcedefinitions:type=spec
	// +optional
	Client *Client `json:"client,omitempty"`
}

func (*DatasourceSpec) DeepCopy added in v0.1.10

func (in *DatasourceSpec) DeepCopy() *DatasourceSpec

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

func (*DatasourceSpec) DeepCopyInto added in v0.1.10

func (in *DatasourceSpec) DeepCopyInto(out *DatasourceSpec)

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

type KubernetesAuth added in v0.1.11

type KubernetesAuth struct {
	// Enable kubernetes auth for perses client
	Enable bool `json:"enable"`
}

func (*KubernetesAuth) DeepCopy added in v0.1.11

func (in *KubernetesAuth) DeepCopy() *KubernetesAuth

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

func (*KubernetesAuth) DeepCopyInto added in v0.1.11

func (in *KubernetesAuth) DeepCopyInto(out *KubernetesAuth)

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

type Metadata added in v0.1.1

type Metadata struct {
	Labels      map[string]string `json:"labels,omitempty"`
	Annotations map[string]string `json:"annotations,omitempty"`
}

Metadata to add to deployed pods

func (*Metadata) DeepCopy added in v0.1.1

func (in *Metadata) DeepCopy() *Metadata

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

func (*Metadata) DeepCopyInto added in v0.1.1

func (in *Metadata) DeepCopyInto(out *Metadata)

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

type OAuth added in v0.1.11

type OAuth struct {
	SecretSource `json:",inline"`
	// Path to client id
	// +optional
	ClientIDPath string `json:"clientIDPath"`
	// Path to client secret
	// +optional
	ClientSecretPath string `json:"clientSecretPath"`
	// TokenURL is the resource server's token endpoint
	// URL. This is a constant specific to each server.
	TokenURL string `json:"tokenURL"`
	// +optional
	// Scope specifies optional requested permissions.
	Scopes []string `json:"scopes,omitempty"`
	// +optional
	// EndpointParams specifies additional parameters for requests to the token endpoint.
	EndpointParams map[string][]string `json:"endpointParams,omitempty"`
	// +optional
	// AuthStyle optionally specifies how the endpoint wants the
	// client ID & client secret sent. The zero value means to
	// auto-detect.
	AuthStyle int `json:"authStyle,omitempty"`
}

func (*OAuth) DeepCopy added in v0.1.11

func (in *OAuth) DeepCopy() *OAuth

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

func (*OAuth) DeepCopyInto added in v0.1.11

func (in *OAuth) DeepCopyInto(out *OAuth)

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

type Perses

type Perses struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   PersesSpec   `json:"spec,omitempty"`
	Status PersesStatus `json:"status,omitempty"`
}

Perses is the Schema for the perses API

func (*Perses) DeepCopy

func (in *Perses) DeepCopy() *Perses

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

func (*Perses) DeepCopyInto

func (in *Perses) DeepCopyInto(out *Perses)

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

func (*Perses) DeepCopyObject

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

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

type PersesConfig

type PersesConfig struct {
	config.Config `json:",inline"`
}

func (*PersesConfig) DeepCopy

func (in *PersesConfig) DeepCopy() *PersesConfig

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

func (*PersesConfig) DeepCopyInto

func (in *PersesConfig) DeepCopyInto(out *PersesConfig)

type PersesDashboard

type PersesDashboard struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   Dashboard             `json:"spec,omitempty"`
	Status PersesDashboardStatus `json:"status,omitempty"`
}

PersesDashboard is the Schema for the persesdashboards API

func (*PersesDashboard) DeepCopy

func (in *PersesDashboard) DeepCopy() *PersesDashboard

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

func (*PersesDashboard) DeepCopyInto

func (in *PersesDashboard) DeepCopyInto(out *PersesDashboard)

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

func (*PersesDashboard) DeepCopyObject

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

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

type PersesDashboardList

type PersesDashboardList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []PersesDashboard `json:"items"`
}

PersesDashboardList contains a list of PersesDashboard

func (*PersesDashboardList) DeepCopy

func (in *PersesDashboardList) DeepCopy() *PersesDashboardList

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

func (*PersesDashboardList) DeepCopyInto

func (in *PersesDashboardList) DeepCopyInto(out *PersesDashboardList)

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

func (*PersesDashboardList) DeepCopyObject

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

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

type PersesDashboardStatus

type PersesDashboardStatus struct {
	// +operator-sdk:csv:customresourcedefinitions:type=status
	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"`
}

PersesDashboardStatus defines the observed state of PersesDashboard

func (*PersesDashboardStatus) DeepCopy

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

func (*PersesDashboardStatus) DeepCopyInto

func (in *PersesDashboardStatus) DeepCopyInto(out *PersesDashboardStatus)

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

type PersesDatasource

type PersesDatasource struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   DatasourceSpec         `json:"spec,omitempty"`
	Status PersesDatasourceStatus `json:"status,omitempty"`
}

PersesDatasource is the Schema for the PersesDatasources API

func (*PersesDatasource) DeepCopy

func (in *PersesDatasource) DeepCopy() *PersesDatasource

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

func (*PersesDatasource) DeepCopyInto

func (in *PersesDatasource) DeepCopyInto(out *PersesDatasource)

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

func (*PersesDatasource) DeepCopyObject

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

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

type PersesDatasourceList

type PersesDatasourceList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []PersesDatasource `json:"items"`
}

PersesDatasourceList contains a list of PersesDatasource

func (*PersesDatasourceList) DeepCopy

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

func (*PersesDatasourceList) DeepCopyInto

func (in *PersesDatasourceList) DeepCopyInto(out *PersesDatasourceList)

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

func (*PersesDatasourceList) DeepCopyObject

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

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

type PersesDatasourceStatus

type PersesDatasourceStatus struct {
	// +operator-sdk:csv:customresourcedefinitions:type=status
	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"`
}

PersesDatasourceStatus defines the observed state of PersesDatasource

func (*PersesDatasourceStatus) DeepCopy

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

func (*PersesDatasourceStatus) DeepCopyInto

func (in *PersesDatasourceStatus) DeepCopyInto(out *PersesDatasourceStatus)

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

type PersesList

type PersesList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Perses `json:"items"`
}

PersesList contains a list of Perses

func (*PersesList) DeepCopy

func (in *PersesList) DeepCopy() *PersesList

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

func (*PersesList) DeepCopyInto

func (in *PersesList) DeepCopyInto(out *PersesList)

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

func (*PersesList) DeepCopyObject

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

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

type PersesService added in v0.1.4

type PersesService struct {
	// +operator-sdk:csv:customresourcedefinitions:type=spec
	// +optional
	Name string `json:"name,omitempty"`
	// +operator-sdk:csv:customresourcedefinitions:type=spec
	// +optional
	Annotations map[string]string `json:"annotations,omitempty"`
}

func (*PersesService) DeepCopy added in v0.1.4

func (in *PersesService) DeepCopy() *PersesService

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

func (*PersesService) DeepCopyInto added in v0.1.4

func (in *PersesService) DeepCopyInto(out *PersesService)

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

type PersesSpec

type PersesSpec struct {
	// +operator-sdk:csv:customresourcedefinitions:type=spec
	Metadata *Metadata `json:"metadata,omitempty"`
	// +operator-sdk:csv:customresourcedefinitions:type=spec
	// +optional
	// Perses client configuration
	Client *Client `json:"client,omitempty"`
	// +operator-sdk:csv:customresourcedefinitions:type=spec
	Config PersesConfig `json:"config,omitempty"`
	// +operator-sdk:csv:customresourcedefinitions:type=spec
	// Args extra arguments to pass to perses
	Args []string `json:"args,omitempty"`
	// +operator-sdk:csv:customresourcedefinitions:type=spec
	ContainerPort int32 `json:"containerPort,omitempty"`
	// +operator-sdk:csv:customresourcedefinitions:type=spec
	// +optional
	Replicas *int32 `json:"replicas,omitempty"`
	// +operator-sdk:csv:customresourcedefinitions:type=spec
	NodeSelector map[string]string `json:"nodeSelector,omitempty"`
	// +operator-sdk:csv:customresourcedefinitions:type=spec
	Tolerations []corev1.Toleration `json:"tolerations,omitempty"`
	// +operator-sdk:csv:customresourcedefinitions:type=spec
	// +optional
	Affinity *corev1.Affinity `json:"affinity,omitempty"`
	// +operator-sdk:csv:customresourcedefinitions:type=spec
	// +optional
	// Image specifies the container image that should be used for the Perses deployment.
	Image string `json:"image,omitempty"`
	// +operator-sdk:csv:customresourcedefinitions:type=spec
	// +optional
	// service specifies the service configuration for the perses instance
	Service *PersesService `json:"service,omitempty"`

	// +operator-sdk:csv:customresourcedefinitions:type=spec
	// +optional
	LivenessProbe *corev1.Probe `json:"livenessProbe,omitempty"`

	// +operator-sdk:csv:customresourcedefinitions:type=spec
	// +optional
	ReadinessProbe *corev1.Probe `json:"readinessProbe,omitempty"`
	// +operator-sdk:csv:customresourcedefinitions:type=spec
	// +optional
	// tls specifies the tls configuration for the perses instance
	TLS *TLS `json:"tls,omitempty"`
	// +operator-sdk:csv:customresourcedefinitions:type=spec
	// +kubebuilder:default:={size: "1Gi"}
	// +optional
	// Storage configuration used by the StatefulSet
	Storage *StorageConfiguration `json:"storage,omitempty"`

	// +operator-sdk:csv:customresourcedefinitions:type=spec
	// +optional
	// ServiceAccountName is the name of the service account to use for the perses deployment or statefulset.
	ServiceAccountName string `json:"serviceAccountName,omitempty"`
}

PersesSpec defines the desired state of Perses

func (*PersesSpec) DeepCopy

func (in *PersesSpec) DeepCopy() *PersesSpec

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

func (*PersesSpec) DeepCopyInto

func (in *PersesSpec) DeepCopyInto(out *PersesSpec)

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

type PersesStatus

type PersesStatus struct {
	// +operator-sdk:csv:customresourcedefinitions:type=status
	Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"`
}

PersesStatus defines the observed state of Perses

func (*PersesStatus) DeepCopy

func (in *PersesStatus) DeepCopy() *PersesStatus

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

func (*PersesStatus) DeepCopyInto

func (in *PersesStatus) DeepCopyInto(out *PersesStatus)

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

type SecretSource added in v0.1.11

type SecretSource struct {
	// +kubebuilder:validation:Enum:={"secret", "configmap", "file"}
	// Type source type of secret
	Type SecretSourceType `json:"type"`
	// Name of basic auth k8s resource (when type is secret or configmap)
	// +optional
	Name string `json:"name,omitempty"`
	// Namsespace of certificate k8s resource (when type is secret or configmap)
	// +optional
	Namespace string `json:"namespace,omitempty"`
}

SecretSource configuration for a perses secret source

func (*SecretSource) DeepCopy added in v0.1.11

func (in *SecretSource) DeepCopy() *SecretSource

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

func (*SecretSource) DeepCopyInto added in v0.1.11

func (in *SecretSource) DeepCopyInto(out *SecretSource)

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

type SecretSourceType added in v0.1.11

type SecretSourceType string

SecretSourceType types of secret sources in k8s

const (
	SecretSourceTypeSecret    SecretSourceType = "secret"
	SecretSourceTypeConfigMap SecretSourceType = "configmap"
	SecretSourceTypeFile      SecretSourceType = "file"
)

type StorageConfiguration added in v0.1.11

type StorageConfiguration struct {
	// StorageClass to use for PVCs.
	// If not specified, will use the default storage class
	// +optional
	StorageClass *string `json:"storageClass,omitempty"`
	// Size of the storage.
	// cannot be decreased.
	// +optional
	Size resource.Quantity `json:"size,omitempty"`
}

StorageConfiguration is the configuration used to create and reconcile PVCs

func (*StorageConfiguration) DeepCopy added in v0.1.11

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

func (*StorageConfiguration) DeepCopyInto added in v0.1.11

func (in *StorageConfiguration) DeepCopyInto(out *StorageConfiguration)

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

type TLS added in v0.1.2

type TLS struct {
	// Enable TLS connection to perses
	Enable bool `json:"enable"`
	// CaCert to verify the perses certificate
	// +optional
	CaCert *Certificate `json:"caCert,omitempty"`
	// UserCert client cert/key for mTLS
	// +optional
	UserCert *Certificate `json:"userCert,omitempty"`
	// InsecureSkipVerify skip verify of perses certificate
	// +optional
	InsecureSkipVerify bool `json:"insecureSkipVerify,omitempty"`
}

func (*TLS) DeepCopy added in v0.1.2

func (in *TLS) DeepCopy() *TLS

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

func (*TLS) DeepCopyInto added in v0.1.2

func (in *TLS) DeepCopyInto(out *TLS)

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

Jump to

Keyboard shortcuts

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