@toa.io/operations 1.0.0-alpha.26 → 1.0.0-alpha.262

package/src/deployment/chart/templates/mono.yaml

@@ -0,0 +1,177 @@
+{{- if .Values.mono }}
+{{- with .Values.mono }}
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: mono
+spec:
+  replicas: {{ .replicas | default 2 }}
+  progressDeadlineSeconds: 900
+  strategy:
+    type: RollingUpdate
+    rollingUpdate:
+      maxUnavailable: 0
+      maxSurge: 50%
+  selector:
+    matchLabels:
+      toa.io/composition: mono
+  template:
+    metadata:
+      labels:
+        toa.io/composition: mono
+        {{- range .components }}
+        {{ . }}: "1"
+        {{- end }}
+    spec:
+      containers:
+        - name: mono
+          image: {{ .image }}
+          {{- if or .backends .probe }}
+          ports:
+            {{- range .backends }}
+            - containerPort: {{ .port }}
+            {{- end }}
+            {{- if .probe }}
+            - containerPort: {{ .probe.port }}
+            {{- end }}
+          {{- end }}
+          {{- if .resources }}
+          resources:
+            {{- if or .resources.cpu .resources.memory }}
+            requests:
+              {{- if .resources.cpu }}
+              cpu: {{ index .resources.cpu 0 }}
+              {{- end }}
+              {{- if .resources.memory }}
+              memory: {{ index .resources.memory 0 }}
+              {{- end }}
+            limits:
+              {{- if .resources.cpu }}
+              cpu: {{ index .resources.cpu 1 }}
+              {{- end }}
+              {{- if .resources.memory }}
+              memory: {{ index .resources.memory 1 }}
+              {{- end }}
+            {{- end }}
+          {{- end }}
+          {{- if .variables }}
+          env:
+            {{- range .variables }}
+            {{- include "env.var" . | indent 12 }}
+            {{- end }}
+          {{- end }}
+          {{- if .probe }}
+          startupProbe:
+            httpGet:
+              path: {{ .probe.path }}
+              port: {{ .probe.port }}
+            {{- if .probe.delay }}
+            initialDelaySeconds: {{ .probe.delay }}
+            {{- end }}
+            periodSeconds: 2
+            timeoutSeconds: 3
+            failureThreshold: 150
+          readinessProbe:
+            httpGet:
+              path: {{ .probe.path }}
+              port: {{ .probe.port }}
+            periodSeconds: 10
+            timeoutSeconds: 3
+            failureThreshold: 3
+          {{- end }}
+          {{- if .mounts }}
+          volumeMounts:
+            {{- range .mounts }}
+            - name: {{ .name }}
+              mountPath: {{ .path }}
+            {{- end }}
+          {{- end }}
+          lifecycle:
+            preStop:
+              exec:
+                command: [sleep, "5"]
+      terminationGracePeriodSeconds: 45
+      {{- if $.Values.credentials }}
+      imagePullSecrets:
+        - name: {{ $.Values.credentials }}
+      {{- end }}
+      {{- if .mounts }}
+      volumes:
+        {{- range .mounts }}
+        - name: {{ .name }}
+          persistentVolumeClaim:
+            claimName: {{ .claim }}
+        {{- end }}
+      {{- end }}
+      topologySpreadConstraints:
+        - maxSkew: 1
+          topologyKey: kubernetes.io/hostname
+          whenUnsatisfiable: ScheduleAnyway
+          labelSelector:
+            matchLabels:
+              toa.io/composition: mono
+{{- if .backends }}
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: mono
+spec:
+  type: ClusterIP
+  selector:
+    toa.io/composition: mono
+  ports:
+    {{- range .backends }}
+    - name: port-{{ .port }}
+      protocol: TCP
+      port: {{ .port }}
+      targetPort: {{ .port }}
+    {{- end }}
+{{- end }}
+{{- if .ingress }}
+---
+apiVersion: networking.k8s.io/v1
+kind: Ingress
+metadata:
+  name: mono
+  {{- if .ingress.annotations }}
+  annotations:
+{{ toYaml .ingress.annotations | indent 4 }}
+  {{- end }}
+spec:
+  {{- if .ingress.class }}
+  ingressClassName: {{ .ingress.class }}
+  {{- end }}
+  {{- $backends := .backends }}
+  rules:
+    {{- range .ingress.hosts }}
+    - host: {{ . }}
+      http:
+        paths:
+          {{- range $backends }}
+          - path: {{ .path }}
+            pathType: Prefix
+            backend:
+              service:
+                name: mono
+                port:
+                  number: {{ .port }}
+          {{- end }}
+    {{- end }}
+    {{- if .ingress.default }}
+    - http:
+        paths:
+          {{- range $backends }}
+          - path: {{ .path }}
+            pathType: Prefix
+            backend:
+              service:
+                name: mono
+                port:
+                  number: {{ .port }}
+          {{- end }}
+    {{- end }}
+{{- end }}
+---
+{{- end }}
+{{- end }}

package/src/deployment/chart/templates/services.yaml

@@ -5,6 +5,16 @@ metadata:
   name: extension-{{ required "deployment name is required" .name }}
 spec:
   replicas: {{ .replicas | default 2 }}
+  # A backstop for stuck rollouts only. Must stay above the `helm upgrade --timeout`
+  # the deploy runs with, so a slow but progressing rollout is not marked failed.
+  progressDeadlineSeconds: 900
+  strategy:
+    type: RollingUpdate
+    rollingUpdate:
+      # a replacement must pass readiness before a running replica is taken out,
+      # otherwise a single pod serves all traffic while the others start up
+      maxUnavailable: 0
+      maxSurge: 50%
   selector:
     matchLabels:
       toa.io/service: extension-{{ .name }}
@@ -16,6 +26,25 @@ spec:
       containers:
         - name: extension-{{ .name }}
           image: {{ .image }}
+          {{- if .resources }}
+          resources:
+            {{- if or .resources.cpu .resources.memory }}
+            requests:
+              {{- if .resources.cpu }}
+              cpu: {{ index .resources.cpu 0 }}
+              {{- end }}
+              {{- if .resources.memory }}
+              memory: {{ index .resources.memory 0 }}
+              {{- end }}
+            limits:
+              {{- if .resources.cpu }}
+              cpu: {{ index .resources.cpu 1 }}
+              {{- end }}
+              {{- if .resources.memory }}
+              memory: {{ index .resources.memory 1 }}
+              {{- end }}
+            {{- end }}
+          {{- end }}
           {{- if .variables }}
           env:
             {{- range .variables }}
@@ -23,14 +52,37 @@ spec:
             {{- end }}
           {{- end }}
           {{- if .probe }}
-          readinessProbe:
+          startupProbe:
             httpGet:
               path: {{ .probe.path }}
               port: {{ .probe.port }}
             {{- if .probe.delay }}
             initialDelaySeconds: {{ .probe.delay }}
             {{- end }}
+            periodSeconds: 2
+            timeoutSeconds: 3
+            failureThreshold: 150
+          readinessProbe:
+            httpGet:
+              path: {{ .probe.path }}
+              port: {{ .probe.port }}
+            periodSeconds: 10
+            timeoutSeconds: 3
+            failureThreshold: 3
           {{- end }}
+          lifecycle:
+            preStop:
+              exec:
+                command: [sleep, "5"]
+      terminationGracePeriodSeconds: 45
+      topologySpreadConstraints:
+        - maxSkew: 1
+          topologyKey: kubernetes.io/hostname
+          whenUnsatisfiable: ScheduleAnyway
+          labelSelector:
+            matchLabels:
+              toa.io/service: extension-{{ .name }}
+{{- if .port }}
 ---
 apiVersion: v1
 kind: Service
@@ -45,9 +97,12 @@ spec:
       protocol: TCP
       port: {{ .port }}
       targetPort: {{ .port }}
----
+{{- end }}
 {{- if .ingress }}
 {{- $service := .name }}
+{{- $port := .port }}
+{{- $path := .ingress.path | default "/" }}
+---
 apiVersion: networking.k8s.io/v1
 kind: Ingress
 metadata:
@@ -65,13 +120,25 @@ spec:
     - host: {{ . }}
       http:
         paths:
-          - path: /
+          - path: {{ $path }}
             pathType: Prefix
             backend:
               service:
                 name: extension-{{ $service }}
                 port:
-                  number: 8000
+                  number: {{ $port }}
+    {{- end }}
+    {{- if .ingress.default }}
+    - http:
+        paths:
+          - path: {{ $path }}
+            pathType: Prefix
+            backend:
+              service:
+                name: extension-{{ $service }}
+                port:
+                  number: {{ $port }}
     {{- end }}
 {{- end }}
+---
 {{- end }}

package/src/deployment/chart/values.yaml

@@ -3,9 +3,16 @@ compositions:
   - name: todos
     image: localhost:5000/composition-todos:0.0.0
     replicas: 2
+    mounts:
+      - name: mount-name
+        path: /storage
+        claim: storage-pvc
     components:
       - todos-tasks
       - todos-stats
+    resources:
+      cpu: [100m, 1]
+      memory: [100Mi, 1Gi]
     variables:
       - name: TOA_CONFIGURATION_TODOS_TASKS
         value: foo
@@ -18,7 +25,6 @@ compositions:
     replicas: 3
     components:
       - users-users
-# TODO: create component services only if sync binding is being used
 components:
   - todos-tasks
   - todos-stats
@@ -28,7 +34,11 @@ services:
     image: localhost:5000/resources-gateway:0.0.0
     port: 8000
     replicas: 2
+    resources:
+      cpu: [100m, 1]
+      memory: [100Mi, 1Gi]
     ingress:
+      default: true
       hosts: [dummies.toa.io]
       class: alb
       annotations:

package/src/deployment/composition.js

@@ -10,6 +10,7 @@ class Composition {
     this.name = composition.name
     this.image = image.reference
     this.components = composition.components.map(component)
+    this.resources = composition.resources
   }
 }
 

package/src/deployment/deployment.js

@@ -13,11 +13,11 @@ class Deployment {
   #process
   #target
 
-  constructor (context, compositions, dependencies, process) {
+  constructor (context, compositions, dependencies, process, image) {
     const dependency = merge(dependencies)
 
     this.#chart = declare(context, dependency)
-    this.#values = describe(context, compositions, dependency)
+    this.#values = describe(context, compositions, dependency, image)
     this.#process = process
   }
 
@@ -42,6 +42,7 @@ class Deployment {
 
     if (options.namespace !== undefined) args.push('-n', options.namespace)
     if (options.wait === true) args.push('--wait')
+    if (options.timeout !== undefined) args.push('--timeout', options.timeout)
 
     await this.#process.execute('helm', ['dependency', 'update', this.#target])
     await this.#process.execute('helm', ['upgrade', this.#chart.name, '-i', ...args, this.#target])
@@ -68,6 +69,9 @@ class Deployment {
     addVariables(this.#values.compositions, variables, used)
     addVariables(this.#values.services, variables, used)
 
+    if (this.#values.mono !== undefined)
+      addVariables([this.#values.mono], variables, used)
+
     return variables
   }
 }

package/src/deployment/factory.js

@@ -11,25 +11,40 @@ const { Service } = require('./service')
 
 class Factory {
   #context
+  #mono
   #compositions
   #dependencies
   #registry
   #process
-  #extensionComponents = []
+  #image
 
-  constructor (context) {
+  constructor (context, options = {}) {
     this.#context = context
+    this.#mono = options.mono === true
     this.#process = new Process()
 
     const imagesFactory = new ImagesFactory(context.name, context.runtime, context.registry)
 
-    this.#registry = new Registry(context.registry, imagesFactory, this.#process)
-    this.#compositions = context.compositions.map((composition) => this.#composition(composition))
+    this.#registry = new Registry(context.name, context.registry, imagesFactory, this.#process)
     this.#dependencies = this.#getDependencies()
+    this.#compositions = []
+
+    if (this.#mono)
+      this.#image = this.#registry.mono({
+        components: context.components
+      })
+    else
+      this.#compositions = context.compositions.map((composition) => this.#composition(composition))
   }
 
   operator () {
-    const deployment = new Deployment(this.#context, this.#compositions, this.#dependencies, this.#process)
+    const deployment = new Deployment(
+      this.#context,
+      this.#compositions,
+      this.#dependencies,
+      this.#process,
+      this.#image
+    )
 
     return new Operator(deployment, this.#registry)
   }
@@ -71,7 +86,8 @@ class Factory {
     const dependency = module.deployment(instances, annotation)
 
     /** @type {toa.deployment.Service[]} */
-    const services = dependency.services?.map((service) => this.#service(path, service))
+    const services = dependency.services?.map((service) =>
+      this.#mono ? service : this.#service(path, service))
 
     return { ...dependency, services }
   }
@@ -87,10 +103,10 @@ class Factory {
     return new Service(service, image)
   }
 
-  static async create (path, environment) {
+  static async create (path, environment, options = {}) {
     const context = await load(path, environment)
 
-    return new Factory(context)
+    return new Factory(context, options)
   }
 }
 

package/src/deployment/images/composition.Dockerfile

@@ -5,7 +5,6 @@ FROM {{build.image}}
 ENV NODE_ENV=production
 RUN if [ "{{runtime.registry}}" != "" ]; then npm set registry {{runtime.registry}}; fi
 RUN if [ "{{runtime.proxy}}" != "" ]; then npm set proxy {{runtime.proxy}}; fi
-RUN npm i -g @toa.io/runtime@{{runtime.version}} --omit=dev
 
 WORKDIR /composition
 COPY --chown=node:node . /composition
@@ -13,7 +12,8 @@ COPY --chown=node:node . /composition
 {{build.run}}
 
 # run 'npm i' in each component
-RUN for entry in *; do if [ -f "$entry/package.json" ]; then (cd $entry && npm i --omit=dev); fi; done
+RUN --mount=type=cache,target=/root/.npm \
+  for entry in *; do if [ -f "$entry/package.json" ]; then (cd $entry && npm i --omit=dev); fi; done
 
 USER node
 CMD toa compose *

package/src/deployment/images/composition.js

@@ -5,6 +5,7 @@ const fs = require('fs-extra')
 const { createHash } = require('node:crypto')
 
 const { Image } = require('./image')
+const { undef } = require('@toa.io/concise/source/expressions/undefined')
 
 class Composition extends Image {
   dockerfile = join(__dirname, 'composition.Dockerfile')
@@ -37,11 +38,7 @@ class Composition extends Image {
   }
 
   get base () {
-    if (this.#image !== undefined) {
-      return this.#image
-    }
-
-    let image = null
+    let image = this.#image
 
     for (const component of this.#components) {
       const value = component.build?.image
@@ -53,7 +50,20 @@ class Composition extends Image {
       image = value
     }
 
-    return image ?? undefined
+    return image
+  }
+
+  get run () {
+    const commands = []
+
+    for (const component of this.#components) {
+      const run = component.build?.run
+
+      if (run !== undefined)
+        commands.push(run)
+    }
+
+    return commands.join('\n')
   }
 
   async prepare (root) {

package/src/deployment/images/factory.js

@@ -2,10 +2,8 @@
 
 const { Composition } = require('./composition')
 const { Service } = require('./service')
+const { Mono } = require('./mono')
 
-/**
- * @implements {toa.deployment.images.Factory}
- */
 class Factory {
   /** @type {string} */
   #scope
@@ -48,6 +46,17 @@ class Factory {
 
     return instance
   }
+
+  /**
+   * @returns {Mono}
+   */
+  mono (composition) {
+    const instance = new Mono(this.#scope, this.#runtime, this.#registry, composition)
+
+    instance.tag()
+
+    return instance
+  }
 }
 
 exports.Factory = Factory

package/src/deployment/images/image.js

@@ -26,9 +26,7 @@ class Image {
   #registry
   #runtime
   #values = {
-    build: {
-      image: 'node:20.9.0-alpine3.18'
-    }
+    build: {}
   }
 
   constructor (scope, runtime, registry) {
@@ -54,6 +52,8 @@ class Image {
 
   get base () {}
 
+  get run () {}
+
   async prepare (root) {
     if (this.dockerfile === undefined) throw new Error('Dockerfile isn\'t specified')
 
@@ -65,7 +65,7 @@ class Image {
 
     const template = await read(this.dockerfile, 'utf-8')
     const contents = template.replace(/{{(\S{1,32})}}/g, (_, key) => this.#value(key))
-    const ignore = 'Dockerfile'
+    const ignore = ['Dockerfile', '**/node_modules'].join('\r\n')
 
     await write(join(path, 'Dockerfile'), contents)
     await write(join(path, '.dockerignore'), ignore)
@@ -77,13 +77,19 @@ class Image {
 
   #setValues () {
     this.#values.runtime = this.#runtime
-    this.#values.build = overwrite(this.#values.build, this.#registry.build)
+    this.#values.build = overwrite({
+      image: `${RUNTIME_IMAGE}:${this.#runtime.version}`
+    }, this.#registry.build)
 
     const image = this.base
 
-    if (image !== undefined) {
+    if (image !== undefined)
       this.#values.build.image = image
-    }
+
+    const run = this.run
+
+    if (run !== undefined)
+      this.#values.build.run = (this.#values.build.run === undefined ? '' : this.#values.build.run + '\n') + run
 
     if (this.#values.build.arguments !== undefined) this.#values.build.arguments = createArguments(this.#values.build.arguments)
     if (this.#values.build.run !== undefined) this.#values.build.run = createRunCommands(this.#values.build.run)
@@ -121,4 +127,7 @@ function createArguments (variables) {
   return args.join('\n')
 }
 
+const RUNTIME_IMAGE = 'ghcr.io/toa-io/runtime'
+
 exports.Image = Image
+exports.RUNTIME_IMAGE = RUNTIME_IMAGE

package/src/deployment/images/mono.Dockerfile

@@ -0,0 +1,18 @@
+FROM {{build.image}}
+
+{{build.arguments}}
+
+ENV NODE_ENV=production
+RUN if [ "{{runtime.registry}}" != "" ]; then npm set registry {{runtime.registry}}; fi
+RUN if [ "{{runtime.proxy}}" != "" ]; then npm set proxy {{runtime.proxy}}; fi
+
+WORKDIR /composition
+COPY --chown=node:node . /composition
+
+{{build.run}}
+
+RUN --mount=type=cache,target=/root/.npm \
+  for entry in *; do if [ -f "$entry/package.json" ]; then (cd $entry && npm i --omit=dev); fi; done
+
+USER node
+CMD toa mono *

package/src/deployment/images/mono.js

@@ -0,0 +1,75 @@
+'use strict'
+
+const { join } = require('node:path')
+const fs = require('fs-extra')
+const { createHash } = require('node:crypto')
+
+const { Image } = require('./image')
+
+class Mono extends Image {
+  dockerfile = join(__dirname, 'mono.Dockerfile')
+
+  #image
+  #components
+
+  constructor (scope, runtime, registry, composition) {
+    super(scope, runtime, registry)
+
+    this.#image = composition.image
+    this.#components = composition.components
+  }
+
+  get name () {
+    return 'mono'
+  }
+
+  get version () {
+    const hash = createHash('sha256')
+
+    for (const component of this.#components) {
+      hash.update(component.locator.id)
+      hash.update(component.version)
+    }
+
+    return hash.digest('hex').slice(0, 8)
+  }
+
+  get base () {
+    let image = this.#image
+
+    for (const component of this.#components) {
+      const value = component.build?.image
+
+      if (image !== null && image !== value)
+        throw new Error('Mono deployment requires different base images for its components. Specify base image for the composition in the context.')
+
+      image = value
+    }
+
+    return image
+  }
+
+  get run () {
+    const commands = []
+
+    for (const component of this.#components) {
+      const run = component.build?.run
+
+      if (run !== undefined)
+        commands.push(run)
+    }
+
+    return commands.join('\n')
+  }
+
+  async prepare (root) {
+    const context = await super.prepare(root)
+
+    for (const component of this.#components)
+      await fs.copy(component.path, join(context, component.locator.label))
+
+    return context
+  }
+}
+
+exports.Mono = Mono