Create operator + crd for Ogmios

.github/workflows/clippy.yml

@@ -0,0 +1,22 @@
+name: Clippy
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./operator
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Clippy check lints
+        run: cargo clippy -- -D warnings

.github/workflows/controller.yml

@@ -0,0 +1,40 @@
+name: Controller
+
+on:
+  push:
+    branches:
+      - "main"
+    paths:
+      - ".github/workflows/controller.yml"
+      - "operator/**"
+
+jobs:
+  build-images:
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - context: operator
+            file: operator/Dockerfile
+            endpoint: demeter-run/ext-cardano-ogmios
+
+    continue-on-error: true
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/[email protected]
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v1
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v2
+        with:
+          context: ${{ matrix.context }}
+          file: ${{ matrix.file }}
+          platforms: linux/amd64
+          push: true
+          tags: ghcr.io/${{ matrix.endpoint }},ghcr.io/${{ matrix.endpoint }}:${{ github.sha }}

README.md

@@ -1,32 +1,9 @@
 # Ext Cardano Ogmios
 
-This project allow demeter to run and expose ogmios
+The approach of this project is to allow a CRD to Ogmios on the K8S cluster and an operator will enable the required resources to expose an Ogmios port.
 
-## Environment
+## Folder structure
 
-| Key  | Value        |
-| ---- | ------------ |
-| ADDR | 0.0.0.0:5000 |
-
-
-## Commands
-
-To generate the CRD will need to execute crdgen
-
-```bash
-cargo run --bin=crdgen
-```
-
-and execute the controller
-
-```bash
-cargo run
-```
-
-## Metrics
-
-to collect metrics for Prometheus, an http api will enable with the route /metrics.
-
-```
-/metrics
-```
+* bootstrap: contains terraform resources
+* operator: rust application integrated with the cluster
+* scripts: useful scripts

bootstrap/crds/main.tf

@@ -0,0 +1,101 @@
+resource "kubernetes_manifest" "customresourcedefinition_ogmiosports_demeter_run" {
+  manifest = {
+    "apiVersion" = "apiextensions.k8s.io/v1"
+    "kind" = "CustomResourceDefinition"
+    "metadata" = {
+      "name" = "ogmiosports.demeter.run"
+    }
+    "spec" = {
+      "group" = "demeter.run"
+      "names" = {
+        "categories" = []
+        "kind" = "OgmiosPort"
+        "plural" = "ogmiosports"
+        "shortNames" = []
+        "singular" = "ogmiosport"
+      }
+      "scope" = "Namespaced"
+      "versions" = [
+        {
+          "additionalPrinterColumns" = [
+            {
+              "jsonPath" = ".spec.network"
+              "name" = "Network"
+              "type" = "string"
+            },
+            {
+              "jsonPath" = ".spec.version"
+              "name" = "Version"
+              "type" = "number"
+            },
+            {
+              "jsonPath" = ".status.endpointUrl"
+              "name" = "Endpoint URL"
+              "type" = "string"
+            },
+            {
+              "jsonPath" = ".status.authToken"
+              "name" = "Auth Token"
+              "type" = "string"
+            },
+          ]
+          "name" = "v1alpha1"
+          "schema" = {
+            "openAPIV3Schema" = {
+              "description" = "Auto-generated derived type for OgmiosPortSpec via `CustomResource`"
+              "properties" = {
+                "spec" = {
+                  "properties" = {
+                    "network" = {
+                      "enum" = [
+                        "mainnet",
+                        "preprod",
+                        "preview",
+                        "sanchonet",
+                      ]
+                      "type" = "string"
+                    }
+                    "version" = {
+                      "format" = "uint8"
+                      "minimum" = 0
+                      "type" = "integer"
+                    }
+                  }
+                  "required" = [
+                    "network",
+                    "version",
+                  ]
+                  "type" = "object"
+                }
+                "status" = {
+                  "nullable" = true
+                  "properties" = {
+                    "authToken" = {
+                      "nullable" = true
+                      "type" = "string"
+                    }
+                    "endpointUrl" = {
+                      "nullable" = true
+                      "type" = "string"
+                    }
+                  }
+                  "type" = "object"
+                }
+              }
+              "required" = [
+                "spec",
+              ]
+              "title" = "OgmiosPort"
+              "type" = "object"
+            }
+          }
+          "served" = true
+          "storage" = true
+          "subresources" = {
+            "status" = {}
+          }
+        },
+      ]
+    }
+  }
+}

operator/.gitignore

@@ -1 +1,2 @@
 /target
+.env

operator/Cargo.toml

@@ -2,15 +2,20 @@
 name = "ext-cardano-ogmios"
 version = "0.1.0"
 edition = "2021"
+default-run = "controller"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
 actix-web = "4.4.0"
+argon2 = "0.5.2"
+base64 = "0.21.5"
+bech32 = "0.9.1"
 dotenv = "0.15.0"
 futures = "0.3.29"
 k8s-openapi = { version = "0.20.0", features = ["latest"] }
 kube = { version = "0.87.1", features = ["runtime", "client", "derive"] }
+lazy_static = "1.4.0"
 prometheus = "0.13.3"
 schemars = "0.8.16"
 serde = { version = "1.0.193", features = ["derive"] }

operator/Dockerfile

@@ -0,0 +1,15 @@
+FROM rust:1.74-slim-buster as build
+
+WORKDIR /app
+
+COPY ./Cargo.lock ./Cargo.lock
+COPY ./Cargo.toml ./Cargo.toml
+COPY ./src ./src
+
+RUN cargo build --release
+
+FROM rust:1.74-slim-buster 
+
+COPY --from=build /app/target/release/controller .
+
+CMD ["./controller"]