blog: building a compound promise (#193)

Signed-off-by: Cat Morris <[email protected]>

Author: kirederik

assets/rubyapp-promise/example-resource.yaml

@@ -0,0 +1,10 @@
+apiVersion: internal.platform.io/v1
+kind: RubyApp
+metadata:
+  name: myapp
+spec:
+  image: syntasso/example-rails-app:v1.0.0
+  database:
+    driver: postgresql
+  cache:
+    driver: redis

assets/rubyapp-promise/promise.yaml

@@ -0,0 +1,73 @@
+apiVersion: platform.kratix.io/v1alpha1
+kind: Promise
+metadata:
+  creationTimestamp: null
+  name: rubyapp
+spec:
+  requiredPromises:
+  - name: postgresql
+    version: v1.0.0-beta.2
+  - name: redis
+    version: v0.1.0
+  - name: runtime
+    version: v1.0.0
+  destinationSelectors:
+  - matchLabels:
+      environment: platform
+  api:
+    apiVersion: apiextensions.k8s.io/v1
+    kind: CustomResourceDefinition
+    metadata:
+      creationTimestamp: null
+      name: rubyapps.internal.platform.io
+    spec:
+      group: internal.platform.io
+      names:
+        kind: RubyApp
+        plural: rubyapps
+        singular: rubyapp
+      scope: Namespaced
+      versions:
+      - name: v1
+        schema:
+          openAPIV3Schema:
+            properties:
+              spec:
+                properties:
+                  cache:
+                    properties:
+                      driver:
+                        type: string
+                        enum: [ redis ]
+                    type: object
+                  database:
+                    properties:
+                      driver:
+                        type: string
+                        enum: [ postgresql ]
+                    type: object
+                  image:
+                    type: string
+                type: object
+            type: object
+        served: true
+        storage: true
+    status:
+      acceptedNames:
+        kind: ""
+        plural: ""
+      conditions: null
+      storedVersions: null
+  workflows:
+    promise: {}
+    resource:
+      configure:
+      - apiVersion: platform.kratix.io/v1alpha1
+        kind: Pipeline
+        metadata:
+          name: instance
+        spec:
+          containers:
+          - image: ghcr.io/syntasso/kratix-docs/rubyapp-promise:v1.0.0
+            name: deploy-resources
+status: {}

assets/rubyapp-promise/workflows/resource/configure/instance/deploy-resources/Dockerfile

@@ -0,0 +1,11 @@
+FROM "alpine"
+
+RUN apk update && apk add --no-cache yq ruby
+
+ADD scripts/pipeline.rb /usr/bin/pipeline.rb
+ADD resources resources
+
+RUN chmod +x /usr/bin/pipeline.rb
+
+CMD [ "sh", "-c", "pipeline.rb" ]
+ENTRYPOINT []

assets/rubyapp-promise/workflows/resource/configure/instance/deploy-resources/resources/postgres-request-template.yaml

@@ -0,0 +1,9 @@
+apiVersion: marketplace.kratix.io/v1alpha1
+kind: postgresql
+metadata:
+  name: example
+  namespace: default
+spec:
+  env: dev
+  teamId: acid
+  dbName: bestdb

assets/rubyapp-promise/workflows/resource/configure/instance/deploy-resources/resources/redis-request-template.yaml

@@ -0,0 +1,7 @@
+apiVersion: marketplace.kratix.io/v1alpha1
+kind: redis
+metadata:
+  name: example
+  namespace: default
+spec:
+  size: small

assets/rubyapp-promise/workflows/resource/configure/instance/deploy-resources/resources/runtime-request-template.yaml

@@ -0,0 +1,13 @@
+apiVersion: marketplace.kratix.io/v1alpha1
+kind: Runtime
+metadata:
+  name: example-runtime
+  namespace: default
+spec:
+  lifecycle: dev
+  image: syntasso/website
+  servicePort: 8000
+  replicas: 1
+  applicationEnv:
+  - name: hello
+    value: from-env

assets/rubyapp-promise/workflows/resource/configure/instance/deploy-resources/scripts/pipeline.rb

@@ -0,0 +1,102 @@
+#!/usr/bin/env ruby
+
+require 'yaml'
+
+# Read the input YAML file
+input_yaml = YAML.load_file('/kratix/input/object.yaml')
+
+# Extract values from input
+app_name = input_yaml['metadata']['name']
+namespace = input_yaml['metadata']['namespace']
+app_image = input_yaml['spec']['image']
+
+# Create the Runtime request
+runtime_request = {
+  'apiVersion' => 'marketplace.kratix.io/v1alpha1',
+  'kind' => 'Runtime',
+  'metadata' => {
+    'name' => app_name,
+    'namespace' => namespace
+  },
+  'spec' => {
+    'image' => app_image,
+    'replicas' => 1,
+    'servicePort' => 80,
+    'applicationEnv' => [
+      { 'name' => 'PORT', 'value' => '80' }
+    ]
+  }
+}
+
+database_driver = input_yaml.dig('spec', 'database', 'driver')
+
+if database_driver == "postgresql" then
+  # The PostgreSQL Request
+  database_request = {
+    'apiVersion' => 'marketplace.kratix.io/v1alpha1',
+    'kind' => 'postgresql',
+    'metadata' => {
+      'name' => app_name + '-db',
+      'namespace' => namespace
+    },
+    'spec' => {
+      'env' => 'dev',
+      'teamId' => app_name,
+      'dbName' => app_name + '-db'
+    }
+  }
+
+  # This is the secret name the PostgreSQL promise will generate
+  secret_name="#{app_name}.#{app_name}-#{app_name}-db-postgresql.credentials.postgresql.acid.zalan.do"
+
+  ## Injecting the secrets into the application env
+  runtime_request['spec']['applicationEnv'].push({
+    'name' => 'PGHOST',
+    'value' => '${app_name}-${app_name}-db-postgresql.default.svc.cluster.local'
+  }, {
+    'name' => 'DBNAME',
+    'value' => '${app_name}-db'
+  }, {
+    'name' => 'PGUSER',
+    'valueFrom' => {
+      'secretKeyRef' => { 'name' => secret_name, 'key' => 'username' }
+    }
+  }, {
+      'name' => 'PGPASSWORD',
+      'valueFrom' => {
+        'secretKeyRef' => { 'name' => secret_name, 'key' => 'password' }
+      }
+    }
+  )
+
+  File.write('/kratix/output/postgresql-request.yaml', database_request.to_yaml)
+end
+
+cache_driver = input_yaml.dig('spec', 'cache', 'driver')
+
+if cache_driver == "redis" then
+  redis_request = {
+    'apiVersion' => 'marketplace.kratix.io/v1alpha1',
+    'kind' => 'redis',
+    'metadata' => {
+      'name' => app_name + '-cache',
+      'namespace' => namespace
+    },
+    'spec' => {
+      'size' => 'small'
+    }
+  }
+
+  runtime_request['spec']['applicationEnv'].push({
+    'name' => 'REDIS_URL',
+    'value' => "redis://rfs-#{app_name}-cache:26379/1"
+  }, {
+    'name' => 'REDIS_POOL_SIZE',
+    'value' => '5'
+  })
+
+  File.write('/kratix/output/redis-request.yaml', redis_request.to_yaml)
+end
+
+# Write to Runtime request to the output file
+File.write('/kratix/output/runtime-request.yaml', runtime_request.to_yaml)