v1beta1

package
v0.0.0-...-406a471 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 25, 2025 License: MIT Imports: 15 Imported by: 0

Documentation

Overview

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(#stack) resource and some [modules](#modules).

Each module can create multiple resources following its needs. See [Other resources](#other-resources).

Various parts of the stack can be configured either using the CRD properties or using some Settings(#settings).

+kubebuilder:object:generate=true +groupName=formance.com

Index

Constants

View Source 
const (
	ModeOneStreamByService = "OneStreamByService"
	ModeOneStreamByStack   = "OneStreamByStack"
)
View Source 
const (
	DeploymentStrategySingle                   = "single"
	DeploymentStrategyMonoWriterMultipleReader = "single-writer"
)
View Source 
const (
	StackLabel          = "formance.com/stack"
	SkipLabel           = "formance.com/skip"
	CreatedByAgentLabel = "formance.com/created-by-agent"
)

Variables

View Source 
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "formance.com", Version: "v1beta1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

This section is empty.

Types

type Analytics 

type Analytics struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   AnalyticsSpec   `json:"spec,omitempty"`
	Status AnalyticsStatus `json:"status,omitempty"`
}

Analytics is the Schema for the analytics API

func (*Analytics) DeepCopy 

func (in *Analytics) DeepCopy() *Analytics

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Analytics.

func (*Analytics) DeepCopyInto 

func (in *Analytics) DeepCopyInto(out *Analytics)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Analytics) DeepCopyObject 

func (in *Analytics) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Analytics) GetConditions 

func (in *Analytics) GetConditions() *Conditions

func (*Analytics) GetStack 

func (in *Analytics) GetStack() string

func (*Analytics) GetVersion 

func (in *Analytics) GetVersion() string

func (*Analytics) IsDebug 

func (in *Analytics) IsDebug() bool

func (*Analytics) IsDev 

func (in *Analytics) IsDev() bool

func (*Analytics) IsEE 

func (in *Analytics) IsEE() bool

func (*Analytics) IsReady 

func (in *Analytics) IsReady() bool

func (*Analytics) SetError 

func (in *Analytics) SetError(s string)

func (*Analytics) SetReady 

func (in *Analytics) SetReady(b bool)

type AnalyticsList 

type AnalyticsList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Analytics `json:"items"`
}

AnalyticsList contains a list of Analytics

func (*AnalyticsList) DeepCopy 

func (in *AnalyticsList) DeepCopy() *AnalyticsList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AnalyticsList.

func (*AnalyticsList) DeepCopyInto 

func (in *AnalyticsList) DeepCopyInto(out *AnalyticsList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*AnalyticsList) DeepCopyObject 

func (in *AnalyticsList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type AnalyticsSpec 

type AnalyticsSpec struct {
	ModuleProperties `json:",inline"`
	StackDependency  `json:",inline"`
}

AnalyticsSpec defines the desired state of Analytics

func (*AnalyticsSpec) DeepCopy 

func (in *AnalyticsSpec) DeepCopy() *AnalyticsSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AnalyticsSpec.

func (*AnalyticsSpec) DeepCopyInto 

func (in *AnalyticsSpec) DeepCopyInto(out *AnalyticsSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AnalyticsStatus 

type AnalyticsStatus struct {
	Status `json:",inline"`
}

AnalyticsStatus defines the observed state of Analytics

func (*AnalyticsStatus) DeepCopy 

func (in *AnalyticsStatus) DeepCopy() *AnalyticsStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AnalyticsStatus.

func (*AnalyticsStatus) DeepCopyInto 

func (in *AnalyticsStatus) DeepCopyInto(out *AnalyticsStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Auth 

type Auth struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   AuthSpec   `json:"spec,omitempty"`
	Status AuthStatus `json:"status,omitempty"`
}

Auth represent the authentication module of a stack.

It is an OIDC compliant server.

Creating it for a stack automatically add authentication on all supported modules.

The auth service is basically a proxy to another OIDC compliant server. +kubebuilder:object:root=true +kubebuilder:subresource:status +kubebuilder:resource:scope=Cluster +kubebuilder:printcolumn:name="Clients",type=string,JSONPath=".status.clients",description="Synchronized auth clients" +kubebuilder:printcolumn:name="Stack",type=string,JSONPath=".spec.stack",description="Stack" +kubebuilder:printcolumn:name="Ready",type=string,JSONPath=".status.ready",description="Is ready" +kubebuilder:printcolumn:name="Info",type=string,JSONPath=".status.info",description="Info" +kubebuilder:printcolumn:name="Version",type=string,JSONPath=".spec.version",description="Version" +kubebuilder:metadata:labels=formance.com/kind=module

func (*Auth) DeepCopy 

func (in *Auth) DeepCopy() *Auth

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Auth.

func (*Auth) DeepCopyInto 

func (in *Auth) DeepCopyInto(out *Auth)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Auth) DeepCopyObject 

func (in *Auth) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Auth) GetConditions 

func (in *Auth) GetConditions() *Conditions

func (Auth) GetStack 

func (in Auth) GetStack() string

func (*Auth) GetVersion 

func (in *Auth) GetVersion() string

func (Auth) IsDebug 

func (in Auth) IsDebug() bool

func (Auth) IsDev 

func (in Auth) IsDev() bool

func (*Auth) IsEE 

func (in *Auth) IsEE() bool

func (*Auth) IsReady 

func (in *Auth) IsReady() bool

func (*Auth) SetError 

func (in *Auth) SetError(s string)

func (*Auth) SetReady 

func (in *Auth) SetReady(b bool)

type AuthClient 

type AuthClient struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   AuthClientSpec   `json:"spec,omitempty"`
	Status AuthClientStatus `json:"status,omitempty"`
}

AuthClient allow to create OAuth2/OIDC clients on the auth server (see Auth(#auth))

func (*AuthClient) DeepCopy 

func (in *AuthClient) DeepCopy() *AuthClient

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AuthClient.

func (*AuthClient) DeepCopyInto 

func (in *AuthClient) DeepCopyInto(out *AuthClient)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*AuthClient) DeepCopyObject 

func (in *AuthClient) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*AuthClient) GetConditions 

func (in *AuthClient) GetConditions() *Conditions

func (AuthClient) GetStack 

func (a AuthClient) GetStack() string

func (*AuthClient) IsReady 

func (in *AuthClient) IsReady() bool

func (*AuthClient) SetError 

func (a *AuthClient) SetError(s string)

func (*AuthClient) SetReady 

func (a *AuthClient) SetReady(b bool)

type AuthClientList 

type AuthClientList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []AuthClient `json:"items"`
}

AuthClientList contains a list of AuthClient

func (*AuthClientList) DeepCopy 

func (in *AuthClientList) DeepCopy() *AuthClientList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AuthClientList.

func (*AuthClientList) DeepCopyInto 

func (in *AuthClientList) DeepCopyInto(out *AuthClientList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*AuthClientList) DeepCopyObject 

func (in *AuthClientList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type AuthClientSpec 

type AuthClientSpec struct {
	StackDependency `json:",inline" yaml:",inline"`
	// ID indicates the client id
	// It must be used with oauth2 `client_id` parameter
	ID string `json:"id" yaml:"id"`
	// +optional
	// Public indicate whether a client is confidential or not.
	// Confidential clients are clients which the secret can be kept secret...
	// As opposed to public clients which cannot have a secret (application single page for example)
	// +kubebuilder:default:=false
	Public bool `json:"public" yaml:"public"`
	// +optional
	// Description represents an optional description of the client
	Description string `json:"description,omitempty" yaml:"description,omitempty"`
	// +optional
	// RedirectUris allow to list allowed redirect uris for the client
	RedirectUris []string `json:"redirectUris,omitempty" yaml:"redirectUris"`
	// +optional
	// RedirectUris allow to list allowed post logout redirect uris for the client
	PostLogoutRedirectUris []string `json:"postLogoutRedirectUris,omitempty" yaml:"postLogoutRedirectUris"`
	// +optional
	// Scopes allow to five some scope to the client
	Scopes []string `json:"scopes,omitempty" yaml:"scopes"`
	// +optional
	// Secret allow to configure a secret for the client.
	// It is not required as some client could use some oauth2 flows which does not requires a client secret
	Secret string `json:"secret,omitempty"`

	// +optional
	SecretFromSecret *v1.SecretKeySelector `json:"secretFromSecret,omitempty" yaml:"-"`
}

func (*AuthClientSpec) DeepCopy 

func (in *AuthClientSpec) DeepCopy() *AuthClientSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AuthClientSpec.

func (*AuthClientSpec) DeepCopyInto 

func (in *AuthClientSpec) DeepCopyInto(out *AuthClientSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (AuthClientSpec) MarshalYAML 

func (spec AuthClientSpec) MarshalYAML() (interface{}, error)

type AuthClientStatus 

type AuthClientStatus struct {
	Status `json:",inline"`

	//+optional
	Hash string `json:"hash,omitempty"`
}

func (*AuthClientStatus) DeepCopy 

func (in *AuthClientStatus) DeepCopy() *AuthClientStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AuthClientStatus.

func (*AuthClientStatus) DeepCopyInto 

func (in *AuthClientStatus) DeepCopyInto(out *AuthClientStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AuthConfig 

type AuthConfig struct {
	// +optional
	ReadKeySetMaxRetries int `json:"readKeySetMaxRetries"`
	// +optional
	CheckScopes bool `json:"checkScopes"`
}

func (*AuthConfig) DeepCopy 

func (in *AuthConfig) DeepCopy() *AuthConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AuthConfig.

func (*AuthConfig) DeepCopyInto 

func (in *AuthConfig) DeepCopyInto(out *AuthConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AuthList 

type AuthList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Auth `json:"items"`
}

AuthList contains a list of Auth

func (*AuthList) DeepCopy 

func (in *AuthList) DeepCopy() *AuthList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AuthList.

func (*AuthList) DeepCopyInto 

func (in *AuthList) DeepCopyInto(out *AuthList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*AuthList) DeepCopyObject 

func (in *AuthList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type AuthSpec 

type AuthSpec struct {
	ModuleProperties `json:",inline"`
	StackDependency  `json:",inline"`
	//+optional
	// Contains information about a delegated authentication server to use to delegate authentication
	DelegatedOIDCServer *DelegatedOIDCServerConfiguration `json:"delegatedOIDCServer,omitempty"`
	//+optional
	// Allow to override the default signing key used to sign JWT tokens.
	SigningKey string `json:"signingKey,omitempty"`
	//+optional
	// Allow to override the default signing key used to sign JWT tokens using a k8s secret
	SigningKeyFromSecret *v1.SecretKeySelector `json:"signingKeyFromSecret,omitempty"`
	//+optional
	// Allow to enable scopes usage on authentication.
	//
	// If not enabled, each service will check the authentication but will not restrict access following scopes.
	// in this case, if authenticated, it is ok.
	// +kubebuilder:default:=false
	EnableScopes bool `json:"enableScopes"`
}

func (*AuthSpec) DeepCopy 

func (in *AuthSpec) DeepCopy() *AuthSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AuthSpec.

func (*AuthSpec) DeepCopyInto 

func (in *AuthSpec) DeepCopyInto(out *AuthSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AuthStatus 

type AuthStatus struct {
	Status `json:",inline"`
	//+optional
	// Clients contains the list of clients created using [AuthClient](#authclient)
	Clients []string `json:"clients"`
}

func (*AuthStatus) DeepCopy 

func (in *AuthStatus) DeepCopy() *AuthStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AuthStatus.

func (*AuthStatus) DeepCopyInto 

func (in *AuthStatus) DeepCopyInto(out *AuthStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Batching 

type Batching struct {
	// Count indicates the number of messages that can be kept in memory before being flushed to ElasticSearch
	Count int `json:"count"`
	// Period indicates the maximum duration messages can be kept in memory before being flushed to ElasticSearch
	Period string `json:"period"`
}

Batching allow to define custom batching configuration

func (*Batching) DeepCopy 

func (in *Batching) DeepCopy() *Batching

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Batching.

func (*Batching) DeepCopyInto 

func (in *Batching) DeepCopyInto(out *Batching)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Benthos 

type Benthos struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   BenthosSpec   `json:"spec,omitempty"`
	Status BenthosStatus `json:"status,omitempty"`
}

Benthos is the Schema for the benthos API

func (*Benthos) DeepCopy 

func (in *Benthos) DeepCopy() *Benthos

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Benthos.

func (*Benthos) DeepCopyInto 

func (in *Benthos) DeepCopyInto(out *Benthos)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Benthos) DeepCopyObject 

func (in *Benthos) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Benthos) GetConditions 

func (in *Benthos) GetConditions() *Conditions

func (Benthos) GetStack 

func (a Benthos) GetStack() string

func (*Benthos) IsReady 

func (in *Benthos) IsReady() bool

func (*Benthos) SetError 

func (in *Benthos) SetError(s string)

func (*Benthos) SetReady 

func (in *Benthos) SetReady(b bool)

type BenthosList 

type BenthosList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Benthos `json:"items"`
}

BenthosList contains a list of Benthos

func (*BenthosList) DeepCopy 

func (in *BenthosList) DeepCopy() *BenthosList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BenthosList.

func (*BenthosList) DeepCopyInto 

func (in *BenthosList) DeepCopyInto(out *BenthosList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*BenthosList) DeepCopyObject 

func (in *BenthosList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type BenthosSpec 

type BenthosSpec struct {
	StackDependency `json:",inline"`
	DevProperties   `json:",inline"`
	//+optional
	ResourceProperties *corev1.ResourceRequirements `json:"resourceRequirements,omitempty"`
	//+optional
	Batching *Batching `json:"batching,omitempty"`
	//+optional
	InitContainers []corev1.Container `json:"initContainers"`
}

func (*BenthosSpec) DeepCopy 

func (in *BenthosSpec) DeepCopy() *BenthosSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BenthosSpec.

func (*BenthosSpec) DeepCopyInto 

func (in *BenthosSpec) DeepCopyInto(out *BenthosSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type BenthosStatus 

type BenthosStatus struct {
	Status `json:",inline"`
	//+optional
	ElasticSearchURI *URI `json:"elasticSearchURI"`
}

func (*BenthosStatus) DeepCopy 

func (in *BenthosStatus) DeepCopy() *BenthosStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BenthosStatus.

func (*BenthosStatus) DeepCopyInto 

func (in *BenthosStatus) DeepCopyInto(out *BenthosStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type BenthosStream 

type BenthosStream struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   BenthosStreamSpec   `json:"spec,omitempty"`
	Status BenthosStreamStatus `json:"status,omitempty"`
}

BenthosStream is the Schema for the benthosstreams API

func (*BenthosStream) DeepCopy 

func (in *BenthosStream) DeepCopy() *BenthosStream

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BenthosStream.

func (*BenthosStream) DeepCopyInto 

func (in *BenthosStream) DeepCopyInto(out *BenthosStream)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*BenthosStream) DeepCopyObject 

func (in *BenthosStream) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*BenthosStream) GetConditions 

func (in *BenthosStream) GetConditions() *Conditions

func (BenthosStream) GetStack 

func (a BenthosStream) GetStack() string

func (*BenthosStream) IsReady 

func (in *BenthosStream) IsReady() bool

func (*BenthosStream) SetError 

func (in *BenthosStream) SetError(s string)

func (*BenthosStream) SetReady 

func (in *BenthosStream) SetReady(b bool)

type BenthosStreamList 

type BenthosStreamList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []BenthosStream `json:"items"`
}

BenthosStreamList contains a list of BenthosStream

func (*BenthosStreamList) DeepCopy 

func (in *BenthosStreamList) DeepCopy() *BenthosStreamList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BenthosStreamList.

func (*BenthosStreamList) DeepCopyInto 

func (in *BenthosStreamList) DeepCopyInto(out *BenthosStreamList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*BenthosStreamList) DeepCopyObject 

func (in *BenthosStreamList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type BenthosStreamSpec 

type BenthosStreamSpec struct {
	StackDependency `json:",inline"`
	Data            string `json:"data"`
	Name            string `json:"name"`
}

func (*BenthosStreamSpec) DeepCopy 

func (in *BenthosStreamSpec) DeepCopy() *BenthosStreamSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BenthosStreamSpec.

func (*BenthosStreamSpec) DeepCopyInto 

func (in *BenthosStreamSpec) DeepCopyInto(out *BenthosStreamSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type BenthosStreamStatus 

type BenthosStreamStatus struct {
	Status `json:",inline"`
}

func (*BenthosStreamStatus) DeepCopy 

func (in *BenthosStreamStatus) DeepCopy() *BenthosStreamStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BenthosStreamStatus.

func (*BenthosStreamStatus) DeepCopyInto 

func (in *BenthosStreamStatus) DeepCopyInto(out *BenthosStreamStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Broker 

type Broker struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   BrokerSpec   `json:"spec,omitempty"`
	Status BrokerStatus `json:"status,omitempty"`
}

Broker is the Schema for the brokers API

func (*Broker) DeepCopy 

func (in *Broker) DeepCopy() *Broker

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Broker.

func (*Broker) DeepCopyInto 

func (in *Broker) DeepCopyInto(out *Broker)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Broker) DeepCopyObject 

func (in *Broker) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Broker) GetConditions 

func (in *Broker) GetConditions() *Conditions

func (*Broker) GetStack 

func (in *Broker) GetStack() string

func (*Broker) IsReady 

func (in *Broker) IsReady() bool

func (*Broker) SetError 

func (in *Broker) SetError(s string)

func (*Broker) SetReady 

func (in *Broker) SetReady(ready bool)

type BrokerConsumer 

type BrokerConsumer struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   BrokerConsumerSpec   `json:"spec,omitempty"`
	Status BrokerConsumerStatus `json:"status,omitempty"`
}

BrokerConsumer is the Schema for the brokerconsumers API

func (*BrokerConsumer) DeepCopy 

func (in *BrokerConsumer) DeepCopy() *BrokerConsumer

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BrokerConsumer.

func (*BrokerConsumer) DeepCopyInto 

func (in *BrokerConsumer) DeepCopyInto(out *BrokerConsumer)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*BrokerConsumer) DeepCopyObject 

func (in *BrokerConsumer) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*BrokerConsumer) GetConditions 

func (in *BrokerConsumer) GetConditions() *Conditions

func (*BrokerConsumer) GetStack 

func (in *BrokerConsumer) GetStack() string

func (*BrokerConsumer) IsReady 

func (in *BrokerConsumer) IsReady() bool

func (*BrokerConsumer) SetError 

func (in *BrokerConsumer) SetError(s string)

func (*BrokerConsumer) SetReady 

func (in *BrokerConsumer) SetReady(b bool)

type BrokerConsumerList 

type BrokerConsumerList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []BrokerConsumer `json:"items"`
}

BrokerConsumerList contains a list of BrokerConsumer

func (*BrokerConsumerList) DeepCopy 

func (in *BrokerConsumerList) DeepCopy() *BrokerConsumerList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BrokerConsumerList.

func (*BrokerConsumerList) DeepCopyInto 

func (in *BrokerConsumerList) DeepCopyInto(out *BrokerConsumerList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*BrokerConsumerList) DeepCopyObject 

func (in *BrokerConsumerList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type BrokerConsumerSpec 

type BrokerConsumerSpec struct {
	StackDependency `json:",inline"`
	Services        []string `json:"services"`
	QueriedBy       string   `json:"queriedBy"`
	//+optional
	// As the name is optional, if not provided, the name will be the QueriedBy property
	// This is only applied when using one stream by stack see Mode
	Name string `json:"name,omitempty"`
}

func (*BrokerConsumerSpec) DeepCopy 

func (in *BrokerConsumerSpec) DeepCopy() *BrokerConsumerSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BrokerConsumerSpec.

func (*BrokerConsumerSpec) DeepCopyInto 

func (in *BrokerConsumerSpec) DeepCopyInto(out *BrokerConsumerSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type BrokerConsumerStatus 

type BrokerConsumerStatus struct {
	Status `json:",inline"`
}

func (*BrokerConsumerStatus) DeepCopy 

func (in *BrokerConsumerStatus) DeepCopy() *BrokerConsumerStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BrokerConsumerStatus.

func (*BrokerConsumerStatus) DeepCopyInto 

func (in *BrokerConsumerStatus) DeepCopyInto(out *BrokerConsumerStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type BrokerList 

type BrokerList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Broker `json:"items"`
}

BrokerList contains a list of Broker

func (*BrokerList) DeepCopy 

func (in *BrokerList) DeepCopy() *BrokerList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BrokerList.

func (*BrokerList) DeepCopyInto 

func (in *BrokerList) DeepCopyInto(out *BrokerList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*BrokerList) DeepCopyObject 

func (in *BrokerList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type BrokerSpec 

type BrokerSpec struct {
	StackDependency `json:",inline"`
}

func (*BrokerSpec) DeepCopy 

func (in *BrokerSpec) DeepCopy() *BrokerSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BrokerSpec.

func (*BrokerSpec) DeepCopyInto 

func (in *BrokerSpec) DeepCopyInto(out *BrokerSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type BrokerStatus 

type BrokerStatus struct {
	Status `json:",inline"`
	//+optional
	URI *URI `json:"uri,omitempty"`
	//+optional
	//+kubebuilder:validation:Enum:={OneStreamByService, OneStreamByStack}
	// Mode indicating the configuration of the nats streams
	// Two modes are defined :
	// * ModeOneStreamByService: In this case, each service will have a dedicated stream created
	// * ModeOneStreamByStack: In this case, a stream will be created for the stack and each service will use a specific subject inside this stream
	Mode Mode `json:"mode"`
	// Streams list streams created when Mode == ModeOneStreamByService
	//+optional
	Streams []string `json:"streams,omitempty"`
}

func (*BrokerStatus) DeepCopy 

func (in *BrokerStatus) DeepCopy() *BrokerStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BrokerStatus.

func (*BrokerStatus) DeepCopyInto 

func (in *BrokerStatus) DeepCopyInto(out *BrokerStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type BrokerTopic 

type BrokerTopic struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   BrokerTopicSpec   `json:"spec,omitempty"`
	Status BrokerTopicStatus `json:"status,omitempty"`
}

BrokerTopic is the Schema for the brokertopics API

func (*BrokerTopic) DeepCopy 

func (in *BrokerTopic) DeepCopy() *BrokerTopic

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BrokerTopic.

func (*BrokerTopic) DeepCopyInto 

func (in *BrokerTopic) DeepCopyInto(out *BrokerTopic)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*BrokerTopic) DeepCopyObject 

func (in *BrokerTopic) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*BrokerTopic) GetConditions 

func (in *BrokerTopic) GetConditions() *Conditions

func (*BrokerTopic) GetStack 

func (a *BrokerTopic) GetStack() string

func (*BrokerTopic) IsReady 

func (in *BrokerTopic) IsReady() bool

func (*BrokerTopic) SetError 

func (in *BrokerTopic) SetError(s string)

func (*BrokerTopic) SetReady 

func (in *BrokerTopic) SetReady(b bool)

type BrokerTopicList 

type BrokerTopicList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []BrokerTopic `json:"items"`
}

BrokerTopicList contains a list of BrokerTopic

func (*BrokerTopicList) DeepCopy 

func (in *BrokerTopicList) DeepCopy() *BrokerTopicList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BrokerTopicList.

func (*BrokerTopicList) DeepCopyInto 

func (in *BrokerTopicList) DeepCopyInto(out *BrokerTopicList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*BrokerTopicList) DeepCopyObject 

func (in *BrokerTopicList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type BrokerTopicSpec 

type BrokerTopicSpec struct {
	StackDependency `json:",inline"`
	//+required
	Service string `json:"service"`
}

func (*BrokerTopicSpec) DeepCopy 

func (in *BrokerTopicSpec) DeepCopy() *BrokerTopicSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BrokerTopicSpec.

func (*BrokerTopicSpec) DeepCopyInto 

func (in *BrokerTopicSpec) DeepCopyInto(out *BrokerTopicSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type BrokerTopicStatus 

type BrokerTopicStatus struct {
	Status `json:",inline"`
}

func (*BrokerTopicStatus) DeepCopy 

func (in *BrokerTopicStatus) DeepCopy() *BrokerTopicStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BrokerTopicStatus.

func (*BrokerTopicStatus) DeepCopyInto 

func (in *BrokerTopicStatus) DeepCopyInto(out *BrokerTopicStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Condition 

type Condition struct {
	// 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)
	// +required
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:Pattern=`^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$`
	// +kubebuilder:validation:MaxLength=316
	Type string `json:"type" protobuf:"bytes,1,opt,name=type"`
	// status of the condition, one of True, False, Unknown.
	// +required
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:Enum=True;False;Unknown
	Status metav1.ConditionStatus `json:"status" protobuf:"bytes,2,opt,name=status"`
	// 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.
	// +optional
	// +kubebuilder:validation:Minimum=0
	ObservedGeneration int64 `json:"observedGeneration,omitempty" protobuf:"varint,3,opt,name=observedGeneration"`
	// 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.
	// +required
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:Type=string
	// +kubebuilder:validation:Format=date-time
	LastTransitionTime metav1.Time `json:"lastTransitionTime" protobuf:"bytes,4,opt,name=lastTransitionTime"`
	// message is a human readable message indicating details about the transition.
	// This may be an empty string.
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MaxLength=32768
	Message string `json:"message" protobuf:"bytes,6,opt,name=message"`
	// reason contains a programmatic identifier indicating the reason for the condition's last transition.
	// Producers of specific condition types may define expected values and meanings for this field,
	// and whether the values are considered a guaranteed API.
	// The value should be a CamelCase string.
	// This field may not be empty.
	// +optional
	// +kubebuilder:validation:MaxLength=1024
	// +kubebuilder:validation:Pattern=`^([A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?)?$`
	Reason string `json:"reason,omitempty" protobuf:"bytes,5,opt,name=reason"`
}

Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, 

type FooStatus struct{
    // Represents the observations of a foo's current state.
    // Known .status.conditions.type are: "Available", "Progressing", and "Degraded"
    // +patchMergeKey=type
    // +patchStrategy=merge
    // +listType=map
    // +listMapKey=type
    Status []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"`

    // other fields
}

func NewCondition 

func NewCondition(t string, generation int64) *Condition

func (*Condition) DeepCopy 

func (in *Condition) DeepCopy() *Condition

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Condition.

func (*Condition) DeepCopyInto 

func (in *Condition) DeepCopyInto(out *Condition)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Condition) Fail 

func (in *Condition) Fail(v string) *Condition

func (*Condition) SetMessage 

func (in *Condition) SetMessage(v string) *Condition

func (*Condition) SetReason 

func (in *Condition) SetReason(reason string) *Condition

func (*Condition) SetStatus 

func (in *Condition) SetStatus(v metav1.ConditionStatus) *Condition

type ConditionPredicate 

type ConditionPredicate func(condition Condition) bool

+kubebuilder:object:generate=false

func AndConditions 

func AndConditions(predicates ...ConditionPredicate) ConditionPredicate

func ConditionGenerationMatch 

func ConditionGenerationMatch(generation int64) ConditionPredicate

func ConditionReasonMatch 

func ConditionReasonMatch(reason string) ConditionPredicate

func ConditionTypeMatch 

func ConditionTypeMatch(t string) ConditionPredicate

type Conditions 

type Conditions []Condition

func (*Conditions) AppendOrReplace 

func (c *Conditions) AppendOrReplace(newCondition Condition, p ConditionPredicate) *Condition

func (*Conditions) Check 

func (c *Conditions) Check(p ConditionPredicate) bool

func (Conditions) DeepCopy 

func (in Conditions) DeepCopy() Conditions

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Conditions.

func (Conditions) DeepCopyInto 

func (in Conditions) DeepCopyInto(out *Conditions)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Conditions) Delete 

func (c *Conditions) Delete(p ConditionPredicate) *Conditions

func (*Conditions) Get 

func (c *Conditions) Get(conditionType string) *Condition

type Database 

type Database struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   DatabaseSpec   `json:"spec,omitempty"`
	Status DatabaseStatus `json:"status,omitempty"`
}

Database represent a concrete database on a PostgreSQL server, it is created by modules requiring a database (Ledger(#ledger) for example).

It uses the settings `postgres.<module-name>.uri` which must have the following uri format: `postgresql://[<username>@<password>]@<host>/<db-name>` Additionally, the uri can define a query param `secret` indicating a k8s secret, than must be used to retrieve database credentials.

On creation, the reconciler behind the Database object will create the database on the postgresql server using a k8s job. On Deletion, by default, the reconciler will let the database untouched. You can allow the reconciler to drop the database on the server by using the Settings(#settings) `clear-database` with the value `true`. If you use that setting, the reconciler will use another job to drop the database. Be careful, no backup are performed!

Database resource honors `aws.service-account` setting, so, you can create databases on an AWS server if you need. See [AWS accounts](#aws-account)

Once a database is fully configured, it retains the postgres uri used. If the setting indicating the server uri changed, the Database object will set the field `.status.outOfSync` to true and will not change anything.

Therefore, to switch to a new server, you must change the setting value, then drop the Database object. It will be recreated with correct uri. +kubebuilder:object:root=true +kubebuilder:subresource:status +kubebuilder:resource:scope=Cluster +kubebuilder:printcolumn:name="Stack",type=string,JSONPath=".spec.stack",description="Stack" +kubebuilder:printcolumn:name="Ready",type=string,JSONPath=".status.ready",description="Ready" +kubebuilder:printcolumn:name="Out of sync",type=string,JSONPath=".status.outOfSync",description="Is the databse configuration out of sync" +kubebuilder:printcolumn:name="Info",type=string,JSONPath=".status.info",description="Info"

func (*Database) DeepCopy 

func (in *Database) DeepCopy() *Database

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Database.

func (*Database) DeepCopyInto 

func (in *Database) DeepCopyInto(out *Database)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Database) DeepCopyObject 

func (in *Database) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Database) GetConditions 

func (in *Database) GetConditions() *Conditions

func (*Database) GetStack 

func (a *Database) GetStack() string

func (*Database) IsReady 

func (in *Database) IsReady() bool

func (*Database) SetError 

func (in *Database) SetError(s string)

func (*Database) SetReady 

func (in *Database) SetReady(b bool)

type DatabaseList 

type DatabaseList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Database `json:"items"`
}

DatabaseList contains a list of Database

func (*DatabaseList) DeepCopy 

func (in *DatabaseList) DeepCopy() *DatabaseList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DatabaseList.

func (*DatabaseList) DeepCopyInto 

func (in *DatabaseList) DeepCopyInto(out *DatabaseList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*DatabaseList) DeepCopyObject 

func (in *DatabaseList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type DatabaseSpec 

type DatabaseSpec struct {
	StackDependency `json:",inline"`
	// Service is a discriminator for the created database.
	// Actually, it will be the module name (ledger, payments...).
	// Therefore, the created database will be named `<stack-name><service>`
	Service string `json:"service"`
	// +kubebuilder:default:=false
	Debug bool `json:"debug,omitempty"`
}

func (*DatabaseSpec) DeepCopy 

func (in *DatabaseSpec) DeepCopy() *DatabaseSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DatabaseSpec.

func (*DatabaseSpec) DeepCopyInto 

func (in *DatabaseSpec) DeepCopyInto(out *DatabaseSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type DatabaseStatus 

type DatabaseStatus struct {
	Status `json:",inline"`
	//+optional
	URI *URI `json:"uri,omitempty"`
	//+optional
	// The generated database name
	Database string `json:"database,omitempty"`
	//+optional
	// OutOfSync indicates than a settings changed the uri of the postgres server
	// The Database object need to be removed to be recreated
	OutOfSync bool `json:"outOfSync,omitempty"`
}

func (*DatabaseStatus) DeepCopy 

func (in *DatabaseStatus) DeepCopy() *DatabaseStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DatabaseStatus.

func (*DatabaseStatus) DeepCopyInto 

func (in *DatabaseStatus) DeepCopyInto(out *DatabaseStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type DelegatedOIDCServerConfiguration 

type DelegatedOIDCServerConfiguration struct {
	// Issuer is the url of the delegated oidc server
	Issuer string `json:"issuer,omitempty"`
	// ClientID is the client id to use for authentication
	ClientID string `json:"clientID,omitempty"`
	// ClientSecret is the client secret to use for authentication
	ClientSecret string `json:"clientSecret,omitempty"`

	// ClientSecretFromSecret is the client secret to use for authentication
	ClientSecretFromSecret *v1.SecretKeySelector `json:"clientSecretFromSecret,omitempty"`
}

func (*DelegatedOIDCServerConfiguration) DeepCopy 

func (in *DelegatedOIDCServerConfiguration) DeepCopy() *DelegatedOIDCServerConfiguration

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DelegatedOIDCServerConfiguration.

func (*DelegatedOIDCServerConfiguration) DeepCopyInto 

func (in *DelegatedOIDCServerConfiguration) DeepCopyInto(out *DelegatedOIDCServerConfiguration)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Dependent 

type Dependent interface {
	Object
	GetStack() string
}

+kubebuilder:object:generate=false

type DeploymentStrategy 

type DeploymentStrategy string

type DevProperties 

type DevProperties struct {
	// +optional
	// Allow to enable debug mode on the module
	// +kubebuilder:default:=false
	Debug bool `json:"debug"`
	// +optional
	// Allow to enable dev mode on the module
	// Dev mode is used to allow some application to do custom setup in development mode (allow insecure certificates for example)
	// +kubebuilder:default:=false
	Dev bool `json:"dev"`
}

func (*DevProperties) DeepCopy 

func (in *DevProperties) DeepCopy() *DevProperties

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DevProperties.

func (*DevProperties) DeepCopyInto 

func (in *DevProperties) DeepCopyInto(out *DevProperties)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (DevProperties) IsDebug 

func (p DevProperties) IsDebug() bool

func (DevProperties) IsDev 

func (p DevProperties) IsDev() bool

type EventPublisher 

type EventPublisher interface {
	// contains filtered or unexported methods
}

+kubebuilder:object:generate=false

type Gateway 

type Gateway struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   GatewaySpec   `json:"spec,omitempty"`
	Status GatewayStatus `json:"status,omitempty"`
}

Gateway is the Schema for the gateways API

func (*Gateway) DeepCopy 

func (in *Gateway) DeepCopy() *Gateway

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Gateway.

func (*Gateway) DeepCopyInto 

func (in *Gateway) DeepCopyInto(out *Gateway)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Gateway) DeepCopyObject 

func (in *Gateway) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Gateway) GetConditions 

func (in *Gateway) GetConditions() *Conditions

func (Gateway) GetStack 

func (a Gateway) GetStack() string

func (*Gateway) GetVersion 

func (in *Gateway) GetVersion() string

func (Gateway) IsDebug 

func (a Gateway) IsDebug() bool

func (Gateway) IsDev 

func (a Gateway) IsDev() bool

func (*Gateway) IsEE 

func (in *Gateway) IsEE() bool

func (*Gateway) IsReady 

func (in *Gateway) IsReady() bool

func (*Gateway) SetError 

func (in *Gateway) SetError(s string)

func (*Gateway) SetReady 

func (in *Gateway) SetReady(b bool)

type GatewayHTTPAPI 

type GatewayHTTPAPI struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   GatewayHTTPAPISpec   `json:"spec,omitempty"`
	Status GatewayHTTPAPIStatus `json:"status,omitempty"`
}

GatewayHTTPAPI is the Schema for the HTTPAPIs API

func (*GatewayHTTPAPI) DeepCopy 

func (in *GatewayHTTPAPI) DeepCopy() *GatewayHTTPAPI

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GatewayHTTPAPI.

func (*GatewayHTTPAPI) DeepCopyInto 

func (in *GatewayHTTPAPI) DeepCopyInto(out *GatewayHTTPAPI)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*GatewayHTTPAPI) DeepCopyObject 

func (in *GatewayHTTPAPI) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*GatewayHTTPAPI) GetConditions 

func (in *GatewayHTTPAPI) GetConditions() *Conditions

func (GatewayHTTPAPI) GetStack 

func (a GatewayHTTPAPI) GetStack() string

func (*GatewayHTTPAPI) IsReady 

func (in *GatewayHTTPAPI) IsReady() bool

func (*GatewayHTTPAPI) SetError 

func (in *GatewayHTTPAPI) SetError(s string)

func (*GatewayHTTPAPI) SetReady 

func (in *GatewayHTTPAPI) SetReady(b bool)

type GatewayHTTPAPIList 

type GatewayHTTPAPIList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []GatewayHTTPAPI `json:"items"`
}

GatewayHTTPAPIList contains a list of GatewayHTTPAPI

func (*GatewayHTTPAPIList) DeepCopy 

func (in *GatewayHTTPAPIList) DeepCopy() *GatewayHTTPAPIList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GatewayHTTPAPIList.

func (*GatewayHTTPAPIList) DeepCopyInto 

func (in *GatewayHTTPAPIList) DeepCopyInto(out *GatewayHTTPAPIList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*GatewayHTTPAPIList) DeepCopyObject 

func (in *GatewayHTTPAPIList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type GatewayHTTPAPIRule 

type GatewayHTTPAPIRule struct {
	Path string `json:"path"`
	//+optional
	Methods []string `json:"methods"`
	//+optional
	//+kubebuilder:default:=false
	Secured bool `json:"secured"`
}

func (*GatewayHTTPAPIRule) DeepCopy 

func (in *GatewayHTTPAPIRule) DeepCopy() *GatewayHTTPAPIRule

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GatewayHTTPAPIRule.

func (*GatewayHTTPAPIRule) DeepCopyInto 

func (in *GatewayHTTPAPIRule) DeepCopyInto(out *GatewayHTTPAPIRule)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type GatewayHTTPAPISpec 

type GatewayHTTPAPISpec struct {
	StackDependency `json:",inline"`
	// Name indicates prefix api
	Name string `json:"name"`
	// Rules
	Rules []GatewayHTTPAPIRule `json:"rules"`
	// Health check endpoint
	HealthCheckEndpoint string `json:"healthCheckEndpoint,omitempty"`
}

func (*GatewayHTTPAPISpec) DeepCopy 

func (in *GatewayHTTPAPISpec) DeepCopy() *GatewayHTTPAPISpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GatewayHTTPAPISpec.

func (*GatewayHTTPAPISpec) DeepCopyInto 

func (in *GatewayHTTPAPISpec) DeepCopyInto(out *GatewayHTTPAPISpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type GatewayHTTPAPIStatus 

type GatewayHTTPAPIStatus struct {
	Status `json:",inline"`
	//+optional
	Ready bool `json:"ready,omitempty"`
}

func (*GatewayHTTPAPIStatus) DeepCopy 

func (in *GatewayHTTPAPIStatus) DeepCopy() *GatewayHTTPAPIStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GatewayHTTPAPIStatus.

func (*GatewayHTTPAPIStatus) DeepCopyInto 

func (in *GatewayHTTPAPIStatus) DeepCopyInto(out *GatewayHTTPAPIStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type GatewayIngress 

type GatewayIngress struct {
	// Indicates the hostname on which the stack will be served.
	// Example : `formance.example.com`
	//+required
	Host string `json:"host"`
	// Indicate the scheme.
	//
	// Actually, It should be `https` unless you know what you are doing.
	// +kubebuilder:default:="https"
	Scheme string `json:"scheme"`

	// Ingress class to use
	//+optional
	IngressClassName *string `json:"ingressClassName,omitempty"`

	// Custom annotations to add on the ingress
	Annotations map[string]string `json:"annotations,omitempty"`
	// Allow to customize the tls part of the ingress
	//+optional
	TLS *GatewayIngressTLS `json:"tls,omitempty"`
}

func (*GatewayIngress) DeepCopy 

func (in *GatewayIngress) DeepCopy() *GatewayIngress

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GatewayIngress.

func (*GatewayIngress) DeepCopyInto 

func (in *GatewayIngress) DeepCopyInto(out *GatewayIngress)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type GatewayIngressTLS 

type GatewayIngressTLS struct {
	// Specify the secret name used for the tls configuration on the ingress
	SecretName string `json:"secretName"`
}

func (*GatewayIngressTLS) DeepCopy 

func (in *GatewayIngressTLS) DeepCopy() *GatewayIngressTLS

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GatewayIngressTLS.

func (*GatewayIngressTLS) DeepCopyInto 

func (in *GatewayIngressTLS) DeepCopyInto(out *GatewayIngressTLS)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type GatewayList 

type GatewayList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Gateway `json:"items"`
}

GatewayList contains a list of Gateway

func (*GatewayList) DeepCopy 

func (in *GatewayList) DeepCopy() *GatewayList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GatewayList.

func (*GatewayList) DeepCopyInto 

func (in *GatewayList) DeepCopyInto(out *GatewayList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*GatewayList) DeepCopyObject 

func (in *GatewayList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type GatewaySpec 

type GatewaySpec struct {
	StackDependency  `json:",inline"`
	ModuleProperties `json:",inline"`
	//+optional
	// Allow to customize the generated ingress
	Ingress *GatewayIngress `json:"ingress,omitempty"`
}

func (*GatewaySpec) DeepCopy 

func (in *GatewaySpec) DeepCopy() *GatewaySpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GatewaySpec.

func (*GatewaySpec) DeepCopyInto 

func (in *GatewaySpec) DeepCopyInto(out *GatewaySpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type GatewayStatus 

type GatewayStatus struct {
	Status `json:",inline"`
	// Detected http apis. See [GatewayHTTPAPI](#gatewayhttpapi)
	//+optional
	SyncHTTPAPIs []string `json:"syncHTTPAPIs"`
}

func (*GatewayStatus) DeepCopy 

func (in *GatewayStatus) DeepCopy() *GatewayStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GatewayStatus.

func (*GatewayStatus) DeepCopyInto 

func (in *GatewayStatus) DeepCopyInto(out *GatewayStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Ledger 

type Ledger struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   LedgerSpec   `json:"spec,omitempty"`
	Status LedgerStatus `json:"status,omitempty"`
}

Ledger is the module allowing to install a ledger instance.

The ledger is actually a stateful application on the writer part. So we cannot scale the ledger as we want without prior configuration.

So, the ledger can run in two modes : * single instance: Only one instance will be deployed. We cannot scale in that mode. * single writer / multiple reader: In this mode, we will have a single writer and multiple readers if needed.

Use setting `ledger.deployment-strategy` with either the value :

  • single : For the single instance mode.
  • single-writer: For the single writer / multiple reader mode. Under the hood, the operator create two deployments and force the scaling of the writer to stay at 1. Then you can scale the deployment of the reader to the value you want.

+kubebuilder:object:root=true +kubebuilder:subresource:status +kubebuilder:resource:scope=Cluster +kubebuilder:printcolumn:name="Stack",type=string,JSONPath=".spec.stack",description="Stack" +kubebuilder:printcolumn:name="Ready",type=string,JSONPath=".status.ready",description="Is ready" +kubebuilder:printcolumn:name="Info",type=string,JSONPath=".status.info",description="Info" +kubebuilder:printcolumn:name="Version",type=string,JSONPath=".spec.version",description="Version" +kubebuilder:metadata:labels=formance.com/kind=module

func (*Ledger) DeepCopy 

func (in *Ledger) DeepCopy() *Ledger

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Ledger.

func (*Ledger) DeepCopyInto 

func (in *Ledger) DeepCopyInto(out *Ledger)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Ledger) DeepCopyObject 

func (in *Ledger) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Ledger) GetConditions 

func (in *Ledger) GetConditions() *Conditions

func (Ledger) GetStack 

func (a Ledger) GetStack() string

func (*Ledger) GetVersion 

func (in *Ledger) GetVersion() string

func (Ledger) IsDebug 

func (a Ledger) IsDebug() bool

func (Ledger) IsDev 

func (a Ledger) IsDev() bool

func (*Ledger) IsEE 

func (in *Ledger) IsEE() bool

func (*Ledger) IsReady 

func (in *Ledger) IsReady() bool

func (*Ledger) SetError 

func (in *Ledger) SetError(s string)

func (*Ledger) SetReady 

func (in *Ledger) SetReady(b bool)

type LedgerList 

type LedgerList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Ledger `json:"items"`
}

LedgerList contains a list of Ledger

func (*LedgerList) DeepCopy 

func (in *LedgerList) DeepCopy() *LedgerList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LedgerList.

func (*LedgerList) DeepCopyInto 

func (in *LedgerList) DeepCopyInto(out *LedgerList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*LedgerList) DeepCopyObject 

func (in *LedgerList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type LedgerSpec 

type LedgerSpec struct {
	ModuleProperties `json:",inline"`
	StackDependency  `json:",inline"`
	// +optional
	Auth *AuthConfig `json:"auth,omitempty"`
	//+kubebuilder:Enum:={single, single-writer}
	//+kubebuilder:default:=single
	//+optional
	// Deprecated.
	DeploymentStrategy DeploymentStrategy `json:"deploymentStrategy,omitempty"`
	// Locking is intended for ledger v1 only
	//+optional
	Locking *LockingStrategy `json:"locking,omitempty"`
}

func (*LedgerSpec) DeepCopy 

func (in *LedgerSpec) DeepCopy() *LedgerSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LedgerSpec.

func (*LedgerSpec) DeepCopyInto 

func (in *LedgerSpec) DeepCopyInto(out *LedgerSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type LedgerStatus 

type LedgerStatus struct {
	Status `json:",inline"`
}

func (*LedgerStatus) DeepCopy 

func (in *LedgerStatus) DeepCopy() *LedgerStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LedgerStatus.

func (*LedgerStatus) DeepCopyInto 

func (in *LedgerStatus) DeepCopyInto(out *LedgerStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type LockingStrategy 

type LockingStrategy struct {
	// +kubebuilder:Enum:={memory,redis}
	// +kubebuilder:default:=memory
	// +optional
	Strategy string `json:"strategy,omitempty"`
	// +optional
	Redis *LockingStrategyRedisConfig `json:"redis"`
}

func (*LockingStrategy) DeepCopy 

func (in *LockingStrategy) DeepCopy() *LockingStrategy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LockingStrategy.

func (*LockingStrategy) DeepCopyInto 

func (in *LockingStrategy) DeepCopyInto(out *LockingStrategy)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type LockingStrategyRedisConfig 

type LockingStrategyRedisConfig struct {
	Uri string `json:"uri,omitempty"`
	// +optional
	// +kubebuilder:default:=false
	TLS bool `json:"tls"`
	// +optional
	// +kubebuilder:default:=false
	InsecureTLS bool `json:"insecure,omitempty"`
	// +optional
	Duration time.Duration `json:"duration,omitempty"`
	// +optional
	Retry time.Duration `json:"retry,omitempty"`
}

func (*LockingStrategyRedisConfig) DeepCopy 

func (in *LockingStrategyRedisConfig) DeepCopy() *LockingStrategyRedisConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LockingStrategyRedisConfig.

func (*LockingStrategyRedisConfig) DeepCopyInto 

func (in *LockingStrategyRedisConfig) DeepCopyInto(out *LockingStrategyRedisConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Mode 

type Mode string

Mode defined how streams are created on the broker (mainly nats)

type Module 

type Module interface {
	Dependent
	GetVersion() string
	IsDebug() bool
	IsDev() bool
	IsEE() bool
}

+kubebuilder:object:generate=false

type ModuleProperties 

type ModuleProperties struct {
	DevProperties `json:",inline"`
	//+optional
	// Version allow to override global version defined at stack level for a specific module
	Version string `json:"version,omitempty"`
}

func (*ModuleProperties) CompareVersion 

func (in *ModuleProperties) CompareVersion(stack *Stack, version string) int

func (*ModuleProperties) DeepCopy 

func (in *ModuleProperties) DeepCopy() *ModuleProperties

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ModuleProperties.

func (*ModuleProperties) DeepCopyInto 

func (in *ModuleProperties) DeepCopyInto(out *ModuleProperties)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Object 

type Object interface {
	client.Object
	SetReady(bool)
	IsReady() bool
	SetError(string)
	GetConditions() *Conditions
}

+kubebuilder:object:generate=false

type Orchestration 

type Orchestration struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   OrchestrationSpec   `json:"spec,omitempty"`
	Status OrchestrationStatus `json:"status,omitempty"`
}

Orchestration is the Schema for the orchestrations API

func (*Orchestration) DeepCopy 

func (in *Orchestration) DeepCopy() *Orchestration

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Orchestration.

func (*Orchestration) DeepCopyInto 

func (in *Orchestration) DeepCopyInto(out *Orchestration)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Orchestration) DeepCopyObject 

func (in *Orchestration) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Orchestration) GetConditions 

func (in *Orchestration) GetConditions() *Conditions

func (Orchestration) GetStack 

func (a Orchestration) GetStack() string

func (*Orchestration) GetVersion 

func (in *Orchestration) GetVersion() string

func (Orchestration) IsDebug 

func (a Orchestration) IsDebug() bool

func (Orchestration) IsDev 

func (a Orchestration) IsDev() bool

func (*Orchestration) IsEE 

func (in *Orchestration) IsEE() bool

func (*Orchestration) IsReady 

func (in *Orchestration) IsReady() bool

func (*Orchestration) SetError 

func (in *Orchestration) SetError(s string)

func (*Orchestration) SetReady 

func (in *Orchestration) SetReady(b bool)

type OrchestrationList 

type OrchestrationList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Orchestration `json:"items"`
}

OrchestrationList contains a list of Orchestration

func (*OrchestrationList) DeepCopy 

func (in *OrchestrationList) DeepCopy() *OrchestrationList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OrchestrationList.

func (*OrchestrationList) DeepCopyInto 

func (in *OrchestrationList) DeepCopyInto(out *OrchestrationList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*OrchestrationList) DeepCopyObject 

func (in *OrchestrationList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type OrchestrationSpec 

type OrchestrationSpec struct {
	StackDependency  `json:",inline"`
	ModuleProperties `json:",inline"`
	// +optional
	Auth *AuthConfig `json:"auth,omitempty"`
}

func (*OrchestrationSpec) DeepCopy 

func (in *OrchestrationSpec) DeepCopy() *OrchestrationSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OrchestrationSpec.

func (*OrchestrationSpec) DeepCopyInto 

func (in *OrchestrationSpec) DeepCopyInto(out *OrchestrationSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type OrchestrationStatus 

type OrchestrationStatus struct {
	Status `json:",inline"`
	//+optional
	TemporalURI *URI `json:"temporalURI,omitempty"`
}

func (*OrchestrationStatus) DeepCopy 

func (in *OrchestrationStatus) DeepCopy() *OrchestrationStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OrchestrationStatus.

func (*OrchestrationStatus) DeepCopyInto 

func (in *OrchestrationStatus) DeepCopyInto(out *OrchestrationStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Payments 

type Payments struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   PaymentsSpec   `json:"spec,omitempty"`
	Status PaymentsStatus `json:"status,omitempty"`
}

+kubebuilder:object:root=true +kubebuilder:subresource:status +kubebuilder:resource:scope=Cluster +kubebuilder:printcolumn:name="Stack",type=string,JSONPath=".spec.stack",description="Stack" +kubebuilder:printcolumn:name="Ready",type=string,JSONPath=".status.ready",description="Is ready" +kubebuilder:printcolumn:name="Info",type=string,JSONPath=".status.info",description="Info" +kubebuilder:printcolumn:name="Version",type=string,JSONPath=".spec.version",description="Version" +kubebuilder:metadata:labels=formance.com/kind=module Payments is the Schema for the payments API

func (*Payments) DeepCopy 

func (in *Payments) DeepCopy() *Payments

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Payments.

func (*Payments) DeepCopyInto 

func (in *Payments) DeepCopyInto(out *Payments)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Payments) DeepCopyObject 

func (in *Payments) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Payments) GetConditions 

func (in *Payments) GetConditions() *Conditions

func (Payments) GetStack 

func (in Payments) GetStack() string

func (*Payments) GetVersion 

func (in *Payments) GetVersion() string

func (Payments) IsDebug 

func (in Payments) IsDebug() bool

func (Payments) IsDev 

func (in Payments) IsDev() bool

func (*Payments) IsEE 

func (in *Payments) IsEE() bool

func (*Payments) IsReady 

func (in *Payments) IsReady() bool

func (*Payments) SetError 

func (in *Payments) SetError(s string)

func (*Payments) SetReady 

func (in *Payments) SetReady(b bool)

type PaymentsList 

type PaymentsList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Payments `json:"items"`
}

PaymentsList contains a list of Payments

func (*PaymentsList) DeepCopy 

func (in *PaymentsList) DeepCopy() *PaymentsList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PaymentsList.

func (*PaymentsList) DeepCopyInto 

func (in *PaymentsList) DeepCopyInto(out *PaymentsList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*PaymentsList) DeepCopyObject 

func (in *PaymentsList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type PaymentsSpec 

type PaymentsSpec struct {
	StackDependency  `json:",inline"`
	ModuleProperties `json:",inline"`
	// +optional
	EncryptionKey string `json:"encryptionKey"`
	// +optional
	Auth *AuthConfig `json:"auth,omitempty"`
}

func (*PaymentsSpec) DeepCopy 

func (in *PaymentsSpec) DeepCopy() *PaymentsSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PaymentsSpec.

func (*PaymentsSpec) DeepCopyInto 

func (in *PaymentsSpec) DeepCopyInto(out *PaymentsSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PaymentsStatus 

type PaymentsStatus struct {
	Status `json:",inline"`
}

func (*PaymentsStatus) DeepCopy 

func (in *PaymentsStatus) DeepCopy() *PaymentsStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PaymentsStatus.

func (*PaymentsStatus) DeepCopyInto 

func (in *PaymentsStatus) DeepCopyInto(out *PaymentsStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Reconciliation 

type Reconciliation struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   ReconciliationSpec   `json:"spec,omitempty"`
	Status ReconciliationStatus `json:"status,omitempty"`
}

Reconciliation is the Schema for the reconciliations API

func (*Reconciliation) DeepCopy 

func (in *Reconciliation) DeepCopy() *Reconciliation

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Reconciliation.

func (*Reconciliation) DeepCopyInto 

func (in *Reconciliation) DeepCopyInto(out *Reconciliation)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Reconciliation) DeepCopyObject 

func (in *Reconciliation) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Reconciliation) GetConditions 

func (in *Reconciliation) GetConditions() *Conditions

func (Reconciliation) GetStack 

func (a Reconciliation) GetStack() string

func (*Reconciliation) GetVersion 

func (in *Reconciliation) GetVersion() string

func (Reconciliation) IsDebug 

func (a Reconciliation) IsDebug() bool

func (Reconciliation) IsDev 

func (a Reconciliation) IsDev() bool

func (*Reconciliation) IsEE 

func (in *Reconciliation) IsEE() bool

func (*Reconciliation) IsReady 

func (in *Reconciliation) IsReady() bool

func (*Reconciliation) SetError 

func (in *Reconciliation) SetError(s string)

func (*Reconciliation) SetReady 

func (in *Reconciliation) SetReady(b bool)

type ReconciliationList 

type ReconciliationList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Reconciliation `json:"items"`
}

ReconciliationList contains a list of Reconciliation

func (*ReconciliationList) DeepCopy 

func (in *ReconciliationList) DeepCopy() *ReconciliationList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ReconciliationList.

func (*ReconciliationList) DeepCopyInto 

func (in *ReconciliationList) DeepCopyInto(out *ReconciliationList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ReconciliationList) DeepCopyObject 

func (in *ReconciliationList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ReconciliationSpec 

type ReconciliationSpec struct {
	StackDependency  `json:",inline"`
	ModuleProperties `json:",inline"`
	// +optional
	Auth *AuthConfig `json:"auth,omitempty"`
}

func (*ReconciliationSpec) DeepCopy 

func (in *ReconciliationSpec) DeepCopy() *ReconciliationSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ReconciliationSpec.

func (*ReconciliationSpec) DeepCopyInto 

func (in *ReconciliationSpec) DeepCopyInto(out *ReconciliationSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ReconciliationStatus 

type ReconciliationStatus struct {
	Status `json:",inline"`
}

func (*ReconciliationStatus) DeepCopy 

func (in *ReconciliationStatus) DeepCopy() *ReconciliationStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ReconciliationStatus.

func (*ReconciliationStatus) DeepCopyInto 

func (in *ReconciliationStatus) DeepCopyInto(out *ReconciliationStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Resource 

type Resource interface {
	Dependent
	// contains filtered or unexported methods
}

+kubebuilder:object:generate=false

type ResourceReference 

type ResourceReference struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   ResourceReferenceSpec   `json:"spec,omitempty"`
	Status ResourceReferenceStatus `json:"status,omitempty"`
}

ResourceReference is a special resources used to refer to externally created resources.

It includes k8s service accounts and secrets.

Why? Because the operator create a namespace by stack, so, a stack does not have access to secrets and service accounts created externally.

A ResourceReference is created by other resource who need to use a specific secret or service account. For example, if you want to use a secret for your database connection (see Database(#database), you will create a setting indicating a secret name. You will need to create this secret yourself, and you will put this secret inside the namespace you want (`default` maybe).

The Database reconciler will create a ResourceReference looking like that : ``` apiVersion: formance.com/v1beta1 kind: ResourceReference metadata: 

name: jqkuffjxcezj-qlii-auth-postgres
ownerReferences:
- apiVersion: formance.com/v1beta1
  blockOwnerDeletion: true
  controller: true
  kind: Database
  name: jqkuffjxcezj-qlii-auth
  uid: 2cc4b788-3ffb-4e3d-8a30-07ed3941c8d2

spec: 

gvk:
  group: ""
  kind: Secret
  version: v1
name: postgres
stack: jqkuffjxcezj-qlii

status: 

...

``` This reconciler behind this ResourceReference will search, in all namespaces, for a secret named "postgres". The secret must have a label `formance.com/stack` with the value matching either a specific stack or `any` to target any stack.

Once the reconciler has found the secret, it will copy it inside the stack namespace, allowing the ResourceReconciler owner to use it. +kubebuilder:object:root=true +kubebuilder:subresource:status +kubebuilder:resource:scope=Cluster +kubebuilder:printcolumn:name="Info",type=string,JSONPath=".status.info",description="Info" +kubebuilder:printcolumn:name="Ready",type=string,JSONPath=".status.ready",description="Is ready"

func (*ResourceReference) DeepCopy 

func (in *ResourceReference) DeepCopy() *ResourceReference

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceReference.

func (*ResourceReference) DeepCopyInto 

func (in *ResourceReference) DeepCopyInto(out *ResourceReference)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ResourceReference) DeepCopyObject 

func (in *ResourceReference) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*ResourceReference) GetConditions 

func (in *ResourceReference) GetConditions() *Conditions

func (*ResourceReference) GetStack 

func (in *ResourceReference) GetStack() string

func (*ResourceReference) IsReady 

func (in *ResourceReference) IsReady() bool

func (*ResourceReference) SetError 

func (in *ResourceReference) SetError(s string)

func (*ResourceReference) SetReady 

func (in *ResourceReference) SetReady(b bool)

type ResourceReferenceList 

type ResourceReferenceList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []ResourceReference `json:"items"`
}

ResourceReferenceList contains a list of ResourceReference

func (*ResourceReferenceList) DeepCopy 

func (in *ResourceReferenceList) DeepCopy() *ResourceReferenceList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceReferenceList.

func (*ResourceReferenceList) DeepCopyInto 

func (in *ResourceReferenceList) DeepCopyInto(out *ResourceReferenceList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ResourceReferenceList) DeepCopyObject 

func (in *ResourceReferenceList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ResourceReferenceSpec 

type ResourceReferenceSpec struct {
	StackDependency  `json:",inline"`
	GroupVersionKind *metav1.GroupVersionKind `json:"gvk"`
	Name             string                   `json:"name"`
}

func (*ResourceReferenceSpec) DeepCopy 

func (in *ResourceReferenceSpec) DeepCopy() *ResourceReferenceSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceReferenceSpec.

func (*ResourceReferenceSpec) DeepCopyInto 

func (in *ResourceReferenceSpec) DeepCopyInto(out *ResourceReferenceSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ResourceReferenceStatus 

type ResourceReferenceStatus struct {
	Status `json:",inline"`
	//+optional
	SyncedResource string `json:"syncedResource,omitempty"`
	//+optional
	Hash string `json:"hash,omitempty"`
}

func (*ResourceReferenceStatus) DeepCopy 

func (in *ResourceReferenceStatus) DeepCopy() *ResourceReferenceStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceReferenceStatus.

func (*ResourceReferenceStatus) DeepCopyInto 

func (in *ResourceReferenceStatus) DeepCopyInto(out *ResourceReferenceStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. 

type Search struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   SearchSpec   `json:"spec,omitempty"`
	Status SearchStatus `json:"status,omitempty"`
}

+kubebuilder:object:root=true +kubebuilder:subresource:status +kubebuilder:resource:scope=Cluster +kubebuilder:printcolumn:name="Stack",type=string,JSONPath=".spec.stack",description="Stack" +kubebuilder:printcolumn:name="Ready",type=string,JSONPath=".status.ready",description="Is ready" +kubebuilder:printcolumn:name="Info",type=string,JSONPath=".status.info",description="Info" +kubebuilder:printcolumn:name="Version",type=string,JSONPath=".spec.version",description="Version" +kubebuilder:metadata:labels=formance.com/kind=module +kubebuilder:metadata:labels=formance.com/is-ee=true Search is the Schema for the searches API

func (*Search) DeepCopy 

func (in *Search) DeepCopy() *Search

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Search.

func (*Search) DeepCopyInto 

func (in *Search) DeepCopyInto(out *Search)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Search) DeepCopyObject 

func (in *Search) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Search) GetConditions 

func (in *Search) GetConditions() *Conditions

func (Search) GetStack 

func (a Search) GetStack() string

func (*Search) GetVersion 

func (in *Search) GetVersion() string

func (Search) IsDebug 

func (a Search) IsDebug() bool

func (Search) IsDev 

func (a Search) IsDev() bool

func (*Search) IsEE 

func (in *Search) IsEE() bool

func (*Search) IsReady 

func (in *Search) IsReady() bool

func (*Search) SetError 

func (in *Search) SetError(s string)

func (*Search) SetReady 

func (in *Search) SetReady(b bool)

type SearchList 

type SearchList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Search `json:"items"`
}

SearchList contains a list of Search

func (*SearchList) DeepCopy 

func (in *SearchList) DeepCopy() *SearchList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SearchList.

func (*SearchList) DeepCopyInto 

func (in *SearchList) DeepCopyInto(out *SearchList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*SearchList) DeepCopyObject 

func (in *SearchList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type SearchSpec 

type SearchSpec struct {
	StackDependency  `json:",inline"`
	ModuleProperties `json:",inline"`
	//+optional
	Batching *Batching `json:"batching,omitempty"`
	// +optional
	Auth *AuthConfig `json:"auth,omitempty"`
}

func (*SearchSpec) DeepCopy 

func (in *SearchSpec) DeepCopy() *SearchSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SearchSpec.

func (*SearchSpec) DeepCopyInto 

func (in *SearchSpec) DeepCopyInto(out *SearchSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SearchStatus 

type SearchStatus struct {
	Status `json:",inline"`
	//+optional
	ElasticSearchURI *URI `json:"elasticSearchURI,omitempty"`
	// TopicCleaned is used to flag stacks where the topics have been cleaned (still search-ledgerv2 and co consumers)
	//+optional
	// +kubebuilder:default:=false
	TopicCleaned bool `json:"topicCleaned,omitempty"`
}

func (*SearchStatus) DeepCopy 

func (in *SearchStatus) DeepCopy() *SearchStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SearchStatus.

func (*SearchStatus) DeepCopyInto 

func (in *SearchStatus) DeepCopyInto(out *SearchStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Settings 

type Settings struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec SettingsSpec `json:"spec,omitempty"`
}

Settings represents a configurable piece of the stacks.

The purpose of this resource is to be able to configure some common settings between a set of stacks.

Example : ```yaml apiVersion: formance.com/v1beta1 kind: Settings metadata: 

name: postgres-uri

spec: 

key: postgres.ledger.uri
stacks:
- stack0
value: postgresql://postgresql.formance.svc.cluster.local:5432

```

This example create a setting named `postgres-uri` targeting the stack named `stack0` and the service `ledger` (see the key `postgres.ledger.uri`).

Therefore, a Database(#database) created for the stack `stack0` and the service named 'ledger' will use the uri `postgresql://postgresql.formance.svc.cluster.local:5432`.

Settings allow to use wildcards in keys and in stacks list.

For example, if you want to use the same database server for all the modules of a specific stack, you can write : ```yaml apiVersion: formance.com/v1beta1 kind: Settings metadata: 

name: postgres-uri

spec: 

key: postgres.*.uri # There, we use a wildcard to indicate we want to use that setting of all services of the stack `stack0`
stacks:
- stack0
value: postgresql://postgresql.formance.svc.cluster.local:5432

```

Also, we could use that setting for all of our stacks using : ```yaml apiVersion: formance.com/v1beta1 kind: Settings metadata: 

name: postgres-uri

spec: 

key: postgres.*.uri # There, we use a wildcard to indicate we want to use that setting for all services of all stacks
stacks:
- * # There we select all the stacks
value: postgresql://postgresql.formance.svc.cluster.local:5432

```

Some settings are really global, while some are used by specific module.

Refer to the documentation of each module and resource to discover available Settings.

##### Global settings ###### AWS account

A stack can use an AWS account for authentication.

It can be used to connect to any AWS service we could use.

It includes RDS, OpenSearch and MSK. To do so, you can create the following setting: ```yaml apiVersion: formance.com/v1beta1 kind: Settings metadata: 

name: aws-service-account

spec: 

key: aws.service-account
stacks:
- '*'
value: aws-access

``` This setting instruct the operator than there is somewhere on the cluster a service account named `aws-access`.

So, each time a service has the capability to use AWS, the operator will use this service account.

The service account could look like that : ```yaml apiVersion: v1 kind: ServiceAccount metadata: 

annotations:
  eks.amazonaws.com/role-arn: arn:aws:iam::************:role/staging-eu-west-1-hosting-stack-access
labels:
  formance.com/stack: any
name: aws-access

``` You can note two things :

  1. We have an annotation indicating the role arn used to connect to AWS. Refer to the AWS documentation to create this role
  2. We have a label `formance.com/stack=any` indicating we are targeting all stacks. Refer to the documentation of ResourceReference(#resourcereference) for further information.

###### JSON logging

You can use the setting `logging.json` with the value `true` to configure elligible service to log as json. Example: ```yaml apiVersion: formance.com/v1beta1 kind: Settings metadata: 

name: json-logging

spec: 

key: logging.json
stacks:
- '*'
value: "true"

``` +kubebuilder:object:root=true +kubebuilder:subresource:status +kubebuilder:resource:scope=Cluster +kubebuilder:printcolumn:name="Key",type=string,JSONPath=".spec.key",description="Key" +kubebuilder:printcolumn:name="Value",type=string,JSONPath=".spec.value",description="Value"

func (*Settings) DeepCopy 

func (in *Settings) DeepCopy() *Settings

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Settings.

func (*Settings) DeepCopyInto 

func (in *Settings) DeepCopyInto(out *Settings)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Settings) DeepCopyObject 

func (in *Settings) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Settings) GetStacks 

func (in *Settings) GetStacks() []string

func (*Settings) IsWildcard 

func (in *Settings) IsWildcard() bool

type SettingsList 

type SettingsList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Settings `json:"items"`
}

SettingsList contains a list of Settings

func (*SettingsList) DeepCopy 

func (in *SettingsList) DeepCopy() *SettingsList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SettingsList.

func (*SettingsList) DeepCopyInto 

func (in *SettingsList) DeepCopyInto(out *SettingsList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*SettingsList) DeepCopyObject 

func (in *SettingsList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type SettingsSpec 

type SettingsSpec struct {
	//+optional
	// Stacks on which the setting is applied. Can contain `*` to indicate a wildcard.
	Stacks []string `json:"stacks,omitempty"`
	// The setting Key. See the documentation of each module or [global settings](#global-settings) to discover them.
	Key string `json:"key"`
	// The value. It must have a specific format following the Key.
	Value string `json:"value"`
}

func (*SettingsSpec) DeepCopy 

func (in *SettingsSpec) DeepCopy() *SettingsSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SettingsSpec.

func (*SettingsSpec) DeepCopyInto 

func (in *SettingsSpec) DeepCopyInto(out *SettingsSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Stack 

type Stack struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   StackSpec   `json:"spec,omitempty"`
	Status StackStatus `json:"status,omitempty"`
}

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](#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(#versions) resource.

The `version` field will have priority over `versionFromFile`.

If `versions` and `versionsFromFile` are not specified, "latest" will be used.

func (*Stack) DeepCopy 

func (in *Stack) DeepCopy() *Stack

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Stack.

func (*Stack) DeepCopyInto 

func (in *Stack) DeepCopyInto(out *Stack)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Stack) DeepCopyObject 

func (in *Stack) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Stack) GetConditions 

func (in *Stack) GetConditions() *Conditions

func (*Stack) GetVersion 

func (in *Stack) GetVersion() string

func (*Stack) IsReady 

func (in *Stack) IsReady() bool

func (*Stack) MustSkip 

func (in *Stack) MustSkip() bool

func (*Stack) SetError 

func (in *Stack) SetError(s string)

func (*Stack) SetReady 

func (in *Stack) SetReady(b bool)

type StackDependency 

type StackDependency struct {
	// Stack indicates the stack on which the module is installed
	Stack string `json:"stack,omitempty" yaml:"-"`
}

func (*StackDependency) DeepCopy 

func (in *StackDependency) DeepCopy() *StackDependency

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StackDependency.

func (*StackDependency) DeepCopyInto 

func (in *StackDependency) DeepCopyInto(out *StackDependency)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (StackDependency) GetStack 

func (d StackDependency) GetStack() string

type StackList 

type StackList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Stack `json:"items"`
}

StackList contains a list of Stack

func (*StackList) DeepCopy 

func (in *StackList) DeepCopy() *StackList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StackList.

func (*StackList) DeepCopyInto 

func (in *StackList) DeepCopyInto(out *StackList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*StackList) DeepCopyObject 

func (in *StackList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type StackSpec 

type StackSpec struct {
	DevProperties `json:",inline"`
	// +optional
	// Version allow to specify the version of the components
	// Must be a valid docker tag
	Version string `json:"version,omitempty"`
	// +optional
	// VersionsFromFile allow to specify a formance.com/Versions object which contains individual versions
	// for each component.
	// Must reference a valid formance.com/Versions object
	VersionsFromFile string `json:"versionsFromFile"`
	// +optional
	// +kubebuilder:default:=false
	// EnableAudit enable audit at the stack level.
	// Actually, it enables audit on [Gateway](#gateway)
	EnableAudit bool `json:"enableAudit,omitempty"`
	// +optional
	// +kubebuilder:default:=false
	// Disabled indicate the stack is disabled.
	// A disabled stack disable everything
	// It just keeps the namespace and the [Database](#database) resources.
	Disabled bool `json:"disabled"`
}

func (*StackSpec) DeepCopy 

func (in *StackSpec) DeepCopy() *StackSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StackSpec.

func (*StackSpec) DeepCopyInto 

func (in *StackSpec) DeepCopyInto(out *StackSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type StackStatus 

type StackStatus struct {
	Status `json:",inline"`
	// Modules register detected modules
	Modules []string `json:"modules,omitempty"`
}

func (*StackStatus) DeepCopy 

func (in *StackStatus) DeepCopy() *StackStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StackStatus.

func (*StackStatus) DeepCopyInto 

func (in *StackStatus) DeepCopyInto(out *StackStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Stargate 

type Stargate struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   StargateSpec   `json:"spec,omitempty"`
	Status StargateStatus `json:"status,omitempty"`
}

+kubebuilder:object:root=true +kubebuilder:subresource:status +kubebuilder:resource:scope=Cluster +kubebuilder:printcolumn:name="Stack",type=string,JSONPath=".spec.stack",description="Stack" +kubebuilder:printcolumn:name="Ready",type=string,JSONPath=".status.ready",description="Is ready" +kubebuilder:printcolumn:name="Info",type=string,JSONPath=".status.info",description="Info" +kubebuilder:printcolumn:name="Version",type=string,JSONPath=".spec.version",description="Version" +kubebuilder:metadata:labels=formance.com/kind=module Stargate is the Schema for the stargates API

func (*Stargate) DeepCopy 

func (in *Stargate) DeepCopy() *Stargate

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Stargate.

func (*Stargate) DeepCopyInto 

func (in *Stargate) DeepCopyInto(out *Stargate)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Stargate) DeepCopyObject 

func (in *Stargate) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Stargate) GetConditions 

func (in *Stargate) GetConditions() *Conditions

func (Stargate) GetStack 

func (s Stargate) GetStack() string

func (*Stargate) GetVersion 

func (in *Stargate) GetVersion() string

func (Stargate) IsDebug 

func (a Stargate) IsDebug() bool

func (Stargate) IsDev 

func (a Stargate) IsDev() bool

func (*Stargate) IsEE 

func (in *Stargate) IsEE() bool

func (*Stargate) IsReady 

func (in *Stargate) IsReady() bool

func (*Stargate) SetError 

func (in *Stargate) SetError(s string)

func (*Stargate) SetReady 

func (in *Stargate) SetReady(b bool)

type StargateAuthSpec 

type StargateAuthSpec struct {
	ClientID     string `json:"clientID"`
	ClientSecret string `json:"clientSecret"`
	Issuer       string `json:"issuer"`
}

func (*StargateAuthSpec) DeepCopy 

func (in *StargateAuthSpec) DeepCopy() *StargateAuthSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StargateAuthSpec.

func (*StargateAuthSpec) DeepCopyInto 

func (in *StargateAuthSpec) DeepCopyInto(out *StargateAuthSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type StargateList 

type StargateList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Stargate `json:"items"`
}

StargateList contains a list of Stargate

func (*StargateList) DeepCopy 

func (in *StargateList) DeepCopy() *StargateList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StargateList.

func (*StargateList) DeepCopyInto 

func (in *StargateList) DeepCopyInto(out *StargateList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*StargateList) DeepCopyObject 

func (in *StargateList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type StargateSpec 

type StargateSpec struct {
	ModuleProperties `json:",inline"`
	StackDependency  `json:",inline"`
	ServerURL        string           `json:"serverURL"`
	OrganizationID   string           `json:"organizationID"`
	StackID          string           `json:"stackID"`
	Auth             StargateAuthSpec `json:"auth"`
}

func (*StargateSpec) DeepCopy 

func (in *StargateSpec) DeepCopy() *StargateSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StargateSpec.

func (*StargateSpec) DeepCopyInto 

func (in *StargateSpec) DeepCopyInto(out *StargateSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type StargateStatus 

type StargateStatus struct {
	Status `json:",inline"`
}

StargateStatus defines the observed state of Stargate

func (*StargateStatus) DeepCopy 

func (in *StargateStatus) DeepCopy() *StargateStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StargateStatus.

func (*StargateStatus) DeepCopyInto 

func (in *StargateStatus) DeepCopyInto(out *StargateStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Status 

type Status struct {
	//+optional
	// Ready indicates if the resource is seen as completely reconciled
	Ready bool `json:"ready"`
	//+optional
	// Info can contain any additional like reconciliation errors
	Info string `json:"info,omitempty"`
	//+optional
	Conditions Conditions `json:"conditions,omitempty"`
}

func (*Status) DeepCopy 

func (in *Status) DeepCopy() *Status

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Status.

func (*Status) DeepCopyInto 

func (in *Status) DeepCopyInto(out *Status)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Status) SetError 

func (c *Status) SetError(err string)

func (*Status) SetReady 

func (c *Status) SetReady(ready bool)

type URI 

type URI struct {
	*url.URL `json:"-"`
}

+k8s:openapi-gen=true +kubebuilder:validation:Type=string

func ParseURL 

func ParseURL(v string) (*URI, error)

func (*URI) DeepCopy 

func (in *URI) DeepCopy() *URI

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new URI.

func (*URI) DeepCopyInto 

func (u *URI) DeepCopyInto(v *URI)

func (URI) IsZero 

func (u URI) IsZero() bool

func (*URI) MarshalJSON 

func (u *URI) MarshalJSON() ([]byte, error)

func (URI) String 

func (u URI) String() string

func (*URI) UnmarshalJSON 

func (u *URI) UnmarshalJSON(data []byte) error

func (*URI) WithoutQuery 

func (in *URI) WithoutQuery() *URI

type Versions 

type Versions struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec map[string]string `json:"spec,omitempty"`
}

Versions is the Schema for the versions API

func (*Versions) DeepCopy 

func (in *Versions) DeepCopy() *Versions

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Versions.

func (*Versions) DeepCopyInto 

func (in *Versions) DeepCopyInto(out *Versions)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Versions) DeepCopyObject 

func (in *Versions) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type VersionsList 

type VersionsList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Versions `json:"items"`
}

VersionsList contains a list of Versions

func (*VersionsList) DeepCopy 

func (in *VersionsList) DeepCopy() *VersionsList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VersionsList.

func (*VersionsList) DeepCopyInto 

func (in *VersionsList) DeepCopyInto(out *VersionsList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*VersionsList) DeepCopyObject 

func (in *VersionsList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type Wallets 

type Wallets struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   WalletsSpec   `json:"spec,omitempty"`
	Status WalletsStatus `json:"status,omitempty"`
}

+kubebuilder:object:root=true +kubebuilder:subresource:status +kubebuilder:resource:scope=Cluster +kubebuilder:printcolumn:name="Stack",type=string,JSONPath=".spec.stack",description="Stack" +kubebuilder:printcolumn:name="Ready",type=string,JSONPath=".status.ready",description="Is ready" +kubebuilder:printcolumn:name="Info",type=string,JSONPath=".status.info",description="Info" +kubebuilder:printcolumn:name="Version",type=string,JSONPath=".spec.version",description="Version" +kubebuilder:metadata:labels=formance.com/kind=module +kubebuilder:metadata:labels=formance.com/is-ee=true Wallets is the Schema for the wallets API

func (*Wallets) DeepCopy 

func (in *Wallets) DeepCopy() *Wallets

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Wallets.

func (*Wallets) DeepCopyInto 

func (in *Wallets) DeepCopyInto(out *Wallets)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Wallets) DeepCopyObject 

func (in *Wallets) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Wallets) GetConditions 

func (in *Wallets) GetConditions() *Conditions

func (Wallets) GetStack 

func (a Wallets) GetStack() string

func (*Wallets) GetVersion 

func (in *Wallets) GetVersion() string

func (Wallets) IsDebug 

func (a Wallets) IsDebug() bool

func (Wallets) IsDev 

func (a Wallets) IsDev() bool

func (*Wallets) IsEE 

func (in *Wallets) IsEE() bool

func (*Wallets) IsReady 

func (in *Wallets) IsReady() bool

func (*Wallets) SetError 

func (in *Wallets) SetError(s string)

func (*Wallets) SetReady 

func (in *Wallets) SetReady(b bool)

type WalletsList 

type WalletsList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Wallets `json:"items"`
}

WalletsList contains a list of Wallets

func (*WalletsList) DeepCopy 

func (in *WalletsList) DeepCopy() *WalletsList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WalletsList.

func (*WalletsList) DeepCopyInto 

func (in *WalletsList) DeepCopyInto(out *WalletsList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*WalletsList) DeepCopyObject 

func (in *WalletsList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type WalletsSpec 

type WalletsSpec struct {
	ModuleProperties `json:",inline"`
	StackDependency  `json:",inline"`
	// +optional
	Auth *AuthConfig `json:"auth,omitempty"`
}

func (*WalletsSpec) DeepCopy 

func (in *WalletsSpec) DeepCopy() *WalletsSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WalletsSpec.

func (*WalletsSpec) DeepCopyInto 

func (in *WalletsSpec) DeepCopyInto(out *WalletsSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type WalletsStatus 

type WalletsStatus struct {
	Status `json:",inline"`
}

WalletsStatus defines the observed state of Wallets

func (*WalletsStatus) DeepCopy 

func (in *WalletsStatus) DeepCopy() *WalletsStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WalletsStatus.

func (*WalletsStatus) DeepCopyInto 

func (in *WalletsStatus) DeepCopyInto(out *WalletsStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Webhooks 

type Webhooks struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   WebhooksSpec   `json:"spec,omitempty"`
	Status WebhooksStatus `json:"status,omitempty"`
}

+kubebuilder:object:root=true +kubebuilder:subresource:status +kubebuilder:resource:scope=Cluster +kubebuilder:printcolumn:name="Stack",type=string,JSONPath=".spec.stack",description="Stack" +kubebuilder:printcolumn:name="Ready",type=string,JSONPath=".status.ready",description="Is ready" +kubebuilder:printcolumn:name="Info",type=string,JSONPath=".status.info",description="Info" +kubebuilder:printcolumn:name="Version",type=string,JSONPath=".spec.version",description="Version" +kubebuilder:metadata:labels=formance.com/kind=module +kubebuilder:metadata:labels=formance.com/is-ee=true Webhooks is the Schema for the webhooks API

func (*Webhooks) DeepCopy 

func (in *Webhooks) DeepCopy() *Webhooks

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Webhooks.

func (*Webhooks) DeepCopyInto 

func (in *Webhooks) DeepCopyInto(out *Webhooks)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Webhooks) DeepCopyObject 

func (in *Webhooks) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Webhooks) GetConditions 

func (in *Webhooks) GetConditions() *Conditions

func (Webhooks) GetStack 

func (a Webhooks) GetStack() string

func (*Webhooks) GetVersion 

func (in *Webhooks) GetVersion() string

func (Webhooks) IsDebug 

func (a Webhooks) IsDebug() bool

func (Webhooks) IsDev 

func (a Webhooks) IsDev() bool

func (*Webhooks) IsEE 

func (in *Webhooks) IsEE() bool

func (*Webhooks) IsReady 

func (in *Webhooks) IsReady() bool

func (*Webhooks) SetError 

func (in *Webhooks) SetError(s string)

func (*Webhooks) SetReady 

func (in *Webhooks) SetReady(b bool)

type WebhooksList 

type WebhooksList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Webhooks `json:"items"`
}

WebhooksList contains a list of Webhooks

func (*WebhooksList) DeepCopy 

func (in *WebhooksList) DeepCopy() *WebhooksList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WebhooksList.

func (*WebhooksList) DeepCopyInto 

func (in *WebhooksList) DeepCopyInto(out *WebhooksList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*WebhooksList) DeepCopyObject 

func (in *WebhooksList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type WebhooksSpec 

type WebhooksSpec struct {
	StackDependency  `json:",inline"`
	ModuleProperties `json:",inline"`
	// +optional
	Auth *AuthConfig `json:"auth,omitempty"`
}

func (*WebhooksSpec) DeepCopy 

func (in *WebhooksSpec) DeepCopy() *WebhooksSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WebhooksSpec.

func (*WebhooksSpec) DeepCopyInto 

func (in *WebhooksSpec) DeepCopyInto(out *WebhooksSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type WebhooksStatus 

type WebhooksStatus struct {
	Status `json:",inline"`
}

func (*WebhooksStatus) DeepCopy 

func (in *WebhooksStatus) DeepCopy() *WebhooksStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WebhooksStatus.

func (*WebhooksStatus) DeepCopyInto 

func (in *WebhooksStatus) DeepCopyInto(out *WebhooksStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.