@toa.io/operations 0.20.0-dev.4 → 0.20.0-dev.40

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toa.io/operations",
-  "version": "0.20.0-dev.4",
+  "version": "0.20.0-dev.40",
   "description": "Toa Deployment",
   "homepage": "https://toa.io",
   "author": {
@@ -22,14 +22,15 @@
     "access": "public"
   },
   "main": "src/index.js",
+  "types": "types/index.d.ts",
   "scripts": {
     "test": "echo \"Error: run tests from root\" && exit 1"
   },
   "dependencies": {
-    "@toa.io/filesystem": "0.20.0-dev.4",
-    "@toa.io/generic": "0.20.0-dev.4",
-    "@toa.io/yaml": "0.20.0-dev.4",
+    "@toa.io/filesystem": "0.20.0-dev.40",
+    "@toa.io/generic": "0.20.0-dev.40",
+    "@toa.io/yaml": "0.20.0-dev.40",
     "execa": "5.1.1"
   },
-  "gitHead": "a62b12d77a405d18eb92e879672455b6fb2fd9f2"
+  "gitHead": "594543488de934deba3598ec5805744af1b3f4c0"
 }

package/readme.md

@@ -11,8 +11,8 @@
 
 registry:
   build:
-    arguments: [NPM_TOKEN]
-    run: echo //npm.pkg.github.com/:_authToken=${NPM_TOKEN} > .npmrc
+    arguments: [GITHUB_TOKEN]
+    run: npm config set //npm.pkg.github.com/:_authToken ${GITHUB_TOKEN}
 ```
 
 `arguments` is a list of environemt varialbes to be passed to `docker build`.
@@ -28,3 +28,15 @@ registry:
       echo test > .test
       rm .test
 ```
+
+#### Registry Credentials
+
+When using private container registry,
+a secret containing required credentials can be specified using `registry.credentials` option.
+
+```yaml
+# context.toa.yaml
+
+registry:
+  credentials: docker-credentials-secret-name
+```

package/src/deployment/.deployment/.describe/components.js

@@ -16,4 +16,5 @@ const components = (compositions) => {
 
   return Array.from(components)
 }
+
 exports.components = components

package/src/deployment/.deployment/.describe/compositions.js

@@ -0,0 +1,26 @@
+'use strict'
+
+function compositions (compositions, variables) {
+  for (const composition of compositions) {
+    addVariables(composition, variables)
+  }
+}
+
+function addVariables (composition, variables) {
+  const used = new Set()
+
+  composition.variables ??= []
+
+  for (const [key, set] of Object.entries(variables)) {
+    if (key !== 'global' && !composition.components.includes(key)) continue
+
+    for (const variable of set) {
+      if (used.has(variable.name)) continue
+
+      composition.variables.push(variable)
+      used.add(variable.name)
+    }
+  }
+}
+
+exports.compositions = compositions

package/src/deployment/.deployment/.describe/index.js

@@ -2,8 +2,12 @@
 
 const { dependencies } = require('./dependencies')
 const { components } = require('./components')
+const { compositions } = require('./compositions')
 const { variables } = require('./variables')
+const { services } = require('./services')
 
 exports.dependencies = dependencies
 exports.components = components
+exports.compositions = compositions
 exports.variables = variables
+exports.services = services

package/src/deployment/.deployment/.describe/services.js

@@ -0,0 +1,9 @@
+'use strict'
+
+function services (services, variables) {
+  for (const service of services) {
+    service.variables = variables.global
+  }
+}
+
+exports.services = services

package/src/deployment/.deployment/describe.js

@@ -2,25 +2,24 @@
 
 const get = require('./.describe')
 
-/**
- * @param {toa.norm.Context} context
- * @param {toa.deployment.Composition[]} compositions
- * @param {toa.deployment.Dependency} dependency
- * @returns {toa.deployment.Contents}
- */
 const describe = (context, compositions, dependency) => {
-  const { references, services, proxies } = dependency
+  const { references, services } = dependency
+
+  dependency.variables.global ??= []
+  dependency.variables.global.unshift({ name: 'TOA_ENV', value: context.environment })
 
   const components = get.components(compositions)
   const dependencies = get.dependencies(references)
-  const variables = get.variables(context, dependency.variables)
+  const credentials = context.registry?.credentials
+
+  get.compositions(compositions, dependency.variables, context.environment)
+  get.services(services, dependency.variables)
 
   return {
     compositions,
     components,
     services,
-    proxies,
-    variables,
+    credentials,
     ...dependencies
   }
 }

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

@@ -2,7 +2,7 @@
 apiVersion: apps/v1
 kind: Deployment
 metadata:
-  name: composition-{{ required "deployment name is required" .name }}
+  name: composition-{{ required "composition name is required" .name }}
 spec:
   replicas: {{ .replicas | default 2 }}
   selector:
@@ -19,20 +19,15 @@ spec:
       containers:
         - name: {{ .name }}
           image: {{ .image }}
-          {{- if $.Values.variables }}
+          {{- if .variables }}
           env:
-            {{- range $component := .components }}
-              {{- range $key, $vars := $.Values.variables }}
-                {{- if eq $component $key }}
-                  {{- range $vars }}
-                  {{- include "env.var" . | indent 12 }}
-                  {{- end }}
-                {{- end }}
-              {{- end }}
-            {{- end }}
-            {{- range $.Values.variables.global }}
+            {{- range .variables }}
             {{- include "env.var" . | indent 12 }}
             {{- end }}
           {{- end }}
+      {{- if $.Values.credentials }}
+      imagePullSecrets:
+        - name: {{ $.Values.credentials }}
+      {{- end }}
 ---
 {{- end }}

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

@@ -16,9 +16,9 @@ spec:
       containers:
         - name: {{ .name }}
           image: {{ .image }}
-          {{- if $.Values.variables }}
+          {{- if .variables }}
           env:
-            {{- range $.Values.variables.global }}
+            {{- range .variables }}
             {{- include "env.var" . | indent 12 }}
             {{- end }}
           {{- end }}

package/src/deployment/chart/values.yaml

@@ -6,6 +6,12 @@ compositions:
     components:
       - todos-tasks
       - todos-stats
+    variables:
+      - name: TOA_CONFIGURATION_TODOS_TASKS
+        value: foo
+        secret:
+          name: secret-name
+          key: secret-key
   - name: users
     image: localhost:5000/composition-users:0.0.0
     replicas: 3
@@ -16,19 +22,6 @@ components:
   - todos-tasks
   - todos-stats
   - users-users
-variables:
-  global:
-    - name: TOA_BINDINGS_AMQP_SYSTEM_USERNAME
-      value: foo
-      secret:
-        name: secret-name
-        key: secret-key
-  todos-tasks:
-    - name: TOA_CONFIGURATION_TODOS_TASKS
-      value: foo
-      secret:
-        name: secret-name
-        key: secret-key
 services:
   - name: resources-gateway
     image: localhost:5000/resources-gateway:0.0.0
@@ -41,7 +34,14 @@ services:
         alb.ingress.kubernetes.io/scheme: internet-facing
         alb.ingress.kubernetes.io/target-type: ip
         alb.ingress.kubernetes.io/listen-ports: '[{"HTTPS": 443}]'
+    variables:
+      - name: TOA_CONFIGURATION_TODOS_TASKS
+        value: foo
+        secret:
+          name: secret-name
+          key: secret-key
 proxies:
   - name: storage-proxy
     target: host.docker.internal
 environment: development
+credentials: docker-credentials

package/src/deployment/deployment.js

@@ -7,39 +7,23 @@ const { dump } = require('@toa.io/yaml')
 
 const { merge, declare, describe } = require('./.deployment')
 
-/**
- * @implements {toa.deployment.Deployment}
- */
 class Deployment {
-  /** @type {toa.deployment.Declaration} */
-  #declaration
-
-  /** @type {toa.deployment.Contents} */
-  #contents
-
-  /** @type {toa.operations.Process} */
+  #chart
+  #values
   #process
-
-  /** @type {string} */
   #target
 
-  /**
-   * @param context {toa.norm.Context}
-   * @param compositions {toa.deployment.Composition[]}
-   * @param dependencies {toa.deployment.Dependency[]}
-   * @param process {toa.operations.Process}
-   */
   constructor (context, compositions, dependencies, process) {
     const dependency = merge(dependencies)
 
-    this.#declaration = declare(context, dependency)
-    this.#contents = describe(context, compositions, dependency)
+    this.#chart = declare(context, dependency)
+    this.#values = describe(context, compositions, dependency)
     this.#process = process
   }
 
   async export (target) {
-    const chart = dump(this.#declaration)
-    const values = dump(this.#contents)
+    const chart = dump(this.#chart)
+    const values = dump(this.#values)
 
     await Promise.all([
       write(join(target, 'Chart.yaml'), chart),
@@ -60,7 +44,7 @@ class Deployment {
     if (options.wait === true) args.push('--wait')
 
     await this.#process.execute('helm', ['dependency', 'update', this.#target])
-    await this.#process.execute('helm', ['upgrade', this.#declaration.name, '-i', ...args, this.#target])
+    await this.#process.execute('helm', ['upgrade', this.#chart.name, '-i', ...args, this.#target])
   }
 
   async template (options) {
@@ -73,12 +57,31 @@ class Deployment {
     if (options.namespace !== undefined) args.push('-n', options.namespace)
 
     return await this.#process.execute('helm',
-      ['template', this.#declaration.name, ...args, this.#target],
+      ['template', this.#chart.name, ...args, this.#target],
       { silently: true })
   }
 
   variables () {
-    return this.#contents.variables
+    const variables = []
+    const used = new Set()
+
+    addVariables(this.#values.compositions, variables, used)
+    addVariables(this.#values.services, variables, used)
+
+    return variables
+  }
+}
+
+function addVariables (list, variables, used = new Set()) {
+  for (const item of list) {
+    if (item.variables === undefined) continue
+
+    for (const variable of item.variables) {
+      if (used.has(variable.name)) continue
+
+      variables.push(variable)
+      used.add(variable.name)
+    }
   }
 }
 

package/src/deployment/factory.js

@@ -8,9 +8,6 @@ const { Registry } = require('./registry')
 const { Composition } = require('./composition')
 const { Service } = require('./service')
 
-/**
- * @implements {toa.deployment.Factory}
- */
 class Factory {
   /** @type {toa.norm.Context} */
   #context
@@ -90,10 +87,10 @@ class Factory {
 
     if (module.deployment === undefined) return
 
-    const annotations = this.#context.annotations?.[pkg.name]
+    const annotation = this.#context.annotations?.[pkg.name]
 
     /** @type {toa.deployment.dependency.Declaration} */
-    const dependency = module.deployment(instances, annotations)
+    const dependency = module.deployment(instances, annotation)
 
     /** @type {toa.deployment.Service[]} */
     const services = dependency.services?.map((service) => this.#service(path, service))

package/src/deployment/images/composition.Dockerfile

@@ -3,16 +3,17 @@ FROM node:18.16.0-alpine3.17
 {{build.arguments}}
 
 ENV NODE_ENV=production
-RUN if [ {{runtime.registry}} != undefined ]; then npm set registry {{runtime.registry}}; fi
-RUN if [ {{runtime.proxy}} != undefined ]; then npm set proxy {{runtime.proxy}}; fi
-RUN npm i -g @toa.io/runtime@{{runtime.version}}
+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
-ADD . .
-
-# run 'npm i' in each component
-RUN find . -maxdepth 1 -type d \( ! -name . \) -exec /bin/sh -c "cd '{}' && if [ -f package.json ]; then npm i; fi" \;
+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
+
+USER node
 CMD toa compose *

package/src/deployment/images/service.Dockerfile

@@ -1,12 +1,14 @@
 FROM node:18.16.0-alpine3.17
 
 ENV NODE_ENV=production
-RUN if [ {{runtime.registry}} != undefined ]; then npm set registry {{runtime.registry}}; fi
-RUN if [ {{runtime.proxy}} != undefined ]; then npm set proxy {{runtime.proxy}}; fi
-RUN npm i -g @toa.io/runtime@{{runtime.version}}
+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 /service
-ADD . .
-RUN npm i
+COPY --chown=node:node . /service
 
+RUN npm i --omit=dev
+
+USER node
 CMD toa serve .

package/src/deployment/operator.js

@@ -2,9 +2,6 @@
 
 const workspace = require('./workspace')
 
-/**
- * @implements {toa.deployment.Operator}
- */
 class Operator {
   /** @type {toa.deployment.Deployment} */
   #deployment

package/types/_deployment/operator.d.ts

@@ -0,0 +1,20 @@
+import * as _deployment from './deployment'
+import * as _dependency from './dependency'
+
+declare namespace toa.deployment {
+
+  interface Operator {
+    export (path?: string): Promise<string>
+
+    install (options?: _deployment.installation.Options): Promise<void>
+
+    template (options?: _deployment.template.Options): Promise<string>
+
+    variables (): _dependency.Variables
+
+    listVariables (): _dependency.Variable[]
+  }
+
+}
+
+export type Operator = toa.deployment.Operator

package/types/dependency.d.ts

@@ -0,0 +1,36 @@
+type Reference = {
+  name: string
+  version: string
+  repository?: string
+  alias?: string
+  values?: Object
+}
+
+type Service = {
+  group: string
+  name: string
+  version: string
+  port: number
+  ingress?: {
+    host: string
+    class: string
+    annotations?: object
+  }
+}
+
+export type Variable = {
+  name: string
+  value?: string
+  secret?: {
+    name: string,
+    key: string
+  }
+}
+
+export type Variables = Record<string, Variable[]>
+
+export type Dependency = {
+  references?: Reference[]
+  services?: Service[]
+  variables?: Variables
+}

package/types/index.d.ts

@@ -0,0 +1 @@
+export * from './dependency'

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

@@ -1,10 +0,0 @@
-{{- range .Values.proxies }}
-apiVersion: v1
-kind: Service
-metadata:
-  name: {{ .name }}
-spec:
-  type: ExternalName
-  externalName: {{ .target }}
----
-{{- end }}

package/src/deployment/deployment.fixtures.js

@@ -1,42 +0,0 @@
-'use strict'
-
-const { generate } = require('randomstring')
-
-const context = /** @type {toa.norm.Context} */ { name: generate() }
-const compositions = []
-/** @type {toa.deployment.Dependency[]} */
-
-/** @type {toa.deployment.dependency.Variable} */
-const bindingVariable = {
-  name: 'TOA_BINDINGS_AMQP_POINTER',
-  value: 'eyJkZWZhdWx0IjoiYW1xcDovL3doYXRldmVyIiwic3lzdGVtIjoiYW1xcDovL2hvc3QwIn0='
-}
-
-/** @type {toa.deployment.dependency.Variable} */
-const secretVariable = {
-  name: 'TOA_BINDINGS_AMQP_DEFAULT_USERNAME',
-  secret: {
-    name: 'toa-bindings-amqp-default',
-    key: 'username'
-  }
-}
-
-/** @type {toa.deployment.Dependency[]} */
-const dependencies = [{
-  variables: { global: [bindingVariable, secretVariable] }
-}]
-
-const process = /** @type {toa.operations.Process} */ { execute: jest.fn() }
-
-const options = /** @type {toa.deployment.installation.Options} */ {
-  namespace: generate(),
-  target: generate()
-}
-
-exports.context = context
-exports.compositions = compositions
-exports.dependencies = dependencies
-exports.process = process
-exports.options = options
-exports.bindingVariable = bindingVariable
-exports.secretVariable = secretVariable

package/src/deployment/deployment.test.js

@@ -1,78 +0,0 @@
-'use strict'
-
-const clone = require('clone-deep')
-
-const fixtures = require('./deployment.fixtures')
-const { Deployment } = require('../../src/deployment/deployment')
-
-/** @type {toa.deployment.Deployment} */
-let deployment
-/** @type {toa.deployment.installation.Options} */
-let options
-
-beforeEach(() => {
-  deployment = new Deployment(fixtures.context, fixtures.compositions, fixtures.dependencies, fixtures.process)
-  options = clone(fixtures.options)
-})
-
-it('should pass -n argument if options.namespace is set', async () => {
-  await deployment.install(options)
-
-  const call = fixtures.process.execute.mock.calls.find((call) => call[0] === 'helm' && call[1][0] === 'upgrade')
-
-  expect(call).toBeDefined()
-
-  const args = call[1]
-  const index = args.findIndex((value) => value === '-n')
-  const namespace = args[index + 1]
-
-  expect(index).not.toStrictEqual(-1)
-  expect(namespace).toStrictEqual(fixtures.options.namespace)
-})
-
-describe('variables', () => {
-  let deployment /** @type {toa.deployment.Deployment} */
-
-  it('should be define', () => {
-    const context = clone(fixtures.context)
-
-    deployment = new Deployment(context, fixtures.compositions, fixtures.dependencies, fixtures.process)
-
-    expect(typeof deployment.variables).toBe('function')
-  })
-
-  it('should return variables', () => {
-    const context = clone(fixtures.context)
-    const [{ variables }] = fixtures.dependencies
-
-    deployment = new Deployment(context, fixtures.compositions, fixtures.dependencies, fixtures.process)
-    expect(deployment.variables()).toEqual(variables)
-  })
-
-  it('should return variables', () => {
-    const context = clone(fixtures.context)
-    const [{ variables }] = fixtures.dependencies
-
-    deployment = new Deployment(context, fixtures.compositions, fixtures.dependencies, fixtures.process)
-
-    expect(deployment.variables()).toEqual(variables)
-  })
-
-  it('should merge all variables', () => {
-    const context = clone(fixtures.context)
-
-    /** @type {toa.deployment.Dependency} */
-    const dep1 = { variables: { global: [fixtures.secretVariable] } }
-
-    /** @type {toa.deployment.Dependency} */
-    const dep2 = { variables: { global: [fixtures.bindingVariable] } }
-
-    deployment = new Deployment(context, fixtures.compositions, [dep1, dep2], fixtures.process)
-
-    const result = deployment.variables()
-    const expectedVariables = [fixtures.bindingVariable, fixtures.secretVariable]
-
-    expect(result.global.length).toBe(expectedVariables.length)
-    expect(result.global).toStrictEqual(expect.arrayContaining(expectedVariables))
-  })
-})

package/types/deployment/operator.d.ts

@@ -1,18 +0,0 @@
-import * as _deployment from './deployment'
-import * as _dependency from './dependency'
-
-declare namespace toa.deployment {
-
-  interface Operator {
-    export(path?: string): Promise<string>
-
-    install(options?: _deployment.installation.Options): Promise<void>
-
-    template(options?: _deployment.template.Options): Promise<string>
-
-    variables(): _dependency.Variables
-  }
-
-}
-
-export type Operator = toa.deployment.Operator

package/types/process.d.ts

@@ -1,13 +0,0 @@
-declare namespace toa.operations {
-
-    namespace process {
-        interface Options {
-            silently?: boolean
-        }
-    }
-
-    interface Process {
-        execute(cmd: string, args: Array<string>, options?: process.Options): Promise<string>
-    }
-
-}