Run build - Create a tag

Run build

Execute the build with a new tag image for the specified build.

POST/v1/build/run/{buildSeq}

Path parameters

buildSeq*integer (int32)

Query parameters

tagNamestring

descriptionstring

callbackUrlstring

callback URL

Response

Body

useYnstring

Usage status (Enabled: Y, Disabled: N)

Example: "Y"

createdstring

creation time

Example: "2022-12-02 08:42:46"

updatedstring

update time

Example: "2022-12-02 08:42:46"

buildNamestring

Example: "build-test"

buildDescstring

Example: "build-test"

registryNamestring

Example: "dev"

imageNamestring

Example: "build-api-test-gradle"

accountSeqinteger

Account number (system's account number)

Example: 1

registryProjectIdinteger

Example: 27

externalRegistrySeqinteger

Example: 0

buildServerHoststring

Build server host (information about the server host where actual build steps are executed and images are generated)

Example: "topic:build-20230623-ws-namespace-thingcluster"

buildServerTlsVerifystring

Whether TLS is used on the server where the actual build is executed (Enabled: Y, Disabled: N)

Example: "N"

buildServerCacrtstring

TLS CA for the build execution server (CA value for TLS integration on the server where the actual build is executed)

Example: ""

buildServerClientCertstring

Client certificate for the build execution server(Client certificate for TLS integration on the server where the actual build is executed.)

Example: ""

buildServerClientKeystring

Client key for the build execution server.(Client key for TLS integration on the server where the actual build is executed.)

Example: ""

buildRunSeqinteger

Example: 1

buildSeqinteger

Example: 1

buildNointeger

Example: 1

runTypestring

Build run type('BUILD' or 'CANCEL' or 'REMOVE')

Example: "BUILD"

runDescstring

Build run type

Example: "Build run test"

runStatestring

build run state('CREATED' or 'RUNNING' or 'DONE' or 'ERROR')

Example: "DONE"

autotagUseYnstring

Automatic tagging usage status (Enabled: Y, Disabled: N)

Example: "N"

autotagPrefixstring

Example: "test"

autotagSeqTypestring

autotag sequence number type('DATETIME' or 'SEQUENCE')

Example: "DATETIME"

tagNamestring

Image tag name (tag name of the image to be built)

Example: "8u292-rmsoft"

callbackUrlstring

callback URL

Example: "http://dashboard:3000/callback"

imageUrlstring

Image URL (URL of the image registered in the registry)

Example: "dev.cocktailcloud.io/ops/build-api-test-gradle"

imageSizeinteger

Image size (bytes) (saved only if the build is successful)

Example: 133745493

imageDigeststring

Image Digest(saved only if the build is successful)

Example: "sha256:30c1930cbee0c55a2ab23708866b8b9c6f555b17382df716d1e675eefbf5083b"

pipelineSeqinteger

Example: 0

relatedPipelineInfoRelatedPipelineInfoVO (object)

Pipeline information model related to builds

pipelineContainerSeqinteger

Example: 0

pipelineWorkloadSeqinteger

Example: 0

namespaceNamestring

Example: "cocktail-system"

workloadNamestring

Example: "cocktail-api"

containerNamestring

Example: "api"

componentSeqinteger

Example: 0

useYnstring

Usage status (Enabled: Y, Disabled: N)

Example: "Y"

accountSeqinteger

Account number (system's account number)

Example: 1

serviceSeqinteger

Example: 0

appmapSeqinteger

Example: 0

clusterIdstring

Example: "thingcluster"

beginTimestring

begintime(format : data-time)

Example: "2022-12-02T08:42:43.000+00:00"

endTimestring (date-time)

endtime(format : data-time)

Example: "2022-12-02T08:43:40.000+00:00"

runTimeBySecinteger

runtime(unit : seconds)(endTime - beginTime)

Example: 57

buildStepRunsarray of BuildStepRunVO (object)

useYnstring

Usage status (Enabled: Y, Disabled: N)

createdstring

Creation time

updatedstring

update time

buildStepRunSeqinteger

buildStepSeqinteger

buildRunSeqinteger

stepTypestring

build step type(CODE_DOWN(Code repesitory task) or USER_TASK(user task) or FTP(file(FTP) task) or HTTP(REST call task) or SHELL(script task) or CREATE_IMAGE(image build task))

stepConfigstring

stepStatestring

bulid step state('WAIT' or 'RUNNING' or 'ERROR' or 'DONE')

stepOrderinteger

logIdstring

logstring

beginTimestring

beginTime(format : data-time)

endTimestring (date-time)

endTime(format : data-time)

runTimeBySecinteger

runTime(단위 : 초)(endTime - beginTime)

useFlagboolean

빌드 단계 사용 여부

buildStepConfigobject

빌드 단계 Config(단계 종류에 따라 필드가 달라짐.)

buildStepSeqinteger

stepType*string

빌드 단계 종류(CODE_DOWN(코드 리파지토리 작업) or USER_TASK(사용자 작업) or FTP(파일(FTP) 작업) or HTTP(REST 호출 작업) or SHELL(스크립트 작업) or CREATE_IMAGE(이미지 빌드 작업))

stepTitlestring

빌드 단계 작업 이름

stepDescstring

빌드 단계 작업 설명

repositoryType*string

레파지토리 종류(GIT)

repositoryUrl*string

레파지토리 URL

commonType*string

Common저장소 사용 여부(체크 박스 선택 : [COMMON] 저장소 체크, 미 선택 : [PRIVATE])

protocolType*string

프로토콜 사용(라디오 버튼 프로토콜 Type 선택 : 'http' or 'https')

userIdstring

사용자 아이디

passwordstring

사용자 비밀번호

branchName*string

브랜치 이름

codeSaveDirstring

코드 저장 디렉토리

httpSslVerifySkipboolean

인증서 검증 skip

possibleActionsarray of string

List of possible actions('VIEW', 'BUILD', 'LOG', 'REMOVE', 'CANCEL')

itemsstring

Request

Response

Run build

Execute the build with a new tag image for the specified build.

POST/v1/build/run/{buildSeq}

Path parameters

buildSeq*integer (int32)

Query parameters

tagNamestring

descriptionstring

callbackUrlstring

callback URL

Response

Body

useYnstring

Usage status (Enabled: Y, Disabled: N)

Example: "Y"

createdstring

creation time

Example: "2022-12-02 08:42:46"

updatedstring

update time

Example: "2022-12-02 08:42:46"

buildNamestring

Example: "build-test"

buildDescstring

Example: "build-test"

registryNamestring

Example: "dev"

imageNamestring

Example: "build-api-test-gradle"

accountSeqinteger

Account number (system's account number)

Example: 1

registryProjectIdinteger

Example: 27

externalRegistrySeqinteger

Example: 0

buildServerHoststring

Build server host (information about the server host where actual build steps are executed and images are generated)

Example: "topic:build-20230623-ws-namespace-thingcluster"

buildServerTlsVerifystring

Whether TLS is used on the server where the actual build is executed (Enabled: Y, Disabled: N)

Example: "N"

buildServerCacrtstring

TLS CA for the build execution server (CA value for TLS integration on the server where the actual build is executed)

Example: ""

buildServerClientCertstring

Client certificate for the build execution server(Client certificate for TLS integration on the server where the actual build is executed.)

Example: ""

buildServerClientKeystring

Client key for the build execution server.(Client key for TLS integration on the server where the actual build is executed.)

Example: ""

buildRunSeqinteger

Example: 1

buildSeqinteger

Example: 1

buildNointeger

Example: 1

runTypestring

Build run type('BUILD' or 'CANCEL' or 'REMOVE')

Example: "BUILD"

runDescstring

Build run type

Example: "Build run test"

runStatestring

build run state('CREATED' or 'RUNNING' or 'DONE' or 'ERROR')

Example: "DONE"

autotagUseYnstring

Automatic tagging usage status (Enabled: Y, Disabled: N)

Example: "N"

autotagPrefixstring

Example: "test"

autotagSeqTypestring

autotag sequence number type('DATETIME' or 'SEQUENCE')

Example: "DATETIME"

tagNamestring

Image tag name (tag name of the image to be built)

Example: "8u292-rmsoft"

callbackUrlstring

callback URL

Example: "http://dashboard:3000/callback"

imageUrlstring

Image URL (URL of the image registered in the registry)

Example: "dev.cocktailcloud.io/ops/build-api-test-gradle"

imageSizeinteger

Image size (bytes) (saved only if the build is successful)

Example: 133745493

imageDigeststring

Image Digest(saved only if the build is successful)

Example: "sha256:30c1930cbee0c55a2ab23708866b8b9c6f555b17382df716d1e675eefbf5083b"

pipelineSeqinteger

Example: 0

relatedPipelineInfoRelatedPipelineInfoVO (object)

Pipeline information model related to builds

pipelineContainerSeqinteger

Example: 0

pipelineWorkloadSeqinteger

Example: 0

namespaceNamestring

Example: "cocktail-system"

workloadNamestring

Example: "cocktail-api"

containerNamestring

Example: "api"

componentSeqinteger

Example: 0

useYnstring

Usage status (Enabled: Y, Disabled: N)

Example: "Y"

accountSeqinteger

Account number (system's account number)

Example: 1

serviceSeqinteger

Example: 0

appmapSeqinteger

Example: 0

clusterIdstring

Example: "thingcluster"

beginTimestring

begintime(format : data-time)

Example: "2022-12-02T08:42:43.000+00:00"

endTimestring (date-time)

endtime(format : data-time)

Example: "2022-12-02T08:43:40.000+00:00"

runTimeBySecinteger

runtime(unit : seconds)(endTime - beginTime)

Example: 57

buildStepRunsarray of BuildStepRunVO (object)

useYnstring

Usage status (Enabled: Y, Disabled: N)

createdstring

Creation time

updatedstring

update time

buildStepRunSeqinteger

buildStepSeqinteger

buildRunSeqinteger

stepTypestring

build step type(CODE_DOWN(Code repesitory task) or USER_TASK(user task) or FTP(file(FTP) task) or HTTP(REST call task) or SHELL(script task) or CREATE_IMAGE(image build task))

stepConfigstring

stepStatestring

bulid step state('WAIT' or 'RUNNING' or 'ERROR' or 'DONE')

stepOrderinteger

logIdstring

logstring

beginTimestring

beginTime(format : data-time)

endTimestring (date-time)

endTime(format : data-time)

runTimeBySecinteger

runTime(단위 : 초)(endTime - beginTime)

useFlagboolean

빌드 단계 사용 여부

buildStepConfigobject

빌드 단계 Config(단계 종류에 따라 필드가 달라짐.)

buildStepSeqinteger

stepType*string

stepTitlestring

빌드 단계 작업 이름

stepDescstring

빌드 단계 작업 설명

repositoryType*string

레파지토리 종류(GIT)

repositoryUrl*string

레파지토리 URL

commonType*string

Common저장소 사용 여부(체크 박스 선택 : [COMMON] 저장소 체크, 미 선택 : [PRIVATE])

protocolType*string

프로토콜 사용(라디오 버튼 프로토콜 Type 선택 : 'http' or 'https')

userIdstring

사용자 아이디

passwordstring

사용자 비밀번호

branchName*string

브랜치 이름

codeSaveDirstring

코드 저장 디렉토리

httpSslVerifySkipboolean

인증서 검증 skip

possibleActionsarray of string

List of possible actions('VIEW', 'BUILD', 'LOG', 'REMOVE', 'CANCEL')

itemsstring

Request

Response

[
  {
    "useYn": "Y",
    "created": "2022-12-02 08:42:46",
    "updated": "2022-12-02 08:42:46",
    "buildName": "build-test",
    "buildDesc": "build-test",
    "registryName": "dev",
    "imageName": "build-api-test-gradle",
    "accountSeq": 1,
    "registryProjectId": 27,
    "externalRegistrySeq": 0,
    "buildServerHost": "topic:build-20230623-ws-namespace-thingcluster",
    "buildServerTlsVerify": "N",
    "buildServerCacrt": "",
    "buildServerClientCert": "",
    "buildServerClientKey": "",
    "buildRunSeq": 1,
    "buildSeq": 1,
    "buildNo": 1,
    "runType": "BUILD",
    "runDesc": "Build run test",
    "runState": "DONE",
    "autotagUseYn": "N",
    "autotagPrefix": "test",
    "autotagSeqType": "DATETIME",
    "tagName": "8u292-rmsoft",
    "callbackUrl": "http://dashboard:3000/callback",
    "imageUrl": "dev.cocktailcloud.io/ops/build-api-test-gradle",
    "imageSize": 133745493,
    "imageDigest": "sha256:30c1930cbee0c55a2ab23708866b8b9c6f555b17382df716d1e675eefbf5083b",
    "pipelineSeq": 0,
    "relatedPipelineInfo": {
      "pipelineContainerSeq": 0,
      "pipelineWorkloadSeq": 0,
      "namespaceName": "cocktail-system",
      "workloadName": "cocktail-api",
      "containerName": "api",
      "componentSeq": 0,
      "useYn": "Y",
      "accountSeq": 1,
      "serviceSeq": 0,
      "appmapSeq": 0,
      "clusterId": "thingcluster"
    },
    "beginTime": "2022-12-02T08:42:43.000+00:00",
    "endTime": "2022-12-02T08:43:40.000+00:00",
    "runTimeBySec": 57,
    "buildStepRuns": [
      {
        "useYn": "Y",
        "created": "2022-12-02 08:42:46",
        "updated": "2022-12-02 08:42:46",
        "buildStepRunSeq": 1,
        "buildStepSeq": 1,
        "buildRunSeq": 1,
        "stepType": "CODE_DOWN",
        "stepConfig": "",
        "stepState": "WAIT",
        "stepOrder": 1,
        "logId": "zgq0ng-1.679.2036-create_image",
        "log": "",
        "beginTime": "2022-12-02T08:42:43.000+00:00",
        "endTime": "2022-12-02T08:43:40.000+00:00",
        "runTimeBySec": 57,
        "useFlag": true,
        "buildStepConfig": {
          "stepType": "CODE_DOWN",
          "repositoryType": "GIT",
          "stepTitle": "code repository task",
          "repositoryUrl": "github.com/gradle-sample-app.git",
          "branchName": "master",
          "codeSaveDir": "repo",
          "commonType": "COMMON",
          "protocolType": "https"
        }
      },
      {
        "useYn": "Y",
        "created": "2022-12-02 08:42:46",
        "updated": "2022-12-02 08:42:46",
        "buildStepRunSeq": 1,
        "buildStepSeq": 1,
        "buildRunSeq": 1,
        "stepType": "USER_TASK",
        "stepConfig": "",
        "stepState": "WAIT",
        "stepOrder": 2,
        "logId": "zgq0ng-1.679.2036-create_image",
        "log": "",
        "beginTime": "2022-12-02T08:42:43.000+00:00",
        "endTime": "2022-12-02T08:43:40.000+00:00",
        "runTimeBySec": 57,
        "useFlag": true,
        "buildStepConfig": {
          "stepType": "USER_TASK",
          "stepTitle": "user task",
          "cmd": [
            "mvn",
            "clean",
            "install"
          ],
          "workingDir": "/build",
          "imageName": "build-api-test-gradle",
          "imageTag": "8u292-rmsoft",
          "dockerVolumeMountVOList": [
            {
              "containerPath": "/build",
              "hostPath": "$PWD/repo"
            }
          ]
        }
      },
      {
        "useYn": "Y",
        "created": "2022-12-02 08:42:46",
        "updated": "2022-12-02 08:42:46",
        "buildStepRunSeq": 1,
        "buildStepSeq": 1,
        "buildRunSeq": 1,
        "stepType": "FTP",
        "stepConfig": "",
        "stepState": "WAIT",
        "stepOrder": 3,
        "logId": "zgq0ng-1.679.2036-create_image",
        "log": "",
        "beginTime": "2022-12-02T08:42:43.000+00:00",
        "endTime": "2022-12-02T08:43:40.000+00:00",
        "runTimeBySec": 57,
        "useFlag": true,
        "buildStepConfig": {
          "stepType": "FTP",
          "stepTitle": "file(FTP) task",
          "url": "test-ftp.gradle-sample-test",
          "ftpType": "SFTP",
          "username": "runapps",
          "sourceFiles": "/data/dataset",
          "remoteDirectory": "data/gradle-sample-dataset",
          "ftpExecType": "DIR_FTP_DOWN"
        }
      },
      {
        "useYn": "Y",
        "created": "2022-12-02 08:42:46",
        "updated": "2022-12-02 08:42:46",
        "buildStepRunSeq": 1,
        "buildStepSeq": 1,
        "buildRunSeq": 1,
        "stepType": "HTTP",
        "stepConfig": "",
        "stepState": "WAIT",
        "stepOrder": 4,
        "logId": "zgq0ng-1.679.2036-create_image",
        "log": "",
        "beginTime": "2022-12-02T08:42:43.000+00:00",
        "endTime": "2022-12-02T08:43:40.000+00:00",
        "runTimeBySec": 57,
        "useFlag": true,
        "buildStepConfig": {
          "stepType": "HTTP",
          "stepTitle": "REST call task",
          "url": "https://priv-regi.cocktailcloud.io/api/gradle-sample-dataset",
          "httpMode": "GET",
          "ignoreSslErrors": false,
          "username": "admin",
          "timeout": 5,
          "validResponseCodes": "200",
          "outputFile": "project-list.txt",
          "consoleLogResponseBody": false
        }
      },
      {
        "useYn": "Y",
        "created": "2022-12-02 08:42:46",
        "updated": "2022-12-02 08:42:46",
        "buildStepRunSeq": 1,
        "buildStepSeq": 1,
        "buildRunSeq": 1,
        "stepType": "SHELL",
        "stepConfig": "",
        "stepState": "WAIT",
        "stepOrder": 5,
        "logId": "zgq0ng-1.679.2036-create_image",
        "log": "",
        "beginTime": "2022-12-02T08:42:43.000+00:00",
        "endTime": "2022-12-02T08:43:40.000+00:00",
        "runTimeBySec": 57,
        "useFlag": true,
        "buildStepConfig": {
          "stepType": "SHELL",
          "stepTitle": "script task",
          "shellType": "SCRIPT",
          "command": "echo \">>> move app source\"\ncd repo\n\necho \">>> node_modules compression\"\ntar -cf node_modules.tar node_modules/\n\nls -al"
        }
      },
      {
        "useYn": "Y",
        "created": "2022-12-02 08:42:46",
        "updated": "2022-12-02 08:42:46",
        "buildStepRunSeq": 1,
        "buildStepSeq": 1,
        "buildRunSeq": 1,
        "stepType": "CREATE_IMAGE",
        "stepConfig": "",
        "stepState": "WAIT",
        "stepOrder": 6,
        "logId": "zgq0ng-1.679.2036-create_image",
        "log": "",
        "beginTime": "2022-12-02T08:42:43.000+00:00",
        "endTime": "2022-12-02T08:43:40.000+00:00",
        "runTimeBySec": 57,
        "useFlag": true,
        "buildStepConfig": {
          "stepType": "CREATE_IMAGE",
          "buildStepSeq": 5,
          "exitCode": "0",
          "dockerFileType": "CONTENTS",
          "stepTitle": "image build task",
          "dockerFile": "FROM gradle:6.9.2-jdk8",
          "severity": "",
          "registryId": 27,
          "registryName": "dev",
          "imageTag": "8u292-rmsoft",
          "imageName": "build-api-test-gradle"
        }
      }
    ],
    "possibleActions": [
      "VIEW",
      "BUILD",
      "LOG",
      "REMOVE"
    ]
  }
]