config.json

{
  "name": "Docker",
  "viewName": "Docker",
  "type": "executer",
  "execProgram": "node",
  "main": "app.js",
  "imgUrl": "logo.png",
  "version": "4.3.0",
  "description": "Build, Push and Pull Docker Containers or run other Docker Commands",
  "category": [
    "Containers"
  ],
  "keywords": [
    "cloud",
    "container",
    "image",
    "docker",
    "push",
    "pull",
    "tag",
    "repository",
    "cli"
  ],
  "methods": [
    {
      "name": "build",
      "viewName": "Build Image",
      "allowEmptyResult": true,
      "params": [
        {
          "name": "PATH",
          "viewName": "Working Directory",
          "type": "string",
          "description": "Path on Kaholo agent to use as working directory, if empty default working directory is used.",
          "placeholder": "myrepo/docker",
          "learnUrl": "https://docs.docker.com/engine/reference/commandline/image_build/",
          "parserType": "filePath",
          "parserOptions": {
            "throwIfDoesntExist": true,
            "acceptedTypes": ["directory"]
          }
        },
        {
          "name": "dockerfileName",
          "viewName": "Dockerfile Path",
          "description": "Dockerfile name or relative path within the working directory",
          "type": "string",
          "default": "Dockerfile",
          "placeholder": "Dockerfile"
        },
        {
          "name": "TAG",
          "viewName": "Tag",
          "type": "string",
          "description": "If specified, tag the new Docker image with the specified tag.",
          "placeholder": "kaholo:1.0.0",
          "learnUrl": "https://docs.docker.com/engine/reference/commandline/image_tag/"
        }
      ]
    },
    {
      "name": "run",
      "viewName": "Run Docker Container",
      "allowEmptyResult": true,
      "params": [
        {
          "name": "imageName",
          "viewName": "Image",
          "type": "string",
          "description": "Name of the docker image to use to create container",
          "placeholder": "alpine",
          "learnUrl": "https://docs.docker.com/engine/reference/run/",
          "required": true
        },
        {
          "name": "command",
          "viewName": "Command",
          "type": "text",
          "description": "Command to be executed by the container",
          "learnUrl": "https://docs.docker.com/engine/reference/run/",
          "required": false
        },
        {
          "name": "environmentalVariables",
          "viewName": "Environment variables",
          "type": "text",
          "parserType": "keyValuePairs",
          "description": "Optional one-per-line key=value pairs for the container's environment",
          "placeholder": "DEPLOYMODE=Test",
          "required": false
        },
        {
          "name": "secretEnvVariables",
          "viewName": "Secret Environment Variables",
          "type": "vault",
          "parserType": "keyValuePairs",
          "description": "One-per-line Key=Value pairs stored as a Kaholo Vault item"
        },
        {
          "name": "workingDirectory",
          "viewName": "Working directory",
          "type": "string",
          "placeholder": "/twiddlebug/workspace/",
          "parserType": "filePath",
          "parserOptions": {
            "throwIfDoesntExist": true
          },
          "description": "Directory on Kaholo agent that will be mounted by container and be the working directory within the container",
          "required": false
        }
      ]
    },
    {
      "name": "pull",
      "viewName": "Pull Image",
      "allowEmptyResult": true,
      "params": [
        {
          "name": "USER",
          "viewName": "Username",
          "type": "string",
          "description": "The username of the Docker user used to authenticate for this request.",
          "placeholder": "username",
          "learnUrl": "https://docs.docker.com/engine/reference/commandline/image_pull/"
        },
        {
          "name": "PASSWORD",
          "viewName": "Password",
          "type": "vault",
          "description": "The password of the Docker user used to authenticate for this request.",
          "placeholder": "pass1234!",
          "learnUrl": "https://docs.docker.com/engine/reference/commandline/image_pull/"
        },
        {
          "name": "image",
          "viewName": "Image",
          "type": "string",
          "description": "Docker-style URL:port/repository:tag string, where URL, port, and tag default (if excluded) to docker.io, 443, and latest, respectively.",
          "placeholder": "mydockerrepos.myorg.com:8088/dev/builds/myproject:1.0.0",
          "learnUrl": "https://docs.docker.com/engine/reference/commandline/image_push/",
          "required": true
        }
      ]
    },
    {
      "name": "pushImage",
      "viewName": "Push Image",
      "allowEmptyResult": true,
      "params": [
        {
          "name": "USER",
          "viewName": "Username",
          "type": "string",
          "description": "The username of the Docker user used to authenticate for this request.",
          "placeholder": "username",
          "learnUrl": "https://docs.docker.com/engine/reference/commandline/image_push/",
          "required": true
        },
        {
          "name": "PASSWORD",
          "viewName": "Password",
          "type": "vault",
          "description": "The password of the Docker user used to authenticate for this request.",
          "placeholder": "pass1234!",
          "learnUrl": "https://docs.docker.com/engine/reference/commandline/image_push/",
          "required": true
        },
        {
          "name": "image",
          "viewName": "Image",
          "type": "string",
          "description": "Docker-style URL:port/repository:tag string, where URL, port, and tag default (if excluded) to docker.io, 443, and latest, respectively.",
          "placeholder": "mydockerrepos.myorg.com:8088/dev/builds/myproject:1.0.0",
          "learnUrl": "https://docs.docker.com/engine/reference/commandline/image_push/",
          "required": true
        }
      ]
    },
    {
      "name": "tag",
      "viewName": "Tag image",
      "allowEmptyResult": true,
      "params": [
        {
          "name": "sourceImage",
          "viewName": "Source Image",
          "type": "string",
          "description": "Source Image in the same format as SOURCE_IMAGE in \"docker tag\" command.",
          "placeholder": "docker.io/alpine:latest",
          "learnUrl": "https://docs.docker.com/engine/reference/commandline/image_tag/",
          "required": true
        },
        {
          "name": "targetImage",
          "viewName": "Target Image",
          "type": "string",
          "description": "Target Image in the same format as TARGET_IMAGE in \"docker tag\" command.",
          "placeholder": "my-repo.io/my-new-tag:1.0.0",
          "learnUrl": "https://docs.docker.com/engine/reference/commandline/image_tag/",
          "required": true
        }
      ]
    },
    {
      "name": "cmdExec",
      "viewName": "Run Docker Command",
      "allowEmptyResult": true,
      "params": [
        {
          "name": "USER",
          "viewName": "Username",
          "type": "string",
          "description": "The username of the Docker user used to authenticate for this request.",
          "placeholder": "username",
          "learnUrl": "https://docs.docker.com/engine/reference/commandline/image_push/"
        },
        {
          "name": "PASSWORD",
          "viewName": "Password",
          "type": "vault",
          "description": "The password of the Docker user used to authenticate for this request.",
          "placeholder": "pass1234!",
          "learnUrl": "https://docs.docker.com/engine/reference/commandline/image_push/"
        },
        {
          "name": "registryUrl",
          "viewName": "Registry URL",
          "type": "string",
          "description": "URL of the docker registry.",
          "placeholder": "https://registry-1.docker.io",
          "learnUrl": "https://docs.docker.com/engine/reference/commandline/image_push/"
        },
        {
          "name": "PARAMS",
          "viewName": "Command",
          "type": "string",
          "description": "The docker command to run. No need to specify 'docker' in the start of the command.",
          "placeholder": "build https://github.com/docker/rootfs.git#container:docker",
          "learnUrl": "https://docs.docker.com/"
        },
        {
          "name": "attemptJson",
          "viewName": "Attempt JSON Output",
          "type": "boolean",
          "default": false,
          "description": "If selected '--format {{json . }}' will be appended to the command, and output will be parsed as JSON"
        }
      ]
    }
  ]
}