replicatedhq / replicatedhq/platform-examples

feat(mlflow): document KOTS auto-update behavior with HelmChart weight ordering

Open
#167 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go Template
Stars
9
Forks
6
PR merge metrics
No merged PRs in 30d

Description

Parent epic: #166
Integration branch: feat/mlflow-enterprise-patterns

Document how KOTS auto-deploy behaves with multi-chart HelmChart weight ordering, including known edge cases.

Scope

  • Add autoDeploy field to release/kots-app.yaml if not present
  • Create applications/mlflow/docs/auto-update.md covering:
    • How auto-deploy interacts with HelmChart weight ordering (infra weight -10 → mlflow weight 10)
    • What happens during operator upgrades (CRD changes, etc.)
    • Edge cases: config field changes requiring re-deploy, semver rollback behavior, required versions
    • Recommended settings for production vs development channels
  • Link from main README.md to the new doc

Files touched

  • applications/mlflow/release/kots-app.yaml (add autoDeploy field)
  • applications/mlflow/docs/auto-update.md (new file)
  • applications/mlflow/README.md (add link)

PR target

Branch PRs to feat/mlflow-enterprise-patterns (not main).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting applications/mlflow/release/kots-app.yaml, applications/mlflow/README.md, and the existing MLflow application structure on feat/mlflow-enterprise-patterns. Document the autoDeploy setting, HelmChart weights, operator-upgrade behavior, listed edge cases, and channel recommendations in applications/mlflow/docs/auto-update.md, then link it from the README.

Written by the indexing model from the issue text.

Assessment

Tech stack
helm, kubernetes
Domain
devops, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
62/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.