Best practices for an app that edits a yaml file?

[justyns]

I'm not entirely sure if Windmill will be good at this or not, but I'm hoping it will work. Any advice is appreciated.

I currently have a yaml file with a list of apps in it. I have a separate script which parses this and for each app, it renders a hashicorp nomad job file or kubernetes manifest. Currently I edit this by hand, but I want a nice UI for it.

As an example, here's a basic app in the list:

  - name: whoami
    image: jwilder/whoami
    http_port: 8000
    count: 2

And here's a more complicated one with more options:

  - name: windmill-worker
    count: 3
    image: ghcr.io/windmill-labs/windmill:1.114.2
    has_inbound: False
    # user: 1100:1100
    env:
      RUST_LOG: info
      BASE_URL: https://windmill.lan.x
      BASE_INTERNAL_URL: https://windmill.lan.x
      NUM_WORKERS: 1
      DISABLE_SERVER: "true"
      METRICS_ADDR: "false"
      KEEP_JOB_DIR: "false"
      TIMEOUT: "3600"
    vault_policies:
      - nomad-windmill
    vault_env_template: |
      {{with secret "kv/data/nomad/windmill"}}
      {{ range $k, $v := .Data.data }}
      {{ $k }}={{ $v | toJSON }}
      {{end}}
      {{end}}
    constraints:
      "${meta.mount_home_nfs}": "True"

In windmill, I have an app that can clone the git repo where this yaml file is stored and runs a python script which converts the yaml into json and displays it in an AgTable.

I think this is where I'm a little lost. Some of the keys are too complex to edit in a table, so I thought I could just make a form to the side of the table where it'd be easier. This works for some of the keys like name/image/count, but I'm not sure how to handle the more complex ones like env which is a nested object.

Are there any examples of something vaguely similar, or maybe just some advice on handling complex/nested objects?

I don't really want to convert the yaml file to a database, but I'm wondering if it would make it easier to manipulate with windmill?

[rubenfiszel]

2 solutions imho:

• we add a json/yaml editor component
• you generate the jsonschema of the form on the fly to fit your yaml structure. This could be done doing yaml -> json and then json -> jsonschema: https://www.npmjs.com/package/json-to-json-schema

[justyns]

Thanks for the response!

we add a json/yaml editor component

I did consider using the text area or rich text editor and just have it edit the raw yaml, but haven't tried it yet. Something more structured would be nice though

you generate the jsonschema of the form on the fly to fit your yaml structure. This could be done doing yaml -> json and then json -> jsonschema: https://www.npmjs.com/package/json-to-json-schema

I can generate the jsonschema, but can you explain what you would do with it? I'm still new to windmill, but I've only seen where the jsonschema is automatically generated for the UI for script inputs. Is there somewhere I could paste my own json schema in and have it generate a ui?