Merge pull request #489 from vshn/feature/billing

Event based billing controller

Author: mdnix

apis/vshn/v1/billing_service.go

@@ -0,0 +1,109 @@
+package v1
+
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+const (
+	// BillingServiceFinalizer is the finalizer used to protect BillingService resources from deletion
+	BillingServiceFinalizer = "billing.appcat.vshn.io/delete-protection"
+)
+
+// +kubebuilder:object:root=true
+// +kubebuilder:subresource:status
+// +kubebuilder:object:generate=true
+// +kubebuilder:resource:scope=Namespaced,categories=appcat
+// +kubebuilder:printcolumn:name="READY",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].status"
+// +kubebuilder:printcolumn:name="SYNCED",type="string",JSONPath=".status.conditions[?(@.type=='Synced')].status"
+// +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp"
+
+// BillingService represents a service instance for billing purposes
+type BillingService struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	// Spec defines the desired state of a BillingService
+	Spec BillingServiceSpec `json:"spec"`
+
+	// Status reflects the observed state of a BillingService
+	Status BillingServiceStatus `json:"status,omitempty"`
+}
+
+// BillingServiceSpec defines the desired state of a BillingService
+type BillingServiceSpec struct {
+	// KeepAfterDeletion defines how many days to keep billing records after service deletion
+	KeepAfterDeletion int `json:"keepAfterDeletion,omitempty"`
+
+	// Odoo contains Odoo-specific billing configuration
+	Odoo OdooSpec `json:"odoo,omitempty"`
+}
+
+// OdooSpec defines Odoo-specific billing configuration
+type OdooSpec struct {
+	// InstanceID uniquely identifies the service instance in Odoo
+	InstanceID string `json:"instanceID"`
+
+	// ProductID identifies the product in the billing system
+	ProductID string `json:"productID"`
+
+	// SalesOrderID identifies the sales order in Odoo
+	SalesOrderID string `json:"salesOrderID,omitempty"`
+
+	// UnitID defines the billing unit type in Odoo
+	UnitID string `json:"unitID"`
+
+	// Size represents the size of the service instance
+	Size string `json:"size,omitempty"`
+
+	// ItemGroupDescription describes the billing item group
+	ItemGroupDescription string `json:"itemGroupDescription"`
+
+	// ItemDescription is a human readable description of the billing item
+	ItemDescription string `json:"itemDescription"`
+}
+
+// BillingServiceStatus defines the observed state of a BillingService
+type BillingServiceStatus struct {
+	// Events contains the history of billing events
+	Events []BillingEventStatus `json:"events,omitempty"`
+
+	// Conditions represent the latest available observations of the billing service's state
+	Conditions []metav1.Condition `json:"conditions,omitempty"`
+}
+
+// BillingEventStatus represents the status of a billing event
+type BillingEventStatus struct {
+	// Type is the type of billing event (created, deleted, scaled)
+	// +kubebuilder:validation:Enum="created";"deleted";"scaled"
+	Type string `json:"type"`
+
+	// ProductID identifies the product in the billing system
+	ProductID string `json:"productId"`
+
+	// Size represents the size/plan at the time of the event
+	Size string `json:"size"`
+
+	// Timestamp when the event occurred
+	Timestamp metav1.Time `json:"timestamp"`
+
+	// State represents the current state of the event (sent, pending, failed, superseded)
+	// +kubebuilder:validation:Enum="sent";"pending";"failed";"superseded"
+	State string `json:"state"`
+
+	// RetryCount tracks the number of retry attempts for failed events
+	// +kubebuilder:default=0
+	RetryCount int `json:"retryCount,omitempty"`
+
+	// LastAttemptTime is when we last tried to send this event
+	LastAttemptTime metav1.Time `json:"lastAttemptTime,omitempty"`
+}
+
+// +kubebuilder:object:root=true
+// +kubebuilder:object:generate=true
+
+// BillingServiceList contains a list of BillingService
+type BillingServiceList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []BillingService `json:"items"`
+}

apis/vshn/v1/groupversion_info.go

@@ -22,6 +22,9 @@ var (
 
 func init() {
 	SchemeBuilder.Register(
+		&BillingService{},
+		&BillingServiceList{},
+
 		&VSHNPostgreSQL{},
 		&VSHNPostgreSQLList{},
 		&XVSHNPostgreSQL{},

apis/vshn/v1/zz_generated.deepcopy.go

@@ -7,8 +7,10 @@ import (
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 	"github.com/vshn/appcat/v4/pkg"
+	"github.com/vshn/appcat/v4/pkg/controller/billing"
 	"github.com/vshn/appcat/v4/pkg/controller/events"
 	"github.com/vshn/appcat/v4/pkg/controller/webhooks"
+	"github.com/vshn/appcat/v4/pkg/odoo"
 	"k8s.io/apimachinery/pkg/runtime"
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/healthz"
@@ -26,6 +28,7 @@ type controller struct {
 	enableProviderWebhooks  bool
 	enableQuotas            bool
 	enableEventForwarding   bool
+	enableBilling           bool
 	certDir                 string
 }
 
@@ -51,6 +54,7 @@ func init() {
 	ControllerCMD.Flags().StringVar(&c.certDir, "certdir", "/etc/webhook/certs", "Set the webhook certificate directory")
 	ControllerCMD.Flags().BoolVar(&c.enableQuotas, "quotas", false, "Enable the quota webhooks, is only active if webhooks is also true")
 	ControllerCMD.Flags().BoolVar(&c.enableEventForwarding, "event-forwarding", true, "Disable event-forwarding")
+	ControllerCMD.Flags().BoolVar(&c.enableBilling, "billing", true, "Disable billing")
 	viper.AutomaticEnv()
 	if !viper.IsSet("PLANS_NAMESPACE") {
 		viper.Set("PLANS_NAMESPACE", "syn-appcat")
@@ -79,6 +83,30 @@ func (c *controller) executeController(cmd *cobra.Command, _ []string) error {
 		return err
 	}
 
+	if c.enableBilling {
+		opts := odoo.Options{
+			BaseURL:      viper.GetString("ODOO_BASE_URL"),
+			DB:           viper.GetString("ODOO_DB"),
+			ClientID:     viper.GetString("ODOO_CLIENT_ID"),
+			ClientSecret: viper.GetString("ODOO_CLIENT_SECRET"),
+			TokenURL:     viper.GetString("ODOO_TOKEN_URL"),
+		}
+
+		if opts.BaseURL == "" || opts.DB == "" || opts.ClientID == "" || opts.ClientSecret == "" || opts.TokenURL == "" {
+			return fmt.Errorf("billing is enabled but Odoo configuration is incomplete")
+		}
+
+		odooClient, err := odoo.NewClient(cmd.Context(), opts)
+		if err != nil {
+			return fmt.Errorf("initialize Odoo client: %w", err)
+		}
+
+		b := billing.New(mgr.GetClient(), mgr.GetScheme(), odooClient)
+		if err := b.SetupWithManager(mgr); err != nil {
+			return err
+		}
+	}
+
 	if c.enableEventForwarding {
 		events := &events.EventHandler{
 			Client: mgr.GetClient(),

cmd/controller.go

@@ -83,6 +83,32 @@ rules:
   - get
   - list
   - watch
+- apiGroups:
+  - vshn.appcat.vshn.io
+  resources:
+  - billingservices
+  verbs:
+  - create
+  - delete
+  - get
+  - list
+  - patch
+  - update
+  - watch
+- apiGroups:
+  - vshn.appcat.vshn.io
+  resources:
+  - billingservices/finalizers
+  verbs:
+  - update
+- apiGroups:
+  - vshn.appcat.vshn.io
+  resources:
+  - billingservices/status
+  verbs:
+  - get
+  - patch
+  - update
 - apiGroups:
   - vshn.appcat.vshn.io
   resources: