README.md

ink

Controllable CICD workflow service

TODO

• Add the worker for kubernetes.
• Support postgres storage backend.

Setup

一、Docker Compose

docker compose -f docker/compose.yml up

二、Source

1. Run inkd

go run ./cmd/inkd --config config/config.yaml

2. Run inker

go run ./cmd/inker --config config/config.yaml --config-sub-key worker

3. Install inkctl

go install github.com/zc2638/ink/cmd/inkctl@latest

bash completion

source <(inkctl completion bash)

Resources

Workflow

For detailed structure, please go to: v1.Workflow

Example

kind: Workflow
name: test-docker
namespace: default
spec:
  steps:
    - name: step1
      image: alpine:3.18
      command:
        - echo 'step1 docker' > test.log
    - name: step2
      image: alpine:3.18
      shell:
        - /bin/bash
        - -c
      command:
        - echo "step2 sleep"
        - sleep 5
        - echo "step2 sleep over"
    - name: step3
      image: alpine:3.18
      env:
        - name: STATUS
          value: success
      command:
        - cat test.log
        - echo "step3 $STATUS"
        - pwd

For setting mode

you can use

inkctl box trigger {namespace}/{name} --set key1=abc --set key2=value2

kind: Workflow
name: test-docker-setting
namespace: default
spec:
  steps:
    - name: step1
      image: alpine:3.18
      settings:
        - name: key1
        - name: key2
          value: default-key2
          desc: for default key value
      command:
        - echo "key1: $key1"
        - echo "key2: $key2"

Box

For detailed structure, please go to: v1.Box

Example

kind: Box
name: test
namespace: default
resources:
  - name: test-docker
    kind: Workflow
  - name: test-secret
    kind: Secret

Secret

For detailed structure, please go to: v1.Secret

Example

kind: Secret
name: test-secret
namespace: default
data:
  secret1: secret1abc123
  secret2: this is secret2

For imagePullSecrets

kind: Secret
name: image-pull-auth-secret
namespace: default
data:
  .dockerconfigjson: |
    {
      "auths": {
        "index.docker.io": {
          "auth": "bmFtZTpwd2Q="
        }
      }
    }