@toa.io/operations 0.20.0-dev.3 → 0.20.0-dev.30

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toa.io/operations",
-  "version": "0.20.0-dev.3",
+  "version": "0.20.0-dev.30",
   "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.3",
-    "@toa.io/generic": "0.20.0-dev.3",
-    "@toa.io/yaml": "0.20.0-dev.3",
+    "@toa.io/filesystem": "0.20.0-dev.30",
+    "@toa.io/generic": "0.20.0-dev.30",
+    "@toa.io/yaml": "0.20.0-dev.30",
     "execa": "5.1.1"
   },
-  "gitHead": "3eabf45761f4cf211e1e4c331933ec60b4a828a7"
+  "gitHead": "61c8e74a336385265767e9fd37d49128cb51b17f"
 }

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.js

@@ -14,6 +14,7 @@ const describe = (context, compositions, dependency) => {
   const components = get.components(compositions)
   const dependencies = get.dependencies(references)
   const variables = get.variables(context, dependency.variables)
+  const credentials = context.registry?.credentials
 
   return {
     compositions,
@@ -21,6 +22,7 @@ const describe = (context, compositions, dependency) => {
     services,
     proxies,
     variables,
+    credentials,
     ...dependencies
   }
 }

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

@@ -34,5 +34,9 @@ spec:
             {{- include "env.var" . | indent 12 }}
             {{- end }}
           {{- end }}
+      {{- if $.Values.credentials }}
+      imagePullSecrets:
+        - name: {{ $.Values.credentials }}
+      {{- end }}
 ---
 {{- end }}

package/src/deployment/chart/values.yaml

@@ -45,3 +45,4 @@ proxies:
   - name: storage-proxy
     target: host.docker.internal
 environment: development
+credentials: docker-credentials

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/types/_deployment/dependency.d.ts

@@ -0,0 +1,72 @@
+import * as _service from './service'
+import { dependencies } from '@toa.io/norm/types/context'
+
+declare namespace toa.deployment {
+
+  namespace dependency {
+
+    type Constructor = (instances: dependencies.Instance[], annotation: any) => Declaration
+
+    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
+      }
+    }
+
+    type Proxy = {
+      name: string
+      target: string
+    }
+
+    type Variable = {
+      name: string
+      value?: string | number
+      secret?: {
+        name: string,
+        key: string
+      }
+    }
+
+    type Variables = {
+      [key: string]: Variable[]
+    }
+
+    type Declaration = {
+      references?: Reference[]
+      services?: Service[] // dependency.Service
+      proxies?: Proxy[]
+      variables?: Variables
+    }
+
+  }
+
+  type Dependency = {
+    references?: dependency.Reference[]
+    services?: _service.Service[] // deployment.Service
+    proxies?: dependency.Proxy[]
+    variables?: dependency.Variables
+  }
+
+}
+
+export type Declaration = toa.deployment.dependency.Declaration
+export type Reference = toa.deployment.dependency.Reference
+export type Service = toa.deployment.dependency.Service
+export type Proxy = toa.deployment.dependency.Proxy
+export type Variables = toa.deployment.dependency.Variables
+export type Variable = toa.deployment.dependency.Variable
+export type Dependency = toa.deployment.Dependency

package/types/deployment/dependency.d.ts

@@ -1,72 +1,36 @@
-import * as _service from './service'
-import { dependencies } from '@toa.io/norm/types/context'
-
-declare namespace toa.deployment {
-
-  namespace dependency {
-
-    type Constructor = (instances: dependencies.Instance[], annotation: any) => Declaration
-
-    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
-      }
-    }
-
-    type Proxy = {
-      name: string
-      target: string
-    }
-
-    type Variable = {
-      name: string
-      value?: string | number
-      secret?: {
-        name: string,
-        key: string
-      }
-    }
-
-    type Variables = {
-      [key: string]: Variable[]
-    }
-
-    type Declaration = {
-      references?: Reference[]
-      services?: Service[] // dependency.Service
-      proxies?: Proxy[]
-      variables?: Variables
-    }
+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
   }
+}
 
-  type Dependency = {
-    references?: dependency.Reference[]
-    services?: _service.Service[] // deployment.Service
-    proxies?: dependency.Proxy[]
-    variables?: dependency.Variables
+type Variable = {
+  name: string
+  value?: string
+  secret?: {
+    name: string,
+    key: string
   }
-
 }
 
-export type Declaration = toa.deployment.dependency.Declaration
-export type Reference = toa.deployment.dependency.Reference
-export type Service = toa.deployment.dependency.Service
-export type Proxy = toa.deployment.dependency.Proxy
-export type Variables = toa.deployment.dependency.Variables
-export type Variable = toa.deployment.dependency.Variable
-export type Dependency = toa.deployment.Dependency
+type Variables = Record<string, Variable[]>
+
+export type Dependency = {
+  references?: Reference[]
+  services?: Service[]
+  variables?: Variables
+}

package/types/deployment/index.d.ts

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

package/types/index.d.ts

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