-
Notifications
You must be signed in to change notification settings - Fork 31
docs: rewrite ocp-admin deploy & use instructions #150
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,54 +1,129 @@ | ||||||
| <!-- | ||||||
| Catalog fragment — maintain via create-collection workflow (assistant + maintainer + PR review). | ||||||
| Golden sources: skills/*/SKILL.md, README.md, AGENTS.md | ||||||
| Deploy & Use instructions for the ocp-admin skill pack. | ||||||
| Golden sources: skills/*/SKILL.md, README.md, AGENTS.md, mcps.json | ||||||
| --> | ||||||
|
|
||||||
| ## Deploy and use | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm concerned that it will change the layout of this pack but not other packs (these files are used to build the catalog as in https://rhecosystemappeng.github.io/agentic-catalog/)
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We could update them again, but the docs update is becoming urgent
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
From the agentic-catalog perspective, everything is fine: the installation steps are correctly reported and the RH catalog has its own settings. I don't see the urgency, unless we want to automate the deployment of these catalog items to production environment.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I meant urgent because there's people trying to start using the agentic-packs but the installation docs are wrong
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I agree with @dmartinol . |
||||||
| **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. | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Can we add a link to that? |
||||||
|
|
||||||
| ### 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) | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nitpicking, but I think directing users to the product pages is more consistent and appropriate. Feel free to dismiss. |
||||||
| - [GitHub Copilot](https://docs.github.com/en/copilot) (CLI or VS Code) | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nitpicking, but I think directing users to the product pages is more consistent and appropriate. Feel free to dismiss. |
||||||
| - [Cursor](https://www.cursor.com/) | ||||||
| - [Gemini CLI](https://github.com/google-gemini/gemini-cli) | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Gemini CLI was shutdown in June, see deprecations table. I know Gemini CLI is still listed as supported in Lola, they have LobsterTrap/lola#218 for tracking Antigravity support. |
||||||
| - [OpenClaw](https://github.com/openclaw/openclaw) | ||||||
|
r2dedios marked this conversation as resolved.
Outdated
|
||||||
| - [OpenCode](https://github.com/opencode-ai/opencode) | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nitpicking, but I think directing users to the product pages is more consistent and appropriate. Feel free to dismiss. |
||||||
| - [Lola](https://github.com/LobsterTrap/lola) CLI installed | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Not sure about this one, which is better... just a thought. Anyway, it's just nitpicking, dismiss if you think we're good as-is. |
||||||
| - [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 | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should we have named the underlying yaml file in the catalog |
||||||
|
|
||||||
| # 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. | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this line is too specific. Also, I think it's more commonly known as an |
||||||
|
|
||||||
| 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="<your-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`). | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm not sure I would suggest users to save |
||||||
|
|
||||||
| ### 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 | ||||||
|
r2dedios marked this conversation as resolved.
Outdated
|
||||||
|
|
||||||
| #### 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 | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Depending on your response to #150 (comment). |
||||||
| ``` | ||||||
Uh oh!
There was an error while loading. Please reload this page.