webhook proxy should return build ID and offer service / api to query build status

[opendevstack]

webhook proxy should return build ID and offer service / api to query build status

[michaelsauter]

I changed my mind overnight a little :) I think I will just pass through whatever response I get from OpenShift also when forwarding a webhook request...

[michaelsauter]

@gerardcl OK for me. I am not sure about if this is still needed, see my last comment. Seems not to be needed for 1.2 at least ...

[metmajer]

Thanks @clemensutschig.

What's the context? We are building a simple multi-repo orchestration engine that would integrate with ODS components through the webhook. Naturally, if B depends on A, we want to know that A has finished before kicking off B. Here, A could be a repo containing infrastructure as code.

[clemensutschig]

I tried it with curl

$ curl -X POST -k https://...../oapi/v1/namespaces/ods28-cd/buildconfigs/be-docker-plain-master/webhooks/............../generic
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100  1583  100  1583    0     0   2110      0 --:--:-- --:--:-- --:--:--  2110
{"kind":"Build","apiVersion":"build.openshift.io/v1","metadata":{"name":"be-docker-plain-master-23","namespace":"ods28-cd","selfLink":"/apis/build.openshift.io/v1/namespaces/ods28-cd/buildconfigs/be-docker-plain-master-23/instantiate","uid":"c8e9c214-85fc-11e9-9b41-0050569e63cb","resourceVersion":"129839908","creationTimestamp":"2019-06-03T12:40:36Z","labels":{"buildconfig":"be-docker-plain-master","openshift.io/build-config.name":"be-docker-plain-master","openshift.io/build.start-policy":"Serial"},"annotations":{"openshift.io/build-config.name":"be-docker-plain-master",**"openshift.io/build.number":"23"**},"ownerReferences":[{"apiVersion":"build.openshift.io/v1","kind":"BuildConfig","name":"be-docker-plain-master","uid":"aaf71a4d-6db1-11e9-9bbe-0050569e63cb","controller":true}]},"spec":{"serviceAccount":"builder","source":{"type":"Git","git":{"uri":"..../ods28/ods28-be-docker-plain.git","ref":"master"},"status":{"phase":"New","config":{"kind":"BuildConfig","namespace":"ods28-cd","name":"be-docker-plain-master"},"output":{}}}
{
  "kind": "Status",
  "apiVersion": "v1",
  "metadata": {

  },
  "status": "Success",
  "message": "invalid Content-Type on payload, ignoring payload and continuing with build",
  "code": 200
}

a curl against

 https://..../apis/build.openshift.io/v1/namespaces/ods28-cd/builds/be-docker-plain-master-23

  "status": {
    "phase": "Pending",
    "config": {
      "kind": "BuildConfig",
      "namespace": "ods28-cd",
      "name": "be-docker-plain-master"
    },
    "output": {

does the rest then

[clemensutschig]

playing with this uncovered openshift/api#331

[clemensutschig]

@oalyman - can you pick this up - or wait until @michaelsauter is back (3 weeks)

[clemensutschig]

completed looks this way

  "status": {
    "phase": "Complete",
    "startTimestamp": "2019-02-18T17:18:20Z",
    "completionTimestamp": "2019-02-18T17:24:22Z",
    "config": {
      "kind": "BuildConfig",
      "namespace": "prov-cd",
      "name": "prov-app-test"
    },
    "output": {

    }

and pending

  "status": {
    "phase": "Pending",
    "config": {
      "kind": "BuildConfig",
      "namespace": "prov-cd",
      "name": "ods-provisioning-app-dev"
    },
    "output": {

    }
  }

[michaelsauter]

@clemensutschig @metmajer So if I understand this correctly, then you want one pipeline (the orchestrating one) to know about the status of other pipelines. If so, why should the webhook proxy answer that question? For me the proxy is simply the glue between Bitbucket and Jenkins. To me it looks like you can answer your question directly from a Jenkins pipeline as you can talk to the OpenShift API directly (via oc commands). Right?

[michaelsauter]

As a first step, I will work on returning the build ID, such as be-docker-plain-master-23 when the webhook request is forwarded. Response will be:

{"buildId": "be-docker-plain-master-23"}

Next step would be to add some kind of subfolder, e.g. /oapi/namespaces/:NAMESPACE/builds/:ID that queries for a build status. Here I would probably just pass on whatever OpenShift returns. Sounds good?

[metmajer]

As I understood it, the webhook proxy should act as the central gateway to a Jenkins instance running on OpenShift (see Clemens' first entry). @michaelsauter then what you suggest would be very convenient. Thanks!

[michaelsauter]

@clemensutschig Do we still need a way to query the build ID?

[gerardcl]

@clemensutschig @michaelsauter moving this to 2.0 if it is not solved yet, if not feel free to close

[michaelsauter]

Closing due to no response, please open a new issue when a further feature is required.