From 2f8180c20eeec2fea34eebb1ba6a74c52563bf8e Mon Sep 17 00:00:00 2001 From: r2dedios Date: Mon, 3 Aug 2026 14:52:04 +0200 Subject: [PATCH 1/3] docs: rewrite ocp-admin deploy & use instructions MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Rewrite the deploy_and_use.md document with validated, step-by-step installation instructions tested against Lola 0.7.0. - List all 6 Lola-supported AI CLIs instead of assuming Claude Code - Fix lola command: marketplace → market - Fix Lola repo link: LobsterTrap/lola - Add OS-specific setup sections (Linux/Fedora and macOS) - Install CLI tools (regctl, cosign, syft) to ~/.local/bin - Remove regctl registry login from install steps (handled by skills) - Remove skills table, redirect to pack README - Add uninstall instructions - Add Developer Preview notice Co-Authored-By: Claude Opus 4.6 --- ocp-admin/.catalog/deploy_and_use.md | 119 ++++++++++++++++++++++----- 1 file changed, 97 insertions(+), 22 deletions(-) diff --git a/ocp-admin/.catalog/deploy_and_use.md b/ocp-admin/.catalog/deploy_and_use.md index 4a4461fe..6e55f005 100644 --- a/ocp-admin/.catalog/deploy_and_use.md +++ b/ocp-admin/.catalog/deploy_and_use.md @@ -1,54 +1,129 @@ +## Deploy and use +**Note:** This skill pack is released as Developer Preview. Developer Preview features provide early access to functionality in advance of possible inclusion in a Red Hat product offering. For more information about the support scope of Red Hat Developer Preview features, see Developer Preview Support Scope. + ### Prerequisites -- Claude Code CLI or IDE extension (if using Claude Code) -- Podman (or Docker) for the container-based MCP servers in **`mcps.json`** -- Red Hat account with access to [cloud.redhat.com](https://cloud.redhat.com) for **cluster creation** and **inventory** flows -- **Offline token** from [OpenShift offline token](https://cloud.redhat.com/openshift/token) for Assisted Installer and OCM APIs -- For **`/cluster-report`**: valid **`KUBECONFIG`** with contexts that point at real OpenShift clusters (read-only MCP mode) +- At least one supported AI coding assistant: + - [Claude Code](https://docs.anthropic.com/en/docs/claude-code) (CLI or IDE extension) + - [GitHub Copilot](https://docs.github.com/en/copilot) (CLI or VS Code) + - [Cursor](https://www.cursor.com/) + - [Gemini CLI](https://github.com/google-gemini/gemini-cli) + - [OpenClaw](https://github.com/openclaw/openclaw) + - [OpenCode](https://github.com/opencode-ai/opencode) +- [Lola](https://github.com/LobsterTrap/lola) CLI installed +- [Podman](https://podman.io/) (or Docker) — the MCP servers run as containers (see [OS-specific setup](#os-specific-setup)) +- A Red Hat account with access to [cloud.redhat.com](https://cloud.redhat.com) + +### Step 1: Install the skill pack + +```bash +# Add the Red Hat Agentic marketplace (one-time setup) +lola market add rh-agentic-collection https://raw.githubusercontent.com/RHEcosystemAppEng/agentic-catalog/main/marketplace/rh-agentic-collection.yml + +# Install the ocp-admin pack (replace claude-code with your AI assistant) +# Valid targets: claude-code, copilot-cli, copilot-vscode, cursor, gemini-cli, openclaw, opencode +lola install ocp-admin -a claude-code +``` + +This installs the skills, the `AGENTS.md` routing file, and the `mcps.json` MCP server definitions into your project. + +Verify the installation: -### Environment setup +```bash +lola list +``` + +### Step 2: Configure environment variables + +The pack uses three MCP servers, each requiring specific credentials passed as environment variables. **Never hardcode tokens or paths — always use environment variables.** -Variable **names** must match **`mcps.json`** (use **`${...}`** placeholders only in git; never commit secrets). +**For cluster creation and inventory** (`openshift-self-managed`, `openshift-ocm-managed`): -**Assisted Installer + managed clusters** (`openshift-self-managed`, `openshift-ocm-managed`): +1. Go to [https://cloud.redhat.com/openshift/token](https://cloud.redhat.com/openshift/token) +2. Click **Load token** → **Copy to clipboard** +3. Export it: ```bash -export OFFLINE_TOKEN="your-offline-api-token" +export OFFLINE_TOKEN="" ``` -**Multi-cluster kube report** (`openshift-administration`): +**For cluster operations and reporting** (`openshift-administration`): ```bash export KUBECONFIG="/path/to/your/kubeconfig" ``` -### Installation (Lola) +To make these persistent, add them to your shell profile (`~/.bashrc`, `~/.zshrc`). + +### Step 3: Use the skills + +The pack provides 7 skills. See the [ocp-admin README](../README.md) for the full list with descriptions and usage examples. + +### OS-specific setup + +#### Linux (Fedora / RHEL) + +**Podman** (required for MCP servers): + +```bash +sudo dnf install -y podman +``` + +**Additional tools for security skills** (`/container-cve-validator`, `/coreos-cve-validator`, `/image-inspect`): ```bash -lola install -f ocp-admin +# Required +pip install requests + +# regctl +curl -L https://github.com/regclient/regclient/releases/latest/download/regctl-linux-amd64 -o ~/.local/bin/regctl +chmod +x ~/.local/bin/regctl + +# cosign +curl -L https://github.com/sigstore/cosign/releases/latest/download/cosign-linux-amd64 -o ~/.local/bin/cosign +chmod +x ~/.local/bin/cosign + +# Optional (fallback SBOM generation) +curl -sSfL https://raw.githubusercontent.com/anchore/syft/main/install.sh | sh -s -- -b ~/.local/bin ``` -Module path: **`ocp-admin`** in **`marketplace/rh-agentic-collection.yml`** ([agentic-catalog](https://github.com/RHEcosystemAppEng/agentic-catalog)). See the root [README.md](../../README.md) for full prerequisites and MCP setup. +#### macOS -### Installation (Claude Code) +**Podman** (required for MCP servers): ```bash -lola install -f ocp-admin -a claude-code +brew install podman +podman machine init +podman machine start ``` -### Installation (Cursor) +**Additional tools for security skills** (`/container-cve-validator`, `/coreos-cve-validator`, `/image-inspect`): ```bash -lola install -f ocp-admin -a cursor +# Required +pip install requests +brew install regclient/tap/regctl +brew install sigstore/tap/cosign + +# Optional (fallback SBOM generation) +brew install anchore/syft/syft ``` -### MCP configuration +### Uninstall + +Remove the skill pack from your project: -Servers are defined in **`mcps.json`** at the pack root: Assisted Installer / OCM (`OFFLINE_TOKEN`) and read-only OpenShift API (`KUBECONFIG`). Use **`${VAR}`** placeholders only; never print token or kubeconfig contents in chat output. +```bash +lola uninstall ocp-admin +``` -**Linux vs macOS:** OpenShift MCP `podman` args may include user-namespace flags for `KUBECONFIG` mounts; adjust per the pack **README** if Podman runs in a VM. +To also remove the marketplace registry: + +```bash +lola market rm rh-agentic-collection +``` From e45e9900baf064cb033f2f5814ab0ed499963d8e Mon Sep 17 00:00:00 2001 From: r2dedios Date: Tue, 4 Aug 2026 12:14:13 +0200 Subject: [PATCH 2/3] docs: simplify deploy_and_use per review feedback - Remove OS-specific setup section entirely - Move security skill dependencies to prerequisites as links - Keep install/uninstall and dev-preview banner --- ocp-admin/.catalog/deploy_and_use.md | 57 +++------------------------- 1 file changed, 6 insertions(+), 51 deletions(-) diff --git a/ocp-admin/.catalog/deploy_and_use.md b/ocp-admin/.catalog/deploy_and_use.md index 6e55f005..d5010925 100644 --- a/ocp-admin/.catalog/deploy_and_use.md +++ b/ocp-admin/.catalog/deploy_and_use.md @@ -16,8 +16,13 @@ - [OpenClaw](https://github.com/openclaw/openclaw) - [OpenCode](https://github.com/opencode-ai/opencode) - [Lola](https://github.com/LobsterTrap/lola) CLI installed -- [Podman](https://podman.io/) (or Docker) — the MCP servers run as containers (see [OS-specific setup](#os-specific-setup)) +- [Podman](https://podman.io/) (or Docker) — the MCP servers run as containers - A Red Hat account with access to [cloud.redhat.com](https://cloud.redhat.com) +- For security skills (`/container-cve-validator`, `/coreos-cve-validator`, `/image-inspect`): + - [Python requests](https://pypi.org/project/requests/) (`pip install requests`) + - [regctl](https://github.com/regclient/regclient) + - [cosign](https://github.com/sigstore/cosign) + - [syft](https://github.com/anchore/syft) (optional, fallback SBOM generation) ### Step 1: Install the skill pack @@ -64,56 +69,6 @@ To make these persistent, add them to your shell profile (`~/.bashrc`, `~/.zshrc The pack provides 7 skills. See the [ocp-admin README](../README.md) for the full list with descriptions and usage examples. -### OS-specific setup - -#### Linux (Fedora / RHEL) - -**Podman** (required for MCP servers): - -```bash -sudo dnf install -y podman -``` - -**Additional tools for security skills** (`/container-cve-validator`, `/coreos-cve-validator`, `/image-inspect`): - -```bash -# Required -pip install requests - -# regctl -curl -L https://github.com/regclient/regclient/releases/latest/download/regctl-linux-amd64 -o ~/.local/bin/regctl -chmod +x ~/.local/bin/regctl - -# cosign -curl -L https://github.com/sigstore/cosign/releases/latest/download/cosign-linux-amd64 -o ~/.local/bin/cosign -chmod +x ~/.local/bin/cosign - -# Optional (fallback SBOM generation) -curl -sSfL https://raw.githubusercontent.com/anchore/syft/main/install.sh | sh -s -- -b ~/.local/bin -``` - -#### macOS - -**Podman** (required for MCP servers): - -```bash -brew install podman -podman machine init -podman machine start -``` - -**Additional tools for security skills** (`/container-cve-validator`, `/coreos-cve-validator`, `/image-inspect`): - -```bash -# Required -pip install requests -brew install regclient/tap/regctl -brew install sigstore/tap/cosign - -# Optional (fallback SBOM generation) -brew install anchore/syft/syft -``` - ### Uninstall Remove the skill pack from your project: From 52da3380155b92dbccd26928a53bd342f38f47cb Mon Sep 17 00:00:00 2001 From: r2dedios Date: Tue, 4 Aug 2026 16:34:05 +0200 Subject: [PATCH 3/3] docs: address review feedback on deploy_and_use - Restore original catalog fragment HTML comment - Remove OpenClaw from supported AI CLIs (not a coding assistant) --- ocp-admin/.catalog/deploy_and_use.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/ocp-admin/.catalog/deploy_and_use.md b/ocp-admin/.catalog/deploy_and_use.md index d5010925..a360afaa 100644 --- a/ocp-admin/.catalog/deploy_and_use.md +++ b/ocp-admin/.catalog/deploy_and_use.md @@ -1,6 +1,6 @@ ## Deploy and use @@ -13,7 +13,6 @@ - [GitHub Copilot](https://docs.github.com/en/copilot) (CLI or VS Code) - [Cursor](https://www.cursor.com/) - [Gemini CLI](https://github.com/google-gemini/gemini-cli) - - [OpenClaw](https://github.com/openclaw/openclaw) - [OpenCode](https://github.com/opencode-ai/opencode) - [Lola](https://github.com/LobsterTrap/lola) CLI installed - [Podman](https://podman.io/) (or Docker) — the MCP servers run as containers @@ -31,7 +30,7 @@ lola market add rh-agentic-collection https://raw.githubusercontent.com/RHEcosystemAppEng/agentic-catalog/main/marketplace/rh-agentic-collection.yml # Install the ocp-admin pack (replace claude-code with your AI assistant) -# Valid targets: claude-code, copilot-cli, copilot-vscode, cursor, gemini-cli, openclaw, opencode +# Valid targets: claude-code, copilot-cli, copilot-vscode, cursor, gemini-cli, opencode lola install ocp-admin -a claude-code ```