api.md

API Reference

Packages

• cluster.ytsaurus.tech/v1

cluster.ytsaurus.tech/v1

Package v1 contains API Schema definitions for the cluster v1 API group

Resource Types

• Chyt
• RemoteDataNodes
• RemoteDataNodesList
• RemoteExecNodes
• RemoteTabletNodes
• RemoteTabletNodesList
• RemoteYtsaurus
• Spyt
• Ytsaurus

BaseLoggerSpec

Appears in:

• StructuredLoggerSpec
• TextLoggerSpec

Field	Description	Default	Validation
name string			MinLength: 1
format LogFormat		plain_text	Enum: [plain_text json yson]
minLogLevel LogLevel		info	Enum: [trace debug info warning error]
compression LogCompression		none	Enum: [none gzip zstd]
useTimestampSuffix boolean		false
rotationPolicy LogRotationPolicy

BootstrapSpec

Appears in:

• YtsaurusSpec

Field	Description	Default	Validation
tabletCellBundles BundlesBootstrapSpec

BundleBootstrapSpec

Appears in:

• BundlesBootstrapSpec

Field	Description	Default	Validation
snapshotMedium string
changelogMedium string
tabletCellCount integer		1

BundlesBootstrapSpec

Appears in:

• BootstrapSpec

Field	Description	Default	Validation
sys BundleBootstrapSpec
default BundleBootstrapSpec

CRIJobEnvironmentSpec

Appears in:

• JobEnvironmentSpec

Field	Description	Default	Validation
entrypointWrapper string array	Specifies wrapper for CRI service (i.e. containerd) command.
sandboxImage string	Sandbox (pause) image.
apiRetryTimeoutSeconds integer	Timeout for retrying CRI API calls.
criNamespace string	CRI namespace for jobs containers.
baseCgroup string	Base cgroup for jobs.
registryConfigPath string	See: https://github.com/containerd/containerd/blob/main/docs/hosts.md
imageSizeEstimation integer	Initial estimation for space required for pulling image into cache.
imageCompressionRatioEstimation integer	Multiplier for image size to account space used by unpacked images.
alwaysPullLatestImage boolean	Always pull "latest" images.
imagePullPeriodSeconds integer	Pull images periodically.

CategoriesFilter

Appears in:

• TextLoggerSpec

Field	Description	Default	Validation
type CategoriesFilterType			Enum: [exclude include]
values string array			MinItems: 1

CategoriesFilterType

Underlying type: string

CategoriesFilterType string describes types of possible log CategoriesFilter.

Appears in:

• CategoriesFilter

Field	Description
exclude
include

Chyt

Chyt is the Schema for the chyts API

Field	Description	Default	Validation
apiVersion string	cluster.ytsaurus.tech/v1
kind string	Chyt
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec ChytSpec
status ChytStatus

ChytReleaseStatus

Underlying type: string

Appears in:

• ChytStatus

Field	Description
CreatingUserSecret
CreatingUser
UploadingIntoCypress
CreatingChPublicClique
Finished

ChytSpec

ChytSpec defines the desired state of Chyt

Appears in:

• Chyt

Field	Description	Default	Validation
imagePullSecrets LocalObjectReference array
ytsaurus LocalObjectReference
image string
makeDefault boolean	Mark specified image as default for cliques.	false
createPublicClique boolean	Create ch_public clique, which is used by default when running CHYT queries.

ChytStatus

ChytStatus defines the observed state of Chyt

Appears in:

• Chyt

Field	Description	Default	Validation
conditions Condition array
releaseStatus ChytReleaseStatus

ClusterNodesSpec

ClusterNodesSpec is a common part of spec for nodes of all flavors.

Appears in:

• DataNodesSpec
• ExecNodesSpec
• RemoteDataNodesSpec
• RemoteExecNodesSpec
• RemoteTabletNodesSpec
• TabletNodesSpec

Field	Description	Default	Validation
tags string array	List of the node tags.
rack string	Name of the node rack.

ClusterState

Underlying type: string

Appears in:

• YtsaurusStatus

Field	Description
Created
Initializing
Running
Reconfiguration
Updating
UpdateFinishing
CancelUpdate

CommonRemoteNodeStatus

CommonRemoteNodeStatus is a set of fields shared between Remote*NodesStatus. It is inlined in these specs.

Appears in:

• RemoteDataNodesStatus
• RemoteExecNodesStatus
• RemoteTabletNodesStatus

Field	Description	Default	Validation
observedGeneration integer	Reflects resource generation which was used for updating status.
releaseStatus RemoteNodeReleaseStatus

CommonSpec

CommonSpec is a set of fields shared between YtsaurusSpec and Remote*NodesSpec. It is inlined in these specs.

Appears in:

• RemoteDataNodesSpec
• RemoteExecNodesSpec
• RemoteTabletNodesSpec
• YtsaurusSpec

Field	Description	Default	Validation
coreImage string
jobImage string	Default docker image for user jobs.
caBundle LocalObjectReference	Reference to ConfigMap with trusted certificates: "ca.crt".
nativeTransport RPCTransportSpec	Common config for native RPC bus transport.
ephemeralCluster boolean	Allow prioritizing performance over data safety. Useful for tests and experiments.	false
useIpv6 boolean		false
useIpv4 boolean		false
keepSocket boolean
forceTcp boolean
useShortNames boolean	Do not add resource name into names of resources under control. When enabled resource should not share namespace with other Ytsaurus.	true
hostNetwork boolean	Use the host's network namespace for all components.	false
usePorto boolean		false
extraPodAnnotations object (keys:string, values:string)
configOverrides LocalObjectReference
imagePullSecrets LocalObjectReference array

ControllerAgentsSpec

Appears in:

• YtsaurusSpec

Field	Description	Default	Validation
image string	Overrides coreImage for component.
entrypointWrapper string array	Specifies wrapper for component container command.
volumes Volume array
volumeMounts VolumeMount array
readinessProbeParams HealthcheckProbeParams
resources ResourceRequirements
instanceCount integer
minReadyInstanceCount integer
locations LocationSpec array
volumeClaimTemplates EmbeddedPersistentVolumeClaim array
runtimeClassName string
enableAntiAffinity boolean	Deprecated: use Affinity.PodAntiAffinity instead.
hostNetwork boolean	Use the host's network namespace, this overrides global option.
monitoringPort integer
loggers TextLoggerSpec array
structuredLoggers StructuredLoggerSpec array
affinity Affinity
nodeSelector object (keys:string, values:string)
tolerations Toleration array
podLabels object (keys:string, values:string)
podAnnotations object (keys:string, values:string)
setHostnameAsFqdn boolean	SetHostnameAsFQDN indicates whether to set the hostname as FQDN.	true
terminationGracePeriodSeconds integer	Optional duration in seconds the pod needs to terminate gracefully.
nativeTransport RPCTransportSpec	Component config for native RPC bus transport.

DataNodesSpec

Appears in:

• RemoteDataNodesSpec
• YtsaurusSpec

Field	Description	Default	Validation
image string	Overrides coreImage for component.
entrypointWrapper string array	Specifies wrapper for component container command.
volumes Volume array
volumeMounts VolumeMount array
readinessProbeParams HealthcheckProbeParams
resources ResourceRequirements
instanceCount integer
minReadyInstanceCount integer
locations LocationSpec array
volumeClaimTemplates EmbeddedPersistentVolumeClaim array
runtimeClassName string
enableAntiAffinity boolean	Deprecated: use Affinity.PodAntiAffinity instead.
hostNetwork boolean	Use the host's network namespace, this overrides global option.
monitoringPort integer
loggers TextLoggerSpec array
structuredLoggers StructuredLoggerSpec array
affinity Affinity
nodeSelector object (keys:string, values:string)
tolerations Toleration array
podLabels object (keys:string, values:string)
podAnnotations object (keys:string, values:string)
setHostnameAsFqdn boolean	SetHostnameAsFQDN indicates whether to set the hostname as FQDN.	true
terminationGracePeriodSeconds integer	Optional duration in seconds the pod needs to terminate gracefully.
nativeTransport RPCTransportSpec	Component config for native RPC bus transport.
tags string array	List of the node tags.
rack string	Name of the node rack.
name string		default	MinLength: 1

DeprecatedSpytSpec

Appears in:

• YtsaurusSpec

Field	Description	Default	Validation
sparkVersion string
spytVersion string

DiscoverySpec

Appears in:

• YtsaurusSpec

Field	Description	Default	Validation
image string	Overrides coreImage for component.
entrypointWrapper string array	Specifies wrapper for component container command.
volumes Volume array
volumeMounts VolumeMount array
readinessProbeParams HealthcheckProbeParams
resources ResourceRequirements
instanceCount integer
minReadyInstanceCount integer
locations LocationSpec array
volumeClaimTemplates EmbeddedPersistentVolumeClaim array
runtimeClassName string
enableAntiAffinity boolean	Deprecated: use Affinity.PodAntiAffinity instead.
hostNetwork boolean	Use the host's network namespace, this overrides global option.
monitoringPort integer
loggers TextLoggerSpec array
structuredLoggers StructuredLoggerSpec array
affinity Affinity
nodeSelector object (keys:string, values:string)
tolerations Toleration array
podLabels object (keys:string, values:string)
podAnnotations object (keys:string, values:string)
setHostnameAsFqdn boolean	SetHostnameAsFQDN indicates whether to set the hostname as FQDN.	true
terminationGracePeriodSeconds integer	Optional duration in seconds the pod needs to terminate gracefully.
nativeTransport RPCTransportSpec	Component config for native RPC bus transport.

EmbeddedObjectMetadata

EmbeddedObjectMetadata contains a subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta Only fields which are relevant to embedded resources are included.

Appears in:

• EmbeddedPersistentVolumeClaim

Field	Description	Default	Validation
name string	Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
labels object (keys:string, values:string)	Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
annotations object (keys:string, values:string)	Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

EmbeddedPersistentVolumeClaim

EmbeddedPersistentVolumeClaim is an embedded version of k8s.io/api/core/v1.PersistentVolumeClaim. It contains TypeMeta and a reduced ObjectMeta.

Appears in:

• ControllerAgentsSpec
• DataNodesSpec
• DiscoverySpec
• ExecNodesSpec
• HTTPProxiesSpec
• InstanceSpec
• MasterCachesSpec
• MastersSpec
• QueryTrackerSpec
• QueueAgentSpec
• RPCProxiesSpec
• RemoteDataNodesSpec
• RemoteExecNodesSpec
• RemoteTabletNodesSpec
• RemoteYtsaurusSpec
• SchedulersSpec
• TCPProxiesSpec
• TabletNodesSpec
• YQLAgentSpec

Field	Description	Default	Validation
metadata EmbeddedObjectMetadata	Refer to Kubernetes API documentation for fields of metadata.
spec PersistentVolumeClaimSpec	Spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

ExecNodesSpec

Appears in:

• RemoteExecNodesSpec
• YtsaurusSpec

Field	Description	Default	Validation
image string	Overrides coreImage for component.
entrypointWrapper string array	Specifies wrapper for component container command.
volumes Volume array
volumeMounts VolumeMount array
readinessProbeParams HealthcheckProbeParams
resources ResourceRequirements
instanceCount integer
minReadyInstanceCount integer
locations LocationSpec array
volumeClaimTemplates EmbeddedPersistentVolumeClaim array
runtimeClassName string
enableAntiAffinity boolean	Deprecated: use Affinity.PodAntiAffinity instead.
hostNetwork boolean	Use the host's network namespace, this overrides global option.
monitoringPort integer
loggers TextLoggerSpec array
structuredLoggers StructuredLoggerSpec array
affinity Affinity
nodeSelector object (keys:string, values:string)
tolerations Toleration array
podLabels object (keys:string, values:string)
podAnnotations object (keys:string, values:string)
setHostnameAsFqdn boolean	SetHostnameAsFQDN indicates whether to set the hostname as FQDN.	true
terminationGracePeriodSeconds integer	Optional duration in seconds the pod needs to terminate gracefully.
nativeTransport RPCTransportSpec	Component config for native RPC bus transport.
tags string array	List of the node tags.
rack string	Name of the node rack.
name string		default	MinLength: 1
initContainers string array	List of init containers as yaml of core/v1 Container.
sidecars string array	List of sidecar containers as yaml of core/v1 Container.
privileged boolean		true
jobProxyLoggers TextLoggerSpec array
jobResources ResourceRequirements	Resources dedicated for running jobs.
jobEnvironment JobEnvironmentSpec

HTTPProxiesSpec

Appears in:

• YtsaurusSpec

Field	Description	Default	Validation
image string	Overrides coreImage for component.
entrypointWrapper string array	Specifies wrapper for component container command.
volumes Volume array
volumeMounts VolumeMount array
readinessProbeParams HealthcheckProbeParams
resources ResourceRequirements
instanceCount integer
minReadyInstanceCount integer
locations LocationSpec array
volumeClaimTemplates EmbeddedPersistentVolumeClaim array
runtimeClassName string
enableAntiAffinity boolean	Deprecated: use Affinity.PodAntiAffinity instead.
hostNetwork boolean	Use the host's network namespace, this overrides global option.
monitoringPort integer
loggers TextLoggerSpec array
structuredLoggers StructuredLoggerSpec array
affinity Affinity
nodeSelector object (keys:string, values:string)
tolerations Toleration array
podLabels object (keys:string, values:string)
podAnnotations object (keys:string, values:string)
setHostnameAsFqdn boolean	SetHostnameAsFQDN indicates whether to set the hostname as FQDN.	true
terminationGracePeriodSeconds integer	Optional duration in seconds the pod needs to terminate gracefully.
nativeTransport RPCTransportSpec	Component config for native RPC bus transport.
serviceType ServiceType		NodePort
httpNodePort integer
httpsNodePort integer
role string		default	MinLength: 1
transport HTTPTransportSpec

HTTPTransportSpec

Appears in:

• HTTPProxiesSpec

Field	Description	Default	Validation
httpsSecret LocalObjectReference	Reference to kubernetes.io/tls secret.
disableHttp boolean

HealthcheckProbeParams

Appears in:

• ControllerAgentsSpec
• DataNodesSpec
• DiscoverySpec
• ExecNodesSpec
• HTTPProxiesSpec
• InstanceSpec
• MasterCachesSpec
• MastersSpec
• QueryTrackerSpec
• QueueAgentSpec
• RPCProxiesSpec
• RemoteDataNodesSpec
• RemoteExecNodesSpec
• RemoteTabletNodesSpec
• RemoteYtsaurusSpec
• SchedulersSpec
• TCPProxiesSpec
• TabletNodesSpec
• YQLAgentSpec

Field	Description	Default	Validation
initialDelaySeconds integer
timeoutSeconds integer
periodSeconds integer
successThreshold integer
failureThreshold integer

InstanceSpec

Appears in:

• ControllerAgentsSpec
• DataNodesSpec
• DiscoverySpec
• ExecNodesSpec
• HTTPProxiesSpec
• MasterCachesSpec
• MastersSpec
• QueryTrackerSpec
• QueueAgentSpec
• RPCProxiesSpec
• RemoteDataNodesSpec
• RemoteExecNodesSpec
• RemoteTabletNodesSpec
• RemoteYtsaurusSpec
• SchedulersSpec
• TCPProxiesSpec
• TabletNodesSpec
• YQLAgentSpec

Field	Description	Default	Validation
image string	Overrides coreImage for component.
entrypointWrapper string array	Specifies wrapper for component container command.
volumes Volume array
volumeMounts VolumeMount array
readinessProbeParams HealthcheckProbeParams
resources ResourceRequirements
instanceCount integer
minReadyInstanceCount integer
locations LocationSpec array
volumeClaimTemplates EmbeddedPersistentVolumeClaim array
runtimeClassName string
enableAntiAffinity boolean	Deprecated: use Affinity.PodAntiAffinity instead.
hostNetwork boolean	Use the host's network namespace, this overrides global option.
monitoringPort integer
loggers TextLoggerSpec array
structuredLoggers StructuredLoggerSpec array
affinity Affinity
nodeSelector object (keys:string, values:string)
tolerations Toleration array
podLabels object (keys:string, values:string)
podAnnotations object (keys:string, values:string)
setHostnameAsFqdn boolean	SetHostnameAsFQDN indicates whether to set the hostname as FQDN.	true
terminationGracePeriodSeconds integer	Optional duration in seconds the pod needs to terminate gracefully.
nativeTransport RPCTransportSpec	Component config for native RPC bus transport.

JobEnvironmentSpec

Appears in:

• ExecNodesSpec
• RemoteExecNodesSpec

Field	Description	Default	Validation
isolated boolean	Isolate job execution environment from exec node or not, by default true when possible.
userSlots integer	Count of slots for user jobs on each exec node, default is 5 per CPU.
cri CRIJobEnvironmentSpec	CRI service configuration for running jobs in sidecar container.
useArtifactBinds boolean	Pass artifacts as read-only bind-mounts rather than symlinks.
doNotSetUserId boolean	Do not use slot user id for running jobs.

LocationSpec

Appears in:

• ControllerAgentsSpec
• DataNodesSpec
• DiscoverySpec
• ExecNodesSpec
• HTTPProxiesSpec
• InstanceSpec
• MasterCachesSpec
• MastersSpec
• QueryTrackerSpec
• QueueAgentSpec
• RPCProxiesSpec
• RemoteDataNodesSpec
• RemoteExecNodesSpec
• RemoteTabletNodesSpec
• RemoteYtsaurusSpec
• SchedulersSpec
• TCPProxiesSpec
• TabletNodesSpec
• YQLAgentSpec

Field	Description	Default	Validation
locationType LocationType
path string			MinLength: 1
medium string		default
quota Quantity	Disk space quota, default is size of related volume.
lowWatermark Quantity	Limit above which the volume is considered to be non-full.
maxTrashMilliseconds integer	Max TTL of trash in milliseconds.		Minimum: 60000

LocationType

Underlying type: string

LocationType string describes types of disk locations for YT components.

Appears in:

• LocationSpec

Field	Description
ChunkStore
ChunkCache
Slots
Logs
MasterChangelogs
MasterSnapshots
ImageCache

LogCompression

Underlying type: string

Appears in:

• BaseLoggerSpec
• StructuredLoggerSpec
• TextLoggerSpec

Field	Description
none
gzip
zstd

LogFormat

Underlying type: string

Appears in:

• BaseLoggerSpec
• StructuredLoggerSpec
• TextLoggerSpec

Field	Description
plain_text
yson
json

LogLevel

Underlying type: string

LogLevel string describes possible Ytsaurus logging level.

Appears in:

• BaseLoggerSpec
• StructuredLoggerSpec
• TextLoggerSpec

Field	Description
trace
debug
info
warning
error

LogRotationPolicy

Appears in:

• BaseLoggerSpec
• StructuredLoggerSpec
• TextLoggerSpec

Field	Description	Default	Validation
rotationPeriodMilliseconds integer
maxSegmentSize Quantity
maxTotalSizeToKeep Quantity
maxSegmentCountToKeep integer

LogWriterType

Underlying type: string

LogWriterType string describes types of possible log writers.

Appears in:

• TextLoggerSpec

Field	Description
file
stderr

MasterCachesConnectionSpec

Appears in:

• MasterCachesSpec
• RemoteYtsaurusSpec

Field	Description	Default	Validation
cellTagMasterCaches integer
hostAddressesMasterCaches string array

MasterCachesSpec

Appears in:

• RemoteYtsaurusSpec
• YtsaurusSpec

Field	Description	Default	Validation
image string	Overrides coreImage for component.
entrypointWrapper string array	Specifies wrapper for component container command.
volumes Volume array
volumeMounts VolumeMount array
readinessProbeParams HealthcheckProbeParams
resources ResourceRequirements
instanceCount integer
minReadyInstanceCount integer
locations LocationSpec array
volumeClaimTemplates EmbeddedPersistentVolumeClaim array
runtimeClassName string
enableAntiAffinity boolean	Deprecated: use Affinity.PodAntiAffinity instead.
hostNetwork boolean	Use the host's network namespace, this overrides global option.
monitoringPort integer
loggers TextLoggerSpec array
structuredLoggers StructuredLoggerSpec array
affinity Affinity
nodeSelector object (keys:string, values:string)
tolerations Toleration array
podLabels object (keys:string, values:string)
podAnnotations object (keys:string, values:string)
setHostnameAsFqdn boolean	SetHostnameAsFQDN indicates whether to set the hostname as FQDN.	true
terminationGracePeriodSeconds integer	Optional duration in seconds the pod needs to terminate gracefully.
nativeTransport RPCTransportSpec	Component config for native RPC bus transport.
cellTagMasterCaches integer
hostAddressesMasterCaches string array
hostAddressesLabel string

MasterConnectionSpec

Appears in:

• MastersSpec
• RemoteYtsaurusSpec

Field	Description	Default	Validation
cellTag integer
hostAddresses string array

MastersSpec

Appears in:

• YtsaurusSpec

Field	Description	Default	Validation
image string	Overrides coreImage for component.
entrypointWrapper string array	Specifies wrapper for component container command.
volumes Volume array
volumeMounts VolumeMount array
readinessProbeParams HealthcheckProbeParams
resources ResourceRequirements
instanceCount integer
minReadyInstanceCount integer
locations LocationSpec array
volumeClaimTemplates EmbeddedPersistentVolumeClaim array
runtimeClassName string
enableAntiAffinity boolean	Deprecated: use Affinity.PodAntiAffinity instead.
hostNetwork boolean	Use the host's network namespace, this overrides global option.
monitoringPort integer
loggers TextLoggerSpec array
structuredLoggers StructuredLoggerSpec array
affinity Affinity
nodeSelector object (keys:string, values:string)
tolerations Toleration array
podLabels object (keys:string, values:string)
podAnnotations object (keys:string, values:string)
setHostnameAsFqdn boolean	SetHostnameAsFQDN indicates whether to set the hostname as FQDN.	true
terminationGracePeriodSeconds integer	Optional duration in seconds the pod needs to terminate gracefully.
nativeTransport RPCTransportSpec	Component config for native RPC bus transport.
cellTag integer
hostAddresses string array
hostAddressLabel string
maxSnapshotCountToKeep integer
maxChangelogCountToKeep integer
sidecars string array	List of sidecar containers as yaml of core/v1 Container.

OauthServiceSpec

Appears in:

• YtsaurusSpec

Field	Description	Default	Validation
host string			MinLength: 1
port integer		80
secure boolean		false
userInfoHandler OauthUserInfoHandlerSpec

OauthUserInfoHandlerSpec

Appears in:

• OauthServiceSpec

Field	Description	Default	Validation
endpoint string		user/info
loginField string		nickname
errorField string
loginTransformations OauthUserLoginTransformation array	LoginTransformations will be applied to the login field consequentially if set. Result of the transformations is treated as YTsaurus OAuth user's username.

OauthUserLoginTransformation

Appears in:

• OauthUserInfoHandlerSpec

Field	Description	Default	Validation
matchPattern string	MatchPattern expects RE2 (https://github.com/google/re2/wiki/syntax) syntax.
replacement string

QueryTrackerSpec

Appears in:

• YtsaurusSpec

Field	Description	Default	Validation
image string	Overrides coreImage for component.
entrypointWrapper string array	Specifies wrapper for component container command.
volumes Volume array
volumeMounts VolumeMount array
readinessProbeParams HealthcheckProbeParams
resources ResourceRequirements
instanceCount integer
minReadyInstanceCount integer
locations LocationSpec array
volumeClaimTemplates EmbeddedPersistentVolumeClaim array
runtimeClassName string
enableAntiAffinity boolean	Deprecated: use Affinity.PodAntiAffinity instead.
hostNetwork boolean	Use the host's network namespace, this overrides global option.
monitoringPort integer
loggers TextLoggerSpec array
structuredLoggers StructuredLoggerSpec array
affinity Affinity
nodeSelector object (keys:string, values:string)
tolerations Toleration array
podLabels object (keys:string, values:string)
podAnnotations object (keys:string, values:string)
setHostnameAsFqdn boolean	SetHostnameAsFQDN indicates whether to set the hostname as FQDN.	true
terminationGracePeriodSeconds integer	Optional duration in seconds the pod needs to terminate gracefully.
nativeTransport RPCTransportSpec	Component config for native RPC bus transport.

QueueAgentSpec

Appears in:

• YtsaurusSpec

Field	Description	Default	Validation
image string	Overrides coreImage for component.
entrypointWrapper string array	Specifies wrapper for component container command.
volumes Volume array
volumeMounts VolumeMount array
readinessProbeParams HealthcheckProbeParams
resources ResourceRequirements
instanceCount integer
minReadyInstanceCount integer
locations LocationSpec array
volumeClaimTemplates EmbeddedPersistentVolumeClaim array
runtimeClassName string
enableAntiAffinity boolean	Deprecated: use Affinity.PodAntiAffinity instead.
hostNetwork boolean	Use the host's network namespace, this overrides global option.
monitoringPort integer
loggers TextLoggerSpec array
structuredLoggers StructuredLoggerSpec array
affinity Affinity
nodeSelector object (keys:string, values:string)
tolerations Toleration array
podLabels object (keys:string, values:string)
podAnnotations object (keys:string, values:string)
setHostnameAsFqdn boolean	SetHostnameAsFQDN indicates whether to set the hostname as FQDN.	true
terminationGracePeriodSeconds integer	Optional duration in seconds the pod needs to terminate gracefully.
nativeTransport RPCTransportSpec	Component config for native RPC bus transport.

RPCProxiesSpec

Appears in:

• YtsaurusSpec

Field	Description	Default	Validation
image string	Overrides coreImage for component.
entrypointWrapper string array	Specifies wrapper for component container command.
volumes Volume array
volumeMounts VolumeMount array
readinessProbeParams HealthcheckProbeParams
resources ResourceRequirements
instanceCount integer
minReadyInstanceCount integer
locations LocationSpec array
volumeClaimTemplates EmbeddedPersistentVolumeClaim array
runtimeClassName string
enableAntiAffinity boolean	Deprecated: use Affinity.PodAntiAffinity instead.
hostNetwork boolean	Use the host's network namespace, this overrides global option.
monitoringPort integer
loggers TextLoggerSpec array
structuredLoggers StructuredLoggerSpec array
affinity Affinity
nodeSelector object (keys:string, values:string)
tolerations Toleration array
podLabels object (keys:string, values:string)
podAnnotations object (keys:string, values:string)
setHostnameAsFqdn boolean	SetHostnameAsFQDN indicates whether to set the hostname as FQDN.	true
terminationGracePeriodSeconds integer	Optional duration in seconds the pod needs to terminate gracefully.
nativeTransport RPCTransportSpec	Component config for native RPC bus transport.
serviceType ServiceType
nodePort integer
role string		default	MinLength: 1
transport RPCTransportSpec

RPCTransportSpec

Appears in:

• CommonSpec
• ControllerAgentsSpec
• DataNodesSpec
• DiscoverySpec
• ExecNodesSpec
• HTTPProxiesSpec
• InstanceSpec
• MasterCachesSpec
• MastersSpec
• QueryTrackerSpec
• QueueAgentSpec
• RPCProxiesSpec
• RemoteDataNodesSpec
• RemoteExecNodesSpec
• RemoteTabletNodesSpec
• RemoteYtsaurusSpec
• SchedulersSpec
• TCPProxiesSpec
• TabletNodesSpec
• YQLAgentSpec
• YtsaurusSpec

Field	Description	Default	Validation
tlsSecret LocalObjectReference	Reference to kubernetes.io/tls secret.
tlsRequired boolean	Require encrypted connections, otherwise only when required by peer.
tlsInsecure boolean	Disable TLS certificate verification.
tlsPeerAlternativeHostName string	Define alternative host name for certificate verification.

RemoteDataNodes

RemoteDataNodes is the Schema for the remotedatanodes API

Appears in:

• RemoteDataNodesList

Field	Description	Default	Validation
apiVersion string	cluster.ytsaurus.tech/v1
kind string	RemoteDataNodes
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec RemoteDataNodesSpec
status RemoteDataNodesStatus

RemoteDataNodesList

RemoteDataNodesList contains a list of RemoteDataNodes

Field	Description	Default	Validation
apiVersion string	cluster.ytsaurus.tech/v1
kind string	RemoteDataNodesList
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items RemoteDataNodes array

RemoteDataNodesSpec

RemoteDataNodesSpec defines the desired state of RemoteDataNodes

Appears in:

• RemoteDataNodes

Field	Description	Default	Validation
remoteClusterSpec LocalObjectReference
coreImage string
jobImage string	Default docker image for user jobs.
caBundle LocalObjectReference	Reference to ConfigMap with trusted certificates: "ca.crt".
nativeTransport RPCTransportSpec	Common config for native RPC bus transport.
ephemeralCluster boolean	Allow prioritizing performance over data safety. Useful for tests and experiments.	false
useIpv6 boolean		false
useIpv4 boolean		false
keepSocket boolean
forceTcp boolean
useShortNames boolean	Do not add resource name into names of resources under control. When enabled resource should not share namespace with other Ytsaurus.	true
hostNetwork boolean	Use the host's network namespace for all components.	false
usePorto boolean		false
extraPodAnnotations object (keys:string, values:string)
configOverrides LocalObjectReference
imagePullSecrets LocalObjectReference array
image string	Overrides coreImage for component.
entrypointWrapper string array	Specifies wrapper for component container command.
volumes Volume array
volumeMounts VolumeMount array
readinessProbeParams HealthcheckProbeParams
resources ResourceRequirements
instanceCount integer
minReadyInstanceCount integer
locations LocationSpec array
volumeClaimTemplates EmbeddedPersistentVolumeClaim array
runtimeClassName string
enableAntiAffinity boolean	Deprecated: use Affinity.PodAntiAffinity instead.
hostNetwork boolean	Use the host's network namespace, this overrides global option.
monitoringPort integer
loggers TextLoggerSpec array
structuredLoggers StructuredLoggerSpec array
affinity Affinity
nodeSelector object (keys:string, values:string)
tolerations Toleration array
podLabels object (keys:string, values:string)
podAnnotations object (keys:string, values:string)
setHostnameAsFqdn boolean	SetHostnameAsFQDN indicates whether to set the hostname as FQDN.	true
terminationGracePeriodSeconds integer	Optional duration in seconds the pod needs to terminate gracefully.
nativeTransport RPCTransportSpec	Component config for native RPC bus transport.
tags string array	List of the node tags.
rack string	Name of the node rack.
name string		default	MinLength: 1

RemoteDataNodesStatus

RemoteDataNodesStatus defines the observed state of RemoteDataNodes

Appears in:

• RemoteDataNodes

Field	Description	Default	Validation
observedGeneration integer	Reflects resource generation which was used for updating status.
releaseStatus RemoteNodeReleaseStatus

RemoteExecNodes

RemoteExecNodes is the Schema for the remoteexecnodes API

Field	Description	Default	Validation
apiVersion string	cluster.ytsaurus.tech/v1
kind string	RemoteExecNodes
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec RemoteExecNodesSpec
status RemoteExecNodesStatus

RemoteExecNodesSpec

RemoteExecNodesSpec defines the desired state of RemoteExecNodes

Appears in:

• RemoteExecNodes

Field	Description	Default	Validation
remoteClusterSpec LocalObjectReference
coreImage string
jobImage string	Default docker image for user jobs.
caBundle LocalObjectReference	Reference to ConfigMap with trusted certificates: "ca.crt".
nativeTransport RPCTransportSpec	Common config for native RPC bus transport.
ephemeralCluster boolean	Allow prioritizing performance over data safety. Useful for tests and experiments.	false
useIpv6 boolean		false
useIpv4 boolean		false
keepSocket boolean
forceTcp boolean
useShortNames boolean	Do not add resource name into names of resources under control. When enabled resource should not share namespace with other Ytsaurus.	true
hostNetwork boolean	Use the host's network namespace for all components.	false
usePorto boolean		false
extraPodAnnotations object (keys:string, values:string)
configOverrides LocalObjectReference
imagePullSecrets LocalObjectReference array
image string	Overrides coreImage for component.
entrypointWrapper string array	Specifies wrapper for component container command.
volumes Volume array
volumeMounts VolumeMount array
readinessProbeParams HealthcheckProbeParams
resources ResourceRequirements
instanceCount integer
minReadyInstanceCount integer
locations LocationSpec array
volumeClaimTemplates EmbeddedPersistentVolumeClaim array
runtimeClassName string
enableAntiAffinity boolean	Deprecated: use Affinity.PodAntiAffinity instead.
hostNetwork boolean	Use the host's network namespace, this overrides global option.
monitoringPort integer
loggers TextLoggerSpec array
structuredLoggers StructuredLoggerSpec array
affinity Affinity
nodeSelector object (keys:string, values:string)
tolerations Toleration array
podLabels object (keys:string, values:string)
podAnnotations object (keys:string, values:string)
setHostnameAsFqdn boolean	SetHostnameAsFQDN indicates whether to set the hostname as FQDN.	true
terminationGracePeriodSeconds integer	Optional duration in seconds the pod needs to terminate gracefully.
nativeTransport RPCTransportSpec	Component config for native RPC bus transport.
tags string array	List of the node tags.
rack string	Name of the node rack.
name string		default	MinLength: 1
initContainers string array	List of init containers as yaml of core/v1 Container.
sidecars string array	List of sidecar containers as yaml of core/v1 Container.
privileged boolean		true
jobProxyLoggers TextLoggerSpec array
jobResources ResourceRequirements	Resources dedicated for running jobs.
jobEnvironment JobEnvironmentSpec

RemoteExecNodesStatus

RemoteExecNodesStatus defines the observed state of RemoteExecNodes

Appears in:

• RemoteExecNodes

Field	Description	Default	Validation
observedGeneration integer	Reflects resource generation which was used for updating status.
releaseStatus RemoteNodeReleaseStatus

RemoteNodeReleaseStatus

Underlying type: string

Appears in:

• CommonRemoteNodeStatus
• RemoteDataNodesStatus
• RemoteExecNodesStatus
• RemoteTabletNodesStatus

Field	Description
Pending
Running

RemoteTabletNodes

RemoteTabletNodes is the Schema for the remotetabletnodes API

Appears in:

• RemoteTabletNodesList

Field	Description	Default	Validation
apiVersion string	cluster.ytsaurus.tech/v1
kind string	RemoteTabletNodes
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec RemoteTabletNodesSpec
status RemoteTabletNodesStatus

RemoteTabletNodesList

RemoteTabletNodesList contains a list of RemoteTabletNodes

Field	Description	Default	Validation
apiVersion string	cluster.ytsaurus.tech/v1
kind string	RemoteTabletNodesList
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items RemoteTabletNodes array

RemoteTabletNodesSpec

RemoteTabletNodesSpec defines the desired state of RemoteTabletNodes

Appears in:

• RemoteTabletNodes

Field	Description	Default	Validation
remoteClusterSpec LocalObjectReference
coreImage string
jobImage string	Default docker image for user jobs.
caBundle LocalObjectReference	Reference to ConfigMap with trusted certificates: "ca.crt".
nativeTransport RPCTransportSpec	Common config for native RPC bus transport.
ephemeralCluster boolean	Allow prioritizing performance over data safety. Useful for tests and experiments.	false
useIpv6 boolean		false
useIpv4 boolean		false
keepSocket boolean
forceTcp boolean
useShortNames boolean	Do not add resource name into names of resources under control. When enabled resource should not share namespace with other Ytsaurus.	true
hostNetwork boolean	Use the host's network namespace for all components.	false
usePorto boolean		false
extraPodAnnotations object (keys:string, values:string)
configOverrides LocalObjectReference
imagePullSecrets LocalObjectReference array
image string	Overrides coreImage for component.
entrypointWrapper string array	Specifies wrapper for component container command.
volumes Volume array
volumeMounts VolumeMount array
readinessProbeParams HealthcheckProbeParams
resources ResourceRequirements
instanceCount integer
minReadyInstanceCount integer
locations LocationSpec array
volumeClaimTemplates EmbeddedPersistentVolumeClaim array
runtimeClassName string
enableAntiAffinity boolean	Deprecated: use Affinity.PodAntiAffinity instead.
hostNetwork boolean	Use the host's network namespace, this overrides global option.
monitoringPort integer
loggers TextLoggerSpec array
structuredLoggers StructuredLoggerSpec array
affinity Affinity
nodeSelector object (keys:string, values:string)
tolerations Toleration array
podLabels object (keys:string, values:string)
podAnnotations object (keys:string, values:string)
setHostnameAsFqdn boolean	SetHostnameAsFQDN indicates whether to set the hostname as FQDN.	true
terminationGracePeriodSeconds integer	Optional duration in seconds the pod needs to terminate gracefully.
nativeTransport RPCTransportSpec	Component config for native RPC bus transport.
tags string array	List of the node tags.
rack string	Name of the node rack.
name string		default	MinLength: 1

RemoteTabletNodesStatus

RemoteTabletNodesStatus defines the observed state of RemoteTabletNodes

Appears in:

• RemoteTabletNodes

Field	Description	Default	Validation
observedGeneration integer	Reflects resource generation which was used for updating status.
releaseStatus RemoteNodeReleaseStatus

RemoteYtsaurus

RemoteYtsaurus is the Schema for the remoteytsauruses API

Field	Description	Default	Validation
apiVersion string	cluster.ytsaurus.tech/v1
kind string	RemoteYtsaurus
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec RemoteYtsaurusSpec
status RemoteYtsaurusStatus

RemoteYtsaurusSpec

RemoteYtsaurusSpec defines the desired state of RemoteYtsaurus

Appears in:

• RemoteYtsaurus

Field	Description	Default	Validation
cellTag integer
hostAddresses string array
image string	Overrides coreImage for component.
entrypointWrapper string array	Specifies wrapper for component container command.
volumes Volume array
volumeMounts VolumeMount array
readinessProbeParams HealthcheckProbeParams
resources ResourceRequirements
instanceCount integer
minReadyInstanceCount integer
locations LocationSpec array
volumeClaimTemplates EmbeddedPersistentVolumeClaim array
runtimeClassName string
enableAntiAffinity boolean	Deprecated: use Affinity.PodAntiAffinity instead.
hostNetwork boolean	Use the host's network namespace, this overrides global option.
monitoringPort integer
loggers TextLoggerSpec array
structuredLoggers StructuredLoggerSpec array
affinity Affinity
nodeSelector object (keys:string, values:string)
tolerations Toleration array
podLabels object (keys:string, values:string)
podAnnotations object (keys:string, values:string)
setHostnameAsFqdn boolean	SetHostnameAsFQDN indicates whether to set the hostname as FQDN.	true
terminationGracePeriodSeconds integer	Optional duration in seconds the pod needs to terminate gracefully.
nativeTransport RPCTransportSpec	Component config for native RPC bus transport.
cellTagMasterCaches integer
hostAddressesMasterCaches string array
hostAddressesLabel string

RemoteYtsaurusStatus

RemoteYtsaurusStatus defines the observed state of RemoteYtsaurus

Appears in:

• RemoteYtsaurus

SchedulersSpec

Appears in:

• YtsaurusSpec

Field	Description	Default	Validation
image string	Overrides coreImage for component.
entrypointWrapper string array	Specifies wrapper for component container command.
volumes Volume array
volumeMounts VolumeMount array
readinessProbeParams HealthcheckProbeParams
resources ResourceRequirements
instanceCount integer
minReadyInstanceCount integer
locations LocationSpec array
volumeClaimTemplates EmbeddedPersistentVolumeClaim array
runtimeClassName string
enableAntiAffinity boolean	Deprecated: use Affinity.PodAntiAffinity instead.
hostNetwork boolean	Use the host's network namespace, this overrides global option.
monitoringPort integer
loggers TextLoggerSpec array
structuredLoggers StructuredLoggerSpec array
affinity Affinity
nodeSelector object (keys:string, values:string)
tolerations Toleration array
podLabels object (keys:string, values:string)
podAnnotations object (keys:string, values:string)
setHostnameAsFqdn boolean	SetHostnameAsFQDN indicates whether to set the hostname as FQDN.	true
terminationGracePeriodSeconds integer	Optional duration in seconds the pod needs to terminate gracefully.
nativeTransport RPCTransportSpec	Component config for native RPC bus transport.

Spyt

Spyt is the Schema for the spyts API

Field	Description	Default	Validation
apiVersion string	cluster.ytsaurus.tech/v1
kind string	Spyt
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec SpytSpec
status SpytStatus

SpytReleaseStatus

Underlying type: string

Appears in:

• SpytStatus

Field	Description
CreatingUserSecret
CreatingUser
UploadingIntoCypress
Finished

SpytSpec

SpytSpec defines the desired state of Spyt

Appears in:

• Spyt

Field	Description	Default	Validation
imagePullSecrets LocalObjectReference array
ytsaurus LocalObjectReference
image string

SpytStatus

SpytStatus defines the observed state of Spyt

Appears in:

• Spyt

Field	Description	Default	Validation
conditions Condition array
releaseStatus SpytReleaseStatus

StrawberryControllerSpec

Appears in:

• YtsaurusSpec

Field	Description	Default	Validation
resources ResourceRequirements
image string
tolerations Toleration array
nodeSelector object (keys:string, values:string)
externalProxy string
controllerFamilies string array	Supported controller families, for example: "chyt", "jupyt", "livy".
defaultRouteFamily string	The family that will receive requests for domains that are not explicitly specified in http_controller_mappings. For example, "chyt" (with ControllerFamilies set to {"chyt", "jupyt"} would mean that requests to "foo." will be processed by chyt controller.

StructuredLoggerSpec

Appears in:

• ControllerAgentsSpec
• DataNodesSpec
• DiscoverySpec
• ExecNodesSpec
• HTTPProxiesSpec
• InstanceSpec
• MasterCachesSpec
• MastersSpec
• QueryTrackerSpec
• QueueAgentSpec
• RPCProxiesSpec
• RemoteDataNodesSpec
• RemoteExecNodesSpec
• RemoteTabletNodesSpec
• RemoteYtsaurusSpec
• SchedulersSpec
• TCPProxiesSpec
• TabletNodesSpec
• YQLAgentSpec

Field	Description	Default	Validation
name string			MinLength: 1
format LogFormat		plain_text	Enum: [plain_text json yson]
minLogLevel LogLevel		info	Enum: [trace debug info warning error]
compression LogCompression		none	Enum: [none gzip zstd]
useTimestampSuffix boolean		false
rotationPolicy LogRotationPolicy
category string

TCPProxiesSpec

Appears in:

• YtsaurusSpec

Field	Description	Default	Validation
image string	Overrides coreImage for component.
entrypointWrapper string array	Specifies wrapper for component container command.
volumes Volume array
volumeMounts VolumeMount array
readinessProbeParams HealthcheckProbeParams
resources ResourceRequirements
instanceCount integer
minReadyInstanceCount integer
locations LocationSpec array
volumeClaimTemplates EmbeddedPersistentVolumeClaim array
runtimeClassName string
enableAntiAffinity boolean	Deprecated: use Affinity.PodAntiAffinity instead.
hostNetwork boolean	Use the host's network namespace, this overrides global option.
monitoringPort integer
loggers TextLoggerSpec array
structuredLoggers StructuredLoggerSpec array
affinity Affinity
nodeSelector object (keys:string, values:string)
tolerations Toleration array
podLabels object (keys:string, values:string)
podAnnotations object (keys:string, values:string)
setHostnameAsFqdn boolean	SetHostnameAsFQDN indicates whether to set the hostname as FQDN.	true
terminationGracePeriodSeconds integer	Optional duration in seconds the pod needs to terminate gracefully.
nativeTransport RPCTransportSpec	Component config for native RPC bus transport.
serviceType ServiceType
minPort integer		32000
portCount integer	Number of ports to allocate for balancing service.	20
role string		default	MinLength: 1

TabletCellBundleInfo

Appears in:

• UpdateStatus

Field	Description	Default	Validation
name string
tabletCellCount integer

TabletNodesSpec

Appears in:

• RemoteTabletNodesSpec
• YtsaurusSpec

Field	Description	Default	Validation
image string	Overrides coreImage for component.
entrypointWrapper string array	Specifies wrapper for component container command.
volumes Volume array
volumeMounts VolumeMount array
readinessProbeParams HealthcheckProbeParams
resources ResourceRequirements
instanceCount integer
minReadyInstanceCount integer
locations LocationSpec array
volumeClaimTemplates EmbeddedPersistentVolumeClaim array
runtimeClassName string
enableAntiAffinity boolean	Deprecated: use Affinity.PodAntiAffinity instead.
hostNetwork boolean	Use the host's network namespace, this overrides global option.
monitoringPort integer
loggers TextLoggerSpec array
structuredLoggers StructuredLoggerSpec array
affinity Affinity
nodeSelector object (keys:string, values:string)
tolerations Toleration array
podLabels object (keys:string, values:string)
podAnnotations object (keys:string, values:string)
setHostnameAsFqdn boolean	SetHostnameAsFQDN indicates whether to set the hostname as FQDN.	true
terminationGracePeriodSeconds integer	Optional duration in seconds the pod needs to terminate gracefully.
nativeTransport RPCTransportSpec	Component config for native RPC bus transport.
tags string array	List of the node tags.
rack string	Name of the node rack.
name string		default	MinLength: 1

TextLoggerSpec

Appears in:

• ControllerAgentsSpec
• DataNodesSpec
• DiscoverySpec
• ExecNodesSpec
• HTTPProxiesSpec
• InstanceSpec
• MasterCachesSpec
• MastersSpec
• QueryTrackerSpec
• QueueAgentSpec
• RPCProxiesSpec
• RemoteDataNodesSpec
• RemoteExecNodesSpec
• RemoteTabletNodesSpec
• RemoteYtsaurusSpec
• SchedulersSpec
• TCPProxiesSpec
• TabletNodesSpec
• YQLAgentSpec

Field	Description	Default	Validation
name string			MinLength: 1
format LogFormat		plain_text	Enum: [plain_text json yson]
minLogLevel LogLevel		info	Enum: [trace debug info warning error]
compression LogCompression		none	Enum: [none gzip zstd]
useTimestampSuffix boolean		false
rotationPolicy LogRotationPolicy
writerType LogWriterType			Enum: [file stderr]
categoriesFilter CategoriesFilter

UISpec

Appears in:

• YtsaurusSpec

Field	Description	Default	Validation
image string
serviceType ServiceType		NodePort
httpNodePort integer
useInsecureCookies boolean	If defined allows insecure (over http) authentication.	true
secure boolean	Use secure connection to the cluster's http-proxies.	false
resources ResourceRequirements
instanceCount integer
externalProxy string	If defined it will be used for direct heavy url/commands like: read_table, write_table, etc.
odinBaseUrl string	Odin is a service for monitoring the availability of YTsaurus clusters.
extraEnvVariables EnvVar array
environment string		testing
theme string		lavander
description string
group string
directDownload boolean	When this is set to false, UI will use backend for downloading instead of proxy. If this is set to true or omitted, UI use proxies, which is a default behaviour.
tolerations Toleration array
nodeSelector object (keys:string, values:string)

UpdateFlow

Underlying type: string

Appears in:

• UpdateStatus

Field	Description
``
Stateless
Master
TabletNodes
Full

UpdateSelector

Underlying type: string

Appears in:

• YtsaurusSpec

Field	Description
``	UpdateSelectorUnspecified means that selector is disabled and would be ignored completely.
Nothing	UpdateSelectorNothing means that no component could be updated.
MasterOnly	UpdateSelectorMasterOnly means that only master could be updated.
DataNodesOnly	UpdateSelectorTabletNodesOnly means that only data nodes could be updated
TabletNodesOnly	UpdateSelectorTabletNodesOnly means that only tablet nodes could be updated
ExecNodesOnly	UpdateSelectorExecNodesOnly means that only tablet nodes could be updated
StatelessOnly	UpdateSelectorStatelessOnly means that only stateless components (everything but master, data nodes, and tablet nodes) could be updated.
Everything	UpdateSelectorEverything means that all components could be updated. With this setting and if master or tablet nodes need update all the components would be updated.

UpdateState

Underlying type: string

Appears in:

• UpdateStatus

Field	Description
None
PossibilityCheck
ImpossibleToStart
WaitingForSafeModeEnabled
WaitingForTabletCellsSaving
WaitingForTabletCellsRemovingStart
WaitingForTabletCellsRemoved
WaitingForSnapshots
WaitingForPodsRemoval
WaitingForPodsCreation
WaitingForMasterExitReadOnly
WaitingForTabletCellsRecovery
WaitingForOpArchiveUpdatingPrepare
WaitingForOpArchiveUpdate
WaitingForQTStateUpdatingPrepare
WaitingForQTStateUpdate
WaitingForYqlaUpdatingPrepare
WaitingForYqlaUpdate
WaitingForSafeModeDisabled

UpdateStatus

Appears in:

• YtsaurusStatus

Field	Description	Default	Validation
state UpdateState		None
components string array
flow UpdateFlow	Flow is an internal field that is needed to persist the chosen flow until the end of an update. Flow can be on of ""(unspecified), Stateless, Master, TabletNodes, Full and update cluster stage executes steps corresponding to that update flow.
conditions Condition array
tabletCellBundles TabletCellBundleInfo array
masterMonitoringPaths string array

YQLAgentSpec

Appears in:

• YtsaurusSpec

Field	Description	Default	Validation
image string	Overrides coreImage for component.
entrypointWrapper string array	Specifies wrapper for component container command.
volumes Volume array
volumeMounts VolumeMount array
readinessProbeParams HealthcheckProbeParams
resources ResourceRequirements
instanceCount integer
minReadyInstanceCount integer
locations LocationSpec array
volumeClaimTemplates EmbeddedPersistentVolumeClaim array
runtimeClassName string
enableAntiAffinity boolean	Deprecated: use Affinity.PodAntiAffinity instead.
hostNetwork boolean	Use the host's network namespace, this overrides global option.
monitoringPort integer
loggers TextLoggerSpec array
structuredLoggers StructuredLoggerSpec array
affinity Affinity
nodeSelector object (keys:string, values:string)
tolerations Toleration array
podLabels object (keys:string, values:string)
podAnnotations object (keys:string, values:string)
setHostnameAsFqdn boolean	SetHostnameAsFQDN indicates whether to set the hostname as FQDN.	true
terminationGracePeriodSeconds integer	Optional duration in seconds the pod needs to terminate gracefully.
nativeTransport RPCTransportSpec	Component config for native RPC bus transport.

Ytsaurus

Ytsaurus is the Schema for the ytsaurus API

Field	Description	Default	Validation
apiVersion string	cluster.ytsaurus.tech/v1
kind string	Ytsaurus
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec YtsaurusSpec
status YtsaurusStatus

YtsaurusSpec

YtsaurusSpec defines the desired state of Ytsaurus

Appears in:

• Ytsaurus

Field	Description	Default	Validation
coreImage string
jobImage string	Default docker image for user jobs.
caBundle LocalObjectReference	Reference to ConfigMap with trusted certificates: "ca.crt".
nativeTransport RPCTransportSpec	Common config for native RPC bus transport.
ephemeralCluster boolean	Allow prioritizing performance over data safety. Useful for tests and experiments.	false
useIpv6 boolean		false
useIpv4 boolean		false
keepSocket boolean
forceTcp boolean
useShortNames boolean	Do not add resource name into names of resources under control. When enabled resource should not share namespace with other Ytsaurus.	true
hostNetwork boolean	Use the host's network namespace for all components.	false
usePorto boolean		false
extraPodAnnotations object (keys:string, values:string)
configOverrides LocalObjectReference
imagePullSecrets LocalObjectReference array
uiImage string
adminCredentials LocalObjectReference
oauthService OauthServiceSpec
isManaged boolean		true
enableFullUpdate boolean		true
updateSelector UpdateSelector	UpdateSelector is an experimental field. Behaviour may change. If UpdateSelector is not empty EnableFullUpdate is ignored.		Enum: [ Nothing MasterOnly DataNodesOnly TabletNodesOnly ExecNodesOnly StatelessOnly Everything]
nodeSelector object (keys:string, values:string)
tolerations Toleration array
bootstrap BootstrapSpec
discovery DiscoverySpec
primaryMasters MastersSpec
secondaryMasters MastersSpec array
masterCaches MasterCachesSpec
httpProxies HTTPProxiesSpec array			MinItems: 1
rpcProxies RPCProxiesSpec array
tcpProxies TCPProxiesSpec array
dataNodes DataNodesSpec array			MinItems: 1
execNodes ExecNodesSpec array
schedulers SchedulersSpec
controllerAgents ControllerAgentsSpec
tabletNodes TabletNodesSpec array
strawberry StrawberryControllerSpec
queryTrackers QueryTrackerSpec
spyt DeprecatedSpytSpec
yqlAgents YQLAgentSpec
queueAgents QueueAgentSpec
ui UISpec

YtsaurusStatus

YtsaurusStatus defines the observed state of Ytsaurus

Appears in:

• Ytsaurus

Field	Description	Default	Validation
state ClusterState		Created
conditions Condition array
observedGeneration integer	Reflects resource generation which was used for updating status.
updateStatus UpdateStatus