odh-cli

odh-cli

CLI tool for ODH (Open Data Hub) and RHOAI (Red Hat OpenShift AI) for interacting with ODH/RHOAI deployments on Kubernetes.

Quick Start

Using Containers

Run the CLI using the pre-built container image:

Podman:

podman run --rm -ti \
  -v $KUBECONFIG:/kubeconfig \
  quay.io/lburgazzoli/odh-cli:latest lint --target-version 3.3.0

Docker:

docker run --rm -ti \
  -v $KUBECONFIG:/kubeconfig \
  quay.io/lburgazzoli/odh-cli:latest lint --target-version 3.3.0

The container has KUBECONFIG=/kubeconfig set by default, so you just need to mount your kubeconfig to that path.

SELinux: On systems with SELinux enabled (Fedora, RHEL, CentOS), add :Z to the volume mount:

# Podman
podman run --rm -ti \
  -v $KUBECONFIG:/kubeconfig:Z \
  quay.io/lburgazzoli/odh-cli:latest lint --target-version 3.3.0

# Docker
docker run --rm -ti \
  -v $KUBECONFIG:/kubeconfig:Z \
  quay.io/lburgazzoli/odh-cli:latest lint --target-version 3.3.0

Available Tags:

• :latest - Latest stable release
• :dev - Latest development build from main branch (updated on every push)
• :vX.Y.Z - Specific version (e.g., :v1.2.3)

Note: The images are OCI-compliant and work with both Podman and Docker. Examples for both are provided below.

Interactive Debugging:

The container includes kubectl, oc, and debugging utilities for interactive troubleshooting:

Podman:

podman run -it --rm \
  -v $KUBECONFIG:/kubeconfig \
  --entrypoint /bin/bash \
  quay.io/lburgazzoli/odh-cli:latest

Docker:

docker run -it --rm \
  -v $KUBECONFIG:/kubeconfig \
  --entrypoint /bin/bash \
  quay.io/lburgazzoli/odh-cli:latest

Once inside the container, use kubectl/oc/wget/curl:

kubectl get pods -n opendatahub
oc get dsci
kubectl-odh lint --target-version 3.3.0

Available tools: kubectl (latest stable), oc (latest stable), wget, curl, tar, gzip, bash

Token Authentication:

For environments where you have a token and server URL instead of a kubeconfig file:

Podman:

podman run --rm -ti \
  quay.io/lburgazzoli/odh-cli:latest \
  lint \
  --target-version 3.3.0 \
  --token=sha256~xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx \
  --server=https://api.my-cluster.p3.openshiftapps.com:6443

Docker:

docker run --rm -ti \
  quay.io/lburgazzoli/odh-cli:latest \
  lint \
  --target-version 3.3.0 \
  --token=sha256~xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx \
  --server=https://api.my-cluster.p3.openshiftapps.com:6443

Using Go Run (No Installation Required)

If you have Go installed, you can run the CLI directly from GitHub without cloning:

# Show help
go run github.com/lburgazzoli/odh-cli/cmd@latest --help

# Show version
go run github.com/lburgazzoli/odh-cli/cmd@latest version

# Run lint command
go run github.com/lburgazzoli/odh-cli/cmd@latest lint --target-version 3.3.0

Note: Replace @latest with @v1.2.3 to run a specific version, or @main for the latest development version.

Token Authentication:

go run github.com/lburgazzoli/odh-cli/cmd@latest \
  lint \
  --target-version 3.3.0 \
  --token=sha256~xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx \
  --server=https://api.my-cluster.p3.openshiftapps.com:6443

Available commands:

• lint - Validate cluster configuration and assess upgrade readiness
• version - Display CLI version information

As kubectl Plugin

Install the kubectl-odh binary to your PATH:

# Download from releases
# Place in PATH as kubectl-odh
# Use with kubectl
kubectl odh lint --target-version 3.3.0
kubectl odh version

Documentation

For detailed documentation, see:

• Design and Architecture
• Development Guide
• Lint Architecture
• Writing Lint Checks

Building from Source

make build

The binary will be available at bin/kubectl-odh.

Building Container Image

make publish

This builds a multi-platform container image (linux/amd64, linux/arm64).