Added helm endpoint to get infos about the given release #4059

akashshinde · 2020-01-24T10:04:30Z

This PR adds following helm service routes CC: @sbose78 @pedjak

/api/helm/manifests?ns=namespace&release_name=release_name

To Test

curl /api/helm/releases?ns=namespace&release_name=release-name
Response should return yaml array of all installed kube resources by respective release.

akashshinde · 2020-01-24T10:33:39Z

/test analyze

sbose78 · 2020-01-24T11:22:00Z

/hold
Checking if UI really needs it.

pedjak · 2020-01-24T12:05:07Z

Not sure if we really need the additional endpoint, because recently merged /api/helm/releases (#3826) gives you the list of all available releases, and the returned response containing these manifests and much more (i.e. all relevant Helm release infos). For example, for /api/helm/releases?namespace=foo, you might get on a cluster the following:

[
  {
    "name": "foo3",
    "info": {
      "first_deployed": "2020-01-22T13:59:18.293548246+01:00",
      "last_deployed": "2020-01-22T13:59:18.293548246+01:00",
      "deleted": "",
      "description": "Install complete",
      "status": "deployed",
      "notes": "1. Get the application URL by running these commands:\n  export POD_NAME=$(kubectl get pods --namespace foo -l \"app=foo3-mink\" -o jsonpath=\"{.items[0].metadata.name}\")\n  echo \"Visit http://127.0.0.1:8080 to use your application\"\n  kubectl port-forward $POD_NAME 8080:80\n"
    },
    "chart": {
      "metadata": {
        "name": "mink",
        "version": "0.1.0",
        "description": "A Helm chart for Kubernetes",
        "apiVersion": "v1"
      },
      "lock": null,
      "templates": [
        {
          "name": "templates/NOTES.txt",
          "data": "MS4gR2V0IHRoZSBhcHBsaWNhdGlvbiBVUkwgYnkgcnVubmluZyB0aGVzZSBjb21tYW5kczoKe3stIGlmIGNvbnRhaW5zICJOb2RlUG9ydCIgLlZhbHVlcy5zZXJ2aWNlLnR5cGUgfX0KICBleHBvcnQgTk9ERV9QT1JUPSQoa3ViZWN0bCBnZXQgLS1uYW1lc3BhY2Uge3sgLlJlbGVhc2UuTmFtZXNwYWNlIH19IC1vIGpzb25wYXRoPSJ7LnNwZWMucG9ydHNbMF0ubm9kZVBvcnR9IiBzZXJ2aWNlcyB7eyB0ZW1wbGF0ZSAiZnVsbG5hbWUiIC4gfX0pCiAgZXhwb3J0IE5PREVfSVA9JChrdWJlY3RsIGdldCBub2RlcyAtLW5hbWVzcGFjZSB7eyAuUmVsZWFzZS5OYW1lc3BhY2UgfX0gLW8ganNvbnBhdGg9InsuaXRlbXNbMF0uc3RhdHVzLmFkZHJlc3Nlc1swXS5hZGRyZXNzfSIpCiAgZWNobyBodHRwOi8vJE5PREVfSVA6JE5PREVfUE9SVC9sb2dpbgp7ey0gZWxzZSBpZiBjb250YWlucyAiTG9hZEJhbGFuY2VyIiAuVmFsdWVzLnNlcnZpY2UudHlwZSB9fQogICAgIE5PVEU6IEl0IG1heSB0YWtlIGEgZmV3IG1pbnV0ZXMgZm9yIHRoZSBMb2FkQmFsYW5jZXIgSVAgdG8gYmUgYXZhaWxhYmxlLgogICAgICAgICAgIFlvdSBjYW4gd2F0Y2ggdGhlIHN0YXR1cyBvZiBieSBydW5uaW5nICdrdWJlY3RsIGdldCBzdmMgLXcge3sgdGVtcGxhdGUgImZ1bGxuYW1lIiAuIH19JwogIGV4cG9ydCBTRVJWSUNFX0lQPSQoa3ViZWN0bCBnZXQgc3ZjIC0tbmFtZXNwYWNlIHt7IC5SZWxlYXNlLk5hbWVzcGFjZSB9fSB7eyB0ZW1wbGF0ZSAiZnVsbG5hbWUiIC4gfX0gLW8ganNvbnBhdGg9J3suc3RhdHVzLmxvYWRCYWxhbmNlci5pbmdyZXNzWzBdLmlwfScpCiAgZWNobyBodHRwOi8vJFNFUlZJQ0VfSVA6e3sgLlZhbHVlcy5zZXJ2aWNlLmV4dGVybmFsUG9ydCB9fQp7ey0gZWxzZSBpZiBjb250YWlucyAiQ2x1c3RlcklQIiAgLlZhbHVlcy5zZXJ2aWNlLnR5cGUgfX0KICBleHBvcnQgUE9EX05BTUU9JChrdWJlY3RsIGdldCBwb2RzIC0tbmFtZXNwYWNlIHt7IC5SZWxlYXNlLk5hbWVzcGFjZSB9fSAtbCAiYXBwPXt7IHRlbXBsYXRlICJmdWxsbmFtZSIgLiB9fSIgLW8ganNvbnBhdGg9InsuaXRlbXNbMF0ubWV0YWRhdGEubmFtZX0iKQogIGVjaG8gIlZpc2l0IGh0dHA6Ly8xMjcuMC4wLjE6ODA4MCB0byB1c2UgeW91ciBhcHBsaWNhdGlvbiIKICBrdWJlY3RsIHBvcnQtZm9yd2FyZCAkUE9EX05BTUUgODA4MDp7eyAuVmFsdWVzLnNlcnZpY2UuZXh0ZXJuYWxQb3J0IH19Cnt7LSBlbmQgfX0K"
        },
        {
          "name": "templates/_helpers.tpl",
          "data": "e3svKiB2aW06IHNldCBmaWxldHlwZT1tdXN0YWNoZTogKi99fQp7ey8qCkV4cGFuZCB0aGUgbmFtZSBvZiB0aGUgY2hhcnQuCiovfX0Ke3stIGRlZmluZSAibmFtZSIgLX19Cnt7LSBkZWZhdWx0IC5DaGFydC5OYW1lIC5WYWx1ZXMubmFtZU92ZXJyaWRlIHwgdHJ1bmMgMjQgLX19Cnt7LSBlbmQgLX19Cgp7ey8qCkNyZWF0ZSBhIGRlZmF1bHQgZnVsbHkgcXVhbGlmaWVkIGFwcCBuYW1lLgpXZSB0cnVuY2F0ZSBhdCAyNCBjaGFycyBiZWNhdXNlIHNvbWUgS3ViZXJuZXRlcyBuYW1lIGZpZWxkcyBhcmUgbGltaXRlZCB0byB0aGlzIChieSB0aGUgRE5TIG5hbWluZyBzcGVjKS4KKi99fQp7ey0gZGVmaW5lICJmdWxsbmFtZSIgLX19Cnt7LSAkbmFtZSA6PSBkZWZhdWx0IC5DaGFydC5OYW1lIC5WYWx1ZXMubmFtZU92ZXJyaWRlIC19fQp7ey0gcHJpbnRmICIlcy0lcyIgLlJlbGVhc2UuTmFtZSAkbmFtZSB8IHRydW5jIDI0IC19fQp7ey0gZW5kIC19fQo="
        },
        {
          "name": "templates/deployment.yaml",
          "data": "YXBpVmVyc2lvbjogZXh0ZW5zaW9ucy92MWJldGExCmtpbmQ6IERlcGxveW1lbnQKbWV0YWRhdGE6CiAgbmFtZToge3sgdGVtcGxhdGUgImZ1bGxuYW1lIiAuIH19CiAgbGFiZWxzOgogICAgY2hhcnQ6ICJ7eyAuQ2hhcnQuTmFtZSB9fS17eyAuQ2hhcnQuVmVyc2lvbiB9fSIKc3BlYzoKICByZXBsaWNhczoge3sgLlZhbHVlcy5yZXBsaWNhQ291bnQgfX0KICB0ZW1wbGF0ZToKICAgIG1ldGFkYXRhOgogICAgICBsYWJlbHM6CiAgICAgICAgYXBwOiB7eyB0ZW1wbGF0ZSAiZnVsbG5hbWUiIC4gfX0KICAgIHNwZWM6CiAgICAgIGNvbnRhaW5lcnM6CiAgICAgIC0gbmFtZToge3sgLkNoYXJ0Lk5hbWUgfX0KICAgICAgICBpbWFnZTogInt7IC5WYWx1ZXMuaW1hZ2UucmVwb3NpdG9yeSB9fTp7eyAuVmFsdWVzLmltYWdlLnRhZyB9fSIKICAgICAgICBpbWFnZVB1bGxQb2xpY3k6IHt7IC5WYWx1ZXMuaW1hZ2UucHVsbFBvbGljeSB9fQogICAgICAgIHBvcnRzOgogICAgICAgIC0gY29udGFpbmVyUG9ydDoge3sgLlZhbHVlcy5zZXJ2aWNlLmludGVybmFsUG9ydCB9fQogICAgICAgIGxpdmVuZXNzUHJvYmU6CiAgICAgICAgICBodHRwR2V0OgogICAgICAgICAgICBwYXRoOiAvCiAgICAgICAgICAgIHBvcnQ6IHt7IC5WYWx1ZXMuc2VydmljZS5pbnRlcm5hbFBvcnQgfX0KICAgICAgICByZWFkaW5lc3NQcm9iZToKICAgICAgICAgIGh0dHBHZXQ6CiAgICAgICAgICAgIHBhdGg6IC8KICAgICAgICAgICAgcG9ydDoge3sgLlZhbHVlcy5zZXJ2aWNlLmludGVybmFsUG9ydCB9fQogICAgICAgIHJlc291cmNlczoKe3sgdG9ZYW1sIC5WYWx1ZXMucmVzb3VyY2VzIHwgaW5kZW50IDEyIH19Cg=="
        },
        {
          "name": "templates/service.yaml",
          "data": "YXBpVmVyc2lvbjogdjEKa2luZDogU2VydmljZQptZXRhZGF0YToKICBuYW1lOiB7eyB0ZW1wbGF0ZSAiZnVsbG5hbWUiIC4gfX0KICBsYWJlbHM6CiAgICBjaGFydDogInt7IC5DaGFydC5OYW1lIH19LXt7IC5DaGFydC5WZXJzaW9uIH19IgpzcGVjOgogIHR5cGU6IHt7IC5WYWx1ZXMuc2VydmljZS50eXBlIH19CiAgcG9ydHM6CiAgLSBwb3J0OiB7eyAuVmFsdWVzLnNlcnZpY2UuZXh0ZXJuYWxQb3J0IH19CiAgICB0YXJnZXRQb3J0OiB7eyAuVmFsdWVzLnNlcnZpY2UuaW50ZXJuYWxQb3J0IH19CiAgICBwcm90b2NvbDogVENQCiAgICBuYW1lOiB7eyAuVmFsdWVzLnNlcnZpY2UubmFtZSB9fQogIHNlbGVjdG9yOgogICAgYXBwOiB7eyB0ZW1wbGF0ZSAiZnVsbG5hbWUiIC4gfX0K"
        }
      ],
      "values": {
        "image": {
          "pullPolicy": "IfNotPresent",
          "repository": "nginx",
          "tag": "stable"
        },
        "replicaCount": 1,
        "resources": {
          "limits": {
            "cpu": "100m",
            "memory": "128Mi"
          },
          "requests": {
            "cpu": "100m",
            "memory": "128Mi"
          }
        },
        "service": {
          "externalPort": 80,
          "internalPort": 80,
          "name": "nginx",
          "type": "ClusterIP"
        }
      },
      "schema": null,
      "files": [
        {
          "name": ".helmignore",
          "data": "IyBQYXR0ZXJucyB0byBpZ25vcmUgd2hlbiBidWlsZGluZyBwYWNrYWdlcy4KIyBUaGlzIHN1cHBvcnRzIHNoZWxsIGdsb2IgbWF0Y2hpbmcsIHJlbGF0aXZlIHBhdGggbWF0Y2hpbmcsIGFuZAojIG5lZ2F0aW9uIChwcmVmaXhlZCB3aXRoICEpLiBPbmx5IG9uZSBwYXR0ZXJuIHBlciBsaW5lLgouRFNfU3RvcmUKIyBDb21tb24gVkNTIGRpcnMKLmdpdC8KLmdpdGlnbm9yZQouYnpyLwouYnpyaWdub3JlCi5oZy8KLmhnaWdub3JlCi5zdm4vCiMgQ29tbW9uIGJhY2t1cCBmaWxlcwoqLnN3cAoqLmJhawoqLnRtcAoqfgojIFZhcmlvdXMgSURFcwoucHJvamVjdAouaWRlYS8KKi50bXByb2oK"
        }
      ]
    },
    "manifest": "---\n# Source: mink/templates/service.yaml\napiVersion: v1\nkind: Service\nmetadata:\n  name: foo3-mink\n  labels:\n    chart: \"mink-0.1.0\"\nspec:\n  type: ClusterIP\n  ports:\n  - port: 80\n    targetPort: 80\n    protocol: TCP\n    name: nginx\n  selector:\n    app: foo3-mink\n---\n# Source: mink/templates/deployment.yaml\napiVersion: extensions/v1beta1\nkind: Deployment\nmetadata:\n  name: foo3-mink\n  labels:\n    chart: \"mink-0.1.0\"\nspec:\n  replicas: 1\n  template:\n    metadata:\n      labels:\n        app: foo3-mink\n    spec:\n      containers:\n      - name: mink\n        image: \"nginx:stable\"\n        imagePullPolicy: IfNotPresent\n        ports:\n        - containerPort: 80\n        livenessProbe:\n          httpGet:\n            path: /\n            port: 80\n        readinessProbe:\n          httpGet:\n            path: /\n            port: 80\n        resources:\n            limits:\n              cpu: 100m\n              memory: 128Mi\n            requests:\n              cpu: 100m\n              memory: 128Mi\n",
    "version": 1,
    "namespace": "foo"
  }
]

If we really want an additional endpoint, then adding GET /api/helm/release?name=myRelease&namespace=myNS returning the full Helm release info for the given Helm release name and the namespace would be more useful in the long run.

akashshinde · 2020-01-24T12:13:20Z

Closing this since the way Pregrag suggested is adequate.

christianvogt · 2020-01-27T15:01:23Z

@sbose78 @pedjak
It would make more sense to support a single release in the API. Otherwise to display details of one release, we need to fetch all releases in the namespace and then filter client side, thus overfetching a lot of information.

sbose78 · 2020-01-27T17:36:43Z

Sure, before providing the API, I wanted to ensure we really want it.

akashshinde · 2020-01-28T10:20:14Z

/retest

akashshinde · 2020-01-28T10:40:10Z

/hold cancel

akashshinde · 2020-01-28T12:07:20Z

/test e2e-gcp-console

pkg/helm/actions/get_manifest.go

pkg/helm/actions/get_manifest_test.go

pkg/helm/handlers/handlers.go

pkg/server/server.go

pkg/helm/handlers/handlers.go

akashshinde · 2020-02-10T10:46:16Z

/test backend

pedjak

+1, I would make GetRelease function private.

pkg/helm/actions/get_release.go

pedjak · 2020-02-11T13:10:37Z

/retitle Added helm endpoint to get infos about the given release

christianvogt · 2020-02-20T18:55:47Z

@sbose78 no bugzilla needed right now to get into master / 4.5
We only need a bugzilla to get changes into 4.4.

This needs approval from someone else though @spadgett @benjaminapetersen @rhamilto

christianvogt · 2020-02-20T18:56:52Z

@akashshinde you're going to want to squash your commits appropriately

spadgett · 2020-02-20T19:00:56Z

docs/helm/README.md

403 is "Forbidden", 400 is "Bad Request". But it looks like we're actually returning "Bad Gateway"?

spadgett · 2020-02-20T19:02:18Z

pkg/helm/handlers/handlers.go

Check for errors?

spadgett · 2020-02-20T19:09:43Z

pkg/server/server.go

This should be 405, Method Not Allowed, with an Allow response header

pedjak · 2020-02-21T15:23:42Z

@christianvogt squeshed
@spadgett pushed fixes.

akashshinde · 2020-02-24T05:26:36Z

/test e2e-gcp-console

akashshinde · 2020-02-24T08:05:37Z

/test e2e-gcp-console

pedjak · 2020-02-24T10:11:20Z

/assign spadgett

christianvogt · 2020-02-24T23:31:53Z

@benjaminapetersen needs approval for backend change

fyi @rohitkrai03

pkg/helm/handlers/handlers.go

pkg/server/server.go

pkg/helm/handlers/handlers.go

akashshinde · 2020-02-25T17:13:19Z

/test backend

pedjak · 2020-02-26T10:06:50Z

/retest

akashshinde · 2020-02-26T11:05:41Z

/test e2e-gcp-console

akashshinde · 2020-02-26T12:43:26Z

/test e2e-gcp-console

spadgett

/approve
/lgtm

openshift-ci-robot · 2020-02-27T17:24:44Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: akashshinde, pedjak, spadgett

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [spadgett]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

openshift-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. component/backend Related to backend labels Jan 24, 2020

openshift-ci-robot requested review from jhadvig and rhamilto January 24, 2020 10:05

openshift-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 24, 2020

akashshinde closed this Jan 24, 2020

akashshinde reopened this Jan 28, 2020

akashshinde changed the title ~~[WIP] Add helm endpoint to get manifests of installed release.~~ Add helm endpoint to get manifests of installed release. Jan 28, 2020

openshift-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jan 28, 2020

openshift-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 28, 2020

akashshinde force-pushed the helm_endpoints branch 2 times, most recently from d6a1800 to 9d6e0e8 Compare January 28, 2020 10:45

pedjak suggested changes Jan 30, 2020

View reviewed changes

openshift-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Feb 7, 2020

pedjak suggested changes Feb 7, 2020

View reviewed changes

pkg/server/server.go Outdated Show resolved Hide resolved

pkg/helm/handlers/handlers.go Outdated Show resolved Hide resolved

akashshinde requested a review from pedjak February 10, 2020 04:33

pedjak approved these changes Feb 10, 2020

View reviewed changes

pkg/helm/actions/get_release.go Outdated Show resolved Hide resolved

openshift-ci-robot assigned pedjak Feb 20, 2020

openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Feb 20, 2020

spadgett reviewed Feb 20, 2020

View reviewed changes

pedjak force-pushed the helm_endpoints branch from 5bda741 to 04fb0ba Compare February 21, 2020 15:21

openshift-ci-robot removed the lgtm Indicates that a PR is ready to be merged. label Feb 21, 2020

openshift-ci-robot assigned spadgett Feb 24, 2020

spadgett reviewed Feb 24, 2020

View reviewed changes

akashshinde force-pushed the helm_endpoints branch from 04fb0ba to e468c5f Compare February 25, 2020 10:40

akashshinde requested review from pedjak and spadgett February 25, 2020 10:42

Add helm endpoint to get info for the installed release

2b14058

akashshinde force-pushed the helm_endpoints branch from e468c5f to 2b14058 Compare February 25, 2020 17:15

pedjak approved these changes Feb 26, 2020

View reviewed changes

spadgett approved these changes Feb 27, 2020

View reviewed changes

openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Feb 27, 2020

openshift-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 27, 2020

openshift-merge-robot merged commit da92d43 into openshift:master Feb 27, 2020

spadgett added this to the v4.5 milestone Feb 28, 2020

Added helm endpoint to get infos about the given release #4059

Added helm endpoint to get infos about the given release #4059

Uh oh!

Conversation

akashshinde commented Jan 24, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

akashshinde commented Jan 24, 2020

Uh oh!

sbose78 commented Jan 24, 2020

Uh oh!

pedjak commented Jan 24, 2020

Uh oh!

akashshinde commented Jan 24, 2020

Uh oh!

christianvogt commented Jan 27, 2020

Uh oh!

sbose78 commented Jan 27, 2020

Uh oh!

akashshinde commented Jan 28, 2020

Uh oh!

akashshinde commented Jan 28, 2020

Uh oh!

akashshinde commented Jan 28, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

akashshinde commented Feb 10, 2020

Uh oh!

pedjak left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

pedjak commented Feb 11, 2020

Uh oh!

christianvogt commented Feb 20, 2020

Uh oh!

christianvogt commented Feb 20, 2020

Uh oh!

spadgett Feb 20, 2020

Choose a reason for hiding this comment

Uh oh!

spadgett Feb 20, 2020

Choose a reason for hiding this comment

Uh oh!

spadgett Feb 20, 2020

Choose a reason for hiding this comment

Uh oh!

pedjak commented Feb 21, 2020

Uh oh!

akashshinde commented Feb 24, 2020

Uh oh!

akashshinde commented Feb 24, 2020

Uh oh!

pedjak commented Feb 24, 2020

Uh oh!

christianvogt commented Feb 24, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

akashshinde commented Feb 25, 2020

Uh oh!

pedjak commented Feb 26, 2020

Uh oh!

akashshinde commented Feb 26, 2020

Uh oh!

akashshinde commented Feb 26, 2020

Uh oh!

spadgett left a comment

Choose a reason for hiding this comment

Uh oh!

akashshinde commented Jan 24, 2020 •

edited

Loading