API reference

Package v1beta1 contains API Schema definitions for the v1beta1 API group

Resource Types:

TemporalCluster

TemporalCluster defines a temporal cluster deployment.

Field Description
apiVersion
string		 temporal.io/v1beta1
kind
string 		TemporalCluster
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
TemporalClusterSpec

Specification of the desired behavior of the Temporal cluster.



image
string 		(Optional)

Image defines the temporal server docker image the cluster should use for each services.
version
github.com/alexandrevilain/temporal-operator/pkg/version.Version 		(Optional)

Version defines the temporal version the cluster to be deployed. This version impacts the underlying persistence schemas versions.
log
LogSpec 		(Optional)

Log defines temporal cluster’s logger configuration.
jobTtlSecondsAfterFinished
int32 		(Optional)

JobTTLSecondsAfterFinished is amount of time to keep job pods after jobs are completed. Defaults to 300 seconds.
jobResources
Kubernetes core/v1.ResourceRequirements 		(Optional)

JobResources allows set resources for setup/update jobs.
jobInitContainers
[]Kubernetes core/v1.Container 		(Optional)

JobInitContainers adds a list of init containers to the setup’s jobs.
numHistoryShards
int32

NumHistoryShards is the desired number of history shards. This field is immutable.
services
ServicesSpec 		(Optional)

Services allows customizations for each temporal services deployment.
persistence
TemporalPersistenceSpec

Persistence defines temporal persistence configuration.
imagePullSecrets
[]Kubernetes core/v1.LocalObjectReference 		(Optional)

An optional list of references to secrets in the same namespace to use for pulling temporal images from registries.
ui
TemporalUISpec 		(Optional)

UI allows configuration of the optional temporal web ui deployed alongside the cluster.
admintools
TemporalAdminToolsSpec 		(Optional)

AdminTools allows configuration of the optional admin tool pod deployed alongside the cluster.
mTLS
MTLSSpec 		(Optional)

MTLS allows configuration of the network traffic encryption for the cluster.
metrics
MetricsSpec 		(Optional)

Metrics allows configuration of scraping endpoints for stats. prometheus or m3.
dynamicConfig
DynamicConfigSpec 		(Optional)

DynamicConfig allows advanced configuration for the temporal cluster.
archival
ClusterArchivalSpec 		(Optional)

Archival allows Workflow Execution Event Histories and Visibility data backups for the temporal cluster.
authorization
AuthorizationSpec 		(Optional)

Authorization allows authorization configuration for the temporal cluster.
status
TemporalClusterStatus

Most recent observed status of the Temporal cluster.

TemporalWorkerProcess

TemporalWorkerProcess is the Schema for the temporalworkerprocesses API.

Field Description
apiVersion
string		 temporal.io/v1beta1
kind
string 		TemporalWorkerProcess
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
TemporalWorkerProcessSpec

clusterRef
TemporalClusterReference

Reference to the temporal cluster the worker will connect to.
version
string 		(Optional)

Version defines the worker process version.
image
string

Image defines the temporal worker docker image the instance should run.
jobTtlSecondsAfterFinished
int32 		(Optional)

JobTTLSecondsAfterFinished is amount of time to keep job pods after jobs are completed. Defaults to 300 seconds.
replicas
int32 		(Optional)

Number of desired replicas. Default to 1.
pullPolicy
Kubernetes core/v1.PullPolicy

Image pull policy for determining how to pull worker process images.
imagePullSecrets
[]Kubernetes core/v1.LocalObjectReference 		(Optional)

An optional list of references to secrets in the same namespace to use for pulling temporal images from registries.
temporalNamespace
string

TemporalNamespace that worker will poll.
builder
TemporalWorkerProcessBuilder

Builder is the configuration for building a TemporalWorkerProcess. THIS FEATURE IS HIGHLY EXPERIMENTAL.
status
TemporalWorkerProcessStatus

ArchivalProvider

(Appears on: ClusterArchivalSpec)

ArchivalProvider contains the config for archivers.

Field Description
filestore
FilestoreArchiver 		(Optional)
s3
S3Archiver 		(Optional)
gcs
GCSArchiver 		(Optional)

ArchivalProviderKind (string alias)

ArchivalSpec

(Appears on: ClusterArchivalSpec, TemporalNamespaceArchivalSpec)

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

Field Description
enabled
bool 		(Optional)

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).
paused
bool

Paused defines if the archival is paused.
enableRead
bool

EnableRead allows temporal to read from the archived Event History.
path
string

Path is …

AuthorizationSpec

(Appears on: TemporalClusterSpec)

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.

Field Description
jwtKeyProvider
AuthorizationSpecJWTKeyProvider 		(Optional)

JWTKeyProvider specifies the signing key provider used for validating JWT tokens.
permissionsClaimName
string 		(Optional)

PermissionsClaimName is the name of the claim within the JWT token that contains the user’s permissions.
authorizer
string 		(Optional)

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).
claimMapper
string 		(Optional)

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).

AuthorizationSpecJWTKeyProvider

(Appears on: AuthorizationSpec)

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.

Field Description
keySourceURIs
[]string 		(Optional)

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.
refreshInterval
Kubernetes meta/v1.Duration 		(Optional)

RefreshInterval defines the time interval at which temporal should refresh the JWT signing keys from the specified URIs.

CassandraConsistencySpec

(Appears on: CassandraSpec)

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

Field Description
consistency
github.com/gocql/gocql.Consistency 		(Optional)

Consistency sets the default consistency level. Values identical to gocql Consistency values. (defaults to LOCAL_QUORUM if not set).
serialConsistency
github.com/gocql/gocql.SerialConsistency 		(Optional)

SerialConsistency sets the consistency for the serial prtion of queries. Values identical to gocql SerialConsistency values. (defaults to LOCAL_SERIAL if not set)

CassandraSpec

(Appears on: DatastoreSpec)

CassandraSpec contains cassandra datastore connections specifications.

Field Description
hosts
[]string

Hosts is a list of cassandra endpoints.
port
int

Port is the cassandra port used for connection by gocql client.
user
string

User is the cassandra user used for authentication by gocql client.
keyspace
string

Keyspace is the cassandra keyspace.
datacenter
string 		(Optional)

Datacenter is the data center filter arg for cassandra.
maxConns
int 		(Optional)

MaxConns is the max number of connections to this datastore for a single keyspace.
connectTimeout
Kubernetes meta/v1.Duration 		(Optional)

ConnectTimeout is a timeout for initial dial to cassandra server.
consistency
CassandraConsistencySpec 		(Optional)

Consistency configuration.
disableInitialHostLookup
bool 		(Optional)

DisableInitialHostLookup instructs the gocql client to connect only using the supplied hosts.

CertificatesDurationSpec

(Appears on: MTLSSpec)

CertificatesDurationSpec defines parameters for the temporal mTLS certificates duration.

Field Description
rootCACertificate
Kubernetes meta/v1.Duration 		(Optional)

RootCACertificate is the ‘duration’ (i.e. lifetime) of the Root CA Certificate. It defaults to 10 years.
intermediateCAsCertificates
Kubernetes meta/v1.Duration 		(Optional)

IntermediateCACertificates is the ‘duration’ (i.e. lifetime) of the intermediate CAs Certificates. It defaults to 5 years.
clientCertificates
Kubernetes meta/v1.Duration 		(Optional)

ClientCertificates is the ‘duration’ (i.e. lifetime) of the client certificates. It defaults to 1 year.
frontendCertificate
Kubernetes meta/v1.Duration 		(Optional)

FrontendCertificate is the ‘duration’ (i.e. lifetime) of the frontend certificate. It defaults to 1 year.
internodeCertificate
Kubernetes meta/v1.Duration 		(Optional)

InternodeCertificate is the ‘duration’ (i.e. lifetime) of the internode certificate. It defaults to 1 year.

ClusterArchivalSpec

(Appears on: TemporalClusterSpec)

ClusterArchivalSpec is the configuration for cluster-wide archival config.

Field Description
enabled
bool 		(Optional)

Enabled defines if the archival is enabled for the cluster.
provider
ArchivalProvider 		(Optional)

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.
history
ArchivalSpec 		(Optional)

History is the default config for the history archival.
visibility
ArchivalSpec 		(Optional)

Visibility is the default config for visibility archival.

ConstrainedValue

(Appears on: DynamicConfigSpec)

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

Field Description
constraints
Constraints 		(Optional)

Constraints describe under what conditions a ConstrainedValue should be used.
value
k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON

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

Constraints

(Appears on: ConstrainedValue)

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

Field Description
namespace
string 		(Optional)
namespaceId
string 		(Optional)
taskQueueName
string 		(Optional)
taskQueueType
string 		(Optional)
shardId
int32 		(Optional)
taskType
string 		(Optional)

ContainerRegistryConfig

(Appears on: TemporalWorkerProcessBuilder)

ContainerRegistryConfig specifies the parameters to connect with desired container repository.

Field Description
repository
string

Repository is the fqdn to the image repo.
username
string

Username is the username for the container repo.
passwordSecretRef
SecretKeyReference

PasswordSecret is the reference to the secret holding the docker repo password.

DatastoreSpec

(Appears on: TemporalPersistenceSpec)

DatastoreSpec contains temporal datastore specifications.

Field Description
name
string 		(Optional)

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.
sql
SQLSpec 		(Optional)

SQL holds all connection parameters for SQL datastores.
elasticsearch
ElasticsearchSpec 		(Optional)

Elasticsearch holds all connection parameters for Elasticsearch datastores.
cassandra
CassandraSpec 		(Optional)

Cassandra holds all connection parameters for Cassandra datastore. Note that cassandra is now deprecated for visibility store.
passwordSecretRef
SecretKeyReference 		(Optional)

PasswordSecret is the reference to the secret holding the password.
tls
DatastoreTLSSpec 		(Optional)

TLS is an optional option to connect to the datastore using TLS.
skipCreate
bool 		(Optional)

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.

DatastoreStatus

(Appears on: TemporalPersistenceStatus)

DatastoreStatus contains the current status of a datastore.

Field Description
created
bool

Created indicates if the database or keyspace has been created.
setup
bool

Setup indicates if tables have been set up.
type
DatastoreType 		(Optional)

Type indicates the datastore type.
schemaVersion
github.com/alexandrevilain/temporal-operator/pkg/version.Version 		(Optional)

SchemaVersion report the current schema version.

DatastoreTLSSpec

(Appears on: DatastoreSpec)

DatastoreTLSSpec contains datastore TLS connections specifications.

Field Description
enabled
bool

Enabled defines if the cluster should use a TLS connection to connect to the datastore.
certFileRef
SecretKeyReference 		(Optional)

CertFileRef is a reference to a secret containing the cert file.
keyFileRef
SecretKeyReference 		(Optional)

KeyFileRef is a reference to a secret containing the key file.
caFileRef
SecretKeyReference 		(Optional)

CaFileRef is a reference to a secret containing the ca file.
enableHostVerification
bool

EnableHostVerification defines if the hostname should be verified when connecting to the datastore.
serverName
string 		(Optional)

ServerName the datastore should present.

DatastoreType (string alias)

(Appears on: DatastoreStatus)

DeploymentOverride

(Appears on: ServiceSpecOverride)

DeploymentOverride provides the ability to override a Deployment.

Field Description
metadata
ObjectMetaOverride
spec
DeploymentOverrideSpec 		(Optional)

Specification of the desired behavior of the Deployment.

DeploymentOverrideSpec

(Appears on: DeploymentOverride)

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

Field Description
template
PodTemplateSpecOverride 		(Optional)

Template describes the pods that will be created.

DynamicConfigSpec

(Appears on: TemporalClusterSpec)

DynamicConfigSpec is the configuration for temporal dynamic config.

Field Description
pollInterval
Kubernetes meta/v1.Duration 		(Optional)

PollInterval defines how often the config should be updated by checking provided values. Defaults to 10s.
values
map[string][]./api/v1beta1.ConstrainedValue

Values contains all dynamic config keys and their constrained values.

ElasticsearchIndices

(Appears on: ElasticsearchSpec)

ElasticsearchIndices holds index names.

Field Description
visibility
string

Visibility defines visibility’s index name.
secondaryVisibility
string 		(Optional)

SecondaryVisibility defines secondary visibility’s index name.

ElasticsearchSpec

(Appears on: DatastoreSpec)

ElasticsearchSpec contains Elasticsearch datastore connections specifications.

Field Description
version
string

Version defines the elasticsearch version.
url
string

URL is the connection url to connect to the instance.
username
string

Username is the username to be used for the connection.
indices
ElasticsearchIndices

Indices holds visibility index names.
logLevel
string 		(Optional)

LogLevel defines the temporal cluster’s es client logger level.
closeIdleConnectionsInterval
Kubernetes meta/v1.Duration 		(Optional)

CloseIdleConnectionsInterval is the max duration a connection stay open while idle.
enableSniff
bool 		(Optional)

EnableSniff enables or disables sniffer on the temporal cluster’s es client.
enableHealthcheck
bool 		(Optional)

EnableHealthcheck enables or disables healthcheck on the temporal cluster’s es client.

FilestoreArchiver

(Appears on: ArchivalProvider)

FilestoreArchiver is the file store archival provider configuration.

Field Description
filePermissions
string

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.
dirPermissions
string

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.

FrontendMTLSSpec

(Appears on: MTLSSpec)

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

Field Description
enabled
bool 		(Optional)

Enabled defines if the operator should enable mTLS for cluster’s public endpoints.

GCSArchiver

(Appears on: ArchivalProvider)

GCSArchiver is the GCS archival provider configuration.

Field Description
credentialsRef
Kubernetes core/v1.SecretKeySelector

SecretAccessKeyRef is the secret key selector containing Google Cloud Storage credentials file.

GitRepositoryRef

(Appears on: GitRepositorySpec)

GitRepositoryRef specifies the Git reference to resolve and checkout.

Field Description
branch
string 		(Optional)

Branch to check out, defaults to ‘main’ if no other field is defined.

GitRepositorySpec

(Appears on: TemporalWorkerProcessBuilder)

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

Field Description
url
string

URL specifies the Git repository URL, it can be an HTTP/S or SSH address.
reference
GitRepositoryRef 		(Optional)

Reference specifies the Git reference to resolve and monitor for changes, defaults to the ‘master’ branch.

InternalFrontendServiceSpec

(Appears on: ServicesSpec)

InternalFrontendServiceSpec contains temporal internal frontend service specifications.

Field Description
ServiceSpec
ServiceSpec

(Members of ServiceSpec are embedded into this type.)

enabled
bool 		(Optional)

Enabled defines if we want to spawn the internal frontend service.

InternodeMTLSSpec

(Appears on: MTLSSpec)

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

Field Description
enabled
bool 		(Optional)

Enabled defines if the operator should enable mTLS for network between cluster nodes.

LogSpec

(Appears on: TemporalClusterSpec)

LogSpec contains the temporal logging configuration.

Field Description
stdout
bool 		(Optional)

Stdout is true if the output needs to goto standard out; default is stderr.
level
string 		(Optional)

Level is the desired log level; see colocated zap_logger.go::parseZapLevel()
outputFile
string 		(Optional)

OutputFile is the path to the log output file.
format
string 		(Optional)

Format determines the format of each log file printed to the output. Use “console” if you want stack traces to appear on multiple lines.
development
bool 		(Optional)

Development determines whether the logger is run in Development (== Test) or in Production mode. Default is Production. Production-stage disables panics from DPanic logging.

MTLSProvider (string alias)

(Appears on: MTLSSpec)

MTLSProvider is the enum for support mTLS provider.

MTLSSpec

(Appears on: TemporalClusterSpec)

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

Field Description
provider
MTLSProvider 		(Optional)

Provider defines the tool used to manage mTLS certificates.
internode
InternodeMTLSSpec 		(Optional)

Internode allows configuration of the internode traffic encryption. Useless if mTLS provider is not cert-manager.
frontend
FrontendMTLSSpec 		(Optional)

Frontend allows configuration of the frontend’s public endpoint traffic encryption. Useless if mTLS provider is not cert-manager.
certificatesDuration
CertificatesDurationSpec 		(Optional)

CertificatesDuration allows configuration of maximum certificates lifetime. Useless if mTLS provider is not cert-manager.
refreshInterval
Kubernetes meta/v1.Duration 		(Optional)

RefreshInterval defines interval between refreshes of certificates in the cluster components. Defaults to 1 hour. Useless if mTLS provider is not cert-manager.
renewBefore
Kubernetes meta/v1.Duration 		(Optional)

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.

MetricsSpec

(Appears on: TemporalClusterSpec)

MetricsSpec determines parameters for configuring metrics endpoints.

Field Description
enabled
bool

Enabled defines if the operator should enable metrics exposition on temporal components.
perUnitHistogramBoundaries
map[string][]string 		(Optional)

PerUnitHistogramBoundaries defines the default histogram bucket boundaries. Configuration of histogram boundaries for given metric unit.

Supported values: - “dimensionless” - “milliseconds” - “bytes”
prometheus
PrometheusSpec 		(Optional)

Prometheus reporter configuration.

ObjectMetaOverride

(Appears on: DeploymentOverride, PodTemplateSpecOverride, TemporalUISpec)

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.

Field Description
labels
map[string]string 		(Optional)

Map of string keys and values that can be used to organize and categorize (scope and select) objects.
annotations
map[string]string 		(Optional)

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.

PodTemplateSpecOverride

(Appears on: DeploymentOverrideSpec)

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.

Field Description
metadata
ObjectMetaOverride
spec
Kubernetes core/v1.PodSpec 		(Optional)

Specification of the desired behavior of the pod.

PrometheusScrapeConfig

(Appears on: PrometheusSpec)

PrometheusScrapeConfig is the configuration for making prometheus scrape components metrics.

Field Description
annotations
bool 		(Optional)

Annotations defines if the operator should add prometheus scrape annotations to the services pods.
serviceMonitor
PrometheusScrapeConfigServiceMonitor 		(Optional)

PrometheusScrapeConfigServiceMonitor

(Appears on: PrometheusScrapeConfig)

PrometheusScrapeConfigServiceMonitor is the configuration for prometheus operator ServiceMonitor.

Field Description
enabled
bool 		(Optional)

Enabled defines if the operator should create a ServiceMonitor for each services.
labels
map[string]string 		(Optional)

Labels adds extra labels to the ServiceMonitor.
override
github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1.ServiceMonitorSpec 		(Optional)

Override allows customization of the created ServiceMonitor. All fields can be overwritten except “endpoints”, “selector” and “namespaceSelector”.
metricRelabelings
[]github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1.RelabelConfig 		(Optional)

MetricRelabelConfigs to apply to samples before ingestion.

PrometheusSpec

(Appears on: MetricsSpec)

PrometheusSpec is the configuration for prometheus reporter.

Field Description
listenAddress
string 		(Optional)

Deprecated. Address for prometheus to serve metrics from.
listenPort
int32 		(Optional)

ListenPort for prometheus to serve metrics from.
scrapeConfig
PrometheusScrapeConfig 		(Optional)

ScrapeConfig is the prometheus scrape configuration.

S3Archiver

(Appears on: ArchivalProvider)

S3Archiver is the S3 archival provider configuration.

Field Description
region
string

Region is the aws s3 region.
endpoint
string 		(Optional)

Use Endpoint if you want to use s3-compatible object storage.
roleName
string 		(Optional)

Use RoleName if you want the temporal service account to assume an AWS Identity and Access Management (IAM) role.
credentials
S3Credentials 		(Optional)

Use credentials if you want to use aws credentials from secret.
s3ForcePathStyle
bool 		(Optional)

Use s3ForcePathStyle if you want to use s3 path style.

S3Credentials

(Appears on: S3Archiver)

Field Description
accessKeyIdRef
Kubernetes core/v1.SecretKeySelector

AccessKeyIDRef is the secret key selector containing AWS access key ID.
secretKeyRef
Kubernetes core/v1.SecretKeySelector

SecretAccessKeyRef is the secret key selector containing AWS secret access key.

SQLSpec

(Appears on: DatastoreSpec)

SQLSpec contains SQL datastore connections specifications.

Field Description
user
string

User is the username to be used for the connection.
pluginName
string

PluginName is the name of SQL plugin.
databaseName
string

DatabaseName is the name of SQL database to connect to.
connectAddr
string

ConnectAddr is the remote addr of the database.
connectProtocol
string 		(Optional)

ConnectProtocol is the protocol that goes with the ConnectAddr.
connectAttributes
map[string]string 		(Optional)

ConnectAttributes is a set of key-value attributes to be sent as part of connect data_source_name url
maxConns
int 		(Optional)

MaxConns the max number of connections to this datastore.
maxIdleConns
int 		(Optional)

MaxIdleConns is the max number of idle connections to this datastore.
maxConnLifetime
Kubernetes meta/v1.Duration 		(Optional)

MaxConnLifetime is the maximum time a connection can be alive
taskScanPartitions
int 		(Optional)

TaskScanPartitions is the number of partitions to sequentially scan during ListTaskQueue operations.
gcpServiceAccount
string 		(Optional)

GCPServiceAccount is the service account to use to authenticate with GCP CloudSQL.

SecretKeyReference

(Appears on: ContainerRegistryConfig, DatastoreSpec, DatastoreTLSSpec)

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

Field Description
name
string

Name of the Secret.
key
string 		(Optional)

Key in the Secret.

ServiceSpec

(Appears on: InternalFrontendServiceSpec, ServicesSpec)

ServiceSpec contains a temporal service specifications.

Field Description
port
int 		(Optional)

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
membershipPort
int 		(Optional)

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
httpPort
int 		(Optional)

HTTPPort defines a custom http port for the service. Default values are: 7243 for Frontend service
replicas
int32 		(Optional)

Number of desired replicas for the service. Default to 1.
resources
Kubernetes core/v1.ResourceRequirements 		(Optional)

Compute Resources required by this service. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
overrides
ServiceSpecOverride 		(Optional)

Overrides adds some overrides to the resources deployed for the service. Those overrides takes precedence over spec.services.overrides.
initContainers
[]Kubernetes core/v1.Container 		(Optional)

InitContainers adds a list of init containers to the service’s deployment.

ServiceSpecOverride

(Appears on: ServiceSpec, ServicesSpec, TemporalAdminToolsSpec, TemporalUISpec)

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

Field Description
deployment
DeploymentOverride

Override configuration for the temporal service Deployment.

ServiceStatus

(Appears on: TemporalClusterStatus)

ServiceStatus reports a service status.

Field Description
name
string

Name of the temporal service.
version
string

Current observed version of the service.
ready
bool

Ready defines if the service is ready.

ServicesSpec

(Appears on: TemporalClusterSpec)

ServicesSpec contains all temporal services specifications.

Field Description
frontend
ServiceSpec 		(Optional)

Frontend service custom specifications.
internalFrontend
InternalFrontendServiceSpec 		(Optional)

Internal Frontend service custom specifications. Only compatible with temporal >= 1.20.0
history
ServiceSpec 		(Optional)

History service custom specifications.
matching
ServiceSpec 		(Optional)

Matching service custom specifications.
worker
ServiceSpec 		(Optional)

Worker service custom specifications.
overrides
ServiceSpecOverride 		(Optional)

Overrides adds some overrides to the resources deployed for all temporal services services. Those overrides can be customized per service using spec.services..overrides.

TemporalAdminToolsSpec

(Appears on: TemporalClusterSpec)

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.

Field Description
enabled
bool 		(Optional)

Enabled defines if the operator should deploy the admin tools alongside the cluster.
image
string 		(Optional)

Image defines the temporal admin tools docker image the instance should run.
resources
Kubernetes core/v1.ResourceRequirements 		(Optional)

Compute Resources required by the ui. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
overrides
ServiceSpecOverride 		(Optional)

Overrides adds some overrides to the resources deployed for the ui.

TemporalClusterClient

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

Field Description
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
TemporalClusterClientSpec

clusterRef
TemporalClusterReference

Reference to the temporal cluster the client will get access to.
status
TemporalClusterClientStatus

TemporalClusterClientSpec

(Appears on: TemporalClusterClient)

TemporalClusterClientSpec defines the desired state of ClusterClient.

Field Description
clusterRef
TemporalClusterReference

Reference to the temporal cluster the client will get access to.

TemporalClusterClientStatus

(Appears on: TemporalClusterClient)

TemporalClusterClientStatus defines the observed state of ClusterClient.

Field Description
serverName
string

ServerName is the hostname returned by the certificate.
secretRef
Kubernetes core/v1.LocalObjectReference

Reference to the Kubernetes Secret containing the certificate for the client.

TemporalClusterReference

(Appears on: TemporalClusterClientSpec, TemporalNamespaceSpec, TemporalWorkerProcessSpec)

TemporalClusterReference is a reference to a TemporalCluster.

Field Description
name
string

The name of the TemporalCluster to reference.
namespace
string

The namespace of the TemporalCluster to reference. Defaults to the namespace of the requested resource if omitted.

TemporalClusterSpec

(Appears on: TemporalCluster)

TemporalClusterSpec defines the desired state of Cluster.

Field Description
image
string 		(Optional)

Image defines the temporal server docker image the cluster should use for each services.
version
github.com/alexandrevilain/temporal-operator/pkg/version.Version 		(Optional)

Version defines the temporal version the cluster to be deployed. This version impacts the underlying persistence schemas versions.
log
LogSpec 		(Optional)

Log defines temporal cluster’s logger configuration.
jobTtlSecondsAfterFinished
int32 		(Optional)

JobTTLSecondsAfterFinished is amount of time to keep job pods after jobs are completed. Defaults to 300 seconds.
jobResources
Kubernetes core/v1.ResourceRequirements 		(Optional)

JobResources allows set resources for setup/update jobs.
jobInitContainers
[]Kubernetes core/v1.Container 		(Optional)

JobInitContainers adds a list of init containers to the setup’s jobs.
numHistoryShards
int32

NumHistoryShards is the desired number of history shards. This field is immutable.
services
ServicesSpec 		(Optional)

Services allows customizations for each temporal services deployment.
persistence
TemporalPersistenceSpec

Persistence defines temporal persistence configuration.
imagePullSecrets
[]Kubernetes core/v1.LocalObjectReference 		(Optional)

An optional list of references to secrets in the same namespace to use for pulling temporal images from registries.
ui
TemporalUISpec 		(Optional)

UI allows configuration of the optional temporal web ui deployed alongside the cluster.
admintools
TemporalAdminToolsSpec 		(Optional)

AdminTools allows configuration of the optional admin tool pod deployed alongside the cluster.
mTLS
MTLSSpec 		(Optional)

MTLS allows configuration of the network traffic encryption for the cluster.
metrics
MetricsSpec 		(Optional)

Metrics allows configuration of scraping endpoints for stats. prometheus or m3.
dynamicConfig
DynamicConfigSpec 		(Optional)

DynamicConfig allows advanced configuration for the temporal cluster.
archival
ClusterArchivalSpec 		(Optional)

Archival allows Workflow Execution Event Histories and Visibility data backups for the temporal cluster.
authorization
AuthorizationSpec 		(Optional)

Authorization allows authorization configuration for the temporal cluster.

TemporalClusterStatus

(Appears on: TemporalCluster)

TemporalClusterStatus defines the observed state of Cluster.

Field Description
version
string

Version holds the current temporal version.
services
[]ServiceStatus

Services holds all services statuses.
persistence
TemporalPersistenceStatus

Persistence holds all datastores statuses.
conditions
[]Kubernetes meta/v1.Condition

Conditions represent the latest available observations of the Cluster state.

TemporalNamespace

A TemporalNamespace creates a namespace in the targeted temporal cluster.

Field Description
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
TemporalNamespaceSpec

clusterRef
TemporalClusterReference

Reference to the temporal cluster the namespace will be created.
description
string 		(Optional)

Namespace description.
ownerEmail
string 		(Optional)

Namespace owner email.
retentionPeriod
Kubernetes meta/v1.Duration

RetentionPeriod to apply on closed workflow executions.
data
map[string]string 		(Optional)

Data is a key-value map for any customized purpose.
securityToken
string 		(Optional)
isGlobalNamespace
bool 		(Optional)

IsGlobalNamespace defines whether the namespace is a global namespace.
clusters
[]string 		(Optional)

List of clusters names to which the namespace can fail over. Only applicable if the namespace is a global namespace.
activeClusterName
string 		(Optional)

The name of active Temporal Cluster. Only applicable if the namespace is a global namespace.
allowDeletion
bool 		(Optional)

AllowDeletion makes the controller delete the Temporal namespace if the CRD is deleted.
archival
TemporalNamespaceArchivalSpec 		(Optional)

Archival is a per-namespace archival configuration. If not set, the default cluster configuration is used.
status
TemporalNamespaceStatus

TemporalNamespaceArchivalSpec

(Appears on: TemporalNamespaceSpec)

TemporalNamespaceArchivalSpec is a per-namespace archival configuration override.

Field Description
history
ArchivalSpec 		(Optional)

History is the config for this namespace history archival.
visibility
ArchivalSpec 		(Optional)

Visibility is the config for this namespace visibility archival.

TemporalNamespaceSpec

(Appears on: TemporalNamespace)

TemporalNamespaceSpec defines the desired state of Namespace.

Field Description
clusterRef
TemporalClusterReference

Reference to the temporal cluster the namespace will be created.
description
string 		(Optional)

Namespace description.
ownerEmail
string 		(Optional)

Namespace owner email.
retentionPeriod
Kubernetes meta/v1.Duration

RetentionPeriod to apply on closed workflow executions.
data
map[string]string 		(Optional)

Data is a key-value map for any customized purpose.
securityToken
string 		(Optional)
isGlobalNamespace
bool 		(Optional)

IsGlobalNamespace defines whether the namespace is a global namespace.
clusters
[]string 		(Optional)

List of clusters names to which the namespace can fail over. Only applicable if the namespace is a global namespace.
activeClusterName
string 		(Optional)

The name of active Temporal Cluster. Only applicable if the namespace is a global namespace.
allowDeletion
bool 		(Optional)

AllowDeletion makes the controller delete the Temporal namespace if the CRD is deleted.
archival
TemporalNamespaceArchivalSpec 		(Optional)

Archival is a per-namespace archival configuration. If not set, the default cluster configuration is used.

TemporalNamespaceStatus

(Appears on: TemporalNamespace)

TemporalNamespaceStatus defines the observed state of Namespace.

Field Description
conditions
[]Kubernetes meta/v1.Condition

Conditions represent the latest available observations of the Namespace state.

TemporalPersistenceSpec

(Appears on: TemporalClusterSpec)

TemporalPersistenceSpec contains temporal persistence specifications.

Field Description
defaultStore
DatastoreSpec

DefaultStore holds the default datastore specs.
visibilityStore
DatastoreSpec

VisibilityStore holds the visibility datastore specs.
secondaryVisibilityStore
DatastoreSpec 		(Optional)

SecondaryVisibilityStore holds the secondary visibility datastore specs. Feature only available for clusters >= 1.21.0.
advancedVisibilityStore
DatastoreSpec 		(Optional)

AdvancedVisibilityStore holds the advanced visibility datastore specs.

TemporalPersistenceStatus

(Appears on: TemporalClusterStatus)

TemporalPersistenceStatus contains temporal persistence status.

Field Description
defaultStore
DatastoreStatus

DefaultStore holds the default datastore status.
visibilityStore
DatastoreStatus

VisibilityStore holds the visibility datastore status.
secondaryVisibilityStore
DatastoreStatus 		(Optional)

SecondaryVisibilityStore holds the secondary visibility datastore status.
advancedVisibilityStore
DatastoreStatus 		(Optional)

AdvancedVisibilityStore holds the advanced visibility datastore status.

TemporalUIIngressSpec

(Appears on: TemporalUISpec)

TemporalUIIngressSpec contains all configurations options for the UI ingress.

Field Description
annotations
map[string]string

Annotations allows custom annotations on the ingress resource.
ingressClassName
string

IngressClassName is the name of the IngressClass the deployed ingress resource should use.
hosts
[]string

Host is the list of host the ingress should use.
tls
[]Kubernetes networking/v1.IngressTLS

TLS configuration.

TemporalUISpec

(Appears on: TemporalClusterSpec)

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

Field Description
enabled
bool 		(Optional)

Enabled defines if the operator should deploy the web ui alongside the cluster.
version
string 		(Optional)

Version defines the temporal ui version the instance should run.
image
string 		(Optional)

Image defines the temporal ui docker image the instance should run.
replicas
int32 		(Optional)

Number of desired replicas for the ui. Default to 1.
resources
Kubernetes core/v1.ResourceRequirements 		(Optional)

Compute Resources required by the ui. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
overrides
ServiceSpecOverride 		(Optional)

Overrides adds some overrides to the resources deployed for the ui.
ingress
TemporalUIIngressSpec 		(Optional)

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.
service
ObjectMetaOverride 		(Optional)

Service is an optional service resource configuration for the UI.

TemporalWorkerProcessBuilder

(Appears on: TemporalWorkerProcessSpec)

Field Description
enabled
bool

Enabled defines if the operator should build the temporal worker process.
version
string

Version is the version of the image that will be used to build worker image.
attempt
int32

BuildAttempt is the build attempt number of a given version
image
string

Image is the image that will be used to build worker image.
buildDir
string

BuildDir is the location of where the sources will be built.
gitRepository
GitRepositorySpec

GitRepository specifies how to connect to Git source control.
buildRegistry
ContainerRegistryConfig

BuildRegistry specifies how to connect to container registry.

TemporalWorkerProcessSpec

(Appears on: TemporalWorkerProcess)

TemporalWorkerProcessSpec defines the desired state of TemporalWorkerProcess.

Field Description
clusterRef
TemporalClusterReference

Reference to the temporal cluster the worker will connect to.
version
string 		(Optional)

Version defines the worker process version.
image
string

Image defines the temporal worker docker image the instance should run.
jobTtlSecondsAfterFinished
int32 		(Optional)

JobTTLSecondsAfterFinished is amount of time to keep job pods after jobs are completed. Defaults to 300 seconds.
replicas
int32 		(Optional)

Number of desired replicas. Default to 1.
pullPolicy
Kubernetes core/v1.PullPolicy

Image pull policy for determining how to pull worker process images.
imagePullSecrets
[]Kubernetes core/v1.LocalObjectReference 		(Optional)

An optional list of references to secrets in the same namespace to use for pulling temporal images from registries.
temporalNamespace
string

TemporalNamespace that worker will poll.
builder
TemporalWorkerProcessBuilder

Builder is the configuration for building a TemporalWorkerProcess. THIS FEATURE IS HIGHLY EXPERIMENTAL.

TemporalWorkerProcessStatus

(Appears on: TemporalWorkerProcess)

TemporalWorkerProcessStatus defines the observed state of TemporalWorkerProcess.

Field Description
created
bool 		(Optional)

Created indicates if the worker process image was created.
ready
bool 		(Optional)

Ready defines if the worker process is ready.
version
string 		(Optional)

Version is the version of the image that will be used to build worker image.
attempt
int32 		(Optional)

BuildAttempt is the build attempt number of a given version
conditions
[]Kubernetes meta/v1.Condition

Conditions represent the latest available observations of the worker process state.

This page was automatically generated with gen-crd-api-reference-docs