🚀 KServe VS Code Workspace

A batteries-included development environment for KServe on OpenShift. Clone, install extensions, and start coding -- debugging, testing, formatting, and cluster management are all pre-configured.

✨ Features

• Go intellisense - Code completion, signature help, go-to-definition, and refactoring via the Go extension
• Python intellisense - Cursorpyright with type checking, auto-imports, and code navigation
• Test Explorer integration - E2E and unit tests discoverable in the Test Explorer with results display
• Debug configurations - Pre-configured launch configs for e2e tests and remote debugging via devspace
• Formatters and linters - Black formatter, Flake8 linting, and ShellCheck for shell scripts
• Kubernetes tooling - Cluster exploration, manifest editing, and resource management
• YAML support - Schema validation and autocompletion for Kubernetes manifests
• Task automation - Adds the KServe Toolbar™ with one-click tasks for common workflows (see workflow.md for details):
  • 🟡 Kind/Upstream: Kind Refresh, Install Dependencies, Network Dependencies, Deploy KServe, Patch Mode
  • 🔴 OpenShift: CRC Refresh, Pull Secret, ODH/RHOAI Operator, DSCI+DSC, E2E Setup, E2E Namespace, Console
  • 🟢 Dev Tools: Devspace Dev, HF Token Secret, Watch Resources, Watch Logs

🛠️ Setup

1. 🍴 Fork and Clone KServe

1. Fork kserve/kserve on GitHub
2. Clone your fork:

   git clone git@github.com:$GITHUB_USER/kserve.git
   cd kserve

2. 📦 Clone Workspace Configuration

Clone this workspace configuration repository into your kserve repository at the root, named as .vscode:

cd kserve
git clone git@github.com:jlost/kserve-workspace.git .vscode

You should now have a .vscode directory at the root of the kserve repository.

3. 🔀 Configure Git Remotes

Set up remotes for the multi-fork hierarchy (upstream, midstream, downstream):

# Add all remotes (origin is already your personal fork from step 1)
git remote add upstream git@github.com:kserve/kserve.git
git remote add odh git@github.com:opendatahub-io/kserve.git
git remote add downstream git@github.com:red-hat-data-services/kserve.git

# Verify setup
git remote -v

Expected output:

downstream  git@github.com:red-hat-data-services/kserve.git (fetch)
downstream  git@github.com:red-hat-data-services/kserve.git (push)
odh         git@github.com:opendatahub-io/kserve.git (fetch)
odh         git@github.com:opendatahub-io/kserve.git (push)
origin      git@github.com:$GITHUB_USER/kserve.git (fetch)
origin      git@github.com:$GITHUB_USER/kserve.git (push)
upstream    git@github.com:kserve/kserve.git (fetch)
upstream    git@github.com:kserve/kserve.git (push)

4. 🔨 Install Development Tools

🤖 Automated Setup (Fedora/MacOS Only)

For Fedora and MacOS users, automated setup scripts are available in .vscode/:

Note: These scripts are Fedora or MacOS-specific and assume zsh as your default shell. If you prefer a different shell or have already set up tools manually, use Manual Setup instead.

1. Install Development Dependencies:

   ./.vscode/install-deps.sh

2. Configure Environment Variables:

   ./.vscode/setup-env.sh

🍎 Mac ARM (Apple Silicon) Notes

Building linux/amd64 images on Mac ARM requires emulation. The default podman machine image may fail -- use this specific Fedora CoreOS image:

brew install podman
podman machine init --disk-size 60 --rootful --cpus 4 --memory 8192 \
  --image https://builds.coreos.fedoraproject.org/prod/streams/stable/builds/40.20241019.3.0/aarch64/fedora-coreos-40.20241019.3.0-applehv.aarch64.raw.gz
podman machine start

Always specify the platform when building: podman build --platform linux/amd64 ...

Notes:

• Emulated builds are slow -- consider a remote x86_64 machine or ROSA BuildConfig for faster iteration
• If builds OOM, increase --memory when reinitializing the machine

📝 Manual Setup

1. Install the required tools using your system's package manager or preferred installation method. All tools must be available in your PATH including for non-interactive shells (i.e. add bin dirs to ~/.zshenv, ~/.bashrc, or ~/.profile depending on your shell).

   🔧 Required Tools

   • Cursor or VS Code
   • oc
   • kubectl
   • crc (OpenShift Local)
   • golang
   • dlv
   • python3.11
   • uv
   • openssl
   • podman
   • yq
   • jq
   • envsubst (gettext)
   • devspace
   • ko
   • kind
   • cloud-provider-kind
   • docker

2. Configure environment variables by adding them to your shell's configuration file (~/.zshenv, ~/.bashrc, or ~/.profile depending on your shell).

   🔑 Required Environment Variables

   The following variables must be available in your env for non-interactive shells:

   QUAY_USERNAME=yourname
   QUAY_PASSWORD=abcdefg
   QUAY_REPO=quay.io/reponame
   KO_DOCKER_REPO=${QUAY_REPO}
   RUNNING_LOCAL=true
   GITHUB_SHA=master
   ENGINE=podman
   BUILDER=${ENGINE}
   HF_TOKEN=hf_abcdefg  # HuggingFace token for private model access
   BROWSER=firefox  # optional, defaults to brave-browser

5. 🔐 Log in to Container Registries

Use podman login to log in to docker and quay:

podman login --authfile "$HOME/.config/containers/auth.json" docker.io
podman login --authfile "$HOME/.config/containers/auth.json" quay.io

Your credentials will be stored in ~/.config/containers/auth.json:

{
    "auths": {
        "docker.io": {
            "auth": "abcdefg"
        },
        "quay.io": {
            "auth": "abcdefg"
        }
    }
}

Some tools (e.g., ko) expect Docker's config at ~/.docker/config.json. Since both files use the same format, create a symlink using an absolute path:

mkdir -p ~/.docker
ln -s "$HOME/.config/containers/auth.json" ~/.docker/config.json

Note: The symlink target must be an absolute path. Verify with ls -la ~/.docker/config.json - it should show the full path (e.g., /home/user/.config/containers/auth.json), not a relative path.

6. 💻 Start VS Code and Install Extensions

Start VS Code from the kserve directory:

code .

Once VS Code has loaded, press F1 and type 'show recommended extensions'. Press ENTER. Install all of the workspace recommendations.

🎯 Optional Steps

These steps are not required but can improve your development experience.

📄 Create a Global Gitignore

A global gitignore prevents common development artifacts from cluttering git status across all your projects. Create one at ~/.gitignore:

cat > ~/.gitignore << 'EOF'
.venv
.cursor
.devspace
__debug_bin*
EOF

Then configure git to use it:

git config --global core.excludesFile ~/.gitignore

❓ FAQ

Q: pytest keeps running in the background after I click Stop. How do I actually stop it?

Always run e2e tests in debug mode. When you click stop in debug mode, the process will actually stop.

Q: Software Catalog shows up instead of OperatorHub in OpenShift Local. How do I install operators?

Operators are still available and can be listed with oc get packagemanifests and installed by creating Subscriptions. Use the "Install ODH Operator" or "Install RHOAI Operator" tasks to install operators.

Q: I'm getting ImagePullBackOff errors. How do I fix this?

Run the "Install Pull Secret" task to inject your docker and quay credentials.

🤝 Contributions

Contributions welcome! Fork and submit a pull request.

Make a best effort to fashion contributions to be as environment-agnostic as possible and document exceptions in Setup.