kubeflow / kubeflow/docs-agent

refactor: Restructure manifests/ into Kustomize base/overlay layout

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

Nobody has claimed this yet.

Dominant language
Python
Stars
42
Forks
111
Avg merge
6d 23m
Merged PRs (30d)
2

Description

Context

All manifests currently live as flat YAML in manifests/.

  • PR #65 is already in review doing this restructure, but there's no tracking issue — so there's nowhere to discuss scope or link downstream work.

Problem

Without a base/overlay structure, every new manifest gets added as a flat file that's not portable across environments. You can't patch for dev vs. prod without duplicating files.

What This Issue Tracks

Restructure manifests/ into:

  • base/ — portable resources any K8s cluster can apply
  • overlays/oci/ — OCI/OKE-specific patches
  • overlays/generic/ — local dev (Minikube/kind)

Files to move: serving-runtime.yaml, inference-service.yaml, milvus-deployment.yaml (strip the status: block), and the deployment/service YAMLs under server-https/.

Why This Order

#47 (scale-to-zero), #48 (KServe InferenceService), the OCI deployment work, and the CORS fix (#76) all require overlays to exist before their patches can land. Nothing in the manifest layer moves cleanly without this structure first.

Acceptance Criteria

  • kubectl apply -k manifests/overlays/generic/ works on a local cluster
  • kubectl apply -k manifests/overlays/oci/ applies OCI-specific patches on top
  • No flat YAMLs remain directly in manifests/
  • PR #65 linked and closed by this issue

Related

  • PR #65 — implementation already in review
  • Parent tracking issue: #72
  • Blocks:
    • #76
    • #47
    • #48 and the OCI deployment work

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 reviewing PR #65 and the YAML files listed under manifests/, including server-https/. Verify the base and generic/OCI overlay layout, then run kubectl apply -k manifests/overlays/generic/ and kubectl apply -k manifests/overlays/oci/; done means no flat YAMLs remain, the overlays apply, and PR #65 is linked and closed.

Written by the indexing model from the issue text.

Assessment

Tech stack
kubernetes
Domain
devops, infrastructure
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.