API Reference

Packages

• stack.formance.com/v1beta3

stack.formance.com/v1beta3

Package v1beta3 contains API Schema definitions for the stack v1beta3 API group

Resource Types

• Configuration
• Migration
• Stack
• Versions

AnnotationsServicesSpec

Appears in:

• AuthSpec
• ControlSpec
• GatewaySpec
• LedgerSpec
• OrchestrationSpec
• PaymentsSpec
• ReconciliationSpec
• SearchSpec
• StargateSpec
• WalletsSpec
• WebhooksSpec

Field	Description
service object (keys:string, values:string)

AuthConfig

Appears in:

• ConfigurationSpec

Field	Description
readKeySetMaxRetries integer
checkScopes boolean

AuthSpec

Appears in:

• ConfigurationServicesSpec

Field	Description
postgres PostgresConfig
staticClients StaticClient array
debug boolean
dev boolean
resourceProperties ResourceProperties
annotations AnnotationsServicesSpec

Batching

Appears in:

• SearchSpec

Field	Description
count integer
period string

Broker

Appears in:

• CollectorConfig
• ConfigurationSpec

Field	Description
kafka KafkaConfig
nats NatsConfig

ClientConfiguration

Appears in:

• StaticClient

Field	Description
public boolean
description string
redirectUris string array
postLogoutRedirectUris string array
scopes string array

CommonServiceProperties

Appears in:

• ControlSpec
• LedgerSpec
• OrchestrationSpec
• PaymentsSpec
• ReconciliationSpec
• SearchSpec
• WalletsSpec
• WebhooksSpec

Field	Description
debug boolean
dev boolean
disabled boolean

Condition

Appears in:

• Conditions

Field	Description
type string	type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
observedGeneration integer	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
lastTransitionTime Time	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
message string	message is a human readable message indicating details about the transition. This may be an empty string.

Conditions

Underlying type: Condition

Appears in:

• StackStatus
• Status

Field	Description
type string	type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
observedGeneration integer	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
lastTransitionTime Time	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
message string	message is a human readable message indicating details about the transition. This may be an empty string.

Configuration

Configuration is the Schema for the configurations API

Field	Description
apiVersion string	stack.formance.com/v1beta3
kind string	Configuration
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec ConfigurationSpec

ConfigurationServicesSpec

ConfigurationServicesSpec define all existing services for a stack. Fields order is important. For example, auth must be defined later as other services create static auth clients which must be used by auth.

Appears in:

• ConfigurationSpec

Field	Description
control ControlSpec
ledger LedgerSpec
payments PaymentsSpec
reconciliation ReconciliationSpec
webhooks WebhooksSpec
wallets WalletsSpec
orchestration OrchestrationSpec
search SearchSpec
auth AuthSpec
gateway GatewaySpec
stargate StargateSpec

ConfigurationSpec

Appears in:

• Configuration

Field	Description
services ConfigurationServicesSpec
broker Broker
monitoring MonitoringSpec
auth AuthConfig
ingress IngressGlobalConfig
temporal TemporalConfig
light boolean	LightMode is experimental and indicate we want monopods
registries object (keys:string, values:RegistryConfig)

ControlSpec

Appears in:

• ConfigurationServicesSpec

Field	Description
debug boolean
dev boolean
disabled boolean
resourceProperties ResourceProperties
annotations AnnotationsServicesSpec

DelegatedOIDCServerConfiguration

Appears in:

• StackAuthSpec

Field	Description
issuer string
clientID string
clientSecret string

DeploymentStrategy

Underlying type: string

Appears in:

• LedgerSpec

DevProperties

Appears in:

• AuthSpec
• CommonServiceProperties
• ControlSpec
• LedgerSpec
• OrchestrationSpec
• PaymentsSpec
• ReconciliationSpec
• SearchSpec
• StackSpec
• StargateSpec
• WalletsSpec
• WebhooksSpec

Field	Description
debug boolean
dev boolean

ElasticSearchBasicAuthConfig

Appears in:

• ElasticSearchConfig

Field	Description
username string
password string
secretName string

ElasticSearchConfig

Appears in:

• SearchSpec

Field	Description
scheme string
host string
port integer
tls ElasticSearchTLSConfig
basicAuth ElasticSearchBasicAuthConfig
pathPrefix string
useZinc boolean

ElasticSearchTLSConfig

Appears in:

• ElasticSearchConfig

Field	Description
enabled boolean
skipCertVerify boolean

GatewaySpec

Appears in:

• ConfigurationServicesSpec

Field	Description
resourceProperties ResourceProperties
annotations AnnotationsServicesSpec
fallback string
enableAuditPlugin boolean
livenessEndpoint string
enableScopes boolean

IngressConfig

Appears in:

• IngressGlobalConfig

Field	Description
annotations object (keys:string, values:string)

IngressGlobalConfig

Appears in:

• ConfigurationSpec

Field	Description
annotations object (keys:string, values:string)
tls IngressTLS

IngressTLS

Appears in:

• IngressGlobalConfig

Field	Description
secretName string	SecretName is the name of the secret used to terminate TLS traffic on port 443. Field is left optional to allow TLS routing based on SNI hostname alone. If the SNI host in a listener conflicts with the "Host" header field used by an IngressRule, the SNI host is used for termination and value of the Host header is used for routing.

KafkaConfig

Appears in:

• Broker
• CollectorConfig

Field	Description
brokers string array
tls boolean
sasl KafkaSASLConfig

KafkaSASLConfig

Appears in:

• KafkaConfig

Field	Description
username string
password string
mechanism string
scramSHASize string

LedgerSpec

Appears in:

• ConfigurationServicesSpec

Field	Description
debug boolean
dev boolean
disabled boolean
postgres PostgresConfig
locking LockingStrategy
allowPastTimestamps boolean
resourceProperties ResourceProperties
annotations AnnotationsServicesSpec
deploymentStrategy DeploymentStrategy
disabled boolean

LockingStrategy

Appears in:

• LedgerSpec

Field	Description
strategy string
redis LockingStrategyRedisConfig

LockingStrategyRedisConfig

Appears in:

• LockingStrategy

Field	Description
uri string
tls boolean
insecure boolean
duration Duration
retry Duration

MetricsSpec

Appears in:

• MonitoringSpec

Field	Description
otlp OtlpSpec

Migration

Migration is the Schema for the migrations API

Field	Description
apiVersion string	stack.formance.com/v1beta3
kind string	Migration
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec MigrationSpec

MigrationSpec

MigrationSpec defines the desired state of Migration

Appears in:

• Migration

Field	Description
configuration string
currentVersion string
version string
module string
targetedVersion string
postUpgrade boolean

MonitoringSpec

Appears in:

• ConfigurationSpec

Field	Description
traces TracesSpec
metrics MetricsSpec

NatsConfig

Appears in:

• Broker
• CollectorConfig

Field	Description
url string
replicas integer

OrchestrationSpec

Appears in:

• ConfigurationServicesSpec

Field	Description
debug boolean
dev boolean
disabled boolean
postgres PostgresConfig
resourceProperties ResourceProperties
annotations AnnotationsServicesSpec

OtlpSpec

Appears in:

• MetricsSpec
• TracesSpec

Field	Description
endpoint string
port integer
insecure boolean
mode string
resourceAttributes string

PaymentsSpec

Appears in:

• ConfigurationServicesSpec

Field	Description
debug boolean
dev boolean
disabled boolean
encryptionKey string
postgres PostgresConfig
resourceProperties ResourceProperties
annotations AnnotationsServicesSpec

PostgresConfig

Appears in:

• AuthSpec
• LedgerSpec
• OrchestrationSpec
• PaymentsSpec
• ReconciliationSpec
• WebhooksSpec

Field	Description
port integer
host string
username string
password string
debug boolean
credentialsFromSecret string
disableSSLMode boolean

ReconciliationSpec

Appears in:

• ConfigurationServicesSpec

Field	Description
debug boolean
dev boolean
disabled boolean
postgres PostgresConfig
resourceProperties ResourceProperties
annotations AnnotationsServicesSpec

RegistryConfig

Appears in:

• ConfigurationSpec

Field	Description
endpoint string

ResourceProperties

Appears in:

• AuthSpec
• ControlSpec
• GatewaySpec
• LedgerSpec
• OrchestrationSpec
• PaymentsSpec
• ReconciliationSpec
• SearchSpec
• StargateSpec
• WalletsSpec
• WebhooksSpec

Field	Description
request resource
limits resource

SearchSpec

Appears in:

• ConfigurationServicesSpec

Field	Description
debug boolean
dev boolean
disabled boolean
elasticSearch ElasticSearchConfig
batching Batching
searchResourceProperties ResourceProperties
benthosResourceProperties ResourceProperties
annotations AnnotationsServicesSpec

Stack

Stack is the Schema for the stacks API

Field	Description
apiVersion string	stack.formance.com/v1beta3
kind string	Stack
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec StackSpec

StackAuthSpec

Appears in:

• StackSpec

Field	Description
delegatedOIDCServer DelegatedOIDCServerConfiguration
staticClients StaticClient array

StackServicePropertiesSpec

Appears in:

• StackServicesSpec

Field	Description
disabled boolean

StackServicesSpec

Appears in:

• StackSpec

Field	Description
ledger StackServicePropertiesSpec
orchestration StackServicePropertiesSpec
reconciliation StackServicePropertiesSpec
payments StackServicePropertiesSpec
wallets StackServicePropertiesSpec
webhooks StackServicePropertiesSpec
control StackServicePropertiesSpec

StackSpec

StackSpec defines the desired state of Stack

Appears in:

• Stack

Field	Description
debug boolean
dev boolean
seed string
host string
auth StackAuthSpec
stargate StackStargateConfig
versions string
scheme string
disabled boolean
services StackServicesSpec

StackStargateConfig

Appears in:

• StackSpec

Field	Description
stargateServerURL string

StargateSpec

Appears in:

• ConfigurationServicesSpec

Field	Description
debug boolean
dev boolean
resourceProperties ResourceProperties
annotations AnnotationsServicesSpec

StaticClient

Appears in:

• AuthSpec
• StackAuthSpec
• StackStatus

Field	Description
public boolean
description string
redirectUris string array
postLogoutRedirectUris string array
scopes string array
id string
secrets string array

Status

Appears in:

• StackStatus

Field	Description
conditions Conditions

TemporalConfig

Appears in:

• ConfigurationSpec

Field	Description
address string
namespace string
tls TemporalTLSConfig

TemporalTLSConfig

TODO: Handle validation

Appears in:

• TemporalConfig

Field	Description
crt string
key string
secretName string

TracesSpec

Appears in:

• MonitoringSpec

Field	Description
otlp OtlpSpec

Versions

Versions is the Schema for the versions API

Field	Description
apiVersion string	stack.formance.com/v1beta3
kind string	Versions
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec VersionsSpec

VersionsSpec

VersionsSpec defines the desired state of Versions

Appears in:

• Versions

Field	Description
control string
ledger string
payments string
search string
auth string
webhooks string
wallets string
orchestration string
gateway string
stargate string
reconciliation string

WalletsSpec

Appears in:

• ConfigurationServicesSpec

Field	Description
debug boolean
dev boolean
disabled boolean
resourceProperties ResourceProperties
annotations AnnotationsServicesSpec

WebhooksSpec

Appears in:

• ConfigurationServicesSpec

Field	Description
debug boolean
dev boolean
disabled boolean
postgres PostgresConfig
debug boolean
dev boolean
resourceProperties ResourceProperties
annotations AnnotationsServicesSpec