API Reference
Packages
formance.com/v1beta1
Package v1beta1 contains API Schema definitions for the formance v1beta1 API group.
It allow to configure a Formance stack.
A stack is composed of a Stack resource and some modules.
Each module can create multiple resources following its needs. See Other resources.
Various parts of the stack can be configured either using the CRD properties or using some Settings.
Modules :
Other resources :
- AuthClient
- Benthos
- BenthosStream
- Broker
- BrokerConsumer
- BrokerTopic
- Database
- GatewayHTTPAPI
- ResourceReference
- Versions
Main resources
Stack
Stack represents a formance stack. A Stack is basically a container. It holds some global properties and creates a namespace if not already existing.
To do more, you need to create some modules.
The Stack resource allow to specify the version of the stack.
It can be specified using either the field .spec.version
or the .spec.versionsFromFile
field (Refer to the documentation of Versions resource.
The version
field will have priority over versionFromFile
.
If versions
and versionsFromFile
are not specified, "latest" will be used.
Field | Description | Default | Validation |
---|---|---|---|
apiVersion string | formance.com/v1beta1 | ||
kind string | Stack | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata . | ||
spec StackSpec | |||
status StackStatus |