v1beta1

package
v0.17.0 Latest Latest
Warning

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

 Go to latest Published: Feb 24, 2024 License: Apache-2.0 Imports: 23 Imported by: 0

Documentation

Overview

Package v1beta1 contains API Schema definitions for the v1beta1 API group +kubebuilder:object:generate=true +groupName=temporal.io

Licensed to Alexandre VILAIN under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. Alexandre VILAIN licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

Constants

View Source 
const (
	// ReconcileErrorCondition indicates a transient or persistent reconciliation error.
	ReconcileErrorCondition string = "ReconcileError"
	// ReconcileSuccessCondition indicates a successful reconciliation.
	ReconcileSuccessCondition string = "ReconcileSuccess"
	// ReadyCondition indicates the cluster is ready to receive traffic.
	ReadyCondition string = "Ready"
)
View Source 
const (
	// ProgressingReason signals a reconciliation has started.
	ProgressingReason string = "Progressing"
	// ReconcileErrorReason signals a unknown reconciliation error.
	ReconcileErrorReason string = "LastReconcileCycleFailed"
	// ReconcileSuccessReason signals a successful reconciliation.
	ReconcileSuccessReason string = "LastReconcileCycleSucceded"
	// ServicesReadyReason signals all temporal services for the cluster are in ready state.
	ServicesReadyReason string = "ServicesReady"
	// ServicesNotReadyReason signals that not all temporal services for the cluster are in ready state.
	ServicesNotReadyReason string = "ServicesNotReady"
	// PersistenceReconciliationFailedReason signals an error while reconciling persistence.
	PersistenceReconciliationFailedReason string = "PersistenceReconciliationFailed"
	// ResourcesReconciliationFailedReason signals an error while reconciling cluster resources.
	ResourcesReconciliationFailedReason string = "ResoucesReconciliationFailed"
	// TemporalClusterValidationFailedReason signals an error while validation desired cluster version.
	TemporalClusterValidationFailedReason string = "TemporalClusterValidationFailed"
	// TemporalNamespaceCreatedReason signals a successful namespace creation.
	TemporalNamespaceCreatedReason string = "TemporalNamespaceCreated"
)
View Source 
const (
	DefaultStoreName             = "default"
	VisibilityStoreName          = "visibility"
	SecondaryVisibilityStoreName = "secondaryVisibility"
	AdvancedVisibilityStoreName  = "advancedVisibility"
)
View Source 
const (

	// DataStoreClientTLSCertFileName is the default client TLS cert file name.
	DataStoreClientTLSCertFileName = "client.pem"
	// DataStoreClientTLSKeyFileName is the default client TLS key file name.
	DataStoreClientTLSKeyFileName = "client.key"
	// DataStoreClientTLSCaFileName is the default client TLS ca file name.
	DataStoreClientTLSCaFileName = "ca.pem"
)

Variables

View Source 
var (
	// GroupVersion is group version used to register these objects.
	GroupVersion = schema.GroupVersion{Group: "temporal.io", Version: "v1beta1"}

	// 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

	// TemporalClusterTypeMeta is the TypeMeta for TemporalCluster.
	TemporalClusterTypeMeta = metav1.TypeMeta{
		Kind:       "TemporalCluster",
		APIVersion: GroupVersion.String(),
	}
)
View Source 
var SQLDataStores = []DatastoreType{MySQLDatastore, MySQL8Datastore, PostgresSQLDatastore, PostgresSQL12Datastore}

Functions

func GetTemporalClusterReadyCondition 

func GetTemporalClusterReadyCondition(c *TemporalCluster) (*metav1.Condition, bool)

GetTemporalClusterReadyCondition returns the ready condition for the provided cluster if found.

func GetTemporalWorkerProcessReadyCondition added in v0.8.0 

func GetTemporalWorkerProcessReadyCondition(w *TemporalWorkerProcess) (*metav1.Condition, bool)

GetTemporalWorkerProcessReadyCondition returns the ready condition for the provided worker process if found.

func SetTemporalClusterReady 

func SetTemporalClusterReady(c *TemporalCluster, status metav1.ConditionStatus, reason, message string)

SetTemporalClusterReady sets the ReadyCondition status for a temporal cluster.

func SetTemporalClusterReconcileError 

func SetTemporalClusterReconcileError(c *TemporalCluster, status metav1.ConditionStatus, reason, message string)

SetTemporalClusterReconcileError sets the ReconcileErrorCondition status for a temporal cluster.

func SetTemporalClusterReconcileSuccess 

func SetTemporalClusterReconcileSuccess(c *TemporalCluster, status metav1.ConditionStatus, reason, message string)

SetTemporalClusterReconcileSuccess sets the ReconcileSuccessCondition status for a temporal cluster.

func SetTemporalNamespaceReady added in v0.11.0 

func SetTemporalNamespaceReady(c *TemporalNamespace, status metav1.ConditionStatus, reason, message string)

SetTemporalNamespaceReady sets the ReadyCondition status for a temporal namespace.

func SetTemporalNamespaceReconcileError 

func SetTemporalNamespaceReconcileError(n *TemporalNamespace, status metav1.ConditionStatus, reason, message string)

SetTemporalNamespaceReconcileError sets the ReconcileErrorCondition status for a temporal namespace.

func SetTemporalNamespaceReconcileSuccess 

func SetTemporalNamespaceReconcileSuccess(n *TemporalNamespace, status metav1.ConditionStatus, reason, message string)

SetTemporalNamespaceReconcileSuccess sets the ReconcileSuccessCondition status for a temporal namespace.

func SetTemporalWorkerProcessReady added in v0.8.0 

func SetTemporalWorkerProcessReady(w *TemporalWorkerProcess, status metav1.ConditionStatus, reason, message string)

SetTemporalWorkerProcessReady sets the ReadyCondition status for a temporal worker process.

func SetTemporalWorkerProcessReconcileError added in v0.8.0 

func SetTemporalWorkerProcessReconcileError(w *TemporalWorkerProcess, status metav1.ConditionStatus, reason, message string)

SetTemporalWorkerProcessReconcileError sets the ReconcileErrorCondition status for a temporal worker process.

func SetTemporalWorkerProcessReconcileSuccess added in v0.8.0 

func SetTemporalWorkerProcessReconcileSuccess(w *TemporalWorkerProcess, status metav1.ConditionStatus, reason, message string)

SetTemporalWorkerProcessReconcileSuccess sets the ReconcileSuccessCondition status for a temporal worker process.

Types

type ArchivalProvider added in v0.15.0 

type ArchivalProvider struct {
	// +optional
	Filestore *FilestoreArchiver `json:"filestore,omitempty"`
	// +optional
	S3 *S3Archiver `json:"s3,omitempty"`
	// +optional
	GCS *GCSArchiver `json:"gcs,omitempty"`
}

ArchivalProvider contains the config for archivers.

func (*ArchivalProvider) DeepCopy added in v0.15.0 

func (in *ArchivalProvider) DeepCopy() *ArchivalProvider

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

func (*ArchivalProvider) DeepCopyInto added in v0.15.0 

func (in *ArchivalProvider) DeepCopyInto(out *ArchivalProvider)

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

func (*ArchivalProvider) Kind added in v0.15.0 

func (p *ArchivalProvider) Kind() ArchivalProviderKind

type ArchivalProviderKind added in v0.15.0 

type ArchivalProviderKind string
const (
	FileStoreArchivalProviderKind ArchivalProviderKind = "filestore"
	S3ArchivalProviderKind        ArchivalProviderKind = "s3"
	GCSArchivalProviderKind       ArchivalProviderKind = "gcs"
	UnknownArchivalProviderKind   ArchivalProviderKind = "unknown"
)

type ArchivalSpec added in v0.15.0 

type ArchivalSpec struct {
	// Enabled defines if the archival is enabled by default for all namespaces
	// or for a particular namespace (depends if it's for a TemporalCluster or a TemporalNamespace).
	// +kubebuilder:default:=false
	// +optional
	Enabled bool `json:"enabled"`
	// Paused defines if the archival is paused.
	// +kubebuilder:default:=false
	Paused bool `json:"paused"`
	// EnableRead allows temporal to read from the archived Event History.
	// +kubebuilder:default:=false
	EnableRead bool `json:"enableRead"`
	// Path is ...
	// +kubebuilder:validation:Required
	Path string `json:"path"`
}

ArchivalSpec is the archival configuration for a particular persistence type (history or visibility).

func (*ArchivalSpec) DeepCopy added in v0.15.0 

func (in *ArchivalSpec) DeepCopy() *ArchivalSpec

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

func (*ArchivalSpec) DeepCopyInto added in v0.15.0 

func (in *ArchivalSpec) DeepCopyInto(out *ArchivalSpec)

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

type AuthorizationSpec added in v0.16.0 

type AuthorizationSpec struct {
	// JWTKeyProvider specifies the signing key provider used for validating JWT tokens.
	// +optional
	JWTKeyProvider AuthorizationSpecJWTKeyProvider `json:"jwtKeyProvider"`

	// PermissionsClaimName is the name of the claim within the JWT token that contains the user's permissions.
	// +optional
	PermissionsClaimName string `json:"permissionsClaimName"`

	// Authorizer defines the authorization mechanism to be used. It can be left as an empty string to
	// use a no-operation authorizer (noopAuthorizer), or set to "default" to use the temporal's default
	// authorizer (defaultAuthorizer).
	// +optional
	Authorizer string `json:"authorizer"`

	// ClaimMapper specifies the claim mapping mechanism used for handling JWT claims. Similar to the Authorizer,
	// it can be left as an empty string to use a no-operation claim mapper (noopClaimMapper), or set to "default"
	// to use the default JWT claim mapper (defaultJWTClaimMapper).
	// +optional
	ClaimMapper string `json:"claimMapper"`
}

AuthorizationSpec defines the specifications for authorization in the temporal cluster. It contains fields that configure how JWT tokens are validated, how permissions are managed, and how claims are mapped.

func (*AuthorizationSpec) DeepCopy added in v0.16.0 

func (in *AuthorizationSpec) DeepCopy() *AuthorizationSpec

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

func (*AuthorizationSpec) DeepCopyInto added in v0.16.0 

func (in *AuthorizationSpec) DeepCopyInto(out *AuthorizationSpec)

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

type AuthorizationSpecJWTKeyProvider added in v0.16.0 

type AuthorizationSpecJWTKeyProvider struct {
	// KeySourceURIs is a list of URIs where the JWT signing keys can be obtained. These URIs are used by the
	// authorization system to fetch the public keys necessary for validating JWT tokens.
	// +optional
	KeySourceURIs []string `json:"keySourceURIs"`

	// RefreshInterval defines the time interval at which temporal should refresh the JWT signing keys from
	// the specified URIs.
	// +optional
	RefreshInterval *metav1.Duration `json:"refreshInterval"`
}

AuthorizationSpecJWTKeyProvider defines the configuration for a JWT key provider within the AuthorizationSpec. It specifies where to source the JWT keys from and how often they should be refreshed.

func (*AuthorizationSpecJWTKeyProvider) DeepCopy added in v0.16.0 

func (in *AuthorizationSpecJWTKeyProvider) DeepCopy() *AuthorizationSpecJWTKeyProvider

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

func (*AuthorizationSpecJWTKeyProvider) DeepCopyInto added in v0.16.0 

func (in *AuthorizationSpecJWTKeyProvider) DeepCopyInto(out *AuthorizationSpecJWTKeyProvider)

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

type CassandraConsistencySpec 

type CassandraConsistencySpec struct {
	// Consistency sets the default consistency level.
	// Values identical to gocql Consistency values. (defaults to LOCAL_QUORUM if not set).
	// +kubebuilder:validation:Enum=ANY;ONE;TWO;THREE;QUORUM;ALL;LOCAL_QUORUM;EACH_QUORUM;LOCAL_ONE
	// +optional
	Consistency *gocql.Consistency `json:"consistency"`
	// SerialConsistency sets the consistency for the serial prtion of queries. Values identical to gocql SerialConsistency values.
	// (defaults to LOCAL_SERIAL if not set)
	// +kubebuilder:validation:Enum=SERIAL;LOCAL_SERIAL
	// +optional
	SerialConsistency *gocql.SerialConsistency `json:"serialConsistency"`
}

CassandraConsistencySpec sets the consistency level for regular & serial queries to Cassandra.

func (*CassandraConsistencySpec) DeepCopy 

func (in *CassandraConsistencySpec) DeepCopy() *CassandraConsistencySpec

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

func (*CassandraConsistencySpec) DeepCopyInto 

func (in *CassandraConsistencySpec) DeepCopyInto(out *CassandraConsistencySpec)

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

type CassandraSpec 

type CassandraSpec struct {
	// Hosts is a list of cassandra endpoints.
	Hosts []string `json:"hosts"`
	// Port is the cassandra port used for connection by gocql client.
	Port int `json:"port"`
	// User is the cassandra user used for authentication by gocql client.
	User string `json:"user"`
	// Keyspace is the cassandra keyspace.
	Keyspace string `json:"keyspace"`
	// Datacenter is the data center filter arg for cassandra.
	// +optional
	Datacenter string `json:"datacenter"`
	// MaxConns is the max number of connections to this datastore for a single keyspace.
	// +optional
	MaxConns int `json:"maxConns"`
	// ConnectTimeout is a timeout for initial dial to cassandra server.
	// +optional
	ConnectTimeout *metav1.Duration `json:"connectTimeout"`
	// Consistency configuration.
	// +optional
	Consistency *CassandraConsistencySpec `json:"consistency,omitempty"`
	// DisableInitialHostLookup instructs the gocql client to connect only using the supplied hosts.
	// +optional
	DisableInitialHostLookup bool `json:"disableInitialHostLookup"`
}

CassandraSpec contains cassandra datastore connections specifications.

func (*CassandraSpec) DeepCopy 

func (in *CassandraSpec) DeepCopy() *CassandraSpec

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

func (*CassandraSpec) DeepCopyInto 

func (in *CassandraSpec) DeepCopyInto(out *CassandraSpec)

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

type CertificatesDurationSpec 

type CertificatesDurationSpec struct {
	// RootCACertificate is the 'duration' (i.e. lifetime) of the Root CA Certificate.
	// It defaults to 10 years.
	// +optional
	RootCACertificate *metav1.Duration `json:"rootCACertificate"` //nolint:tagliatelle
	// IntermediateCACertificates is the 'duration' (i.e. lifetime) of the intermediate CAs Certificates.
	// It defaults to 5 years.
	// +optional
	IntermediateCAsCertificates *metav1.Duration `json:"intermediateCAsCertificates"`
	// ClientCertificates is the 'duration' (i.e. lifetime) of the client certificates.
	// It defaults to 1 year.
	// +optional
	ClientCertificates *metav1.Duration `json:"clientCertificates"`
	// FrontendCertificate is the 'duration' (i.e. lifetime) of the frontend certificate.
	// It defaults to 1 year.
	// +optional
	FrontendCertificate *metav1.Duration `json:"frontendCertificate"`
	// InternodeCertificate is the 'duration' (i.e. lifetime) of the internode certificate.
	// It defaults to 1 year.
	// +optional
	InternodeCertificate *metav1.Duration `json:"internodeCertificate"`
}

CertificatesDurationSpec defines parameters for the temporal mTLS certificates duration.

func (*CertificatesDurationSpec) DeepCopy 

func (in *CertificatesDurationSpec) DeepCopy() *CertificatesDurationSpec

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

func (*CertificatesDurationSpec) DeepCopyInto 

func (in *CertificatesDurationSpec) DeepCopyInto(out *CertificatesDurationSpec)

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

type ClusterArchivalSpec added in v0.15.0 

type ClusterArchivalSpec struct {
	// Enabled defines if the archival is enabled for the cluster.
	// +kubebuilder:default:=false
	// +optional
	Enabled bool `json:"enabled"`
	// Provider defines the archival provider for the cluster.
	// The same provider is used for both history and visibility,
	// but some config can be changed using spec.archival.[history|visibility].config.
	// +optional
	Provider *ArchivalProvider `json:"provider,omitempty"`
	// History is the default config for the history archival.
	// +optional
	History *ArchivalSpec `json:"history,omitempty"`
	// Visibility is the default config for visibility archival.
	// +optional
	Visibility *ArchivalSpec `json:"visibility,omitempty"`
}

ClusterArchivalSpec is the configuration for cluster-wide archival config.

func (*ClusterArchivalSpec) DeepCopy added in v0.15.0 

func (in *ClusterArchivalSpec) DeepCopy() *ClusterArchivalSpec

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

func (*ClusterArchivalSpec) DeepCopyInto added in v0.15.0 

func (in *ClusterArchivalSpec) DeepCopyInto(out *ClusterArchivalSpec)

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

func (*ClusterArchivalSpec) IsEnabled added in v0.15.0 

func (s *ClusterArchivalSpec) IsEnabled() bool

type ConstrainedValue added in v0.11.0 

type ConstrainedValue struct {
	// Constraints describe under what conditions a ConstrainedValue should be used.
	// +optional
	Constraints Constraints `json:"constraints"`
	// Value is the value for the configuration key.
	// The type of the Value field depends on the key.
	// Acceptable types will be one of: int, float64, bool, string, map[string]any, time.Duration
	Value *apiextensionsv1.JSON `json:"value"`
}

ConstrainedValue is an alias for temporal's dynamicconfig.ConstrainedValue.

func (*ConstrainedValue) DeepCopy added in v0.11.0 

func (in *ConstrainedValue) DeepCopy() *ConstrainedValue

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

func (*ConstrainedValue) DeepCopyInto added in v0.11.0 

func (in *ConstrainedValue) DeepCopyInto(out *ConstrainedValue)

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

type Constraints added in v0.11.0 

type Constraints struct {
	// +optional
	Namespace string `json:"namespace"`
	// +optional
	NamespaceID string `json:"namespaceId"`
	// +optional
	TaskQueueName string `json:"taskQueueName"`
	// +optional
	TaskQueueType string `json:"taskQueueType"`
	// +optional
	ShardID int32 `json:"shardId"`
	// +optional
	TaskType string `json:"taskType"`
}

Constraints is an alias for temporal's dynamicconfig.Constraints. It describes under what conditions a ConstrainedValue should be used.

func (*Constraints) DeepCopy added in v0.11.0 

func (in *Constraints) DeepCopy() *Constraints

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

func (*Constraints) DeepCopyInto added in v0.11.0 

func (in *Constraints) DeepCopyInto(out *Constraints)

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

type ContainerRegistryConfig added in v0.8.0 

type ContainerRegistryConfig struct {
	// Repository is the fqdn to the image repo.
	// +required
	Repository string `json:"repository"`
	// Username is the username for the container repo.
	// +required
	Username string `json:"username"`
	// PasswordSecret is the reference to the secret holding the docker repo password.
	// +required
	PasswordSecretRef SecretKeyReference `json:"passwordSecretRef"`
}

ContainerRegistryConfig specifies the parameters to connect with desired container repository.

func (*ContainerRegistryConfig) DeepCopy added in v0.8.0 

func (in *ContainerRegistryConfig) DeepCopy() *ContainerRegistryConfig

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

func (*ContainerRegistryConfig) DeepCopyInto added in v0.8.0 

func (in *ContainerRegistryConfig) DeepCopyInto(out *ContainerRegistryConfig)

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

type DatastoreSpec 

type DatastoreSpec struct {
	// Name is the name of the datastore.
	// It should be unique and will be referenced within the persistence spec.
	// Defaults to "default" for default sore, "visibility" for visibility store,
	// "secondaryVisibility" for secondary visibility store and
	// "advancedVisibility" for advanced visibility store.
	// +optional
	Name string `json:"name"`
	// SQL holds all connection parameters for SQL datastores.
	// +optional
	SQL *SQLSpec `json:"sql,omitempty"`
	// Elasticsearch holds all connection parameters for Elasticsearch datastores.
	// +optional
	Elasticsearch *ElasticsearchSpec `json:"elasticsearch,omitempty"`
	// Cassandra holds all connection parameters for Cassandra datastore.
	// Note that cassandra is now deprecated for visibility store.
	// +optional
	Cassandra *CassandraSpec `json:"cassandra,omitempty"`
	// PasswordSecret is the reference to the secret holding the password.
	// +optional
	PasswordSecretRef *SecretKeyReference `json:"passwordSecretRef,omitempty"`
	// TLS is an optional option to connect to the datastore using TLS.
	// +optional
	TLS *DatastoreTLSSpec `json:"tls,omitempty"`
	// SkipCreate instructs the operator to skip creating the database for SQL datastores or to skip creating keyspace for Cassandra. Use this option if your database or keyspace has already been provisioned by an administrator.
	// +optional
	SkipCreate bool `json:"skipCreate"`
}

DatastoreSpec contains temporal datastore specifications.

func (*DatastoreSpec) DeepCopy 

func (in *DatastoreSpec) DeepCopy() *DatastoreSpec

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

func (*DatastoreSpec) DeepCopyInto 

func (in *DatastoreSpec) DeepCopyInto(out *DatastoreSpec)

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

func (*DatastoreSpec) Default added in v0.10.0 

func (s *DatastoreSpec) Default()

Default set default fields values.

func (*DatastoreSpec) GetPasswordEnvVarName 

func (s *DatastoreSpec) GetPasswordEnvVarName() string

GetPasswordEnvVarName crafts the environment variable name for the datastore.

func (*DatastoreSpec) GetTLSCaFileMountPath 

func (s *DatastoreSpec) GetTLSCaFileMountPath() string

GetTLSCaFileMountPath returns the CA key mount path. It returns empty if the tls config is nil or if no secret key ref has been specified.

func (*DatastoreSpec) GetTLSCertFileMountPath 

func (s *DatastoreSpec) GetTLSCertFileMountPath() string

GetTLSKeyFileMountPath returns the client TLS cert mount path. It returns empty if the tls config is nil or if no secret key ref has been specified.

func (*DatastoreSpec) GetTLSKeyFileMountPath 

func (s *DatastoreSpec) GetTLSKeyFileMountPath() string

GetTLSKeyFileMountPath returns the client TLS key mount path. It returns empty if the tls config is nil or if no secret key ref has been specified.

func (*DatastoreSpec) GetType 

func (s *DatastoreSpec) GetType() DatastoreType

GetType returns datastore type.

func (*DatastoreSpec) IsSQL added in v0.15.2 

func (s *DatastoreSpec) IsSQL() bool

IsSQL returns true if the datastore is an SQL datastore.

type DatastoreStatus 

type DatastoreStatus struct {
	// Created indicates if the database or keyspace has been created.
	Created bool `json:"created"`
	// Setup indicates if tables have been set up.
	Setup bool `json:"setup"`
	// Type indicates the datastore type.
	// +optional
	Type DatastoreType `json:"type"`
	// SchemaVersion report the current schema version.
	// +optional
	SchemaVersion *version.Version `json:"schemaVersion,omitempty"`
}

DatastoreStatus contains the current status of a datastore.

func (*DatastoreStatus) DeepCopy 

func (in *DatastoreStatus) DeepCopy() *DatastoreStatus

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

func (*DatastoreStatus) DeepCopyInto 

func (in *DatastoreStatus) DeepCopyInto(out *DatastoreStatus)

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

type DatastoreTLSSpec 

type DatastoreTLSSpec struct {
	// Enabled defines if the cluster should use a TLS connection to connect to the datastore.
	Enabled bool `json:"enabled"`
	// CertFileRef is a reference to a secret containing the cert file.
	// +optional
	CertFileRef *SecretKeyReference `json:"certFileRef,omitempty"`
	// KeyFileRef is a reference to a secret containing the key file.
	// +optional
	KeyFileRef *SecretKeyReference `json:"keyFileRef,omitempty"`
	// CaFileRef is a reference to a secret containing the ca file.
	// +optional
	CaFileRef *SecretKeyReference `json:"caFileRef,omitempty"`
	// EnableHostVerification defines if the hostname should be verified when connecting to the datastore.
	EnableHostVerification bool `json:"enableHostVerification"`
	// ServerName the datastore should present.
	// +optional
	ServerName string `json:"serverName"`
}

DatastoreTLSSpec contains datastore TLS connections specifications.

func (*DatastoreTLSSpec) DeepCopy 

func (in *DatastoreTLSSpec) DeepCopy() *DatastoreTLSSpec

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

func (*DatastoreTLSSpec) DeepCopyInto 

func (in *DatastoreTLSSpec) DeepCopyInto(out *DatastoreTLSSpec)

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

type DatastoreType 

type DatastoreType string
const (
	CassandraDatastore     DatastoreType = "cassandra"
	PostgresSQLDatastore   DatastoreType = "postgres"
	PostgresSQL12Datastore DatastoreType = "postgres12"
	MySQLDatastore         DatastoreType = "mysql"
	MySQL8Datastore        DatastoreType = "mysql8"
	ElasticsearchDatastore DatastoreType = "elasticsearch"
	UnknownDatastore       DatastoreType = "unknown"
)

type DeploymentOverride added in v0.9.0 

type DeploymentOverride struct {
	*ObjectMetaOverride `json:"metadata,omitempty"`
	// Specification of the desired behavior of the Deployment.
	// +optional
	Spec *DeploymentOverrideSpec `json:"spec,omitempty"`
}

DeploymentOverride provides the ability to override a Deployment.

func (*DeploymentOverride) DeepCopy added in v0.9.0 

func (in *DeploymentOverride) DeepCopy() *DeploymentOverride

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

func (*DeploymentOverride) DeepCopyInto added in v0.9.0 

func (in *DeploymentOverride) DeepCopyInto(out *DeploymentOverride)

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

type DeploymentOverrideSpec added in v0.9.0 

type DeploymentOverrideSpec struct {
	// Template describes the pods that will be created.
	// +optional
	Template *PodTemplateSpecOverride `json:"template,omitempty"`
}

DeploymentOverrideSpec provides the ability to override a Deployment Spec. It's a subset of fields included in k8s.io/api/apps/v1.DeploymentSpec.

func (*DeploymentOverrideSpec) DeepCopy added in v0.9.0 

func (in *DeploymentOverrideSpec) DeepCopy() *DeploymentOverrideSpec

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

func (*DeploymentOverrideSpec) DeepCopyInto added in v0.9.0 

func (in *DeploymentOverrideSpec) DeepCopyInto(out *DeploymentOverrideSpec)

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

type DynamicConfigSpec added in v0.11.0 

type DynamicConfigSpec struct {
	// PollInterval defines how often the config should be updated by checking provided values.
	// Defaults to 10s.
	// +optional
	PollInterval *metav1.Duration `json:"pollInterval"`
	// Values contains all dynamic config keys and their constrained values.
	Values map[string][]ConstrainedValue `json:"values"`
}

DynamicConfigSpec is the configuration for temporal dynamic config.

func (*DynamicConfigSpec) DeepCopy added in v0.11.0 

func (in *DynamicConfigSpec) DeepCopy() *DynamicConfigSpec

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

func (*DynamicConfigSpec) DeepCopyInto added in v0.11.0 

func (in *DynamicConfigSpec) DeepCopyInto(out *DynamicConfigSpec)

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

type ElasticsearchIndices 

type ElasticsearchIndices struct {
	// Visibility defines visibility's index name.
	// +kubebuilder:default=temporal_visibility_v1
	Visibility string `json:"visibility"`
	// SecondaryVisibility defines secondary visibility's index name.
	// +optional
	SecondaryVisibility string `json:"secondaryVisibility"`
}

ElasticsearchIndices holds index names.

func (*ElasticsearchIndices) DeepCopy 

func (in *ElasticsearchIndices) DeepCopy() *ElasticsearchIndices

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

func (*ElasticsearchIndices) DeepCopyInto 

func (in *ElasticsearchIndices) DeepCopyInto(out *ElasticsearchIndices)

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

type ElasticsearchSpec 

type ElasticsearchSpec struct {
	// Version defines the elasticsearch version.
	// +kubebuilder:default=v7
	// +kubebuilder:validation:Pattern=`^v(6|7|8)$`
	Version string `json:"version"`
	// URL is the connection url to connect to the instance.
	// +kubebuilder:validation:Pattern=`^https?:\/\/.+$`
	URL string `json:"url"`
	// Username is the username to be used for the connection.
	Username string `json:"username"`
	// Indices holds visibility index names.
	Indices ElasticsearchIndices `json:"indices"`
	// LogLevel defines the temporal cluster's es client logger level.
	// +optional
	LogLevel string `json:"logLevel"`
	// CloseIdleConnectionsInterval is the max duration a connection stay open while idle.
	// +optional
	CloseIdleConnectionsInterval metav1.Duration `json:"closeIdleConnectionsInterval"`
	// EnableSniff enables or disables sniffer on the temporal cluster's es client.
	// +optional
	EnableSniff bool `json:"enableSniff"`
	// EnableHealthcheck enables or disables healthcheck on the temporal cluster's es client.
	// +optional
	EnableHealthcheck bool `json:"enableHealthcheck"`
}

ElasticsearchSpec contains Elasticsearch datastore connections specifications.

func (*ElasticsearchSpec) DeepCopy 

func (in *ElasticsearchSpec) DeepCopy() *ElasticsearchSpec

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

func (*ElasticsearchSpec) DeepCopyInto 

func (in *ElasticsearchSpec) DeepCopyInto(out *ElasticsearchSpec)

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

type FilestoreArchiver added in v0.15.0 

type FilestoreArchiver struct {
	// FilePermissions sets the file permissions of the archived files.
	// It's recommend to leave it empty and use the default value of "0666" to avoid read/write issues.
	// +kubebuilder:default:="0666"
	FilePermissions string `json:"filePermissions"`
	// DirPermissions sets the directory permissions of the archive directory.
	// It's recommend to leave it empty and use the default value of "0766" to avoid read/write issues.
	// +kubebuilder:default:="0766"
	DirPermissions string `json:"dirPermissions"`
}

FilestoreArchiver is the file store archival provider configuration.

func (*FilestoreArchiver) DeepCopy added in v0.15.0 

func (in *FilestoreArchiver) DeepCopy() *FilestoreArchiver

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

func (*FilestoreArchiver) DeepCopyInto added in v0.15.0 

func (in *FilestoreArchiver) DeepCopyInto(out *FilestoreArchiver)

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

type FrontendMTLSSpec 

type FrontendMTLSSpec struct {
	// Enabled defines if the operator should enable mTLS for cluster's public endpoints.
	// +optional
	Enabled bool `json:"enabled"`
}

FrontendMTLSSpec defines parameters for the temporal encryption in transit with mTLS.

func (*FrontendMTLSSpec) DeepCopy 

func (in *FrontendMTLSSpec) DeepCopy() *FrontendMTLSSpec

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

func (*FrontendMTLSSpec) DeepCopyInto 

func (in *FrontendMTLSSpec) DeepCopyInto(out *FrontendMTLSSpec)

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

func (FrontendMTLSSpec) GetCertificateMountPath 

func (FrontendMTLSSpec) GetCertificateMountPath() string

GetCertificateMountPath returns the mount path for the frontend certificate.

func (FrontendMTLSSpec) GetIntermediateCACertificateMountPath 

func (FrontendMTLSSpec) GetIntermediateCACertificateMountPath() string

GetIntermediateCACertificateMountPath returns the mount path for intermediate CA certificates.

func (FrontendMTLSSpec) GetWorkerCertificateMountPath 

func (FrontendMTLSSpec) GetWorkerCertificateMountPath() string

GetWorkerCertificateMountPath returns the mount path for the worker certificate.

func (FrontendMTLSSpec) ServerName 

func (FrontendMTLSSpec) ServerName(serverName string) string

ServerName returns frontend servername for mTLS certificates.

type GCSArchiver added in v0.15.0 

type GCSArchiver struct {
	// SecretAccessKeyRef is the secret key selector containing Google Cloud Storage credentials file.
	// +kubebuilder:validation:Required
	CredentialsRef *corev1.SecretKeySelector `json:"credentialsRef"`
}

GCSArchiver is the GCS archival provider configuration.

func (GCSArchiver) CredentialsFileMountPath added in v0.15.0 

func (GCSArchiver) CredentialsFileMountPath() string

func (*GCSArchiver) DeepCopy added in v0.15.0 

func (in *GCSArchiver) DeepCopy() *GCSArchiver

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

func (*GCSArchiver) DeepCopyInto added in v0.15.0 

func (in *GCSArchiver) DeepCopyInto(out *GCSArchiver)

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

type GitRepositoryRef added in v0.8.0 

type GitRepositoryRef struct {
	// Branch to check out, defaults to 'main' if no other field is defined.
	// +optional
	Branch string `json:"branch,omitempty"`
}

GitRepositoryRef specifies the Git reference to resolve and checkout.

func (*GitRepositoryRef) DeepCopy added in v0.8.0 

func (in *GitRepositoryRef) DeepCopy() *GitRepositoryRef

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

func (*GitRepositoryRef) DeepCopyInto added in v0.8.0 

func (in *GitRepositoryRef) DeepCopyInto(out *GitRepositoryRef)

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

type GitRepositorySpec added in v0.8.0 

type GitRepositorySpec struct {
	// URL specifies the Git repository URL, it can be an HTTP/S or SSH address.
	// +kubebuilder:validation:Pattern="^(http|https|ssh)://.*$"
	// +required
	URL string `json:"url"`
	// Reference specifies the Git reference to resolve and monitor for
	// changes, defaults to the 'master' branch.
	// +optional
	Reference *GitRepositoryRef `json:"reference,omitempty"`
}

GitRepositorySpec specifies the required configuration to produce an Artifact for a Git repository.

func (*GitRepositorySpec) DeepCopy added in v0.8.0 

func (in *GitRepositorySpec) DeepCopy() *GitRepositorySpec

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

func (*GitRepositorySpec) DeepCopyInto added in v0.8.0 

func (in *GitRepositorySpec) DeepCopyInto(out *GitRepositorySpec)

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

type InternalFrontendServiceSpec added in v0.12.0 

type InternalFrontendServiceSpec struct {
	ServiceSpec `json:",inline"`
	// Enabled defines if we want to spawn the internal frontend service.
	// +optional
	// +kubebuilder:default:=false
	Enabled bool `json:"enabled,omitempty"`
}

InternalFrontendServiceSpec contains temporal internal frontend service specifications.

func (*InternalFrontendServiceSpec) DeepCopy added in v0.12.0 

func (in *InternalFrontendServiceSpec) DeepCopy() *InternalFrontendServiceSpec

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

func (*InternalFrontendServiceSpec) DeepCopyInto added in v0.12.0 

func (in *InternalFrontendServiceSpec) DeepCopyInto(out *InternalFrontendServiceSpec)

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

func (*InternalFrontendServiceSpec) IsEnabled added in v0.12.0 

func (s *InternalFrontendServiceSpec) IsEnabled() bool

type InternodeMTLSSpec 

type InternodeMTLSSpec struct {
	// Enabled defines if the operator should enable mTLS for network between cluster nodes.
	// +optional
	Enabled bool `json:"enabled"`
}

InternodeMTLSSpec defines parameters for the temporal encryption in transit with mTLS.

func (*InternodeMTLSSpec) DeepCopy 

func (in *InternodeMTLSSpec) DeepCopy() *InternodeMTLSSpec

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

func (*InternodeMTLSSpec) DeepCopyInto 

func (in *InternodeMTLSSpec) DeepCopyInto(out *InternodeMTLSSpec)

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

func (InternodeMTLSSpec) GetCertificateMountPath 

func (InternodeMTLSSpec) GetCertificateMountPath() string

GetCertificateMountPath returns the mount path for the internode certificate.

func (InternodeMTLSSpec) GetIntermediateCACertificateMountPath 

func (InternodeMTLSSpec) GetIntermediateCACertificateMountPath() string

GetIntermediateCACertificateMountPath returns the mount path for intermediate CA certificates.

func (InternodeMTLSSpec) ServerName 

func (InternodeMTLSSpec) ServerName(serverName string) string

ServerName returns internode servername for mTLS certificates.

type LogSpec added in v0.15.2 

type LogSpec struct {
	// Stdout is true if the output needs to goto standard out; default is stderr.
	// +optional
	// +kubebuilder:default=true
	Stdout *bool `json:"stdout"`
	// Level is the desired log level; see colocated zap_logger.go::parseZapLevel()
	// +optional
	// +kubebuilder:validation:Enum=debug;info;warn;error;dpanic;panic;fatal
	// +kubebuilder:default=info
	Level string `json:"level"`
	// OutputFile is the path to the log output file.
	// +optional
	OutputFile string `json:"outputFile"`
	// Format determines the format of each log file printed to the output.
	// Use "console" if you want stack traces to appear on multiple lines.
	// +kubebuilder:validation:Enum=json;console
	// +kubebuilder:default=json
	// +optional
	Format string `json:"format"`
	// Development determines whether the logger is run in Development (== Test) or in
	// Production mode.  Default is Production.  Production-stage disables panics from
	// DPanic logging.
	// +kubebuilder:default=false
	// +optional
	Development bool `json:"development"`
}

LogSpec contains the temporal logging configuration.

func (*LogSpec) DeepCopy added in v0.15.2 

func (in *LogSpec) DeepCopy() *LogSpec

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

func (*LogSpec) DeepCopyInto added in v0.15.2 

func (in *LogSpec) DeepCopyInto(out *LogSpec)

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

type MTLSProvider 

type MTLSProvider string

MTLSProvider is the enum for support mTLS provider. 

const (
	// CertManagerMTLSProvider uses cert-manager to manage mTLS certificate.
	CertManagerMTLSProvider MTLSProvider = "cert-manager"
	LinkerdMTLSProvider     MTLSProvider = "linkerd"
	IstioMTLSProvider       MTLSProvider = "istio"
)

type MTLSSpec 

type MTLSSpec struct {
	// Provider defines the tool used to manage mTLS certificates.
	// +kubebuilder:default=cert-manager
	// +kubebuilder:validation:Enum=cert-manager;linkerd;istio
	// +optional
	Provider MTLSProvider `json:"provider"`
	// Internode allows configuration of the internode traffic encryption.
	// Useless if mTLS provider is not cert-manager.
	// +optional
	Internode *InternodeMTLSSpec `json:"internode,omitempty"`
	// Frontend allows configuration of the frontend's public endpoint traffic encryption.
	// Useless if mTLS provider is not cert-manager.
	// +optional
	Frontend *FrontendMTLSSpec `json:"frontend,omitempty"`
	// CertificatesDuration allows configuration of maximum certificates lifetime.
	// Useless if mTLS provider is not cert-manager.
	// +optional
	CertificatesDuration *CertificatesDurationSpec `json:"certificatesDuration,omitempty"`
	// RefreshInterval defines interval between refreshes of certificates in the cluster components.
	// Defaults to 1 hour.
	// Useless if mTLS provider is not cert-manager.
	// +optional
	RefreshInterval *metav1.Duration `json:"refreshInterval"`
	// RenewBefore is defines how long before the currently issued certificate's expiry
	// cert-manager should renew the certificate. The default is 2/3 of the
	// issued certificate's duration. Minimum accepted value is 5 minutes.
	// Useless if mTLS provider is not cert-manager.
	// +optional
	RenewBefore *metav1.Duration `json:"renewBefore,omitempty"`
}

MTLSSpec defines parameters for the temporal encryption in transit with mTLS.

func (*MTLSSpec) DeepCopy 

func (in *MTLSSpec) DeepCopy() *MTLSSpec

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

func (*MTLSSpec) DeepCopyInto 

func (in *MTLSSpec) DeepCopyInto(out *MTLSSpec)

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

func (*MTLSSpec) FrontendEnabled 

func (m *MTLSSpec) FrontendEnabled() bool

func (*MTLSSpec) InternodeEnabled 

func (m *MTLSSpec) InternodeEnabled() bool

func (*MTLSSpec) Validate added in v0.15.4 

func (m *MTLSSpec) Validate() (admission.Warnings, field.ErrorList)

type MetricsSpec 

type MetricsSpec struct {
	// Enabled defines if the operator should enable metrics exposition on temporal components.
	Enabled bool `json:"enabled"`
	// PerUnitHistogramBoundaries defines the default histogram bucket boundaries.
	// Configuration of histogram boundaries for given metric unit.
	//
	// Supported values:
	// - "dimensionless"
	// - "milliseconds"
	// - "bytes"
	// +optional
	PerUnitHistogramBoundaries map[string][]string `json:"perUnitHistogramBoundaries,omitempty"`
	// Prometheus reporter configuration.
	// +optional
	Prometheus *PrometheusSpec `json:"prometheus,omitempty"`
}

MetricsSpec determines parameters for configuring metrics endpoints.

func (*MetricsSpec) DeepCopy 

func (in *MetricsSpec) DeepCopy() *MetricsSpec

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

func (*MetricsSpec) DeepCopyInto 

func (in *MetricsSpec) DeepCopyInto(out *MetricsSpec)

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

func (*MetricsSpec) IsEnabled added in v0.12.0 

func (m *MetricsSpec) IsEnabled() bool

type ObjectMetaOverride added in v0.9.0 

type ObjectMetaOverride struct {
	// Map of string keys and values that can be used to organize and categorize
	// (scope and select) objects.
	// +optional
	Labels map[string]string `json:"labels,omitempty"`

	// Annotations is an unstructured key value map stored with a resource that may be
	// set by external tools to store and retrieve arbitrary metadata.
	// +optional
	Annotations map[string]string `json:"annotations,omitempty"`
}

ObjectMetaOverride provides the ability to override an object metadata. It's a subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta.

func (*ObjectMetaOverride) DeepCopy added in v0.9.0 

func (in *ObjectMetaOverride) DeepCopy() *ObjectMetaOverride

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

func (*ObjectMetaOverride) DeepCopyInto added in v0.9.0 

func (in *ObjectMetaOverride) DeepCopyInto(out *ObjectMetaOverride)

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

type PodTemplateSpecOverride added in v0.9.0 

type PodTemplateSpecOverride struct {
	*ObjectMetaOverride `json:"metadata,omitempty"`

	// Specification of the desired behavior of the pod.
	// +optional
	Spec *corev1.PodSpec `json:"spec,omitempty"`
}

PodTemplateSpecOverride provides the ability to override a pod template spec. It's a subset of the fields included in k8s.io/api/core/v1.PodTemplateSpec.

func (*PodTemplateSpecOverride) DeepCopy added in v0.9.0 

func (in *PodTemplateSpecOverride) DeepCopy() *PodTemplateSpecOverride

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

func (*PodTemplateSpecOverride) DeepCopyInto added in v0.9.0 

func (in *PodTemplateSpecOverride) DeepCopyInto(out *PodTemplateSpecOverride)

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

type PrometheusScrapeConfig added in v0.9.0 

type PrometheusScrapeConfig struct {
	// Annotations defines if the operator should add prometheus scrape annotations to the services pods.
	// +optional
	Annotations bool `json:"annotations"`
	// +optional
	ServiceMonitor *PrometheusScrapeConfigServiceMonitor `json:"serviceMonitor,omitempty"`
}

PrometheusScrapeConfig is the configuration for making prometheus scrape components metrics.

func (*PrometheusScrapeConfig) DeepCopy added in v0.9.0 

func (in *PrometheusScrapeConfig) DeepCopy() *PrometheusScrapeConfig

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

func (*PrometheusScrapeConfig) DeepCopyInto added in v0.9.0 

func (in *PrometheusScrapeConfig) DeepCopyInto(out *PrometheusScrapeConfig)

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

type PrometheusScrapeConfigServiceMonitor added in v0.9.0 

type PrometheusScrapeConfigServiceMonitor struct {
	// Enabled defines if the operator should create a ServiceMonitor for each services.
	// +optional
	Enabled bool `json:"enabled"`
	// Labels adds extra labels to the ServiceMonitor.
	// +optional
	Labels map[string]string `json:"labels,omitempty"`
	// Override allows customization of the created ServiceMonitor.
	// All fields can be overwritten except "endpoints", "selector" and "namespaceSelector".
	// +optional
	Override *monitoringv1.ServiceMonitorSpec `json:"override,omitempty"`
	// MetricRelabelConfigs to apply to samples before ingestion.
	// +optional
	MetricRelabelConfigs []*monitoringv1.RelabelConfig `json:"metricRelabelings,omitempty"`
}

PrometheusScrapeConfigServiceMonitor is the configuration for prometheus operator ServiceMonitor.

func (*PrometheusScrapeConfigServiceMonitor) DeepCopy added in v0.10.0 

func (in *PrometheusScrapeConfigServiceMonitor) DeepCopy() *PrometheusScrapeConfigServiceMonitor

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

func (*PrometheusScrapeConfigServiceMonitor) DeepCopyInto added in v0.10.0 

func (in *PrometheusScrapeConfigServiceMonitor) DeepCopyInto(out *PrometheusScrapeConfigServiceMonitor)

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

type PrometheusSpec 

type PrometheusSpec struct {
	// Deprecated. Address for prometheus to serve metrics from.
	// +optional
	// +deprecated
	ListenAddress string `json:"listenAddress"`
	// ListenPort for prometheus to serve metrics from.
	// +optional
	ListenPort *int32 `json:"listenPort,omitempty"`
	// ScrapeConfig is the prometheus scrape configuration.
	// +optional
	ScrapeConfig *PrometheusScrapeConfig `json:"scrapeConfig,omitempty"`
}

PrometheusSpec is the configuration for prometheus reporter.

func (*PrometheusSpec) DeepCopy 

func (in *PrometheusSpec) DeepCopy() *PrometheusSpec

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

func (*PrometheusSpec) DeepCopyInto 

func (in *PrometheusSpec) DeepCopyInto(out *PrometheusSpec)

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

type S3Archiver added in v0.15.0 

type S3Archiver struct {
	// Region is the aws s3 region.
	// +kubebuilder:validation:Required
	Region string `json:"region"`
	// Use Endpoint if you want to use s3-compatible object storage.
	// +optional
	Endpoint *string `json:"endpoint,omitempty"`
	// Use RoleName if you want the temporal service account
	// to assume an AWS Identity and Access Management (IAM) role.
	// +optional
	RoleName *string `json:"roleName,omitempty"`
	// Use credentials if you want to use aws credentials from secret.
	// +optional
	Credentials *S3Credentials `json:"credentials,omitempty"`
	// Use s3ForcePathStyle if you want to use s3 path style.
	// +optional
	S3ForcePathStyle bool `json:"s3ForcePathStyle"`
}

S3Archiver is the S3 archival provider configuration.

func (*S3Archiver) DeepCopy added in v0.15.0 

func (in *S3Archiver) DeepCopy() *S3Archiver

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

func (*S3Archiver) DeepCopyInto added in v0.15.0 

func (in *S3Archiver) DeepCopyInto(out *S3Archiver)

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

type S3Credentials added in v0.15.0 

type S3Credentials struct {
	// AccessKeyIDRef is the secret key selector containing AWS access key ID.
	// +kubebuilder:validation:Required
	AccessKeyIDRef *corev1.SecretKeySelector `json:"accessKeyIdRef"`
	// SecretAccessKeyRef is the secret key selector containing AWS secret access key.
	// +kubebuilder:validation:Required
	SecretAccessKeyRef *corev1.SecretKeySelector `json:"secretKeyRef"`
}

func (*S3Credentials) DeepCopy added in v0.15.0 

func (in *S3Credentials) DeepCopy() *S3Credentials

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

func (*S3Credentials) DeepCopyInto added in v0.15.0 

func (in *S3Credentials) DeepCopyInto(out *S3Credentials)

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

type SQLSpec 

type SQLSpec struct {
	// User is the username to be used for the connection.
	User string `json:"user"`
	// PluginName is the name of SQL plugin.
	// +kubebuilder:validation:Enum=postgres;postgres12;mysql;mysql8
	PluginName string `json:"pluginName"`
	// DatabaseName is the name of SQL database to connect to.
	DatabaseName string `json:"databaseName"`
	// ConnectAddr is the remote addr of the database.
	ConnectAddr string `json:"connectAddr"`
	// ConnectProtocol is the protocol that goes with the ConnectAddr.
	// +optional
	ConnectProtocol string `json:"connectProtocol"`
	// ConnectAttributes is a set of key-value attributes to be sent as part of connect data_source_name url
	// +optional
	ConnectAttributes map[string]string `json:"connectAttributes,omitempty"`
	// MaxConns the max number of connections to this datastore.
	// +optional
	MaxConns int `json:"maxConns"`
	// MaxIdleConns is the max number of idle connections to this datastore.
	// +optional
	MaxIdleConns int `json:"maxIdleConns"`
	// MaxConnLifetime is the maximum time a connection can be alive
	// +optional
	MaxConnLifetime metav1.Duration `json:"maxConnLifetime"`
	// TaskScanPartitions is the number of partitions to sequentially scan during ListTaskQueue operations.
	// +optional
	TaskScanPartitions int `json:"taskScanPartitions"`
	// GCPServiceAccount is the service account to use to authenticate with GCP CloudSQL.
	// +optional
	GCPServiceAccount *string `json:"gcpServiceAccount,omitempty"`
}

SQLSpec contains SQL datastore connections specifications.

func (*SQLSpec) DeepCopy 

func (in *SQLSpec) DeepCopy() *SQLSpec

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

func (*SQLSpec) DeepCopyInto 

func (in *SQLSpec) DeepCopyInto(out *SQLSpec)

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

type SecretKeyReference 

type SecretKeyReference struct {
	// Name of the Secret.
	// +required
	Name string `json:"name"`
	// Key in the Secret.
	// +optional
	Key string `json:"key,omitempty"`
}

SecretKeyReference contains enough information to locate the referenced Kubernetes Secret object in the same namespace.

func (*SecretKeyReference) DeepCopy 

func (in *SecretKeyReference) DeepCopy() *SecretKeyReference

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

func (*SecretKeyReference) DeepCopyInto 

func (in *SecretKeyReference) DeepCopyInto(out *SecretKeyReference)

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

type ServiceSpec 

type ServiceSpec struct {
	// Port defines a custom gRPC port for the service.
	// Default values are:
	// 7233 for Frontend service
	// 7234 for History service
	// 7235 for Matching service
	// 7239 for Worker service
	// +optional
	Port *int `json:"port"`
	// MembershipPort defines a custom membership port for the service.
	// Default values are:
	// 6933 for Frontend service
	// 6934 for History service
	// 6935 for Matching service
	// 6939 for Worker service
	// +optional
	MembershipPort *int `json:"membershipPort"`
	// HTTPPort defines a custom http port for the service.
	// Default values are:
	// 7243 for Frontend service
	// +optional
	HTTPPort *int `json:"httpPort"`
	// Number of desired replicas for the service. Default to 1.
	// +kubebuilder:validation:Minimum=1
	// +optional
	Replicas *int32 `json:"replicas"`
	// Compute Resources required by this service.
	// More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
	// +optional
	Resources corev1.ResourceRequirements `json:"resources,omitempty"`
	// Overrides adds some overrides to the resources deployed for the service.
	// Those overrides takes precedence over spec.services.overrides.
	// +optional
	Overrides *ServiceSpecOverride `json:"overrides,omitempty"`
	// InitContainers adds a list of init containers to the service's deployment.
	// +optional
	InitContainers []corev1.Container `json:"initContainers,omitempty"`
}

ServiceSpec contains a temporal service specifications.

func (*ServiceSpec) DeepCopy 

func (in *ServiceSpec) DeepCopy() *ServiceSpec

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

func (*ServiceSpec) DeepCopyInto 

func (in *ServiceSpec) DeepCopyInto(out *ServiceSpec)

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

type ServiceSpecOverride added in v0.9.0 

type ServiceSpecOverride struct {
	// Override configuration for the temporal service Deployment.
	Deployment *DeploymentOverride `json:"deployment,omitempty"`
}

ServiceSpecOverride provides the ability to override the generated manifests of a temporal service.

func (*ServiceSpecOverride) DeepCopy added in v0.9.0 

func (in *ServiceSpecOverride) DeepCopy() *ServiceSpecOverride

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

func (*ServiceSpecOverride) DeepCopyInto added in v0.9.0 

func (in *ServiceSpecOverride) DeepCopyInto(out *ServiceSpecOverride)

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

type ServiceStatus 

type ServiceStatus struct {
	// Name of the temporal service.
	Name string `json:"name"`
	// Current observed version of the service.
	Version string `json:"version"`
	// Ready defines if the service is ready.
	Ready bool `json:"ready"`
}

ServiceStatus reports a service status.

func (*ServiceStatus) DeepCopy 

func (in *ServiceStatus) DeepCopy() *ServiceStatus

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

func (*ServiceStatus) DeepCopyInto 

func (in *ServiceStatus) DeepCopyInto(out *ServiceStatus)

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

type ServicesSpec 

type ServicesSpec struct {
	// Frontend service custom specifications.
	// +optional
	Frontend *ServiceSpec `json:"frontend,omitempty"`
	// Internal Frontend service custom specifications.
	// Only compatible with temporal >= 1.20.0
	// +optional
	InternalFrontend *InternalFrontendServiceSpec `json:"internalFrontend,omitempty"`
	// History service custom specifications.
	// +optional
	History *ServiceSpec `json:"history,omitempty"`
	// Matching service custom specifications.
	// +optional
	Matching *ServiceSpec `json:"matching,omitempty"`
	// Worker service custom specifications.
	// +optional
	Worker *ServiceSpec `json:"worker,omitempty"`
	// Overrides adds some overrides to the resources deployed for all temporal services services.
	// Those overrides can be customized per service using spec.services.<serviceName>.overrides.
	// +optional
	Overrides *ServiceSpecOverride `json:"overrides,omitempty"`
}

ServicesSpec contains all temporal services specifications.

func (*ServicesSpec) DeepCopy 

func (in *ServicesSpec) DeepCopy() *ServicesSpec

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

func (*ServicesSpec) DeepCopyInto 

func (in *ServicesSpec) DeepCopyInto(out *ServicesSpec)

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

func (*ServicesSpec) GetServiceSpec 

func (s *ServicesSpec) GetServiceSpec(name primitives.ServiceName) (*ServiceSpec, error)

GetServiceSpec returns service spec from its name.

type TemporalAdminToolsSpec 

type TemporalAdminToolsSpec struct {
	// Enabled defines if the operator should deploy the admin tools alongside the cluster.
	// +optional
	Enabled bool `json:"enabled"`
	// Image defines the temporal admin tools docker image the instance should run.
	// +optional
	Image string `json:"image"`
	// Compute Resources required by the ui.
	// More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
	// +optional
	Resources corev1.ResourceRequirements `json:"resources,omitempty"`
	// Overrides adds some overrides to the resources deployed for the ui.
	// +optional
	Overrides *ServiceSpecOverride `json:"overrides,omitempty"`
}

TemporalAdminToolsSpec defines parameters for the temporal admin tools within a Temporal cluster deployment. Note that deployed admin tools version is the same as the cluster's version.

func (*TemporalAdminToolsSpec) DeepCopy 

func (in *TemporalAdminToolsSpec) DeepCopy() *TemporalAdminToolsSpec

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

func (*TemporalAdminToolsSpec) DeepCopyInto 

func (in *TemporalAdminToolsSpec) DeepCopyInto(out *TemporalAdminToolsSpec)

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

type TemporalCluster 

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

	// Specification of the desired behavior of the Temporal cluster.
	Spec TemporalClusterSpec `json:"spec,omitempty"`
	// Most recent observed status of the Temporal cluster.
	Status TemporalClusterStatus `json:"status,omitempty"`
}

TemporalCluster defines a temporal cluster deployment.

func (*TemporalCluster) ChildResourceName 

func (c *TemporalCluster) ChildResourceName(resource string) string

ChildResourceName returns child resource name using the cluster's name.

func (*TemporalCluster) DeepCopy 

func (in *TemporalCluster) DeepCopy() *TemporalCluster

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

func (*TemporalCluster) DeepCopyInto 

func (in *TemporalCluster) DeepCopyInto(out *TemporalCluster)

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

func (*TemporalCluster) DeepCopyObject 

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

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

func (*TemporalCluster) Default added in v0.10.0 

func (c *TemporalCluster) Default()

Default set default fields values.

func (*TemporalCluster) GetPublicClientAddress 

func (c *TemporalCluster) GetPublicClientAddress() string

func (*TemporalCluster) IsReady added in v0.13.3 

func (c *TemporalCluster) IsReady() bool

IsReady returns true if the TemporalCluster's conditions reports it ready.

func (*TemporalCluster) MTLSWithCertManagerEnabled 

func (c *TemporalCluster) MTLSWithCertManagerEnabled() bool

MTLSEnabled returns true if mTLS is enabled for internode or frontend using cert-manager.

func (*TemporalCluster) SelectorLabels added in v0.13.0 

func (c *TemporalCluster) SelectorLabels() map[string]string

func (*TemporalCluster) ServerName 

func (c *TemporalCluster) ServerName() string

ServerName returns cluster's server name.

type TemporalClusterClient 

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

	Spec   TemporalClusterClientSpec   `json:"spec,omitempty"`
	Status TemporalClusterClientStatus `json:"status,omitempty"`
}

A TemporalClusterClient creates a new mTLS client in the targeted temporal cluster.

func (*TemporalClusterClient) DeepCopy 

func (in *TemporalClusterClient) DeepCopy() *TemporalClusterClient

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

func (*TemporalClusterClient) DeepCopyInto 

func (in *TemporalClusterClient) DeepCopyInto(out *TemporalClusterClient)

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

func (*TemporalClusterClient) DeepCopyObject 

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

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

type TemporalClusterClientList 

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

TemporalClusterClientList contains a list of ClusterClient.

func (*TemporalClusterClientList) DeepCopy 

func (in *TemporalClusterClientList) DeepCopy() *TemporalClusterClientList

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

func (*TemporalClusterClientList) DeepCopyInto 

func (in *TemporalClusterClientList) DeepCopyInto(out *TemporalClusterClientList)

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

func (*TemporalClusterClientList) DeepCopyObject 

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

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

type TemporalClusterClientSpec 

type TemporalClusterClientSpec struct {
	// Reference to the temporal cluster the client will get access to.
	ClusterRef TemporalClusterReference `json:"clusterRef"`
}

TemporalClusterClientSpec defines the desired state of ClusterClient.

func (*TemporalClusterClientSpec) DeepCopy 

func (in *TemporalClusterClientSpec) DeepCopy() *TemporalClusterClientSpec

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

func (*TemporalClusterClientSpec) DeepCopyInto 

func (in *TemporalClusterClientSpec) DeepCopyInto(out *TemporalClusterClientSpec)

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

type TemporalClusterClientStatus 

type TemporalClusterClientStatus struct {
	// ServerName is the hostname returned by the certificate.
	ServerName string `json:"serverName"`
	// Reference to the Kubernetes Secret containing the certificate for the client.
	SecretRef *corev1.LocalObjectReference `json:"secretRef,omitempty"`
}

TemporalClusterClientStatus defines the observed state of ClusterClient.

func (*TemporalClusterClientStatus) DeepCopy 

func (in *TemporalClusterClientStatus) DeepCopy() *TemporalClusterClientStatus

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

func (*TemporalClusterClientStatus) DeepCopyInto 

func (in *TemporalClusterClientStatus) DeepCopyInto(out *TemporalClusterClientStatus)

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

type TemporalClusterList 

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

TemporalClusterList contains a list of Cluster.

func (*TemporalClusterList) DeepCopy 

func (in *TemporalClusterList) DeepCopy() *TemporalClusterList

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

func (*TemporalClusterList) DeepCopyInto 

func (in *TemporalClusterList) DeepCopyInto(out *TemporalClusterList)

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

func (*TemporalClusterList) DeepCopyObject 

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

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

type TemporalClusterReference added in v0.8.0 

type TemporalClusterReference struct {
	// The name of the TemporalCluster to reference.
	Name string `json:"name,omitempty"`
	// The namespace of the TemporalCluster to reference.
	// Defaults to the namespace of the requested resource if omitted.
	// +kubebuilder:validation:Optional
	Namespace string `json:"namespace,omitempty"`
}

TemporalClusterReference is a reference to a TemporalCluster.

func (*TemporalClusterReference) DeepCopy added in v0.8.0 

func (in *TemporalClusterReference) DeepCopy() *TemporalClusterReference

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

func (*TemporalClusterReference) DeepCopyInto added in v0.8.0 

func (in *TemporalClusterReference) DeepCopyInto(out *TemporalClusterReference)

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

func (*TemporalClusterReference) NamespacedName added in v0.10.0 

func (r *TemporalClusterReference) NamespacedName(obj client.Object) types.NamespacedName

NamespacedName returns NamespacedName for the referenced TemporalCluster. If the namespace is not set, it uses the provided object's namespace.

type TemporalClusterSpec 

type TemporalClusterSpec struct {
	// Image defines the temporal server docker image the cluster should use for each services.
	// +optional
	Image string `json:"image"`
	// Version defines the temporal version the cluster to be deployed.
	// This version impacts the underlying persistence schemas versions.
	// +optional
	Version *version.Version `json:"version"`
	// Log defines temporal cluster's logger configuration.
	// +optional
	Log *LogSpec `json:"log,omitempty"`
	// JobTTLSecondsAfterFinished is amount of time to keep job pods after jobs are completed.
	// Defaults to 300 seconds.
	// +optional
	//+kubebuilder:default:=300
	//+kubebuilder:validation:Minimum=1
	JobTTLSecondsAfterFinished *int32 `json:"jobTtlSecondsAfterFinished"`
	// JobResources allows set resources for setup/update jobs.
	// +optional
	JobResources corev1.ResourceRequirements `json:"jobResources,omitempty"`
	// JobInitContainers adds a list of init containers to the setup's jobs.
	// +optional
	JobInitContainers []corev1.Container `json:"jobInitContainers,omitempty"`
	// NumHistoryShards is the desired number of history shards.
	// This field is immutable.
	//+kubebuilder:validation:Minimum=1
	NumHistoryShards int32 `json:"numHistoryShards"`
	// Services allows customizations for each temporal services deployment.
	// +optional
	Services *ServicesSpec `json:"services,omitempty"`
	// Persistence defines temporal persistence configuration.
	Persistence TemporalPersistenceSpec `json:"persistence"`
	// An optional list of references to secrets in the same namespace
	// to use for pulling temporal images from registries.
	// +optional
	ImagePullSecrets []corev1.LocalObjectReference `json:"imagePullSecrets,omitempty"`
	// UI allows configuration of the optional temporal web ui deployed alongside the cluster.
	// +optional
	UI *TemporalUISpec `json:"ui,omitempty"`
	// AdminTools allows configuration of the optional admin tool pod deployed alongside the cluster.
	// +optional
	AdminTools *TemporalAdminToolsSpec `json:"admintools,omitempty"`
	// MTLS allows configuration of the network traffic encryption for the cluster.
	// +optional
	MTLS *MTLSSpec `json:"mTLS,omitempty"` //nolint:tagliatelle
	// Metrics allows configuration of scraping endpoints for stats. prometheus or m3.
	// +optional
	Metrics *MetricsSpec `json:"metrics,omitempty"`
	// DynamicConfig allows advanced configuration for the temporal cluster.
	// +optional
	DynamicConfig *DynamicConfigSpec `json:"dynamicConfig,omitempty"`
	// Archival allows Workflow Execution Event Histories and Visibility data backups for the temporal cluster.
	// +optional
	Archival *ClusterArchivalSpec `json:"archival,omitempty"`
	// Authorization allows authorization configuration for the temporal cluster.
	// +optional
	Authorization *AuthorizationSpec `json:"authorization,omitempty"`
}

TemporalClusterSpec defines the desired state of Cluster.

func (*TemporalClusterSpec) DeepCopy 

func (in *TemporalClusterSpec) DeepCopy() *TemporalClusterSpec

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

func (*TemporalClusterSpec) DeepCopyInto 

func (in *TemporalClusterSpec) DeepCopyInto(out *TemporalClusterSpec)

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

type TemporalClusterStatus 

type TemporalClusterStatus struct {
	// Version holds the current temporal version.
	Version string `json:"version,omitempty"`
	// Services holds all services statuses.
	Services []ServiceStatus `json:"services,omitempty"`
	// Persistence holds all datastores statuses.
	Persistence *TemporalPersistenceStatus `json:"persistence,omitempty"`
	// Conditions represent the latest available observations of the Cluster state.
	Conditions []metav1.Condition `json:"conditions"`
}

TemporalClusterStatus defines the observed state of Cluster.

func (*TemporalClusterStatus) AddServiceStatus 

func (s *TemporalClusterStatus) AddServiceStatus(status *ServiceStatus)

AddServiceStatus adds the provided service status to the cluster's status.

func (*TemporalClusterStatus) DeepCopy 

func (in *TemporalClusterStatus) DeepCopy() *TemporalClusterStatus

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

func (*TemporalClusterStatus) DeepCopyInto 

func (in *TemporalClusterStatus) DeepCopyInto(out *TemporalClusterStatus)

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

type TemporalNamespace 

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

	Spec   TemporalNamespaceSpec   `json:"spec,omitempty"`
	Status TemporalNamespaceStatus `json:"status,omitempty"`
}

A TemporalNamespace creates a namespace in the targeted temporal cluster.

func (*TemporalNamespace) DeepCopy 

func (in *TemporalNamespace) DeepCopy() *TemporalNamespace

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

func (*TemporalNamespace) DeepCopyInto 

func (in *TemporalNamespace) DeepCopyInto(out *TemporalNamespace)

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

func (*TemporalNamespace) DeepCopyObject 

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

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

type TemporalNamespaceArchivalSpec added in v0.15.0 

type TemporalNamespaceArchivalSpec struct {
	// History is the config for this namespace history archival.
	// +optional
	History *ArchivalSpec `json:"history,omitempty"`
	// Visibility is the config for this namespace visibility archival.
	// +optional
	Visibility *ArchivalSpec `json:"visibility,omitempty"`
}

TemporalNamespaceArchivalSpec is a per-namespace archival configuration override.

func (*TemporalNamespaceArchivalSpec) DeepCopy added in v0.15.0 

func (in *TemporalNamespaceArchivalSpec) DeepCopy() *TemporalNamespaceArchivalSpec

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

func (*TemporalNamespaceArchivalSpec) DeepCopyInto added in v0.15.0 

func (in *TemporalNamespaceArchivalSpec) DeepCopyInto(out *TemporalNamespaceArchivalSpec)

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

type TemporalNamespaceList 

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

TemporalNamespaceList contains a list of Namespace.

func (*TemporalNamespaceList) DeepCopy 

func (in *TemporalNamespaceList) DeepCopy() *TemporalNamespaceList

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

func (*TemporalNamespaceList) DeepCopyInto 

func (in *TemporalNamespaceList) DeepCopyInto(out *TemporalNamespaceList)

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

func (*TemporalNamespaceList) DeepCopyObject 

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

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

type TemporalNamespaceSpec 

type TemporalNamespaceSpec struct {
	// Reference to the temporal cluster the namespace will be created.
	ClusterRef TemporalClusterReference `json:"clusterRef"`
	// Namespace description.
	// +optional
	Description string `json:"description,omitempty"`
	// Namespace owner email.
	// +optional
	OwnerEmail string `json:"ownerEmail,omitempty"`
	// RetentionPeriod to apply on closed workflow executions.
	RetentionPeriod *metav1.Duration `json:"retentionPeriod"`
	// Data is a key-value map for any customized purpose.
	// +optional
	Data map[string]string `json:"data,omitempty"`
	// +optional
	SecurityToken string `json:"securityToken,omitempty"`
	// IsGlobalNamespace defines whether the namespace is a global namespace.
	// +optional
	IsGlobalNamespace bool `json:"isGlobalNamespace,omitempty"`
	// List of clusters names to which the namespace can fail over.
	// Only applicable if the namespace is a global namespace.
	// +optional
	Clusters []string `json:"clusters,omitempty"`
	// The name of active Temporal Cluster.
	// Only applicable if the namespace is a global namespace.
	// +optional
	ActiveClusterName string `json:"activeClusterName,omitempty"`
	// AllowDeletion makes the controller delete the Temporal namespace if the
	// CRD is deleted.
	// +optional
	AllowDeletion bool `json:"allowDeletion,omitempty"`
	// Archival is a per-namespace archival configuration.
	// If not set, the default cluster configuration is used.
	// +optional
	Archival *TemporalNamespaceArchivalSpec `json:"archival,omitempty"`
}

TemporalNamespaceSpec defines the desired state of Namespace.

func (*TemporalNamespaceSpec) DeepCopy 

func (in *TemporalNamespaceSpec) DeepCopy() *TemporalNamespaceSpec

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

func (*TemporalNamespaceSpec) DeepCopyInto 

func (in *TemporalNamespaceSpec) DeepCopyInto(out *TemporalNamespaceSpec)

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

type TemporalNamespaceStatus 

type TemporalNamespaceStatus struct {
	// Conditions represent the latest available observations of the Namespace state.
	Conditions []metav1.Condition `json:"conditions"`
}

TemporalNamespaceStatus defines the observed state of Namespace.

func (*TemporalNamespaceStatus) DeepCopy 

func (in *TemporalNamespaceStatus) DeepCopy() *TemporalNamespaceStatus

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

func (*TemporalNamespaceStatus) DeepCopyInto 

func (in *TemporalNamespaceStatus) DeepCopyInto(out *TemporalNamespaceStatus)

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

type TemporalPersistenceSpec 

type TemporalPersistenceSpec struct {
	// DefaultStore holds the default datastore specs.
	DefaultStore *DatastoreSpec `json:"defaultStore"`
	// VisibilityStore holds the visibility datastore specs.
	VisibilityStore *DatastoreSpec `json:"visibilityStore"`
	// SecondaryVisibilityStore holds the secondary visibility datastore specs.
	// Feature only available for clusters >= 1.21.0.
	// +optional
	SecondaryVisibilityStore *DatastoreSpec `json:"secondaryVisibilityStore,omitempty"`
	// AdvancedVisibilityStore holds the advanced visibility datastore specs.
	// +optional
	AdvancedVisibilityStore *DatastoreSpec `json:"advancedVisibilityStore,omitempty"`
}

TemporalPersistenceSpec contains temporal persistence specifications.

func (*TemporalPersistenceSpec) DeepCopy 

func (in *TemporalPersistenceSpec) DeepCopy() *TemporalPersistenceSpec

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

func (*TemporalPersistenceSpec) DeepCopyInto 

func (in *TemporalPersistenceSpec) DeepCopyInto(out *TemporalPersistenceSpec)

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

func (*TemporalPersistenceSpec) GetDatastores 

func (p *TemporalPersistenceSpec) GetDatastores() []*DatastoreSpec

func (*TemporalPersistenceSpec) GetDatastoresMap added in v0.12.0 

func (p *TemporalPersistenceSpec) GetDatastoresMap() map[string]*DatastoreSpec

type TemporalPersistenceStatus 

type TemporalPersistenceStatus struct {
	// DefaultStore holds the default datastore status.
	DefaultStore *DatastoreStatus `json:"defaultStore"`
	// VisibilityStore holds the visibility datastore status.
	VisibilityStore *DatastoreStatus `json:"visibilityStore"`
	// SecondaryVisibilityStore holds the secondary visibility datastore status.
	// +optional
	SecondaryVisibilityStore *DatastoreStatus `json:"secondaryVisibilityStore"`
	// AdvancedVisibilityStore holds the advanced visibility datastore status.
	// +optional
	AdvancedVisibilityStore *DatastoreStatus `json:"advancedVisibilityStore,omitempty"`
}

TemporalPersistenceStatus contains temporal persistence status.

func (*TemporalPersistenceStatus) DeepCopy 

func (in *TemporalPersistenceStatus) DeepCopy() *TemporalPersistenceStatus

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

func (*TemporalPersistenceStatus) DeepCopyInto 

func (in *TemporalPersistenceStatus) DeepCopyInto(out *TemporalPersistenceStatus)

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

type TemporalUIIngressSpec 

type TemporalUIIngressSpec struct {
	// Annotations allows custom annotations on the ingress resource.
	Annotations map[string]string `json:"annotations,omitempty"`
	// IngressClassName is the name of the IngressClass the deployed ingress resource should use.
	IngressClassName *string `json:"ingressClassName,omitempty"`
	// Host is the list of host the ingress should use.
	Hosts []string `json:"hosts"`
	// TLS configuration.
	TLS []networkingv1.IngressTLS `json:"tls,omitempty" protobuf:"bytes,2,rep,name=tls"`
}

TemporalUIIngressSpec contains all configurations options for the UI ingress.

func (*TemporalUIIngressSpec) DeepCopy 

func (in *TemporalUIIngressSpec) DeepCopy() *TemporalUIIngressSpec

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

func (*TemporalUIIngressSpec) DeepCopyInto 

func (in *TemporalUIIngressSpec) DeepCopyInto(out *TemporalUIIngressSpec)

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

type TemporalUISpec 

type TemporalUISpec struct {
	// Enabled defines if the operator should deploy the web ui alongside the cluster.
	// +optional
	Enabled bool `json:"enabled"`
	// Version defines the temporal ui version the instance should run.
	// +optional
	Version string `json:"version"`
	// Image defines the temporal ui docker image the instance should run.
	// +optional
	Image string `json:"image"`
	// Number of desired replicas for the ui. Default to 1.
	// +kubebuilder:validation:Minimum=1
	// +optional
	Replicas *int32 `json:"replicas"`
	// Compute Resources required by the ui.
	// More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
	// +optional
	Resources corev1.ResourceRequirements `json:"resources,omitempty"`
	// Overrides adds some overrides to the resources deployed for the ui.
	// +optional
	Overrides *ServiceSpecOverride `json:"overrides,omitempty"`
	// Ingress is an optional ingress configuration for the UI.
	// If lived empty, no ingress configuration will be created and the UI will only by available trough ClusterIP service.
	// +optional
	Ingress *TemporalUIIngressSpec `json:"ingress,omitempty"`
	// Service is an optional service resource configuration for the UI.
	// +optional
	Service *ObjectMetaOverride `json:"service,omitempty"`
}

TemporalUISpec defines parameters for the temporal UI within a Temporal cluster deployment.

func (*TemporalUISpec) DeepCopy 

func (in *TemporalUISpec) DeepCopy() *TemporalUISpec

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

func (*TemporalUISpec) DeepCopyInto 

func (in *TemporalUISpec) DeepCopyInto(out *TemporalUISpec)

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

type TemporalWorkerProcess added in v0.8.0 

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

	Spec   TemporalWorkerProcessSpec   `json:"spec,omitempty"`
	Status TemporalWorkerProcessStatus `json:"status,omitempty"`
}

TemporalWorkerProcess is the Schema for the temporalworkerprocesses API.

func (*TemporalWorkerProcess) ChildResourceName added in v0.8.0 

func (w *TemporalWorkerProcess) ChildResourceName(resource string) string

ChildResourceName returns child resource name using the worker processes name.

func (*TemporalWorkerProcess) DeepCopy added in v0.8.0 

func (in *TemporalWorkerProcess) DeepCopy() *TemporalWorkerProcess

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

func (*TemporalWorkerProcess) DeepCopyInto added in v0.8.0 

func (in *TemporalWorkerProcess) DeepCopyInto(out *TemporalWorkerProcess)

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

func (*TemporalWorkerProcess) DeepCopyObject added in v0.8.0 

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

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

func (*TemporalWorkerProcess) Default added in v0.10.0 

func (w *TemporalWorkerProcess) Default()

Default set default fields values.

func (*TemporalWorkerProcess) SelectorLabels added in v0.13.0 

func (w *TemporalWorkerProcess) SelectorLabels() map[string]string

type TemporalWorkerProcessBuilder added in v0.8.0 

type TemporalWorkerProcessBuilder struct {
	// Enabled defines if the operator should build the temporal worker process.
	// +required
	Enabled bool `json:"enabled"`
	// Version is the version of the image that will be used to build worker image.
	Version string `json:"version,omitempty"`
	// BuildAttempt is the build attempt number of a given version
	BuildAttempt *int32 `json:"attempt,omitempty"`
	// Image is the image that will be used to build worker image.
	Image string `json:"image,omitempty"`
	// BuildDir is the location of where the sources will be built.
	BuildDir string `json:"buildDir,omitempty"`
	// GitRepository specifies how to connect to Git source control.
	GitRepository *GitRepositorySpec `json:"gitRepository,omitempty"`
	// BuildRegistry specifies how to connect to container registry.
	BuildRegistry *ContainerRegistryConfig `json:"buildRegistry,omitempty"`
}

func (*TemporalWorkerProcessBuilder) BuilderEnabled added in v0.8.0 

func (b *TemporalWorkerProcessBuilder) BuilderEnabled() bool

func (*TemporalWorkerProcessBuilder) DeepCopy added in v0.8.0 

func (in *TemporalWorkerProcessBuilder) DeepCopy() *TemporalWorkerProcessBuilder

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

func (*TemporalWorkerProcessBuilder) DeepCopyInto added in v0.8.0 

func (in *TemporalWorkerProcessBuilder) DeepCopyInto(out *TemporalWorkerProcessBuilder)

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

func (*TemporalWorkerProcessBuilder) GetBuildRepoPasswordEnvVarName added in v0.8.0 

func (b *TemporalWorkerProcessBuilder) GetBuildRepoPasswordEnvVarName() string

GetPasswordEnvVarName crafts the environment variable name for the datastore.

type TemporalWorkerProcessList added in v0.8.0 

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

TemporalWorkerProcessList contains a list of TemporalWorkerProcess.

func (*TemporalWorkerProcessList) DeepCopy added in v0.8.0 

func (in *TemporalWorkerProcessList) DeepCopy() *TemporalWorkerProcessList

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

func (*TemporalWorkerProcessList) DeepCopyInto added in v0.8.0 

func (in *TemporalWorkerProcessList) DeepCopyInto(out *TemporalWorkerProcessList)

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

func (*TemporalWorkerProcessList) DeepCopyObject added in v0.8.0 

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

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

type TemporalWorkerProcessSpec added in v0.8.0 

type TemporalWorkerProcessSpec struct {
	// Reference to the temporal cluster the worker will connect to.
	ClusterRef *TemporalClusterReference `json:"clusterRef"`
	// Version defines the worker process version.
	// +optional
	Version string `json:"version"`
	// Image defines the temporal worker docker image the instance should run.
	Image string `json:"image"`
	// JobTTLSecondsAfterFinished is amount of time to keep job pods after jobs are completed.
	// Defaults to 300 seconds.
	// +optional
	//+kubebuilder:default:=300
	//+kubebuilder:validation:Minimum=1
	JobTTLSecondsAfterFinished *int32 `json:"jobTtlSecondsAfterFinished"`
	// Number of desired replicas. Default to 1.
	// +kubebuilder:validation:Minimum=1
	// +optional
	Replicas *int32 `json:"replicas"`
	// Image pull policy for determining how to pull worker process images.
	PullPolicy corev1.PullPolicy `json:"pullPolicy,omitempty"`
	// An optional list of references to secrets in the same namespace
	// to use for pulling temporal images from registries.
	// +optional
	ImagePullSecrets []corev1.LocalObjectReference `json:"imagePullSecrets,omitempty"`
	// TemporalNamespace that worker will poll.
	TemporalNamespace string `json:"temporalNamespace"`
	// Builder is the configuration for building a TemporalWorkerProcess.
	// THIS FEATURE IS HIGHLY EXPERIMENTAL.
	Builder *TemporalWorkerProcessBuilder `json:"builder,omitempty"`
}

TemporalWorkerProcessSpec defines the desired state of TemporalWorkerProcess.

func (*TemporalWorkerProcessSpec) DeepCopy added in v0.8.0 

func (in *TemporalWorkerProcessSpec) DeepCopy() *TemporalWorkerProcessSpec

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

func (*TemporalWorkerProcessSpec) DeepCopyInto added in v0.8.0 

func (in *TemporalWorkerProcessSpec) DeepCopyInto(out *TemporalWorkerProcessSpec)

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

type TemporalWorkerProcessStatus added in v0.8.0 

type TemporalWorkerProcessStatus struct {
	// Created indicates if the worker process image was created.
	// +optional
	Created bool `json:"created"`
	// Ready defines if the worker process is ready.
	// +optional
	Ready bool `json:"ready"`
	// Version is the version of the image that will be used to build worker image.
	// +optional
	Version string `json:"version"`
	// BuildAttempt is the build attempt number of a given version
	// +optional
	BuildAttempt *int32 `json:"attempt"`
	// Conditions represent the latest available observations of the worker process state.
	Conditions []metav1.Condition `json:"conditions"`
}

TemporalWorkerProcessStatus defines the observed state of TemporalWorkerProcess.

func (*TemporalWorkerProcessStatus) AddWorkerDeploymentStatus added in v0.8.0 

func (s *TemporalWorkerProcessStatus) AddWorkerDeploymentStatus(status *TemporalWorkerProcessStatus)

AddWorkerProcessStatus adds the provided worker process status.

func (*TemporalWorkerProcessStatus) DeepCopy added in v0.8.0 

func (in *TemporalWorkerProcessStatus) DeepCopy() *TemporalWorkerProcessStatus

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

func (*TemporalWorkerProcessStatus) DeepCopyInto added in v0.8.0 

func (in *TemporalWorkerProcessStatus) DeepCopyInto(out *TemporalWorkerProcessStatus)

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

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.