Kubernetes API and helm

[AntonTsaberyaby]

What would you like help with?

I would like help with my configuration

How are you running Renovate?

Self-hosted

If you're self-hosting Renovate, tell us which platform (GitHub, GitLab, etc) and which version of Renovate.

Gitlab

Please tell us more about your question or problem

Hello guys, I have a goal to update the API versions in Kubernetes manifest files in my repositories. I have decided to use the kubernetes-api datasource for this. However, my manifest files are stored not in plain format but as Helm templates. I have enabled debugging and see the following messages in the log:

Could you please advise on the correct way to use Renovate for updating API versions in the manifests when Helm is used?

Thank you!

Logs (if relevant)

DEBUG: Failed to parse Kubernetes manifest. (repository=infra/k8s/jitsi, packageFile=helm/templates/jigasi/deployment.yaml)
       "err": {
         "name": "YAMLException",
         "reason": "missed comma between flow collection entries",

[rarkins]

You're asserting it's a bug?

[AntonTsaberyaby]

I'm not sure. I don't fully understand how the kubernetes-api datasource should work. Is it meant to update non-templated manifests only, or should it also update Helm manifests? Could what I'm describing be a bug?

[viceice]

I think this can be easily supported by stripping templates before parsing in kubernetes manager as we already do in other managers

[rarkins]

I'm wondering why you selected the bug option, especially if you don't understand it.

[rarkins]

I will answer once it's corrected

[AntonTsaberyaby]

Thank you for bringing this to my attention. I will correct this

[rarkins]

Renovate expects this to be valid yaml which can be parsed.

You could work around this immediately by creating a custom regex manager to parse your files.

Alternatively, please create an example reproduction and we'll see if we can build in a capability to compile or strip out the templates first before parsing.

[AntonTsaberyaby]

Ok. I will prepare an reproduction repo.

[AntonTsaberyaby]

Made a repo https://github.com/AntonTsaberyaby/jitsi-helm/tree/main
Config and description in readme

[github-actions[bot]]

Hi there,

Get your discussion fixed faster by creating a minimal reproduction. This means a repository dedicated to reproducing this issue with the minimal dependencies and config possible.

Before we start working on your issue we need to know exactly what's causing the current behavior. A minimal reproduction helps us with this. Discussions without reproductions are less likely to be converted to Issues.

To get started, please read our guide on creating a minimal reproduction.

Good luck,

The Renovate team

[viceice]

• feat(manager/kubernetes): strip go templates before parsing #28816

[AntonTsaberyaby]

I'm not sure I can advise this. What options do we have to solve this problem? Can we run an external utility like helm template to check the template's validity?

[rarkins]

The options are:

• Strip templates and hope we still have valid YAML, or
• Compile templates (and hope it doesn't fail), or
• Rewrite the manager to use bespoke parsing (e.g. regex-based) instead of YAML parsing

Your previous comment seemed to imply the third option above, although I assume you're not volunteering to PR it?

[viceice]

I'll look into the reproduction and maybe I can fix the cause

[viceice]

if i'm enabling json mode then we get to this line: {{ $key }}: {{ tpl $value $ | quote }}

https://github.com/renovate-reproductions/28705-jitsi-helm/blob/f5714dcb3bfff436b60b95c99b982dd8ca373623/templates/common-configmap.yaml#L43

this is of cause no valid yaml 😕 . without json:true we get duplicate key errors.

@zharinov Do you think we can use your good enough parser instead? or is it to hard because of the indention based language?

[zharinov]

It supports indentation based languages, but I haven't tried it to parse YAML with it (only Python)

[AntonTsaberyaby]

The options are:

• Strip templates and hope we still have valid YAML, or
• Compile templates (and hope it doesn't fail), or
• Rewrite the manager to use bespoke parsing (e.g. regex-based) instead of YAML parsing

Your previous comment seemed to imply the third option above, although I assume you're not volunteering to PR it?

@rarkins Thanks for the update. I can try to figure it out, but I don't write in Node.js, so I probably won't be able to make an adequate fix in a reasonable amount of time.

[viceice]

• feat(util/yaml): replace more go templates #29061

[AntonTsaberyaby]

I have tested the new fix, thank you for your work! I tested the fix on another set of templates, most of the parsing errors have been eliminated but some still remain. For example:

DEBUG: Failed to parse Kubernetes manifest. (
       "err": {
         "name": "YAMLException",
         "reason": "bad indentation of a mapping entry",
         "mark": {
           "name": "helm/templates/etherpad-deployment.yaml",
           "buffer": "\napiVersion: apps/v1\nkind: Deployment\nmetadata:\n  name: -etherpad\n  labels:\n    app.kubernetes.io/name: -etherpad\n    \n  annotations:\n    \nspec:\n  replicas: \n  selector:\n    matchLabels:\n      app.kubernetes.io/name: -etherpad\n      app.kubernetes.io/instance: \n  template:\n    metadata:\n      labels:\n        app.kubernetes.io/name: -etherpad\n        app.kubernetes.io/instance: \n      annotations:\n        \n        \n        \n    spec:\n    \n      imagePullSecrets:\n        \n    \n      containers:\n        - name: etherpad\n          \n          image: dreg.sbmt.io/library/\n          \n          image: dreg.sbmt.io/dhub/etherpad/etherpad:1.8.18\n          \n          imagePullPolicy: \n          env:\n          - name: TITLE\n            value: \"Video Chat\"\n          - name: DEFAULT_PAD_TEXT\n            value: \"Здесь можно написать свой текст!\"\n          - name: SKIN_NAME\n            value: \"colibris\"\n          - name: SKIN_VARIANTS\n            value: \"super-light-toolbar super-light-editor light-background full-width-editor\"\n          - name: PAD_OPTIONS_LANG\n            value: \"ru\"\n          - name: SUPPRESS_ERRORS_IN_PAD_TEXT\n            value: \"true\"\n          - name: REQUIRE_AUTHORIZATION\n            value: \"true\"\n          - name: ADMIN_PASSWORD\n            valueFrom:\n              secretKeyRef:\n                name: -auth\n                key: ETHERPAD_ADMIN_PASSWORD\n                optional: false\n          ports:\n          - name: http\n            containerPort: 9001\n            protocol: TCP\n          \n          livenessProbe:\n          \n          \n          \n          readinessProbe:\n          \n          \n          resources:\n            \n    \n      nodeSelector:\n        \n    \n    \n      affinity:\n        \n    \n    \n      tolerations:\n        \n    \n\n---\n\napiVersion: v1\nkind: Service\nmetadata:\n  name: -etherpad\n  labels:\n    app.kubernetes.io/name: -etherpad\n    helm.sh/chart: -\n    app.kubernetes.io/managed-by: \n    app.kubernetes.io/instance: \n    app.kubernetes.io/version: \nspec:\n  type: ClusterIP\n  ports:\n  - name: http\n    port: 9001\n  selector:\n    app.kubernetes.io/name: -etherpad\n\n",
           "position": 1905,
           "line": 94,
           "column": 19,
           "snippet": " 92 |   name: -etherpad\n 93 |   labels:\n 94 |     app.kubernetes.io/name: -etherpad\n 95 |     helm.sh/chart: -\n-------------------------^\n 96 |     app.kubernetes.io/managed-by: \n 97 |     app.kubernetes.io/instance: "
         },
         "message": "bad indentation of a mapping entry in \"helm/templates/etherpad-deployment.yaml\" (95:20)\n\n 92 |   name: -etherpad\n 93 |   labels:\n 94 |     app.kubernetes.io/name: -etherpad\n 95 |     helm.sh/chart: -\n-------------------------^\n 96 |     app.kubernetes.io/managed-by: \n 97 |     app.kubernetes.io/instance: ",
         "stack": "YAMLException: bad indentation of a mapping entry in \"helm/templates/etherpad-deployment.yaml\" (95:20)\n\n 92 |   name: -etherpad\n 93 |   labels:\n 94 |     app.kubernetes.io/name: -etherpad\n 95 |     helm.sh/chart: -\n-------------------------^\n 96 |     app.kubernetes.io/managed-by: \n 97 |     app.kubernetes.io/instance: \n    at generateError (/usr/local/renovate/node_modules/.pnpm/js-yaml@4.1.0/node_modules/js-yaml/lib/loader.js:183:10)\n    at throwError (/usr/local/renovate/node_modules/.pnpm/js-yaml@4.1.0/node_modules/js-yaml/lib/loader.js:187:9)\n    at readBlockMapping (/usr/local/renovate/node_modules/.pnpm/js-yaml@4.1.0/node_modules/js-yaml/lib/loader.js:1182:7)\n    at composeNode (/usr/local/renovate/node_modules/.pnpm/js-yaml@4.1.0/node_modules/js-yaml/lib/loader.js:1441:12)\n    at readBlockMapping (/usr/local/renovate/node_modules/.pnpm/js-yaml@4.1.0/node_modules/js-yaml/lib/loader.js:1164:11)\n    at composeNode (/usr/local/renovate/node_modules/.pnpm/js-yaml@4.1.0/node_modules/js-yaml/lib/loader.js:1441:12)\n    at readBlockMapping (/usr/local/renovate/node_modules/.pnpm/js-yaml@4.1.0/node_modules/js-yaml/lib/loader.js:1164:11)\n    at composeNode (/usr/local/renovate/node_modules/.pnpm/js-yaml@4.1.0/node_modules/js-yaml/lib/loader.js:1441:12)\n    at readDocument (/usr/local/renovate/node_modules/.pnpm/js-yaml@4.1.0/node_modules/js-yaml/lib/loader.js:1625:3)\n    at loadDocuments (/usr/local/renovate/node_modules/.pnpm/js-yaml@4.1.0/node_modules/js-yaml/lib/loader.js:1688:5)\n    at loadAll (/usr/local/renovate/node_modules/.pnpm/js-yaml@4.1.0/node_modules/js-yaml/lib/loader.js:1701:19)\n    at parseYaml (/usr/local/renovate/lib/util/yaml.ts:34:32)\n    at extractApis (/usr/local/renovate/lib/modules/manager/kubernetes/extract.ts:74:20)\n    at Object.extractPackageFile (/usr/local/renovate/lib/modules/manager/kubernetes/extract.ts:34:8)\n    at extractPackageFile (/usr/local/renovate/lib/modules/manager/index.ts:75:9)\n    at getManagerPackageFiles (/usr/local/renovate/lib/workers/repository/extract/manager-files.ts:58:43)\n    at /usr/local/renovate/lib/workers/repository/extract/index.ts:57:28\n    at async Promise.all (index 1)\n    at extractAllDependencies (/usr/local/renovate/lib/workers/repository/extract/index.ts:54:26)\n    at extract (/usr/local/renovate/lib/workers/repository/process/extract-update.ts:140:28)"
       }

The parser stumbles upon a line like:

  labels:
    app.kubernetes.io/name: {{ include "jitsi-meet.fullname" . }}-etherpad

If needed, I can provide the template for additional review.

[AntonTsaberyaby]

@viceice Can you look at this?

[AntonTsaberyaby]

Any news?

[github-actions[bot]]

Hi there,

This is intended as a polite, automated request that users avoid @ mentioning repository maintainers like @rarkins or @viceice. Doing so causes annoying mobile notifications and makes it harder to maintain this repository.

We know it might be common elsewhere but we participate in hundreds of discussions a week and would need to turn off GitHub mobile notifications if we were mentioned in every one.

As a general rule, we will read and respond to all discussions in this repository, so there is no need to mention us.

Thanks, the Renovate team