reference.asciidoc

API Reference

Packages

• saas.3scale.net/v1alpha1

saas.3scale.net/v1alpha1

Package v1alpha1 contains API Schema definitions for the saas v1alpha1 API group

Resource Types

• Apicast

• AutoSSL

• Backend

• CORSProxy

• EchoAPI

• MappingService

• RedisShard

• Sentinel

• ShardedRedisBackup

• System

• TwemproxyConfig

• Zync

APISpec

APISpec is the configuration for main Zync api component

Appears In:

• ZyncSpec

Field	Description
pdb PodDisruptionBudgetSpec	Pod Disruption Budget for the component
hpa HorizontalPodAutoscalerSpec	Horizontal Pod Autoscaler for the component
replicas integer	Number of replicas (ignored if hpa is enabled) for the component
resources ResourceRequirementsSpec	Resource requirements for the component
livenessProbe ProbeSpec	Liveness probe for the component
readinessProbe ProbeSpec	Readiness probe for the component
nodeAffinity NodeAffinity	Describes node affinity scheduling rules for the pod.
tolerations Toleration array	If specified, the pod’s tolerations.
publishingStrategies PublishingStrategies	Describes how the services provided by this workload are exposed to its consumers

AddressSpec

AddressSpec allows the definition of an address

Appears In:

• SearchServerSpec

Field	Description
host string	Defines the address host
port integer	Defines the address port

Apicast

Apicast is the Schema for the apicasts API

Field	Description
apiVersion string	saas.3scale.net/v1alpha1
kind string	Apicast
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec ApicastSpec
status ApicastStatus

ApicastConfig

ApicastConfig configures app behavior for Apicast

Appears In:

• ApicastEnvironmentSpec

Field	Description
configurationCache integer	Apicast configurations cache TTL
threescalePortalEndpoint string	Endpoint to request proxy configurations to
logLevel string	Openresty log level
oidcLogLevel string	OpenID Connect integration log level

ApicastEnvironmentSpec

ApicastEnvironmentSpec is the configuration for an Apicast environment

Appears In:

• ApicastSpec

Field	Description
image ImageSpec	Image specification for the component
pdb PodDisruptionBudgetSpec	Pod Disruption Budget for the component
hpa HorizontalPodAutoscalerSpec	Horizontal Pod Autoscaler for the component
replicas integer	Number of replicas (ignored if hpa is enabled) for the component
resources ResourceRequirementsSpec	Resource requirements for the component
livenessProbe ProbeSpec	Liveness probe for the component
readinessProbe ProbeSpec	Readiness probe for the component
config ApicastConfig	Application specific configuration options for the component
nodeAffinity NodeAffinity	Describes node affinity scheduling rules for the pod.
tolerations Toleration array	If specified, the pod’s tolerations.
canary Canary	Canary defines spec changes for the canary Deployment. If left unset the canary Deployment wil not be created.
publishingStrategies PublishingStrategies	Describes how the services provided by this workload are exposed to its consumers
endpoint Endpoint	The external endpoint/s for the component DEPRECATED
marin3r Marin3rSidecarSpec	Marin3r configures the Marin3r sidecars for the component DEPRECATED
loadBalancer ElasticLoadBalancerSpec	Configures the AWS load balancer for the component DEPRECATED

ApicastSpec

ApicastSpec defines the desired state of Apicast

Appears In:

• Apicast

Field	Description
staging ApicastEnvironmentSpec	Configures the staging Apicast environment
production ApicastEnvironmentSpec	Configures the production Apicast environment
grafanaDashboard GrafanaDashboardSpec	Configures the Grafana Dashboard for the component

AssetsSpec

AssetsSpec has configuration to access assets in AWS s3

Appears In:

• SystemConfig

Field	Description
bucket string	AWS S3 bucket name
region string	AWS S3 region
accessKey SecretReference	AWS access key
secretKey SecretReference	AWS secret access key
host string	Assets host (CDN)
s3Endpoint string	Assets custom S3 endpoint

AutoSSL

AutoSSL is the Schema for the autossls API

Field	Description
apiVersion string	saas.3scale.net/v1alpha1
kind string	AutoSSL
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec AutoSSLSpec
status AutoSSLStatus

AutoSSLConfig

AutoSSLConfig defines configuration options for the component

Appears In:

• AutoSSLSpec

Field	Description
logLevel string	Sets the nginx log level
acmeStaging boolean	Enables/disables the Let’s Encrypt staging ACME endpoint
contactEmail string	Defines an email address for Let’s Encrypt notifications
proxyEndpoint string	The endpoint to proxy_pass requests to
verificationEndpoint string	The endpoint used to validate if certificate generation is allowed for the domain
domainWhitelist string array	List of domains that will bypass domain verification
domainBlacklist string array	List of domains that will never get autogenerated certificates
redisHost string	Host for the redis database to store certificates
redisPort integer	Port for the redis database to store certificates

AutoSSLSpec

AutoSSLSpec defines the desired state of AutoSSL

Appears In:

• AutoSSL

Field	Description
image ImageSpec	Image specification for the component
pdb PodDisruptionBudgetSpec	Pod Disruption Budget for the component
hpa HorizontalPodAutoscalerSpec	Horizontal Pod Autoscaler for the component
replicas integer	Number of replicas (ignored if hpa is enabled) for the component
resources ResourceRequirementsSpec	Resource requirements for the component
livenessProbe ProbeSpec	Liveness probe for the component
readinessProbe ProbeSpec	Readiness probe for the component
grafanaDashboard GrafanaDashboardSpec	Configures the Grafana Dashboard for the component
config AutoSSLConfig	Application specific configuration options for the component
nodeAffinity NodeAffinity	Describes node affinity scheduling rules for the pod.
tolerations Toleration array	If specified, the pod’s tolerations.
canary Canary	Canary defines spec changes for the canary Deployment. If left unset the canary Deployment wil not be created.
publishingStrategies PublishingStrategies	Describes how the services provided by this workload are exposed to its consumers
endpoint Endpoint	The external endpoint/s for the component DEPRECATED
loadBalancer ElasticLoadBalancerSpec	Configures the AWS load balancer for the component DEPRECATED

Backend

Backend is the Schema for the backends API

Field	Description
apiVersion string	saas.3scale.net/v1alpha1
kind string	Backend
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec BackendSpec
status BackendStatus

BackendConfig

BackendConfig configures app behavior for Backend

Appears In:

• BackendSpec

Field	Description
rackEnv string	Rack environment
masterServiceID integer	Master service account ID in Porta
redisStorageDSN string	Redis Storage DSN
redisQueuesDSN string	Redis Queues DSN
externalSecret ExternalSecret	External Secret common configuration
systemEventsHookURL SecretReference	A reference to the secret holding the backend-system-events-hook URL
systemEventsHookPassword SecretReference	A reference to the secret holding the backend-system-events-hook password
internalAPIUser SecretReference	A reference to the secret holding the backend-internal-api user
internalAPIPassword SecretReference	A reference to the secret holding the backend-internal-api password
errorMonitoringService SecretReference	A reference to the secret holding the backend-error-monitoring service
errorMonitoringKey SecretReference	A reference to the secret holding the backend-error-monitoring key

BackendSpec

BackendSpec defines the desired state of Backend

Appears In:

• Backend

Field	Description
image ImageSpec	Image specification for the component
config BackendConfig	Application specific configuration options for the component
grafanaDashboard GrafanaDashboardSpec	Configures the Grafana Dashboard for the component
listener ListenerSpec	Configures the backend listener
worker WorkerSpec	Configures the backend worker
cron CronSpec	Configures the backend cron
twemproxy TwemproxySpec	Configures twemproxy

BugsnagSpec

BugsnagSpec has configuration for Bugsnag integration

Appears In:

• SystemConfig

• ZyncConfig

Field	Description
releaseStage string	Release Stage to identify environment
apiKey SecretReference	API key

CORSProxy

CORSProxy is the Schema for the corsproxies API

Field	Description
apiVersion string	saas.3scale.net/v1alpha1
kind string	CORSProxy
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec CORSProxySpec
status CORSProxyStatus

CORSProxyConfig

CORSProxyConfig defines configuration options for the component

Appears In:

• CORSProxySpec

Field	Description
externalSecret ExternalSecret	External Secret common configuration
systemDatabaseDSN SecretReference	System database connection string

CORSProxySpec

CORSProxySpec defines the desired state of CORSProxy

Appears In:

• CORSProxy

Field	Description
image ImageSpec	Image specification for the component
pdb PodDisruptionBudgetSpec	Pod Disruption Budget for the component
hpa HorizontalPodAutoscalerSpec	Horizontal Pod Autoscaler for the component
replicas integer	Number of replicas (ignored if hpa is enabled) for the component
resources ResourceRequirementsSpec	Resource requirements for the component
livenessProbe ProbeSpec	Liveness probe for the component
readinessProbe ProbeSpec	Readiness probe for the component
grafanaDashboard GrafanaDashboardSpec	Configures the Grafana Dashboard for the component
config CORSProxyConfig	Application specific configuration options for the component
nodeAffinity NodeAffinity	Describes node affinity scheduling rules for the pod.
tolerations Toleration array	If specified, the pod’s tolerations.
publishingStrategies PublishingStrategies	Describes how the services provided by this workload are exposed to its consumers

Canary

Canary allows the definition of a canary Deployment

Appears In:

• ApicastEnvironmentSpec

• AutoSSLSpec

• ListenerSpec

• SystemAppSpec

• SystemSidekiqSpec

• WorkerSpec

Field	Description
sendTraffic boolean	SendTraffic controls if traffic is sent to the canary
imageName string	ImageName to use for the canary Deployment
imageTag string	ImageTag to use for the canary Deployment
replicas integer	Number of replicas for the canary Deployment
patches string array	Patches to apply for the canary Deployment. Patches are expected to be JSON documents as an RFC 6902 patches.

CronSpec

CronSpec is the configuration for Backend Cron

Appears In:

• BackendSpec

Field	Description
replicas integer	Number of replicas for the component
resources ResourceRequirementsSpec	Resource requirements for the component
nodeAffinity NodeAffinity	Describes node affinity scheduling rules for the pod.
tolerations Toleration array	If specified, the pod’s tolerations.

DeploymentStrategySpec

Appears In:

• SystemAppSpec

• SystemSidekiqSpec

Field	Description
type DeploymentStrategyType	Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.
rollingUpdate RollingUpdateDeployment	Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate.

EchoAPI

EchoAPI is the Schema for the echoapis API

Field	Description
apiVersion string	saas.3scale.net/v1alpha1
kind string	EchoAPI
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec EchoAPISpec
status EchoAPIStatus

EchoAPISpec

EchoAPISpec defines the desired state of echoapi

Appears In:

• EchoAPI

Field	Description
image ImageSpec	Image specification for the component
replicas integer	Configures the Grafana Dashboard for the component
hpa HorizontalPodAutoscalerSpec	Resource requirements for the component
pdb PodDisruptionBudgetSpec	Number of replicas (ignored if hpa is enabled) for the component
resources ResourceRequirementsSpec	Horizontal Pod Autoscaler for the component
livenessProbe ProbeSpec	Liveness probe for the component
readinessProbe ProbeSpec	Readiness probe for the component
nodeAffinity NodeAffinity	Describes node affinity scheduling rules for the pod.
tolerations Toleration array	If specified, the pod’s tolerations.
publishingStrategies PublishingStrategies	Describes how the services provided by this workload are exposed to its consumers
endpoint Endpoint	The external endpoint/s for the component DEPRECATED
marin3r Marin3rSidecarSpec	Marin3r configures the Marin3r sidecars for the component DEPRECATED
loadBalancer NetworkLoadBalancerSpec	Configures the AWS load balancer for the component DEPRECATED

ElasticLoadBalancerSpec

ElasticLoadBalancerSpec configures the AWS load balancer for the component

Appears In:

• ApicastEnvironmentSpec

• AutoSSLSpec

• Simple

• WorkloadPublishingStrategyUpgrader

Field	Description
proxyProtocol boolean	Enables/disbles use of proxy protocol in the load balancer
crossZoneLoadBalancingEnabled boolean	Enables/disables cross zone load balancing
connectionDrainingEnabled boolean	Enables/disables connection draining
connectionDrainingTimeout integer	Sets the timeout for connection draining
healthcheckHealthyThreshold integer	Sets the healthy threshold for the load balancer
healthcheckUnhealthyThreshold integer	Sets the unhealthy threshold for the load balancer
healthcheckInterval integer	Sets the interval between health checks
healthcheckTimeout integer	Sets the timeout for the health check

Endpoint

Endpoint sets the external endpoint for the component

Appears In:

• ApicastEnvironmentSpec

• AutoSSLSpec

• EchoAPISpec

• ListenerSpec

• WorkloadPublishingStrategyUpgrader

Field	Description
dns string array	The list of dns records that will point to the component

EnvoyDynamicConfig

Appears In:

• Marin3rSidecarSpec

Field	Description
generatorVersion string	GeneratorVersion specifies the version of a given template. "v1" is the default.
listenerHttp ListenerHttp	ListenerHttp contains options for an HTTP/HTTPS listener
routeConfiguration RouteConfiguration	RouteConfiguration contains options for an Envoy route_configuration protobuffer message
cluster Cluster	Cluster contains options for an Envoy cluster protobuffer message
runtime Runtime	Runtime contains options for an Envoy runtime protobuffer message
rawConfig RawConfig

ExternalSecret

ExternalSecret is a reference to the ExternalSecret common configuration

Appears In:

• BackendConfig

• CORSProxyConfig

• MappingServiceConfig

• SystemConfig

• ZyncConfig

Field	Description
secretStoreRef ExternalSecretSecretStoreReferenceSpec	SecretStoreRef defines which SecretStore to use when fetching the secret data
refreshInterval Duration	RefreshInterval is the amount of time before the values reading again from the SecretStore provider (duration)

ExternalSecretSecretStoreReferenceSpec

ExternalSecretSecretStoreReferenceSpec is a reference to a secret store

Appears In:

• ExternalSecret

Field	Description
name string	The Vault secret store reference name
kind string	The Vault secret store reference kind

GithubSpec

GithubSpec has configuration for Github integration

Appears In:

• SystemConfig

Field	Description
clientID SecretReference	Client ID
clientSecret SecretReference	Client secret

GrafanaDashboardSpec

GrafanaDashboardSpec configures the Grafana Dashboard for the component

Appears In:

• ApicastSpec

• AutoSSLSpec

• BackendSpec

• CORSProxySpec

• MappingServiceSpec

• SentinelSpec

• SystemSpec

• TwemproxyConfigSpec

• ZyncSpec

Field	Description
selectorKey string	Label key used by grafana-operator for dashboard discovery
selectorValue string	Label value used by grafana-operator for dashboard discovery

HorizontalPodAutoscalerSpec

HorizontalPodAutoscalerSpec defines the HPA for the component

Appears In:

• APISpec

• ApicastEnvironmentSpec

• AutoSSLSpec

• CORSProxySpec

• EchoAPISpec

• ListenerSpec

• MappingServiceSpec

• QueSpec

• SystemAppSpec

• SystemSidekiqSpec

• WorkerSpec

Field	Description
minReplicas integer	Lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available.
maxReplicas integer	Upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas.
resourceName string	Target resource used to autoscale (cpu/memory)
resourceUtilization integer	A percentage indicating the target resource consumption used to autoscale
behavior HorizontalPodAutoscalerBehavior	Behavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively). If not set, the default HPAScalingRules for scale up and scale down are used.

ImageSpec

ImageSpec defines the image for the component

Appears In:

• ApicastEnvironmentSpec

• AutoSSLSpec

• BackendSpec

• CORSProxySpec

• EchoAPISpec

• MappingServiceSpec

• RedisShardSpec

• SentinelSpec

• SystemRailsConsoleSpec

• SystemSearchdSpec

• SystemSpec

• SystemTektonTaskConfig

• TwemproxySpec

• ZyncRailsConsoleSpec

• ZyncSpec

Field	Description
name string	Docker repository of the image
tag string	Image tag
pullSecretName string	Name of the Secret that holds quay.io credentials to access the image repository
pullPolicy PullPolicy	Pull policy for the image

ListenerConfig

ListenerConfig configures app behavior for Backend Listener

Appears In:

• ListenerSpec

Field	Description
logFormat string	Listener log format
redisAsync boolean	Enable (true) or disable (false) listener redis async mode
listenerWorkers integer	Number of worker processes per listener pod
legacyReferrerFilters boolean	Enable (true) or disable (false) Legacy Referrer Filters

ListenerSpec

ListenerSpec is the configuration for Backend Listener

Appears In:

• BackendSpec

Field	Description
config ListenerConfig	Listener specific configuration options for the component element
pdb PodDisruptionBudgetSpec	Pod Disruption Budget for the component
hpa HorizontalPodAutoscalerSpec	Horizontal Pod Autoscaler for the component
replicas integer	Number of replicas (ignored if hpa is enabled) for the component
resources ResourceRequirementsSpec	Resource requirements for the component
livenessProbe ProbeSpec	Liveness probe for the component
readinessProbe ProbeSpec	Readiness probe for the component
nodeAffinity NodeAffinity	Describes node affinity scheduling rules for the pod.
tolerations Toleration array	If specified, the pod’s tolerations.
canary Canary	Canary defines spec changes for the canary Deployment. If left unset the canary Deployment wil not be created.
publishingStrategies PublishingStrategies	Describes how the services provided by this workload are exposed to its consumers
endpoint Endpoint	The external endpoint/s for the component DEPRECATED
marin3r Marin3rSidecarSpec	Marin3r configures the Marin3r sidecars for the component DEPRECATED
loadBalancer NetworkLoadBalancerSpec	Configures the AWS load balancer for the component DEPRECATED

MappingService

MappingService is the Schema for the mappingservices API

Field	Description
apiVersion string	saas.3scale.net/v1alpha1
kind string	MappingService
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec MappingServiceSpec
status MappingServiceStatus

MappingServiceConfig

MappingServiceConfig configures app behavior for MappingService

Appears In:

• MappingServiceSpec

Field	Description
apiHost string	System endpoint to fetch proxy configs from
previewBaseDomain string	Base domain to replace the proxy configs base domain
logLevel string	Openresty log level
externalSecret ExternalSecret	External Secret common configuration
systemAdminToken SecretReference	A reference to the secret holding the system admin token

MappingServiceSpec

MappingServiceSpec defines the desired state of MappingService

Appears In:

• MappingService

Field	Description
image ImageSpec	Image specification for the component
pdb PodDisruptionBudgetSpec	Pod Disruption Budget for the component
hpa HorizontalPodAutoscalerSpec	Horizontal Pod Autoscaler for the component
replicas integer	Number of replicas (ignored if hpa is enabled) for the component
resources ResourceRequirementsSpec	Resource requirements for the component
livenessProbe ProbeSpec	Liveness probe for the component
readinessProbe ProbeSpec	Readiness probe for the component
grafanaDashboard GrafanaDashboardSpec	Configures the Grafana Dashboard for the component
config MappingServiceConfig	Application specific configuration options for the component
nodeAffinity NodeAffinity	Describes node affinity scheduling rules for the pod.
tolerations Toleration array	If specified, the pod’s tolerations.
publishingStrategies PublishingStrategies	Describes how the services provided by this workload are exposed to its consumers

Marin3rSidecarSpec

Marin3rSidecarSpec defines the marin3r sidecar for the component

Appears In:

• ApicastEnvironmentSpec

• EchoAPISpec

• ListenerSpec

• PublishingStrategy

• WorkloadPublishingStrategyUpgrader

Field	Description
Simple Simple
nodeID string	The NodeID that identifies the Envoy sidecar to the DiscoveryService
envoyAPIVersion string	The Envoy API version to use
envoyImage string	The Envoy iamge to use
ports SidecarPort array	The ports that the sidecar exposes
resources ResourceRequirementsSpec	Compute Resources required by the sidecar container.
shtdnmgrPort integer	The port where Marin3r’s shutdown manager listens
shtdnmgrExtraLifecycleHooks string array	Extra containers to sync with the shutdown manager upon pod termination
extraPodAnnotations object (keys:string, values:string)	Extra annotations to pass the Pod to further configure the sidecar container.
dynamicConfigs object (keys:string, values:EnvoyDynamicConfig)	Envoy dynamic configuration. Populating this field causes the operator to create a Marin3r EnvoyConfig resource, so Marin3r must be installed in the cluster.

MonitoredShard

MonitoredShard contains information of one of the shards monitored by the Sentinel resource

Appears In:

• SentinelStatus

Field	Description
name string	Name is the name of the redis shard
servers object (keys:string, values:RedisServerDetails)	Server is a map intended to store configuration information of each of the RedisServer instances that belong to the MonitoredShard

NetworkLoadBalancerSpec

NetworkLoadBalancerSpec configures the AWS NLB load balancer for the component

Appears In:

• EchoAPISpec

• ListenerSpec

• Simple

• WorkloadPublishingStrategyUpgrader

Field	Description
proxyProtocol boolean	Enables/disbles use of proxy protocol in the load balancer
crossZoneLoadBalancingEnabled boolean	Enables/disables cross zone load balancing
eipAllocations string array	The list of optional Elastic IPs allocations
loadBalancerName string	Optionally specify the load balancer name
deletionProtection boolean	Deletion protection setting

PodDisruptionBudgetSpec

PodDisruptionBudgetSpec defines the PDB for the component

Appears In:

• APISpec

• ApicastEnvironmentSpec

• AutoSSLSpec

• CORSProxySpec

• EchoAPISpec

• ListenerSpec

• MappingServiceSpec

• QueSpec

• SentinelSpec

• SystemAppSpec

• SystemSidekiqSpec

• WorkerSpec

Field	Description
minAvailable IntOrString	An eviction is allowed if at least "minAvailable" pods selected by "selector" will still be available after the eviction, i.e. even in the absence of the evicted pod. So for example you can prevent all voluntary evictions by specifying "100%".
maxUnavailable IntOrString	An eviction is allowed if at most "maxUnavailable" pods selected by "selector" are unavailable after the eviction, i.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions by specifying 0. This is a mutually exclusive setting with "minAvailable".

ProbeSpec

ProbeSpec specifies configuration for a probe

Appears In:

• APISpec

• ApicastEnvironmentSpec

• AutoSSLSpec

• CORSProxySpec

• EchoAPISpec

• ListenerSpec

• MappingServiceSpec

• QueSpec

• SentinelSpec

• SystemAppSpec

• SystemSearchdSpec

• SystemSidekiqSpec

• TwemproxySpec

• WorkerSpec

Field	Description
initialDelaySeconds integer	Number of seconds after the container has started before liveness probes are initiated
timeoutSeconds integer	Number of seconds after which the probe times out
periodSeconds integer	How often (in seconds) to perform the probe
successThreshold integer	Minimum consecutive successes for the probe to be considered successful after having failed
failureThreshold integer	Minimum consecutive failures for the probe to be considered failed after having succeeded

PublishingStrategies

Appears In:

• APISpec

• ApicastEnvironmentSpec

• AutoSSLSpec

• CORSProxySpec

• EchoAPISpec

• ListenerSpec

• MappingServiceSpec

• SystemAppSpec

Field	Description
mode PublishingStrategiesReconcileMode	PublishingStrategiesReconcileMode specifies if the list of strategies should be merged with the defautls or replace them entirely. Allowed values are "Merge" or "Replace". "Replace" strategy should be used to enable 2 strategies at the same time for a single endpoint.
endpoints PublishingStrategy array	Endpoints holds the list of publishing strategies for each workload endpoint.

PublishingStrategiesReconcileMode (string)

Appears In:

• PublishingStrategies

PublishingStrategy

Appears In:

• PublishingStrategies

Field	Description
strategy Strategy	Strategy defines the type of publishing strategy
name string	EndpointName defines the endpoint affected by this publishing strategy
simple Simple	Simple holds configuration for the Simple publishing strategy
marin3rSidecar Marin3rSidecarSpec	Marin3rSidecar holds configuration for the Marin3rSidecar publishing strategy
create boolean	Create explicitely tells the controller that this is a new endpoint that should be added. Default is false, causing the controller to error when seeing an unknown endpoint.

QueSpec

QueSpec is the configuration for Zync que

Appears In:

• ZyncSpec

Field	Description
pdb PodDisruptionBudgetSpec	Pod Disruption Budget for the component
hpa HorizontalPodAutoscalerSpec	Horizontal Pod Autoscaler for the component
replicas integer	Number of replicas (ignored if hpa is enabled) for the component
resources ResourceRequirementsSpec	Resource requirements for the component
livenessProbe ProbeSpec	Liveness probe for the component
readinessProbe ProbeSpec	Readiness probe for the component
nodeAffinity NodeAffinity	Describes node affinity scheduling rules for the pod.
tolerations Toleration array	If specified, the pod’s tolerations.

RateLimitOptions

RateLimitOptions contains options for the ratelimit filter of the http connection manager

Appears In:

• ListenerHttp

Field	Description
domain string	The rate limit domain
failureModeDeny boolean	Whether to allow requests or not if the rate limit service is unavailable
timeout Duration	Max time to wait for a response from the rate limit service
rateLimitCluster string	Location of the rate limit service. Must point to one of the defined clusters.

RedHatCustomerPortalSpec

RedHatCustomerPortalSpec has configuration for integration with Red Hat Customer Portal

Appears In:

• SystemConfig

Field	Description
clientID SecretReference	Client ID
clientSecret SecretReference	Client secret
realm string	Realm

RedisServerDetails

Appears In:

• MonitoredShard

Field	Description
role Role
address string
config object (keys:string, values:string)
info object (keys:string, values:string)

RedisShard

RedisShard is the Schema for the redisshards API

Field	Description
apiVersion string	saas.3scale.net/v1alpha1
kind string	RedisShard
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec RedisShardSpec
status RedisShardStatus

RedisShardNodes

Appears In:

• RedisShardStatus

Field	Description
master object (keys:string, values:string)	Master is the node that acts as master role in the redis shard
slaves object (keys:string, values:string)	Slaves are the nodes that act as master role in the redis shard

RedisShardSpec

RedisShardSpec defines the desired state of RedisShard

Appears In:

• RedisShard

Field	Description
image ImageSpec	Image specification for the component
masterIndex integer	MasterIndex is the StatefulSet Pod index of the redis server with the master role. The other Pods are slaves of the master one.
slaveCount integer	SlaveCount is the number of redis slaves
command string	Command overrides the redis container command

RedisShardStatus

RedisShardStatus defines the observed state of RedisShard

Appears In:

• RedisShard

Field	Description
shardNodes RedisShardNodes	ShardNodes describes the nodes in the redis shard

RedisSpec

RedisSpec holds redis configuration

Appears In:

• SystemConfig

Field	Description
queuesDSN string	Data source name

ResourceRequirementsSpec

ResourceRequirementsSpec defines the resource requirements for the component

Appears In:

• APISpec

• ApicastEnvironmentSpec

• AutoSSLSpec

• CORSProxySpec

• CronSpec

• EchoAPISpec

• ListenerSpec

• MappingServiceSpec

• Marin3rSidecarSpec

• QueSpec

• SentinelSpec

• SystemAppSpec

• SystemRailsConsoleSpec

• SystemSearchdSpec

• SystemSidekiqSpec

• SystemTektonTaskSpec

• TwemproxySpec

• WorkerSpec

• ZyncRailsConsoleSpec

Field	Description
claims ResourceClaim array	Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable.

S3Options

Appears In:

• ShardedRedisBackupSpec

Field	Description
bucket string	S3 bucket name
path string	S3 path where backups should be uploaded
region string	AWS region
credentialsSecretRef LocalObjectReference	Reference to a Secret tha contains credentials to access S3 API. The credentials must have the following permissions: s3:GetObject, s3:PutObject, and s3:ListBucket, s3:ListObjects, s3:PutObjectTagging.
serviceEndpoint string	Optionally use a custom s3 service endpoint. Useful for testing with Minio.

SMTPSpec

SMTPSpec has options to configure system’s SMTP

Appears In:

• SystemConfig

Field	Description
address string	Address
user SecretReference	User
password SecretReference	Password
port integer	Port
authProtocol string	Authentication protocol
opensslVerifyMode string	OpenSSL verify mode
starttls boolean	Enable/disable STARTTLS
starttlsAuto boolean	Enable/disable auto STARTTLS

SSHOptions

Appears In:

• ShardedRedisBackupSpec

Field	Description
user string	SSH user
privateKeySecretRef LocalObjectReference	Reference to a Secret that contains the SSH private key
port integer	SSH port (default is 22)
sudo boolean	Use sudo to execute commands agains the remote host

SearchServerSpec

Appears In:

• SystemConfig

Field	Description
AddressSpec AddressSpec
batchSize integer	Defines the batch size

SearchdConfig

SearchdConfig has configuration options for System’s searchd

Appears In:

• SystemSearchdSpec

Field	Description
serviceName string	Allows setting the service name for Searchd
port integer	The TCP port Searchd will run its daemon on
databasePath string	Searchd database path
databaseStorageSize Quantity	Searchd database storage size
databaseStorageClass string	Searchd database storage type

SecretReference

SecretReference is a reference to a secret stored in some secrets engine

Appears In:

• AssetsSpec

• BackendConfig

• BugsnagSpec

• CORSProxyConfig

• GithubSpec

• MappingServiceConfig

• RedHatCustomerPortalSpec

• SMTPSpec

• SegmentSpec

• SystemBackendSpec

• SystemConfig

• SystemRecaptchaSpec

• SystemZyncSpec

• ZyncConfig

Field	Description
fromVault VaultSecretReference	FromVault is a reference to a secret key/value stored in a Hashicorp Vault
override string	Override allows to directly specify a string value.
fromSeed SeedSecretReference	FromSeed will try to retrieve the secret value from the default seed Secret.

SeedSecretReference

SeedSecretReference represents options to retrieve the secret value from the default seed Secret. There are no configurable options at this point.

Appears In:

• SecretReference

SegmentSpec

SegmentSpec has configuration for Segment integration

Appears In:

• SystemConfig

Field	Description
deletionWorkspace string	Deletion workspace
deletionToken SecretReference	Deletion token
writeKey SecretReference	Write key

Sentinel

Sentinel is the Schema for the sentinels API

Field	Description
apiVersion string	saas.3scale.net/v1alpha1
kind string	Sentinel
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec SentinelSpec
status SentinelStatus

SentinelConfig

SentinelConfig defines configuration options for the component

Appears In:

• SentinelSpec

Field	Description
monitoredShards object (keys:string, values:string array)	Monitored shards indicates the redis servers that form part of each shard monitored by sentinel
clusterTopology object (keys:string, values:object)	ClusterTopology indicates the redis servers that form part of each shard monitored by sentinel
storageClass string	StorageClass is the storage class to be used for the persistent sentinel config file where the shards state is stored
storageSize Quantity	StorageSize is the storage size to provision for the persistent sentinel config file where the shards state is stored
metricsRefreshInterval Duration	MetricsRefreshInterval determines the refresh interval for gahtering metrics from sentinel

SentinelSpec

SentinelSpec defines the desired state of Sentinel

Appears In:

• Sentinel

Field	Description
image ImageSpec	Image specification for the component
replicas integer	Number of replicas (ignored if hpa is enabled) for the component
pdb PodDisruptionBudgetSpec	Pod Disruption Budget for the component
resources ResourceRequirementsSpec	Resource requirements for the component
livenessProbe ProbeSpec	Liveness probe for the component
readinessProbe ProbeSpec	Readiness probe for the component
grafanaDashboard GrafanaDashboardSpec	Configures the Grafana Dashboard for the component
nodeAffinity NodeAffinity	Describes node affinity scheduling rules for the pod.
tolerations Toleration array	If specified, the pod’s tolerations.
config SentinelConfig	Config configures the sentinel process

SentinelStatus

SentinelStatus defines the observed state of Sentinel

Appears In:

• Sentinel

Field	Description
sentinels string array	Addresses of the sentinel instances currently running
monitoredShards MonitoredShard array	MonitoredShards is the list of shards that the Sentinel resource is currently monitoring

ServiceType (string)

Appears In:

• Simple

• WorkloadPublishingStrategyUpgrader

ShardedRedisBackup

ShardedRedisBackup is the Schema for the shardedredisbackups API

Field	Description
apiVersion string	saas.3scale.net/v1alpha1
kind string	ShardedRedisBackup
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec ShardedRedisBackupSpec
status ShardedRedisBackupStatus

ShardedRedisBackupSpec

ShardedRedisBackupSpec defines the desired state of ShardedRedisBackup

Appears In:

• ShardedRedisBackup

Field	Description
sentinelRef string	Reference to a sentinel instance
schedule string	Cron-like schedule specification
dbFile string	Name of the dbfile in the redis instances
sshOptions SSHOptions	SSH connection options
s3Options S3Options	S3 storage options
timeout Duration	Max allowed time for a backup to complete
historyLimit integer	Max number of backup history to keep
pollInterval Duration	How frequently redis is polled for the BGSave status
pause boolean	If true, backup execution is stopped

ShardedRedisBackupStatus

ShardedRedisBackupStatus defines the observed state of ShardedRedisBackup

Appears In:

• ShardedRedisBackup

ShardedRedisTopology

Appears In:

• TwemproxyServerPool

Field	Description
shardName string	The name of the locigal shard
physicalShard string	The physical shard where the logical one is stored. This name should match the shard names monitored by Sentinel.

SidecarPort

SidecarPort defines port for the Marin3r sidecar container

Appears In:

• Marin3rSidecarSpec

Field	Description
name string	Port name
port integer	Port value

SidekiqConfig

SidekiqConfig configures app behavior for System Sidekiq

Appears In:

• SystemSidekiqSpec

Field	Description
queues string array	List of queues to be consumed by sidekiq. Format: queue[,Priority]
maxThreads integer	Number of rails max threads per sidekiq pod

Simple

Appears In:

• Marin3rSidecarSpec

• PublishingStrategy

Field	Description
serviceType ServiceType	ServiceType defines the type of k8s Service to use for exposing the service to its consumers
externalDnsHostnames string array	ExternalDnsHostnames defines the hostnames that ExternalDNS should configure records for external consumners to reach the service Only works with Services of type NLB/ELB
serviceName string	ServiceNameOverride allows the user to override the generated Service name
servicePorts ServicePort array	ServicePortsOverride allows the user to override the ports of a Service. It’s a replace operation, so specify all the required ports.
elasticLoadBalancerConfig ElasticLoadBalancerSpec	Classic LB configuration
networkLoadBalancerConfig NetworkLoadBalancerSpec	NLB configuration

Strategy (string)

Appears In:

• PublishingStrategy

System

System is the Schema for the systems API

Field	Description
apiVersion string	saas.3scale.net/v1alpha1
kind string	System
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec SystemSpec
status SystemStatus

SystemApicastEndpointsSpec

ApicastSpec holds properties to configure Apicast endpoints

Appears In:

• SystemConfig

Field	Description
stagingDomain string	Apicast Staging endpoint
productionDomain string	Apicast Production endpoint
cloudHostedRegistryURL string	Policies registry URL for Apicast Cloud Hosteed
selfManagedRegistryURL string	Policies registry URL for Apicast Self Managed (on-prem)

SystemAppSpec

SystemAppSpec configures the App component of System

Appears In:

• SystemSpec

Field	Description
deploymentStrategy DeploymentStrategySpec	The deployment strategy to use to replace existing pods with new ones.
pdb PodDisruptionBudgetSpec	Pod Disruption Budget for the component
hpa HorizontalPodAutoscalerSpec	Horizontal Pod Autoscaler for the component
replicas integer	Number of replicas (ignored if hpa is enabled) for the component
resources ResourceRequirementsSpec	Resource requirements for the component
livenessProbe ProbeSpec	Liveness probe for the component
readinessProbe ProbeSpec	Readiness probe for the component
nodeAffinity NodeAffinity	Describes node affinity scheduling rules for the pod.
tolerations Toleration array	If specified, the pod’s tolerations.
terminationGracePeriodSeconds integer	Configures the TerminationGracePeriodSeconds
canary Canary	Canary defines spec changes for the canary Deployment. If left unset the canary Deployment wil not be created.
publishingStrategies PublishingStrategies	Describes how the services provided by this workload are exposed to its consumers

SystemBackendSpec

SystemBackendSpec has configuration options for backend

Appears In:

• SystemConfig

Field	Description
externalEndpoint string	External endpoint
internalEndpoint string	Internal endpoint
internalAPIUser SecretReference	Internal API user
internalAPIPassword SecretReference	Internal API password
redisDSN string	Redis data source name

SystemConfig

SystemConfig holds configuration for SystemApp component

Appears In:

• SystemSpec

Field	Description
rails SystemRailsSpec	Rails configuration options for system components
sandboxProxyOpensslVerifyMode string	OpenSSL verification mode for sandbox proxy
forceSSL boolean	Enable (true) or disable (false) enforcing SSL
sslCertsDir string	SSL certificates path
searchServer SearchServerSpec	Search service options
threescaleProviderPlan string	3scale provider plan
threescaleSuperdomain string	3scale superdomain
configFilesSecret string	Secret containging system configuration files to be mounted in the pods
externalSecret ExternalSecret	External Secret common configuration
databaseDSN SecretReference	DSN of system’s main database
eventsSharedSecret SecretReference	EventsSharedSecret is a password that protects System’s event hooks endpoint.
recaptcha SystemRecaptchaSpec	Holds recaptcha configuration options
secretKeyBase SecretReference	SecretKeyBase: https://api.rubyonrails.org/classes/Rails/Application.html#method-i-secret_key_base You can generate one random key using 'bundle exec rake secret'
accessCode SecretReference	AccessCode to protect admin urls
segment SegmentSpec	Options for Segment integration
github GithubSpec	Options for Github integration
redhatCustomerPortal RedHatCustomerPortalSpec	Options for configuring RH Customer Portal integration
bugsnag BugsnagSpec	Options for configuring Bugsnag integration
databaseSecret SecretReference	DatabaseSecret is a site key stored off-database for improved more secure password hashing See https://github.com/3scale/porta/blob/ae498814cef3d856613f60d29330882fa870271d/config/initializers/site_keys.rb#L2-L19
memcachedServers string	Memcached servers
redis RedisSpec	Redis configuration options
smtp SMTPSpec	SMTP configuration options
mappingServiceAccessToken SecretReference	Mapping Service access token
zync SystemZyncSpec	Zync has configuration options for system to contact zync
backend SystemBackendSpec	Backend has configuration options for system to contact backend
assets AssetsSpec	Assets has configuration to access assets in AWS s3
apicast SystemApicastEndpointsSpec	Apicast can be used to pass down apicast endpoints configuration

SystemRailsConsoleSpec

SystemRailsConsoleSpec configures the App component of System

Appears In:

• SystemSpec

Field	Description
image ImageSpec	Image specification for the Console component. Defaults to system image if not defined.
resources ResourceRequirementsSpec	Resource requirements for the component
nodeAffinity NodeAffinity	Describes node affinity scheduling rules for the pod.
tolerations Toleration array	If specified, the pod’s tolerations.

SystemRailsSpec

SystemRailsSpec configures rails for system components

Appears In:

• SystemConfig

Field	Description
console boolean	Rails Console
environment string	Rails environment
logLevel string	Rails log level (debug, info, warn, error, fatal or unknown)

SystemRecaptchaSpec

SystemRecaptchaSpec holds recaptcha configurations

Appears In:

• SystemConfig

Field	Description
publicKey SecretReference	Public key
privateKey SecretReference	Private key

SystemSearchdSpec

SystemSearchdSpec configures the App component of System

Appears In:

• SystemSpec

Field	Description
enabled boolean	Deploy searchd instance
image ImageSpec	Image specification for the Searchd component. Defaults to system image if not defined.
config SearchdConfig	Configuration options for System’s Searchd
resources ResourceRequirementsSpec	Resource requirements for the Searchd component
livenessProbe ProbeSpec	Liveness probe for the Searchd component
readinessProbe ProbeSpec	Readiness probe for the Searchd component
nodeAffinity NodeAffinity	Describes node affinity scheduling rules for the Searchd pod
tolerations Toleration array	If specified, the Searchd pod’s tolerations.
terminationGracePeriodSeconds integer	Configures the TerminationGracePeriodSeconds for Searchd

SystemSidekiqSpec

SystemSidekiqSpec configures the Sidekiq component of System

Appears In:

• SystemSpec

Field	Description
deploymentStrategy DeploymentStrategySpec	The deployment strategy to use to replace existing pods with new ones.
config SidekiqConfig	Sidekiq specific configuration options for the component element
pdb PodDisruptionBudgetSpec	Pod Disruption Budget for the component
hpa HorizontalPodAutoscalerSpec	Horizontal Pod Autoscaler for the component
replicas integer	Number of replicas (ignored if hpa is enabled) for the component
resources ResourceRequirementsSpec	Resource requirements for the component
livenessProbe ProbeSpec	Liveness probe for the component
readinessProbe ProbeSpec	Readiness probe for the component
nodeAffinity NodeAffinity	Describes node affinity scheduling rules for the pod.
tolerations Toleration array	If specified, the pod’s tolerations.
canary Canary	Canary defines spec changes for the canary Deployment. If left unset the canary Deployment wil not be created.
terminationGracePeriodSeconds integer	Configures the TerminationGracePeriodSeconds

SystemSpec

SystemSpec defines the desired state of System

Appears In:

• System

Field	Description
config SystemConfig	Application specific configuration options for System components
image ImageSpec	Image specification for the component
app SystemAppSpec	Application specific configuration options
sidekiqDefault SystemSidekiqSpec	Sidekiq Default specific configuration options
sidekiqBilling SystemSidekiqSpec	Sidekiq Billing specific configuration options
sidekiqLow SystemSidekiqSpec	Sidekiq Low specific configuration options
searchd SystemSearchdSpec	Searchd specific configuration options
console SystemRailsConsoleSpec	Console specific configuration options
tasks SystemTektonTaskSpec array	Configures the Tekton Tasks for the component
grafanaDashboard GrafanaDashboardSpec	Configures the Grafana Dashboard for the component
twemproxy TwemproxySpec	Configures twemproxy

SystemTektonTaskConfig

SystemTektonTaskConfig configures app behavior for System SystemTektonTask

Appears In:

• SystemTektonTaskSpec

Field	Description
image ImageSpec	Image specification for the Console component. Defaults to system image if not defined.
command string array	List of commands to be consumed by the task.
args string array	List of args to be consumed by the task.
extraEnv EnvVar array	List of extra evironment variables to be consumed by the task.
timeout Duration	Timeout for the Tekton task

SystemTektonTaskSpec

SystemTektonTaskSpec configures the Sidekiq component of System

Appears In:

• SystemSpec

Field	Description
enabled boolean	Deploy task instance
name string	Name for the Tekton task and pipeline
description string	Description for the Tekton task and pipeline
config SystemTektonTaskConfig	System Tekton Task specific configuration options for the component element
resources ResourceRequirementsSpec	Pod Disruption Budget for the component
nodeAffinity NodeAffinity	Describes node affinity scheduling rules for the pod.
tolerations Toleration array	If specified, the pod’s tolerations.
terminationGracePeriodSeconds integer	Configures the TerminationGracePeriodSeconds

SystemZyncSpec

SystemZyncSpec has configuration options for zync

Appears In:

• SystemConfig

Field	Description
authToken SecretReference	Zync authentication token
endpoint string	Zync endpoint

TargetRedisServers (string)

Appears In:

• TwemproxyServerPool

TargetServer

Defines a server targeted by one of the TwemproxyConfig server pools

Appears In:

• TwemproxyConfigStatus

Field	Description
serverAlias string
serverAddress string

TwemproxyConfig

TwemproxyConfig is the Schema for the twemproxyconfigs API

Field	Description
apiVersion string	saas.3scale.net/v1alpha1
kind string	TwemproxyConfig
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec TwemproxyConfigSpec
status TwemproxyConfigStatus

TwemproxyConfigSpec

TwemproxyConfigSpec defines the desired state of TwemproxyConfig

Appears In:

• TwemproxyConfig

Field	Description
sentinelURIs string array	SentinelURI is the redis URI of sentinel. If not set, the controller will try to autodiscover Sentinel within the namespace. TODO: remove, unused
serverPools TwemproxyServerPool array	ServerPools is the list of Twemproxy server pools WARNING: only 1 pool is supported at this time
reconcileServerPools boolean	ReconcileServerPools is a flag that allows to deactivate the reconcile of the contents of the managed ConfigMap. This is useful in an emergency, to fix something manually. The re-sync logic will still work whenever the contents of the ConfigMap are changed, even if they are manually changed. This switch defaults to "true".
grafanaDashboard GrafanaDashboardSpec	Configures the Grafana Dashboard for the component

TwemproxyConfigStatus

TwemproxyConfigStatus defines the observed state of TwemproxyConfig

Appears In:

• TwemproxyConfig

Field	Description
targets object (keys:string, values:TargetServer)	The list of serves currently targeted by this TwemproxyConfig

TwemproxyOptions

Appears In:

• TwemproxySpec

Field	Description
logLevel integer	Set logging level to N. (default: 5, min: 0, max: 11)
metricsAddress integer	Set stats monitoring port to port. (default: 22222)
statsInterval Duration	Set stats aggregation interval in msec to interval. (default: 30s)

TwemproxyServerPool

Appears In:

• TwemproxyConfigSpec

Field	Description
name string	The name of the server pool
topology ShardedRedisTopology array	The topology of the servers within the server pool. This field describes the association of logical shards to physical shards.
bindAddress string	The address to bind to. Format is ip:port
timeout integer	Timeout to stablish connection with the servers in the server pool
tcpBacklog integer	Max number of pending connections in the queue
preConnect boolean	Connect to all servers in the pool during startup
target TargetRedisServers	Target defines which are the servers that will be configured as backend redis servers for the Twemproxy configuration. The default is to target masters, but read-write slaves can be configured through this option. If read-write slaves are configured but there are none available, the config will fall back to masters. The masters never fall back to slaves though and will just wait for sentinel triggered failovers to solve the unavailability.

TwemproxySpec

TwemproxySpec configures twemproxy sidecars to access a sharded redis

Appears In:

• BackendSpec

• SystemSpec

Field	Description
image ImageSpec	Image specification for the component
resources ResourceRequirementsSpec	Resource requirements for the component
livenessProbe ProbeSpec	Liveness probe for the component
readinessProbe ProbeSpec	Readiness probe for the component
twemproxyConfigRef string	TwemproxyConfigRef is a reference to a TwemproxyConfig resource in the same Namespace
options TwemproxyOptions	Options

VaultSecretReference

VaultSecretReference is a reference to a secret stored in a Hashicorp Vault

Appears In:

• SecretReference

Field	Description
path string	The Vault path where the secret is located
key string	The Vault key of the secret

WorkerConfig

WorkerConfig configures app behavior for Backend Worker

Appears In:

• WorkerSpec

Field	Description
logFormat string	Worker log format
redisAsync boolean	Enable (true) or disable (false) worker redis async mode

WorkerSpec

WorkerSpec is the configuration for Backend Worker

Appears In:

• BackendSpec

Field	Description
config WorkerConfig	Listener specific configuration options for the component element
pdb PodDisruptionBudgetSpec	Pod Disruption Budget for the component
hpa HorizontalPodAutoscalerSpec	Horizontal Pod Autoscaler for the component
replicas integer	Number of replicas (ignored if hpa is enabled) for the component
resources ResourceRequirementsSpec	Resource requirements for the component
livenessProbe ProbeSpec	Liveness probe for the component
readinessProbe ProbeSpec	Readiness probe for the component
nodeAffinity NodeAffinity	Describes node affinity scheduling rules for the pod.
tolerations Toleration array	If specified, the pod’s tolerations.
canary Canary	Canary defines spec changes for the canary Deployment. If left unset the canary Deployment wil not be created.

Zync

Zync is the Schema for the zyncs API

Field	Description
apiVersion string	saas.3scale.net/v1alpha1
kind string	Zync
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec ZyncSpec
status ZyncStatus

ZyncConfig

ZyncConfig configures app behavior for Zync

Appears In:

• ZyncSpec

Field	Description
rails ZyncRailsSpec	Rails configuration options for zync components
externalSecret ExternalSecret	External Secret common configuration
databaseDSN SecretReference	A reference to the secret holding the database DSN
secretKeyBase SecretReference	A reference to the secret holding the secret-key-base
zyncAuthToken SecretReference	A reference to the secret holding the zync authentication token
bugsnag BugsnagSpec	Options for configuring Bugsnag integration

ZyncRailsConsoleSpec

ZyncRailsConsoleSpec configures the Console component of Zync

Appears In:

• ZyncSpec

Field	Description
enabled boolean	Enables or disables the Zync Console statefulset
image ImageSpec	Defaults to zync image if not defined.
resources ResourceRequirementsSpec	Resource requirements for the component
nodeAffinity NodeAffinity	Describes node affinity scheduling rules for the pod.
tolerations Toleration array	If specified, the pod’s tolerations.

ZyncRailsSpec

ZyncRailsSpec configures rails for system components

Appears In:

• ZyncConfig

Field	Description
environment string	Rails environment
logLevel string	Rails log level (debug, info, warn, error, fatal or unknown)
maxThreads integer	Rails max threads (only applies to api)

ZyncSpec

ZyncSpec defines the desired state of Zync

Appears In:

• Zync

Field	Description
image ImageSpec	Image specification for the component
config ZyncConfig	Application specific configuration options for the component
grafanaDashboard GrafanaDashboardSpec	Configures the Grafana Dashboard for the component
api APISpec	Configures the main zync api component
que QueSpec	Configures the zync que component
console ZyncRailsConsoleSpec	Console specific configuration options