API Reference

Packages

• cogynt.io/v1

cogynt.io/v1

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

Resource Types

• Cogynt

AlertManagerSpec

Appears in:

• MimirSpec

Field	Description	Default	Validation
replicas integer
resources ResourceRequirements
storage string

AuditOTP

AuditOTP defines the desired state of AuditOTP.

Appears in:

• AuditSpec

Field	Description	Default	Validation
replicas integer	(Optional) Sets the the desired number of replicas; [ default: 1 ]
resources ResourceRequirements	(Optional) ResourceRequirements describes the compute resource requirements.
affinity Affinity	(Optional) Describes node affinity scheduling rules for the pod.
securityContext PodSecurityContext	(Optional) Holds pod-level security attributes and common container settings.

AuditSpec

Appears in:

• CogyntSpec

Field	Description	Default	Validation
enableDevTools boolean	(Optional) Enable dev tools for Audit; [ default: false ]
otp AuditOTP	(Optional) Defines the desired state of audit-otp
ui AuditUI	(Optional) Defines the desired state of audit-ui

AuditUI

AuditUI defines the desired state of AuditUI.

Appears in:

• AuditSpec

Field	Description	Default	Validation
replicas integer	(Optional) Sets the the desired number of replicas; [ default: 1 ]
resources ResourceRequirements	(Optional) ResourceRequirements describes the compute resource requirements.
affinity Affinity	(Optional) Describes node affinity scheduling rules for the pod.
securityContext PodSecurityContext	(Optional) Holds pod-level security attributes and common container settings.

AuthOTP

AuthOTP defines the desired state of AuthOTP.

Appears in:

• AuthSpec

Field	Description	Default	Validation
replicas integer	(Optional) Sets the the desired number of replicas; [ default: 1 ]
resources ResourceRequirements	(Optional) ResourceRequirements describes the compute resource requirements.
affinity Affinity	(Optional) Describes node affinity scheduling rules for the pod.
securityContext PodSecurityContext	(Optional) Holds pod-level security attributes and common container settings.
provider AuthProvider
google Google
microsoft Microsoft
saml Saml
cyberAlphaUsers string	(Optional) Comma list that defines the desired users for cyber alpha

AuthProvider

Underlying type: string

Appears in:

• AuthOTP

Field	Description
none
google
saml
microsoft
keycloak

AuthSpec

Appears in:

• CogyntSpec

Field	Description	Default	Validation
useSecureCookie boolean
otp AuthOTP	(Optional) Defines the desired state of auth-otp
ui AuthUI	(Optional) Defines the desired state of auth-ui

AuthUI

AuthUI defines the desired state of AuthUI.

Appears in:

• AuthSpec

Field	Description	Default	Validation
replicas integer	(Optional) Sets the the desired number of replicas; [ default: 1 ]
resources ResourceRequirements	(Optional) ResourceRequirements describes the compute resource requirements.
affinity Affinity	(Optional) Describes node affinity scheduling rules for the pod.
securityContext PodSecurityContext	(Optional) Holds pod-level security attributes and common container settings.

AuthentikSpec

AuthentikSpec defines the desired state of Authentik.

Appears in:

• CogyntSpec

Field	Description	Default	Validation
enabled boolean	(Optional) Enables Authentik for deployment; [ default: false ]

AuthoringGqlOTP

AuthoringGqlOTP defines the desired state of AuthoringGqlOTP.

Appears in:

• AuthoringSpec

Field	Description	Default	Validation
replicas integer	(Optional) Sets the the desired number of replicas; [ default: 1 ]
resources ResourceRequirements	(Optional) ResourceRequirements describes the compute resource requirements.
affinity Affinity	(Optional) Describes node affinity scheduling rules for the pod.
securityContext PodSecurityContext	(Optional) Holds pod-level security attributes and common container settings.
eksRoleArn string	(Optional) Sets the AWS EKS Role ARN w/ Authoring S3 permissions; [ validation: required if cluster.type=eks ]
gcpServiceAccount string	(Optional) Sets the GCP Service Account w/ Authoring GCS permissions; [ validation: required if cluster.type=gke ]
exportBucket string	(Optional) Sets S3 or GCS bucket for exported Authoring data

AuthoringReactUI

AuthoringReactUI defines the desired state of AuthoringReactUI.

Appears in:

• AuthoringSpec

Field	Description	Default	Validation
replicas integer	(Optional) Sets the the desired number of replicas; [ default: 1 ]
resources ResourceRequirements	(Optional) ResourceRequirements describes the compute resource requirements.
affinity Affinity	(Optional) Describes node affinity scheduling rules for the pod.
securityContext PodSecurityContext	(Optional) Holds pod-level security attributes and common container settings.

AuthoringSpec

Appears in:

• CogyntSpec

Field	Description	Default	Validation
otp AuthoringGqlOTP	(Optional) Defines the desired state of authoring-gql-otp
ui AuthoringReactUI	(Optional) Defines the desired state of authoring-react-ui

AwsAuth

Appears in:

• CogyntSpec

Field	Description	Default	Validation
enabled boolean	(Optional) Enables AWS authentication; [ default: true]
accountID string
enableCogyntDevopsUsers boolean
mapUsers string

Backup

Appears in:

• ClusterSpec

Field	Description	Default	Validation
enabled boolean	(Optional) Enables backups for applications in the cluster; [ default: true ]
schedule string	(Optional) Sets schedule for backups in cron format; [ default: "30 3 * * 0" ]
backupBucket string	(Optional) Sets the object storage bucket for backups; [ validation: empty=false ]
eksRoleArn string	(Optional) Sets the AWS EKS Role ARN w/ S3 Bucket permissions; [ validation: Required if cluster.type=eks ]
gcpServiceAccount string	(Optional) Sets the GCP Service Account w/ GCS permissions; [ validation: Required if cluster.type=gke ]
region string	(Optional) Sets AWS/GCP Region for opensearch snapshot backups

ClassificationLevel

Underlying type: string

Appears in:

• CogyntSpec

Field	Description
NONE
CONFIDENTIAL
UNCLASSIFIED
SECRET
TOP SECRET

ClusterProvider

Underlying type: string

Appears in:

• ClusterSpec

Field	Description
aws
google
azure
onprem

ClusterSpec

ClusterSpec defines the desired state of ClusterSpec.

Appears in:

• CogyntSpec

Field	Description	Default	Validation
provider ClusterProvider	(Optional) Sets the cluster provider; [ default: aws; validation: oneof\{aws,google\} ]
type ClusterType	(Optional) Sets the cluster type; [ default: eks; validation: oneof\{eks,kops,gke\} ]
region string	(Optional) Sets the cluster provider region [ default: us-west-2 ]
storagePool StoragePool	(Optional) Sets the storage pool for the cluster
backup Backup	(Optional) Sets the backup parameters for the cluster

ClusterType

Underlying type: string

Appears in:

• ClusterSpec

Field	Description
eks
kops
gke

Cogynt

Cogynt is the schema for Cogynt's API.

Field	Description	Default	Validation
apiVersion string	cogynt.io/v1
kind string	Cogynt
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec CogyntSpec

CogyntSpec

CogyntSpec defines the desired state of Cogynt.

Appears in:

• Cogynt

Field	Description	Default	Validation
hostnames string array	Set your ingess hostnames; [ validation: empty=false ]
subdomainSuffix string	(Optional) Set your ingess subdomain suffix; [ example: authoring-suffix.hostname.com ]
namespaceOverrides string array	(Optional) List of namespaces to deploy Cogynt;
channel ReleaseChannel	(Optional) Sets release channel; [ default: stable ]
replicas integer	(Optional) Set global replicas; [ default: 1 ]
imageRegistry string	(Optional) Set custom image registry;
imagePullSecrets LocalObjectReference array	(Optional) ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod; [ default: - name: cogynt-registry ]
images Image array
logLevel string	(Optional) Set global log level; [ default: info ]
classificationLevel ClassificationLevel	(Optional) Set global classification level; [ default: none ]
tlskey string
tlspem string
cluster ClusterSpec
awsAuth AwsAuth
audit AuditSpec
auth AuthSpec
authoring AuthoringSpec
dataImporter DataImporterSpec
permissions PermissionsSpec
submissionPortal SubmissionPortalSpec
workstation WorkstationSpec
intelligence IntelligenceSpec
authentik AuthentikSpec
confluent ConfluentSpec
opensearch OpensearchSpec
externalDNS ExternalDNSSpec
externalSecrets ExternalSecretsSpec
flink FlinkSpec
hcvault HCVaultSpec
istio IstioSpec
jupyterHub JupyterHubSpec
kubeDash KubeDashSpec
o11y O11ySpec
postgresql PostgreSQLSpec
redis RedisSpec
pinot PinotSpec
superset SupersetSpec
gatekeeper GatekeeperSpec

Common

Common defines a common use k8s util.

Appears in:

• AuditOTP
• AuditUI
• AuthOTP
• AuthUI
• AuthoringGqlOTP
• AuthoringReactUI
• DataImporterSpec
• FlinkOperator
• IntelligenceOTP
• PermissionsSpec
• PinotBroker
• PinotController
• PinotMinion
• PinotServer
• SubmissionPortalOTP
• SubmissionPortalUI
• SupersetServer
• SupersetWorker
• WorkstationIngestOTP
• WorkstationOTP
• WorkstationUI

Field	Description	Default	Validation
replicas integer	(Optional) Sets the the desired number of replicas; [ default: 1 ]
resources ResourceRequirements	(Optional) ResourceRequirements describes the compute resource requirements.
affinity Affinity	(Optional) Describes node affinity scheduling rules for the pod.
securityContext PodSecurityContext	(Optional) Holds pod-level security attributes and common container settings.

CompactorSpec

Appears in:

• LokiSpec
• MimirSpec
• TempoSpec

Field	Description	Default	Validation
replicas integer
resources ResourceRequirements
storage string

ConfluentSpec

ConfluentSpec defines the desired state of Confluent.

Appears in:

• CogyntSpec

Field	Description	Default	Validation
enabled boolean	(Optional) Enables ConfluentSpec for deployment; [ default: true ]
kafka Kafka
zookeeper Zookeeper
connect Connect

Connect

Connect is the schema for Connect.

Appears in:

• ConfluentSpec

Field	Description	Default	Validation
replicas integer
resources ResourceRequirements

Dashboard

Appears in:

• OpensearchCommon

Field	Description	Default	Validation
enabled boolean	(Optional) Enables Dashboard for deployment; [ default: false ]

DataImporterSpec

DataImporterSpec defines the desired state of modeldoc-ui.

Appears in:

• CogyntSpec

Field	Description	Default	Validation
replicas integer	(Optional) Sets the the desired number of replicas; [ default: 1 ]
resources ResourceRequirements	(Optional) ResourceRequirements describes the compute resource requirements.
affinity Affinity	(Optional) Describes node affinity scheduling rules for the pod.
securityContext PodSecurityContext	(Optional) Holds pod-level security attributes and common container settings.
afForms boolean	(Optional) Enables manual entry; [ default: false ]

DistributorSpec

Appears in:

• LokiSpec
• MimirSpec
• TempoSpec

Field	Description	Default	Validation
replicas integer
resources ResourceRequirements

ExternalDNSSpec

ExternalDNSSpec defines the desired state of ExternalDNSSpec.

Appears in:

• CogyntSpec

Field	Description	Default	Validation
enabled boolean	(Optional) Enables External DNS for deployment; [ default: true ]
eksRoleArn string	(Optional) Sets the AWS EKS Role ARN w/ External DNS permissions; [ validation: required if cluster.type=eks ]
gcpServiceAccount string	(Optional) Sets the GCP Service Account w/ External DNS permissions; [ validation: required if cluster.provider=google ]
accessKeyID string
secretAccessKey string

ExternalSecretsSpec

ExternalSecretsSpec defines the desired state of ExternalSecretsSpec.

Appears in:

• CogyntSpec

Field	Description	Default	Validation
enabled boolean	(Optional) Enables External Secrets for deployment; [ default: false ]
eksRoleArn string	(Optional) Sets the AWS EKS Role ARN w/ External DNS permissions;
gcpServiceAccount string	(Optional) Sets the GCP Service Account w/ External DNS permissions;
domainList string array	(Optional) Sets the list of domains to get certs for;
secretPrefix string	(Optional) Sets prefix of the Secret;

FlinkOperator

FlinkOperator defines the desired state of FlinkOperator.

Appears in:

• FlinkSpec

Field	Description	Default	Validation
replicas integer	(Optional) Sets the the desired number of replicas; [ default: 1 ]
resources ResourceRequirements	(Optional) ResourceRequirements describes the compute resource requirements.
affinity Affinity	(Optional) Describes node affinity scheduling rules for the pod.
securityContext PodSecurityContext	(Optional) Holds pod-level security attributes and common container settings.

FlinkSpec

Appears in:

• CogyntSpec

Field	Description	Default	Validation
operator FlinkOperator
eksRoleArn string	(Optional) Sets the AWS EKS Role ARN w/ S3 Bucket permissions; [ validation: required if cluster.type=eks ]
gcpServiceAccount string	(Optional) Sets the GCP Service Account w/ GCS permissions; [ validation: required if cluster.type=gke ]
checkpointBucket string
checkpointEndpointURL string
checkpointBucketAccessKey string
checkpointBucketAccessSecret string
checkpointMode string
checkpointTimeout integer
checkpointFrequency integer
savepointFrequency integer

GatekeeperSpec

GatekeeperSpec defines the desired state of Gatekeeper.

Appears in:

• CogyntSpec

Field	Description	Default	Validation
enabled boolean	(Optional) Enables Gatekeeper for deployment; [ default: false ]

Google

Appears in:

• AuthOTP
• SubmissionPortalOTP

Field	Description	Default	Validation
clientID string
clientSecret string

HCVaultSpec

HCVaultSpec defines the desired state of HCVaultSpec.

Appears in:

• CogyntSpec

Field	Description	Default	Validation
enabled boolean	(Optional) Enables HC Vault for deployment; [ default: true ]
ingress boolean	(Optional) Enables HC Vault ingress for deployment; [ default: false ]
eksRoleArn string	(Optional) Sets the AWS EKS Role ARN w/ HC Vault permissions; [ validation: required if cluster.type=eks ]
kmsKeyID string	(Optional) Sets the AWS KMS Key ID for HC Vault; [ validation: required if cluster.type=eks ]
gcpServiceAccount string	(Optional) Sets the GCP Service Account w/ HC Vault permissions; [ validation: required if cluster.provider=google ]
gcpProject string	(Optional) Sets the GCP project name w/ the HC Vault key ring; [ validation: required if cluster.provider=google ]
keyRingRegion string	(Optional) Sets the GCP region the key ring is in; [ validation: required if cluster.provider=google ]
keyRing string	(Optional) Sets the GCP key ring name; [ validation: required if cluster.provider=google ]
cryptoKey string	(Optional) Sets the GCP key ring crypto key name; [ validation: required if cluster.provider=google ]
storage string	(Optional) Sets the volume storage.; [ default: 20Gi ]

Image

Underlying type: object

Image represents image configuration.

Appears in:

• CogyntSpec

IngesterSpec

Appears in:

• LokiSpec
• MimirSpec
• TempoSpec

Field	Description	Default	Validation
replicas integer
resources ResourceRequirements
storage string

IntelligenceOTP

IntelligenceOTP defines the desired state of IntelligenceOTP.

Appears in:

• IntelligenceSpec

Field	Description	Default	Validation
replicas integer	(Optional) Sets the the desired number of replicas; [ default: 1 ]
resources ResourceRequirements	(Optional) ResourceRequirements describes the compute resource requirements.
affinity Affinity	(Optional) Describes node affinity scheduling rules for the pod.
securityContext PodSecurityContext	(Optional) Holds pod-level security attributes and common container settings.
eksRoleArn string	(Optional) Sets the AWS EKS Role ARN w/ Intelligence Attachments S3 permissions; [ validation: required if cluster.type=eks ]
replicaCount integer	(Optional) Sets the number of Opensearch replicas for the Intelligence Ingest index; [ default: 2 ]

IntelligenceSpec

IntelligenceSpec defines the desired state of IntelligenceSpec.

Appears in:

• CogyntSpec

Field	Description	Default	Validation
enabled boolean	(Optional) Enables IntelligenceSpec for deployment; [ default: false ]
otp IntelligenceOTP	(Optional) Defines the desired state of intelligence-otp

IstioSpec

IstioSpec defines the desired state of IstioSpec.

Appears in:

• CogyntSpec

Field	Description	Default	Validation
eksRoleArn string	(Optional) Sets the AWS EKS Role ARN w/ IstioSpec permissions; [ validation: required if cluster.type=eks ]
internalLoadBalancer boolean	(Optional) Sets the Load Balancer to internal; [ default: true ]
loadBalancerSourceRanges string array	(Optional) Sets allowed source IP ranges; [ default: 0.0.0.0/0 ]

JupyterHubSpec

JupyterHubSpec defines the desired state of JupyterHub.

Appears in:

• CogyntSpec

Field	Description	Default	Validation
enabled boolean	(Optional) Enables Jupyter Hub for deployment; [ default: false ]
ingress boolean	(Optional) Enables Jupyter Hub ingress for deployment; [ default: false ]

Kafka

Kafka defines the observed state of Kafka.

Appears in:

• ConfluentSpec

Field	Description	Default	Validation
replicas integer	(Optional) Set Kafka replica count; [ default: 3 ]
heapSize string	(Optional) Set Kafka heap size;[ default: 1g ]
tierEnabled boolean	(Optional) Enable kafka tiered storage; [ default: false ]
tierBackend string	(Optional) Set kafka tiered storage backend; [ default: s3; validation: oneof\{s3,gcs\} ]
eksRoleArn string	(Optional) Sets the AWS EKS Role ARN w/ S3 Bucket permissions; [ validation: required if cluster.type=eks ]
s3Bucket string	(Optional) Set S3 bucket for kafka tiered storage (trims prefix "s3://")
gcpServiceAccount string	(Optional) Sets the GCP Service Account w/ GCS permissions; [ validation: required if cluster.type=gke ]
gcsBucket string	(Optional) Set GCS bucket for kafka tiered storage (trims prefix "gs://")
gcsRegion string	(Optional) Set GCS bucket region for kafka tiered storage
gcsPrefix string	(Optional) This prefix will be added to tiered storage objects stored in GCS.
resources ResourceRequirements
storage string
maxStorage string

KubeDashSpec

KubeDash defines the desired state of Cogynt.

Appears in:

• CogyntSpec

Field	Description	Default	Validation
enabled boolean	(Optional) Enables Kubernetes Dashboard for deployment; [ default: true ]
ingress boolean	(Optional) Enables Kubernetes Dashboard ingress for deployment; [ default: false ]
insecure boolean	(Optional) Enables Kubernetes Dashboard insecure access for deployment; [ default: false ]

LokiSpec

LokiSpec defines the desired state of Loki.

Appears in:

• O11ySpec

Field	Description	Default	Validation
enabled boolean	(Optional) Enables Loki for deployment; [ default: true ]
eksRoleArn string	(Optional) Sets the AWS EKS Role ARN w/ S3 permissions; [ validation: required if cluster.type=eks ]
gcpServiceAccount string	(Optional) Sets the GCP Service Account w/ GCS permissions; [ validation: required if cluster.provider=google ]
storage O11yStorageSpec
additionalPodLogNamespaces string array	(Optional) Sets additional namespaces for aggregating pod logs;
cache MemCachedSpec
compactor CompactorSpec
distributor DistributorSpec
ingester IngesterSpec
querier QuerierSpec
queryFrontend QueryFrontendSpec
ruler RulerSpec
indexGateway StoreGatewaySpec

MemCachedSpec

Appears in:

• LokiSpec
• MimirSpec
• TempoSpec

Field	Description	Default	Validation
enabled boolean
resources ResourceRequirements

Microsoft

Appears in:

• AuthOTP

Field	Description	Default	Validation
id string
secret string

MimirSpec

MimirSpec defines the desired state of Mimir.

Appears in:

• O11ySpec

Field	Description	Default	Validation
enabled boolean	(Optional) Enables Mimir for deployment; [ default: true ]
eksRoleArn string	(Optional) Sets the AWS EKS Role ARN w/ S3 permissions; [ validation: required if cluster.type=eks ]
gcpServiceAccount string	(Optional) Sets the GCP Service Account w/ GCS permissions; [ validation: required if cluster.provider=google ]
storage O11yStorageSpec
alertManager AlertManagerSpec
cache MemCachedSpec
compactor CompactorSpec
distributor DistributorSpec
ingester IngesterSpec
querier QuerierSpec
queryFrontend QueryFrontendSpec
queryScheduler QuerySchedulerSpec
ruler RulerSpec
indexGateway StoreGatewaySpec

O11ySpec

Appears in:

• CogyntSpec

Field	Description	Default	Validation
enabled boolean	(Optional) Enables Observability suite for deployment; [ default: true ]
loki LokiSpec
tempo TempoSpec
mimir MimirSpec

O11yStorageSpec

Appears in:

• LokiSpec
• MimirSpec
• TempoSpec

Field	Description	Default	Validation
type string	(Optional) Sets the storage type; [ default: s3; validation: oneof\{s3,gcs\} ]
bucket string
region string	(Optional) Sets the s3 bucket enpoint region; [ default: us-west-2; ]

OpensearchCommon

OpensearchCommon defines the observed state of OpensearchCommon.

Appears in:

• OpensearchSpec

Field	Description	Default	Validation
master OpensearchMaster
data OpensearchData
dashboard Dashboard

OpensearchData

OpensearchData is the schema for Cogynt's API.

Appears in:

• OpensearchCommon

Field	Description	Default	Validation
replicas integer	(Optional) Sets the desired number of replicas.; [ default: 3 ]
resources ResourceRequirements	(Optional) Sets the compute resource requirements.
heapSize string	(Optional) Set Opensearch heap size;[ default: 3g ]
storage string	(Optional) Sets the initial volume storage.; [ default: 50Gi ]
maxStorage string	(Optional) Sets the max volume storage to scale to.; [ default: 200Gi ]

OpensearchMaster

Opensearch Master is the Schema for Cogynt's API.

Appears in:

• OpensearchCommon

Field	Description	Default	Validation
replicas integer	(Optional) Sets the the desired number of replicas; [ default: 2 ]

OpensearchSpec

OpensearchSpec defines the desired state of Opensearch.

Appears in:

• CogyntSpec

Field	Description	Default	Validation
enabled boolean	(Optional) Enables Opensearch for deployment; [ default: true ]
common OpensearchCommon

PermissionsSpec

PermissionsSpec defines the desired state of PermissionsNodejs

Appears in:

• CogyntSpec

Field	Description	Default	Validation
replicas integer	(Optional) Sets the the desired number of replicas; [ default: 1 ]
resources ResourceRequirements	(Optional) ResourceRequirements describes the compute resource requirements.
affinity Affinity	(Optional) Describes node affinity scheduling rules for the pod.
securityContext PodSecurityContext	(Optional) Holds pod-level security attributes and common container settings.

PinotBroker

PinotBroker is the schema for the Pinot Broker.

Appears in:

• PinotSpec

Field	Description	Default	Validation
replicas integer	(Optional) Sets the the desired number of replicas; [ default: 1 ]
resources ResourceRequirements	(Optional) ResourceRequirements describes the compute resource requirements.
affinity Affinity	(Optional) Describes node affinity scheduling rules for the pod.
securityContext PodSecurityContext	(Optional) Holds pod-level security attributes and common container settings.
heapSize string	(Optional) Set the PinotBroker JVM HeapSize; [ default: "1G" ]

PinotController

PinotController is the schema for the Pinot Controller.

Appears in:

• PinotSpec

Field	Description	Default	Validation
replicas integer	(Optional) Sets the the desired number of replicas; [ default: 1 ]
resources ResourceRequirements	(Optional) ResourceRequirements describes the compute resource requirements.
affinity Affinity	(Optional) Describes node affinity scheduling rules for the pod.
securityContext PodSecurityContext	(Optional) Holds pod-level security attributes and common container settings.
storage string	(Optional) Set the Pinot Controller storage; [ default: "20Gi" ]
maxStorage string	(Optional) Sets the max volume storage to scale to.; [ default: 200Gi ]
heapSize string	(Optional) Set the PinotController JVM HeapSize; [ default: "1G" ]

PinotDeepStorageSpec

Appears in:

• PinotSpec

Field	Description	Default	Validation
type string	(Optional) Sets the storage type; [ default: s3; validation: oneof\{s3,gcs\} ]
bucket string	Sets the deep storage bucket; [ validation: empty=false ]
region string	(Optional) Sets the s3 bucket enpoint region; [ default: us-west-2; validation: required if pinot.deepstorage.type=s3; ]
projectID string	(Optional) Sets the GCP Project ID for the bucket; [ validation: required if pinot.deepstorage.type=gcs; ]

PinotMinion

PinotMinion is the schema for the Pinot Minion.

Appears in:

• PinotSpec

Field	Description	Default	Validation
replicas integer	(Optional) Sets the the desired number of replicas; [ default: 1 ]
resources ResourceRequirements	(Optional) ResourceRequirements describes the compute resource requirements.
affinity Affinity	(Optional) Describes node affinity scheduling rules for the pod.
securityContext PodSecurityContext	(Optional) Holds pod-level security attributes and common container settings.
storage string	(Optional) Set the Pinot Minion storage; [ default: "20Gi" ]
maxStorage string	(Optional) Sets the max volume storage to scale to.; [ default: 200Gi ]
heapSize string	(Optional) Set the Pinot Minion JVM HeapSize; [ default: "1G" ]

PinotServer

PinotServer is the schema for the Pinot Server.

Appears in:

• PinotSpec

Field	Description	Default	Validation
replicas integer	(Optional) Sets the the desired number of replicas; [ default: 1 ]
resources ResourceRequirements	(Optional) ResourceRequirements describes the compute resource requirements.
affinity Affinity	(Optional) Describes node affinity scheduling rules for the pod.
securityContext PodSecurityContext	(Optional) Holds pod-level security attributes and common container settings.
storage string	(Optional) Set the Pinot Server storage; [ default: "20Gi" ]
maxStorage string	(Optional) Sets the max volume storage to scale to.; [ default: 200Gi ]
heapSize string	(Optional) Set the Pinot Server JVM HeapSize; [ default: "1G" ]

PinotSpec

PinotSpec defines the desired state of Pinot.

Appears in:

• CogyntSpec

Field	Description	Default	Validation
enabled boolean	(Optional) Enables PinotSpec for deployment; [ default: false ]
clusterName string	(Optional) Set the Pinot clusterName; [ default: "pinot" ]
ingress boolean	(Optional) Set the Pinot ingress; [ default: false ]
eksRoleArn string	(Optional) Sets the AWS EKS Role ARN w/ S3 permissions; [ validation: required if pinot.deepstorage.type=s3 ]
deepStorage PinotDeepStorageSpec	// (Optional) Sets the GCP Service Account w/ GCS permissions; [ validation: required if pinot.deepstorage.type=gcs ] GCPServiceAccount string json:"gcpServiceAccount,omitempty"
controller PinotController
server PinotServer
minion PinotMinion
broker PinotBroker

PostgreSQLSpec

PostgreSQLSpec defines the desired state of PostgreSQL.

Appears in:

• CogyntSpec

Field	Description	Default	Validation
enabled boolean
walBucket string
common PostgresSpec
submissionPortal PostgresSpec
workstation PostgresSpec
eksRoleArn string	(Optional) Sets the AWS EKS Role ARN w/ S3 Bucket permissions; [ validation: Required if cluster.type=eks ]
gcpServiceAccount string	(Optional) Sets the GCP Service Account w/ GCS permissions; [ validation: Required if cluster.type=gke ]

PostgresSpec

PostgresSpec defines the observed state of Postgres.

Appears in:

• PostgreSQLSpec

Field	Description	Default	Validation
replicas integer	(Optional) Sets the desired number of replicas.; [ default: 1 ]
resources ResourceRequirements	(Optional) Sets the compute resource requirements.
storage string	(Optional) Sets the initial volume storage.; [ default: 100Gi ]
maxStorage string	(Optional) Sets the max volume storage to scale to.; [ default: 500Gi ]

QuerierSpec

Appears in:

• LokiSpec
• MimirSpec
• TempoSpec

Field	Description	Default	Validation
replicas integer
resources ResourceRequirements

QueryFrontendSpec

Appears in:

• LokiSpec
• MimirSpec
• TempoSpec

Field	Description	Default	Validation
replicas integer
resources ResourceRequirements

QuerySchedulerSpec

Appears in:

• MimirSpec

Field	Description	Default	Validation
replicas integer
resources ResourceRequirements

RedisSpec

RedisSpec defines the desired state of Redis.

Appears in:

• CogyntSpec

Field	Description	Default	Validation
enabled boolean	(Optional) Enables RedisSpec for deployment; [ default: true ]
workstation RedisWorkstation	(Optional) Sets the desired state for Workstation RedisSpec;

RedisWorkstation

RedisWorkstation defines the observed state of RedisWorkstation.

Appears in:

• RedisSpec

Field	Description	Default	Validation
replicas integer	(Optional) Sets the desired number of replicas.; [ default: 1 ]
resources ResourceRequirements	(Optional) Sets the compute resource requirements.
storage string	(Optional) Sets the initial volume storage.; [ default: 100Gi ]
maxStorage string	(Optional) Sets the max volume storage to scale to.; [ default: 500Gi ]

ReleaseChannel

Underlying type: string

Appears in:

• CogyntSpec

Field	Description
stable
rc
unstable
develop

RulerSpec

Appears in:

• LokiSpec
• MimirSpec

Field	Description	Default	Validation
replicas integer
resources ResourceRequirements

Saml

Appears in:

• AuthOTP
• SubmissionPortalOTP

Field	Description	Default	Validation
spEntityID string
idpID string
spBaseURL string
idpMetadataFile string
idpNameIDFormat string
idpSignRequests string
idpSignMetadata string
idpSignAssertionInResp string
idpSignEnvelopesInResp string
tlspem string
tlskey string

StoragePool

Appears in:

• ClusterSpec

Field	Description	Default	Validation
volumeCount integer	(Optional) Sets the count of volumes attached to each storage node; [ default: 3; validation: gte=2,lte=16 ]
volumeSize integer	(Optional) Sets the size in GB for each volume attached; [ default: 100; validation: gte=50,lte=16384 ]
volumeIOPS integer	(Optional) Sets the IOPS for each volume attached; [ default: 3000; validation: gte=3000,lte=16000 ]
totalMaxCapacity integer	(Optional) Sets the max total size in GB for the cluster storage pool; [ default: 2000 ]
enablePxSaasKey boolean	(Optional) Sets the Portworx Saas Key for the cluster storage; [ default: true ]
gkeClusterAdminUser string	(Optional) Sets the storage GKE cluster admin user service account; [ validation: required if cluster.provider=google ]
enableEncryption boolean	(Optional) Sets the Portworx encryption for the cluster storage; [ default: false ]
encryptionKMSKeyID string	(Optional) Sets the KMS Key ID used to encrypt cluster storage; [ validation: required if enableEncryption=true ]

StoreGatewaySpec

Appears in:

• LokiSpec
• MimirSpec

Field	Description	Default	Validation
replicas integer
resources ResourceRequirements
storage string

SubmissionPortalAuthProvider

Underlying type: string

Appears in:

• SubmissionPortalOTP

Field	Description
none
saml

SubmissionPortalOTP

SubmissionPortalOTP defines the desired state of SubmissionPortalOTP.

Appears in:

• SubmissionPortalSpec

Field	Description	Default	Validation
replicas integer	(Optional) Sets the the desired number of replicas; [ default: 1 ]
resources ResourceRequirements	(Optional) ResourceRequirements describes the compute resource requirements.
affinity Affinity	(Optional) Describes node affinity scheduling rules for the pod.
securityContext PodSecurityContext	(Optional) Holds pod-level security attributes and common container settings.
provider SubmissionPortalAuthProvider
google Google
saml Saml	// Microsoft *Microsoft json:"microsoft,omitempty"
adminWhitelist string array
eksRoleArn string
attachments SubmissionPortalOTPAttachments

SubmissionPortalOTPAttachments

Appears in:

• SubmissionPortalOTP

Field	Description	Default	Validation
storageProvider string	(Optional) Set the storage provider for attachments, [ default: aws ]
bucket string	(Required) Set the bucket and path for attachments. The app appends /attachments to the path and no protocol
maxUploadSize integer	(Optional) Set the max file size for attachments, default: 1073741824

SubmissionPortalSpec

Appears in:

• CogyntSpec

Field	Description	Default	Validation
enabled boolean	(Optional) Enables RedisSpec for deployment; [ default: true ]
otp SubmissionPortalOTP	UseSecureCookie *bool json:"useSecureCookie,omitempty" (Optional) Defines the desired state of submission-portal-otp
ui SubmissionPortalUI	(Optional) Defines the desired state of submission-portal-ui

SubmissionPortalUI

SubmissionPortalUI defines the desired state of SubmissionPortalUI.

Appears in:

• SubmissionPortalSpec

Field	Description	Default	Validation
replicas integer	(Optional) Sets the the desired number of replicas; [ default: 1 ]
resources ResourceRequirements	(Optional) ResourceRequirements describes the compute resource requirements.
affinity Affinity	(Optional) Describes node affinity scheduling rules for the pod.
securityContext PodSecurityContext	(Optional) Holds pod-level security attributes and common container settings.

SupersetServer

SupersetServer is the schema for the Superset Server.

Appears in:

• SupersetSpec

Field	Description	Default	Validation
replicas integer	(Optional) Sets the the desired number of replicas; [ default: 1 ]
resources ResourceRequirements	(Optional) ResourceRequirements describes the compute resource requirements.
affinity Affinity	(Optional) Describes node affinity scheduling rules for the pod.
securityContext PodSecurityContext	(Optional) Holds pod-level security attributes and common container settings.

SupersetSpec

SupersetSpec defines the desired state of Superset.

Appears in:

• CogyntSpec

Field	Description	Default	Validation
enabled boolean	(Optional) Enables SupersetSpec for deployment; [ default: false ]
mapBoxApiKey string	(Optional) Sets the Superset Map Box API key for deployment; [ default: nil ]
server SupersetServer
worker SupersetWorker

SupersetWorker

SupersetWorker is the schema for the Superset Worker.

Appears in:

• SupersetSpec

Field	Description	Default	Validation
replicas integer	(Optional) Sets the the desired number of replicas; [ default: 1 ]
resources ResourceRequirements	(Optional) ResourceRequirements describes the compute resource requirements.
affinity Affinity	(Optional) Describes node affinity scheduling rules for the pod.
securityContext PodSecurityContext	(Optional) Holds pod-level security attributes and common container settings.

TempoSpec

TempoSpec defines the desired state of Tempo.

Appears in:

• O11ySpec

Field	Description	Default	Validation
enabled boolean	(Optional) Enables Tempo for deployment; [ default: true ]
eksRoleArn string	(Optional) Sets the AWS EKS Role ARN w/ S3 permissions; [ validation: required if cluster.type=eks ]
gcpServiceAccount string	(Optional) Sets the GCP Service Account w/ GCS permissions; [ validation: required if cluster.provider=google ]
storage O11yStorageSpec
cache MemCachedSpec
compactor CompactorSpec
distributor DistributorSpec
ingester IngesterSpec
querier QuerierSpec
queryFrontend QueryFrontendSpec

WorkstationIngestOTP

WorkstationIngestOTP defines the desired state of WorkstationIngestOTP.

Appears in:

• WorkstationSpec

Field	Description	Default	Validation
replicas integer	(Optional) Sets the the desired number of replicas; [ default: 1 ]
resources ResourceRequirements	(Optional) ResourceRequirements describes the compute resource requirements.
affinity Affinity	(Optional) Describes node affinity scheduling rules for the pod.
securityContext PodSecurityContext	(Optional) Holds pod-level security attributes and common container settings.
replicaCount integer	(Optional) Sets the number of Opensearch replicas for the Workstation Ingest index; [ default: 2 ]
shardCount integer	(Optional) Sets the shard count of the Workstation Ingest Opensearch index; [ default: 6 ]
opensearchSnapshots WorkstationIngestOTPOpensearchSnapshots	Set the WorkstationIngestSpec opensearch snapshot configs.

WorkstationIngestOTPOpensearchSnapshots

WorkstationIngestOTPOpensearchSnapshots defines the desired state of WorkstationOTPOpensearchSnapshots.

Appears in:

• WorkstationIngestOTP

Field	Description	Default	Validation
storageProvider string	(Optional) Set the storage provider for opensearch snapshots, [ default: aws ]
bucket string	(Required) Set the bucket and path for opensearch snapshots. The app appends /opensearch-snapshots to the path and no protocol

WorkstationOTP

WorkstationOTP defines the desired state of WorkstationOTP.

Appears in:

• WorkstationSpec

Field	Description	Default	Validation
replicas integer	(Optional) Sets the the desired number of replicas; [ default: 1 ]
resources ResourceRequirements	(Optional) ResourceRequirements describes the compute resource requirements.
affinity Affinity	(Optional) Describes node affinity scheduling rules for the pod.
securityContext PodSecurityContext	(Optional) Holds pod-level security attributes and common container settings.
eksRoleArn string	(Optional) Sets the AWS EKS Role ARN w/ Workstation Attachments S3 permissions; [ validation: required if cluster.type=eks ]
gcpServiceAccount string	(Optional) Sets the GCP Service Account w/ Workstation Attachments GCS permissions; [ validation: required if cluster.type=gke ]
attachments WorkstationOTPAttachments	Set the WorkstationSpec attachments configs.
datalake WorkstationOTPDataLake	Set the WorkstationSpec datalake configs.

WorkstationOTPAttachments

WorkstationOTPAttachments defines the desired state of WorkstationOTPAttachments.

Appears in:

• WorkstationOTP

Field	Description	Default	Validation
storageProvider string	(Optional) Set the storage provider for attachments, [ default: aws ]
bucket string	(Required) Set the bucket and path for attachments. The app appends /attachments to the path and no protocol
maxUploadSize integer	(Optional) Set the max file size for attachments, default: 1073741824

WorkstationOTPDataLake

WorkstationOTPDataLake defines the desired state of WorkstationOTPDataLake.

Appears in:

• WorkstationOTP

Field	Description	Default	Validation
storageProvider string	(Optional) Set the storage provider for dataLake, [ default: aws ]
bucket string	(Required) Set the bucket and path for dataLake.

WorkstationSpec

WorkstationSpec defines the desired state of Workstation.

Appears in:

• CogyntSpec

Field	Description	Default	Validation
enableDevTools boolean	(Optional) Enable dev tools for WorkstationSpec; [ default: false ]
enableBetaFeatures boolean	(Optional) Enables beta features in WorkstationSpec, [ default: false ]
otp WorkstationOTP	(Optional) Defines the desired state of ws-otp
ingest WorkstationIngestOTP	(Optional) Defines the desired state of ws-ingest-otp
ui WorkstationUI	(Optional) Defines the desired state of ws-ui

WorkstationUI

WorkstationUI defines the desired state of WorkstationUI.

Appears in:

• WorkstationSpec

Field	Description	Default	Validation
replicas integer	(Optional) Sets the the desired number of replicas; [ default: 1 ]
resources ResourceRequirements	(Optional) ResourceRequirements describes the compute resource requirements.
affinity Affinity	(Optional) Describes node affinity scheduling rules for the pod.
securityContext PodSecurityContext	(Optional) Holds pod-level security attributes and common container settings.

Zookeeper

Zookeeper is the schema for Zookeeper.

Appears in:

• ConfluentSpec

Field	Description	Default	Validation
replicas integer
heapSize string
resources ResourceRequirements
storage string