Create Web-based Configuration Builder for Build Templates

[rohansen856]

Summary

Create a minimal web interface that allows users to build configuration templates for the zlinux-artifacts-builder system through an intuitive form-based UI with dropdowns, selects, radio buttons, checkboxes, etc.

Currently, users need to manually create YAML configuration files for build templates. This requires understanding the schema and manually editing files like:

artifacts:
  - type: binary
    language: go
    build_script:
      repo_name: linux-on-ibm-z-scripts
      path: Go/1.21/build_go.sh
      args: ["--version", "1.21"]
      docker_image: ubuntu:20.04
  - type: rpm
  - type: container
    image_name: "{{repo_name}}"
    dockerfile: Dockerfile
    registry: ghcr.io
architecture: s390x
schedule: "{{global_schedule}}"
webhook: "{{global_webhook}}"

Proposed Solution

Build a web interface that:

Core Features

• Form-based Template Builder: Visual form with appropriate input types for each configuration option
• Dynamic Artifact Addition: Allow users to add/remove multiple artifacts with different types
• Real-time YAML Preview: Show generated YAML as users fill the form
• Template Validation: Client-side validation of required fields and valid combinations

UI Components Needed

• Dropdowns:
  • Artifact types (binary, rpm, container, debian)
  • Programming languages (go, java, python, c/cpp)
  • Architecture selection (s390x, amd64, etc.)
  • Docker base images
• Text Inputs:
  • Repository names, paths, image names
  • Build script arguments
  • Schedule expressions
• Checkboxes:
  • Enable/disable features (webhook, schedule)
  • Optional components
• Radio Buttons:
  • Single-choice options where applicable
• Multi-select:
  • Build script arguments (array inputs)

Technical Requirements

• Minimal dependencies (vanilla JS or lightweight framework)
• Generate valid YAML output
• Responsive design for various screen sizes
• Export functionality (download generated config)

Example Workflow

1. User selects "Go Binary" from artifact type dropdown
2. Form dynamically shows Go-specific options (version, build script path)
3. User adds additional artifacts (RPM, container)
4. Real-time preview shows generated YAML
5. User downloads or copies the final configuration

Acceptance Criteria

• Web form covers all template configuration options from existing templates
• Generated YAML is valid and matches manual template structure
• Interface is intuitive for non-technical users
• Supports multiple artifact types in single template
• Includes validation and helpful error messages
• Mobile-responsive design

Implementation Notes

• Should integrate with existing template system in config/templates/
• Consider hosting as static site or simple web service
• May want to validate against actual schema used by orchestrator
• Could potentially be served alongside main build system

[rohansen856]

To clarify the goal of this Issue, We can build a minimal html frontend for generating the yaml config needed for the repositories in .build-template.yaml file (ex.: https://github.com/linuxonzapps/sysdig/blob/main/.build-template.yaml). This would clarify what fields are available for all the oprions and produce a safe yaml config without any abstraction.

We can host this with github pages itself without any hassle and provide the llink in this repo's about (which contains the llink to this repo itself currently).

Built a minimal html demo:

cc @pleia2 @rposts

[pleia2]

Thanks for your work on this, I like where it's going.

My proposal is to set up a repository that you can work in called zlinux-artifacts-builder-web-config and then work out hosting the prototype on github pages.

[rohansen856]

Thanks for your work on this, I like where it's going.

My proposal is to set up a repository that you can work in called zlinux-artifacts-builder-web-config and then work out hosting the prototype on github pages.

That sounds great! We can do a lot more things in that scenario, like listing the links to the available pages directly in there (ex.: for sysdig a small card-like section with the link: https://github.com/linuxonzapps/sysdig/releases). I am up for the task!

[pleia2]

@rohansen856 I've gone ahead and created https://github.com/linuxonzapps/zlinux-artifacts-builder-web-config and added you as the maintainer.

Since this is a small project, I'd say that for the prototype you're developing I think it's fine for you to push to main. I only ask that you update the README.md to explain that it's in rapid development and not quite ready for use yet.

Once you feel like it's in a place for @rposts and I to take a closer look, please loop us in and that's when we'll do a closer code review of the whole codebase. That's when we'll get a more formalized process in place to enforce reviews. I just wanted to pull this into the project now and remove blockers.

[rohansen856]

@rohansen856 I've gone ahead and created https://github.com/linuxonzapps/zlinux-artifacts-builder-web-config and added you as the maintainer.

Since this is a small project, I'd say that for the prototype you're developing I think it's fine for you to push to main. I only ask that you update the README.md to explain that it's in rapid development and not quite ready for use yet.

Once you feel like it's in a place for @rposts and I to take a closer look, please loop us in and that's when we'll do a closer code review of the whole codebase. That's when we'll get a more formalized process in place to enforce reviews. I just wanted to pull this into the project now and remove blockers.

Sounds great! I will be updating the codebase there and keep you all in the loop. Also once its ready for review Will innform you!

[rohansen856]

Hey @pleia2 @rposts, The web-based configuration builder is now ready for review. Hosted it through github pages, so You can preview the live site here:

https://linuxonzapps.github.io/zlinux-artifacts-builder-web-config/

The changes i did:

• Interactive YAML template builder with live preview
• Example configuration pre-loaded from the minio repository
• Complete listing of available s390x build artifact repositories

Looking forward to your feedback!