feat(connectivity): add Connectivity module bound to the stack ledger

.gitignore

@@ -31,3 +31,6 @@ charts
 
 # E2E test artifacts
 tests/e2e/artifacts/
+
+# Local scratch files
+tmp/

Dockerfile

@@ -0,0 +1,34 @@
+FROM golang:1.26-alpine AS builder
+
+RUN apk add --no-cache git
+
+WORKDIR /src
+
+COPY go.mod go.sum ./
+RUN go mod download
+
+COPY . .
+
+ARG VERSION=latest
+ARG COMMIT=unknown
+ARG LICENCE_PUBLIC_KEY_B64=""
+
+WORKDIR /src/cmd
+
+RUN set -e; \
+    LDFLAGS="-X github.com/formancehq/operator/v3/cmd.Version=${VERSION} \
+    -X github.com/formancehq/operator/v3/cmd.BuildDate=$(date +%s) \
+    -X github.com/formancehq/operator/v3/cmd.Commit=${COMMIT}"; \
+    if [ -n "$LICENCE_PUBLIC_KEY_B64" ]; then \
+        LICENCE_PUBLIC_KEY="$(printf '%s' "$LICENCE_PUBLIC_KEY_B64" | base64 -d)"; \
+        LDFLAGS="${LDFLAGS} -X 'github.com/formancehq/go-libs/v5/pkg/authn/licence.formancePublicKey=${LICENCE_PUBLIC_KEY}'"; \
+    fi; \
+    CGO_ENABLED=0 go build -buildvcs=false -o /usr/bin/operator -ldflags="${LDFLAGS}" .
+
+FROM alpine:3.20
+
+RUN apk update && apk add --no-cache ca-certificates curl
+
+ENTRYPOINT ["/usr/bin/operator"]
+
+COPY --from=builder /usr/bin/operator /usr/bin/operator

Earthfile

@@ -45,9 +45,13 @@ compile:
     SAVE ARTIFACT main
 
 build-image:
-    FROM core+final-image
-    ENTRYPOINT ["/usr/bin/operator"]
-    COPY --pass-args (+compile/main) /usr/bin/operator
+    ARG LICENCE_PUBLIC_KEY_B64=""
+    ARG EARTHLY_BUILD_SHA
+    FROM DOCKERFILE \
+        --build-arg LICENCE_PUBLIC_KEY_B64=$LICENCE_PUBLIC_KEY_B64 \
+        --build-arg VERSION=$tag \
+        --build-arg COMMIT=$EARTHLY_BUILD_SHA \
+        -f Dockerfile .
     ARG REPOSITORY=ghcr.io
     ARG tag=latest
     DO --pass-args core+SAVE_IMAGE --COMPONENT=operator --TAG=$tag

PROJECT

@@ -173,4 +173,10 @@ resources:
   kind: Broker
   path: github.com/formancehq/operator/api/formance.com/v1beta1
   version: v1beta1
+- api:
+    crdVersion: v1
+  group: formance.com
+  kind: LedgerConfiguration
+  path: github.com/formancehq/operator/api/formance.com/v1beta1
+  version: v1beta1
 version: "3"

api/formance.com/v1beta1/connectivity_types.go

@@ -0,0 +1,103 @@
+/*
+Copyright 2022.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1beta1
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+type ConnectivitySpec struct {
+	ModuleProperties `json:",inline"`
+	StackDependency  `json:",inline"`
+}
+
+type ConnectivityStatus struct {
+	Status `json:",inline"`
+}
+
+// Connectivity is the module allowing to install a connectivity instance.
+//
+// Connectivity ingests data from external sources (blockchains, payment
+// providers, ...) through a plugin system and writes double-entry
+// transactions into the stack ledger. It delegates the actual workload to the
+// connectivity operator (connectivity.formance.com), bound to the stack's
+// Ledger v3 gRPC endpoint.
+//
+// +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
+type Connectivity struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   ConnectivitySpec   `json:"spec,omitempty"`
+	Status ConnectivityStatus `json:"status,omitempty"`
+}
+
+func (in *Connectivity) IsEE() bool {
+	return false
+}
+
+func (in *Connectivity) IsReady() bool {
+	return in.Status.Ready
+}
+
+func (in *Connectivity) SetReady(b bool) {
+	in.Status.Ready = b
+}
+
+func (in *Connectivity) SetError(s string) {
+	in.Status.Info = s
+}
+
+func (in *Connectivity) GetConditions() *Conditions {
+	return &in.Status.Conditions
+}
+
+func (in *Connectivity) GetVersion() string {
+	return in.Spec.Version
+}
+
+func (a Connectivity) GetStack() string {
+	return a.Spec.Stack
+}
+
+func (a Connectivity) IsDebug() bool {
+	return a.Spec.Debug
+}
+
+func (a Connectivity) IsDev() bool {
+	return a.Spec.Dev
+}
+
+//+kubebuilder:object:root=true
+
+// ConnectivityList contains a list of Connectivity
+type ConnectivityList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []Connectivity `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&Connectivity{}, &ConnectivityList{})
+}

api/formance.com/v1beta1/gateway_types.go

@@ -86,6 +86,9 @@ type GatewayStatus struct {
 	// Detected http apis. See [GatewayHTTPAPI](#gatewayhttpapi)
 	//+optional
 	SyncHTTPAPIs []string `json:"syncHTTPAPIs"`
+	// Detected grpc apis. See [GatewayGRPCAPI](#gatewaygrpcapi)
+	//+optional
+	SyncGRPCAPIs []string `json:"syncGRPCAPIs,omitempty"`
 }
 
 //+kubebuilder:object:root=true

api/formance.com/v1beta1/gatewaybackend_types.go

@@ -0,0 +1,48 @@
+/*
+Copyright 2022.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1beta1
+
+const GatewayBackendTLSSecretLabel = "formance.com/gateway-backend-tls"
+
+// GatewayBackendTLS configures TLS when Gateway connects to a backend.
+type GatewayBackendTLS struct {
+	// SecretName contains the CA used to verify the backend certificate.
+	// +kubebuilder:validation:MinLength=1
+	SecretName string `json:"secretName"`
+	// CASecretKey is the key containing the CA certificate.
+	// +optional
+	// +kubebuilder:default:="ca.crt"
+	CASecretKey string `json:"caSecretKey,omitempty"`
+	// ServerName is used for backend certificate verification.
+	// +kubebuilder:validation:MinLength=1
+	ServerName string `json:"serverName"`
+}
+
+// GatewayBackendRef selects the Kubernetes Service used by a Gateway route.
+// When omitted, Gateway keeps using the module's historical Service.
+type GatewayBackendRef struct {
+	// Name is the backend Service name in the Stack namespace.
+	// +kubebuilder:validation:MinLength=1
+	Name string `json:"name"`
+	// Port is the backend Service port.
+	// +kubebuilder:validation:Minimum=1
+	// +kubebuilder:validation:Maximum=65535
+	Port int32 `json:"port"`
+	// TLS enables a verified TLS connection to the backend.
+	// +optional
+	TLS *GatewayBackendTLS `json:"tls,omitempty"`
+}

api/formance.com/v1beta1/gatewaygrpcapi_types.go

@@ -0,0 +1,91 @@
+/*
+Copyright 2022.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1beta1
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+type GatewayGRPCAPISpec struct {
+	StackDependency `json:",inline"`
+	// Name indicates the module name (e.g. "ledger")
+	Name string `json:"name"`
+	// GRPCServices is the list of fully-qualified gRPC service names
+	// exposed by this module (e.g. "formance.ledger.v1.LedgerService")
+	GRPCServices []string `json:"grpcServices"`
+	// Port is the gRPC port on the backend service
+	//+optional
+	//+kubebuilder:default:=8081
+	Port int32 `json:"port,omitempty"`
+	// BackendRef overrides the historical <name>-grpc Service.
+	// +optional
+	BackendRef *GatewayBackendRef `json:"backendRef,omitempty"`
+}
+
+type GatewayGRPCAPIStatus struct {
+	Status `json:",inline"`
+	//+optional
+	Ready bool `json:"ready,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="Ready"
+
+// GatewayGRPCAPI is the Schema for the GRPCAPIs API
+type GatewayGRPCAPI struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   GatewayGRPCAPISpec   `json:"spec,omitempty"`
+	Status GatewayGRPCAPIStatus `json:"status,omitempty"`
+}
+
+func (in *GatewayGRPCAPI) SetReady(b bool) {
+	in.Status.Ready = b
+}
+
+func (in *GatewayGRPCAPI) IsReady() bool {
+	return in.Status.Ready
+}
+
+func (in *GatewayGRPCAPI) SetError(s string) {
+	in.Status.Info = s
+}
+
+func (a GatewayGRPCAPI) GetStack() string {
+	return a.Spec.Stack
+}
+
+func (in *GatewayGRPCAPI) GetConditions() *Conditions {
+	return &in.Status.Conditions
+}
+
+//+kubebuilder:object:root=true
+
+// GatewayGRPCAPIList contains a list of GatewayGRPCAPI
+type GatewayGRPCAPIList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []GatewayGRPCAPI `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&GatewayGRPCAPI{}, &GatewayGRPCAPIList{})
+}

api/formance.com/v1beta1/gatewayhttpapi_types.go

@@ -27,6 +27,9 @@ type GatewayHTTPAPIRule struct {
 	//+optional
 	//+kubebuilder:default:=false
 	Secured bool `json:"secured"`
+	// BackendRef overrides the historical module Service for this rule.
+	// +optional
+	BackendRef *GatewayBackendRef `json:"backendRef,omitempty"`
 }
 
 type GatewayHTTPAPISpec struct {

api/formance.com/v1beta1/ledger_types.go

@@ -20,6 +20,8 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
+const LedgerV3Label = "formance.com/ledger-v3"
+
 type LedgerSpec struct {
 	ModuleProperties `json:",inline"`
 	StackDependency  `json:",inline"`