Merge pull request #1 from benjamin-wright/refactor

- Swap out cockroach for standard postgres
- Version updates
- Simplify generic state management to avoid needing pointer references
- Use migrations image, to promote bundling migrations into images instead of loading etcd with them in CRDs
- Simplify kube clients and split out resource types into their own packages

.envrc

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+export KUBECONFIG=$(pwd)/.scratch/kubeconfig

.github/workflows/tags.yaml

@@ -22,7 +22,7 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@v4
         with:
-          go-version: '1.19'
+          go-version: '1.22'
       - name: Install dependencies
         run: go mod download
       - name: Build
@@ -34,6 +34,35 @@ jobs:
           file: ./deploy/Dockerfile
           push: true
           tags: benwright/db-operator:${{ github.ref_name }}
+  migrations:
+    runs-on: ubuntu-latest
+    environment: production
+    steps:
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+      - name: Login to Docker Hub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKER_HUB_USER_NAME }}
+          password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
+      - uses: actions/checkout@v3
+      - name: Set up Go
+        uses: actions/setup-go@v4
+        with:
+          go-version: '1.22'
+      - name: Install dependencies
+        run: go mod download
+      - name: Build
+        run: CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -ldflags="-w -s" -v -o ./dist/mig ./cmd/migrations/main.go
+      - name: Image
+        uses: docker/build-push-action@v4
+        with:
+          context: ./dist
+          file: ./deploy/Dockerfile
+          push: true
+          tags: benwright/db-pg-migrations:${{ github.ref_name }}
   chart:
     runs-on: ubuntu-latest
     environment: production

.gitignore

@@ -1,3 +1,4 @@
 .scratch
 dist
-*.tgz
+*.tgz
+.DS_Store

README.md

@@ -3,6 +3,10 @@
 An operator for creating and managing development databases and other stateful infrastructure
 
 Currently supports:
-- CockroachDB
+- Postgres
 - Redis
-- NATs
+- NATs
+
+## NOTES
+
+- use the database client to fetch the owner when setting and unsetting permissions

cmd/migrations/main.go

@@ -0,0 +1,48 @@
+package main
+
+import (
+	"os"
+
+	"github.com/benjamin-wright/db-operator/pkg/postgres/config"
+	"github.com/benjamin-wright/db-operator/pkg/postgres/migrations"
+	"github.com/rs/zerolog"
+	"github.com/rs/zerolog/log"
+)
+
+func main() {
+	zerolog.SetGlobalLevel(zerolog.InfoLevel)
+	path, ok := os.LookupEnv("POSTGRES_MIGRATIONS_PATH")
+	if !ok {
+		path = "/migrations"
+	}
+
+	log.Info().Msgf("loading migrations from %s", path)
+	m, err := migrations.LoadMigrations(path)
+	if err != nil {
+		log.Fatal().Err(err).Msg("failed to load migrations")
+	}
+
+	cfg, err := config.FromEnv()
+	if err != nil {
+		log.Fatal().Err(err).Msg("failed to load config from env")
+	}
+
+	client, err := migrations.New(cfg)
+	if err != nil {
+		log.Fatal().Err(err).Msg("failed to create client")
+	}
+
+	log.Info().Msg("initializing client")
+	err = client.Init()
+	if err != nil {
+		log.Fatal().Err(err).Msg("failed to init client")
+	}
+
+	log.Info().Msg("running migrations")
+	err = client.Run(m)
+	if err != nil {
+		log.Fatal().Err(err).Msg("failed to run migrations")
+	}
+
+	log.Info().Msg("migrations complete")
+}

cmd/operator/main.go

@@ -25,6 +25,7 @@ func main() {
 	}
 
 	zerolog.SetGlobalLevel(level)
+	log.Logger = log.Output(zerolog.ConsoleWriter{Out: os.Stderr})
 
 	log.Info().Msg("Starting operator...")
 

deploy/Dockerfile

@@ -1,5 +1,7 @@
 FROM scratch
 
-COPY app /app
+ARG BINARY_NAME
+
+COPY ${BINARY_NAME} /app
 
 ENTRYPOINT [ "/app" ]

deploy/Test.Dockerfile

@@ -3,4 +3,4 @@ FROM scratch
 COPY tests /tests
 
 ENTRYPOINT [ "/tests" ]
-CMD [ "-test.run", "Integration", "-test.v" ]
+CMD [ "-test.run", "Integration" ]

deploy/chart/crds/nats-client.crd.yaml

@@ -15,7 +15,7 @@ spec:
             spec:
               type: object
               properties:
-                dbRef:
+                cluster:
                   type: object
                   properties:
                     name:
@@ -25,7 +25,7 @@ spec:
                   required: [ name, namespace ]
                 secret:
                   type: string
-              required: [ dbRef, secret ]
+              required: [ cluster, secret ]
             status:
               type: object
               properties:
@@ -44,5 +44,5 @@ spec:
     singular: natsclient
     kind: NatsClient
     shortNames:
-    - nc
-    - ncs
+    - ncl
+    - ncls

deploy/chart/crds/nats-db.crd.yaml → deploy/chart/crds/nats-cluster.crd.yaml

@@ -1,7 +1,7 @@
 apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
-  name: natsdbs.ponglehub.co.uk
+  name: natsclusters.ponglehub.co.uk
 spec:
   group: ponglehub.co.uk
   versions:
@@ -26,9 +26,9 @@ spec:
         jsonPath: .status.ready
   scope: Namespaced
   names:
-    plural: natsdbs
-    singular: natsdb
-    kind: NatsDB
+    plural: natsclusters
+    singular: natscluster
+    kind: NatsCluster
     shortNames:
-    - ndb
-    - ndbs
+    - nc
+    - ncs

deploy/chart/crds/cockroach-client.crd.yaml → deploy/chart/crds/postgres-client.crd.yaml

@@ -1,7 +1,7 @@
 apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
-  name: cockroachclients.ponglehub.co.uk
+  name: postgresclients.ponglehub.co.uk
 spec:
   group: ponglehub.co.uk
   versions:
@@ -15,7 +15,7 @@ spec:
             spec:
               type: object
               properties:
-                dbRef:
+                cluster:
                   type: object
                   properties:
                     name:
@@ -25,11 +25,13 @@ spec:
                   required: [ name, namespace ]
                 database:
                   type: string
+                owner:
+                  type: boolean
                 username:
                   type: string
                 secret:
                   type: string
-              required: [ dbRef, database, username, secret ]
+              required: [ cluster, database, username, secret ]
             status:
               type: object
               properties:
@@ -44,9 +46,9 @@ spec:
         jsonPath: .status.ready
   scope: Namespaced
   names:
-    plural: cockroachclients
-    singular: cockroachclient
-    kind: CockroachClient
+    plural: postgresclients
+    singular: postgresclient
+    kind: PostgresClient
     shortNames:
-    - cc
-    - ccs
+    - pgcl
+    - pgcls

deploy/chart/crds/cockroach-db.crd.yaml → deploy/chart/crds/postgres-cluster.crd.yaml

@@ -1,7 +1,7 @@
 apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
-  name: cockroachdbs.ponglehub.co.uk
+  name: postgresclusters.ponglehub.co.uk
 spec:
   group: ponglehub.co.uk
   versions:
@@ -27,13 +27,13 @@ spec:
       additionalPrinterColumns:
       - name: Ready
         type: boolean
-        description: Defines whether the database is running
+        description: Defines whether the database cluster is running
         jsonPath: .status.ready
   scope: Namespaced
   names:
-    plural: cockroachdbs
-    singular: cockroachdb
-    kind: CockroachDB
+    plural: postgresclusters
+    singular: postgresclusters
+    kind: PostgresCluster
     shortNames:
-    - cdb
-    - cdbs
+    - pgc
+    - pgcs

deploy/chart/crds/redis-client.crd.yaml

@@ -15,7 +15,7 @@ spec:
             spec:
               type: object
               properties:
-                dbRef:
+                cluster:
                   type: object
                   properties:
                     name:
@@ -27,7 +27,7 @@ spec:
                   type: integer
                 secret:
                   type: string
-              required: [ dbRef, unit, secret ]
+              required: [ cluster, unit, secret ]
             status:
               type: object
               properties:
@@ -46,5 +46,5 @@ spec:
     singular: redisclient
     kind: RedisClient
     shortNames:
-    - rc
-    - rcs
+    - rcl
+    - rcls

deploy/chart/crds/redis-db.crd.yaml

@@ -1,7 +1,7 @@
 apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
-  name: redisdbs.ponglehub.co.uk
+  name: redisclusters.ponglehub.co.uk
 spec:
   group: ponglehub.co.uk
   versions:
@@ -31,9 +31,9 @@ spec:
         jsonPath: .status.ready
   scope: Namespaced
   names:
-    plural: redisdbs
-    singular: redisdb
-    kind: RedisDB
+    plural: redisclusters
+    singular: rediscluster
+    kind: RedisCluster
     shortNames:
-    - rdb
-    - rdbs
+    - rc
+    - rcs

deploy/chart/values.yaml

@@ -11,5 +11,5 @@ rbacs:
   resources: ["persistentvolumeclaims"]
   verbs: ["get", "list", "watch", "delete"]
 - apiGroups: ["ponglehub.co.uk"]
-  resources: ["cockroachdbs", "cockroachmigrations", "cockroachclients", "redisdbs", "redisclients", "natsdbs", "natsclients"]
+  resources: ["postgresclusters", "postgresmigrations", "postgresclients", "redisclusters", "redisclients", "natsclusters", "natsclients"]
   verbs: ["get", "list", "watch", "update"]