docs: rewrite ocp-admin deploy & use instructions - #150
Conversation
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 <noreply@anthropic.com>
dmartinol
left a comment
There was a problem hiding this comment.
Thanks for your contribution! I have some doubts about these changes, as they affect a single pack, change the page layout in the catalog and create duplications (see the installation instructions).
Before merging pls consider the next comments, generate the catalog pages and review the generated sections.
| Golden sources: skills/*/SKILL.md, README.md, AGENTS.md, mcps.json | ||
| --> | ||
|
|
||
| ## Deploy and use |
There was a problem hiding this comment.
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/)
There was a problem hiding this comment.
We could update them again, but the docs update is becoming urgent
There was a problem hiding this comment.
We could update them again, but the docs update is becoming urgent
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.
There was a problem hiding this comment.
I meant urgent because there's people trying to start using the agentic-packs but the installation docs are wrong
There was a problem hiding this comment.
I agree with @dmartinol .
I think that if we update any of the catalog files in a manner such as this, we should probably update the same files in each pack at the same time.
- Remove OS-specific setup section entirely - Move security skill dependencies to prerequisites as links - Keep install/uninstall and dev-preview banner
|
@dmartinol I updated the doc following your feedback. Please take a look |
- Restore original catalog fragment HTML comment - Remove OpenClaw from supported AI CLIs (not a coding assistant)
If you want this to be merged, pls confirm it's not affecting the generation of agentic-catalog pages. |
|
I updated the catalog script for generating the gh pages poiting to Most of all, I'd like to validate that this new docs are Ok, and if so, apply the same update to every agentic pack, so the docs are up to date |
| - [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) |
There was a problem hiding this comment.
Gemini CLI was shutdown in June, see deprecations table.
I'm not sure you can still install it, but if you can or you already have it installed, you can't run it. You'll get a message requsting you to install Antigravity (agy) instead. We have APPENG-5742 to track this.
I know Gemini CLI is still listed as supported in Lola, they have LobsterTrap/lola#218 for tracking Antigravity support.
But since just running Gemini CLI gives an error, and Agy is not supported yet. I would leave Gemini off this list.
| --> | ||
|
|
||
| ## 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. |
There was a problem hiding this comment.
see Developer Preview Support Scope
Can we add a link to that?
| - [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) | ||
| - [OpenCode](https://github.com/opencode-ai/opencode) |
There was a problem hiding this comment.
| - [OpenCode](https://github.com/opencode-ai/opencode) | |
| - [OpenCode](https://opencode.ai/) |
There was a problem hiding this comment.
Nitpicking, but I think directing users to the product pages is more consistent and appropriate. Feel free to dismiss.
| - **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) |
There was a problem hiding this comment.
| - [Claude Code](https://docs.anthropic.com/en/docs/claude-code) (CLI or IDE extension) | |
| - [Claude Code](https://claude.com/product/claude-code) (CLI or IDE extension) |
There was a problem hiding this comment.
Nitpicking, but I think directing users to the product pages is more consistent and appropriate. Feel free to dismiss.
| - 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) |
There was a problem hiding this comment.
| - [GitHub Copilot](https://docs.github.com/en/copilot) (CLI or VS Code) | |
| - [GitHub Copilot](https://github.com/features/copilot) (CLI or VS Code) |
There was a problem hiding this comment.
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 | ||
| - [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`): |
There was a problem hiding this comment.
Not a comment on this PR, more of a general wondering. I haven't notice before now that we depend on local installations for running skills, and I don't think it's a practice we've taken in other plugins. Was this tested with cloud assitants, i.e. ChatGPT? @dmartinol
|
|
||
| ```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 |
There was a problem hiding this comment.
| lola market add rh-agentic-collection https://raw.githubusercontent.com/RHEcosystemAppEng/agentic-catalog/main/marketplace/rh-agentic-collection.yml | |
| lola market add rh-agentic-plugins https://raw.githubusercontent.com/RHEcosystemAppEng/agentic-catalog/main/marketplace/rh-agentic-collection.yml |
There was a problem hiding this comment.
Should we have named the underlying yaml file in the catalog rh-agentic-plugins.yml instead of the existing rh-agentic-collection.yml when we did the catalog repo seperation and name change?
| ``` | ||
|
|
||
| Variable **names** must match **`mcps.json`** (use **`${...}`** placeholders only in git; never commit secrets). | ||
| This installs the skills, the `AGENTS.md` routing file, and the `mcps.json` MCP server definitions into your project. |
There was a problem hiding this comment.
I think this line is too specific. AGENTS.md will only be created if you choose opencode as your target, for claudecode it will be CLAUDE.md. Also the mcps.json, each target as it own file name and placments, I would stay away from mentioning file names here to avoid confusion.
Also, I think it's more commonly known as an instructions file rather than a routing file.
| ``` | ||
|
|
||
| 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. | ||
| To make these persistent, add them to your shell profile (`~/.bashrc`, `~/.zshrc`). |
There was a problem hiding this comment.
I'm not sure I would suggest users to save KUBECONFIG="/path/to/your/kubeconfig" in thier main shell profile. 😁
|
|
||
| **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. | ||
| ```bash | ||
| lola market rm rh-agentic-collection |
There was a problem hiding this comment.
| lola market rm rh-agentic-collection | |
| lola market rm rh-agentic-plugins |
Summary
ocp-admin/.catalog/deploy_and_use.mdwith validated, step-by-step installation instructions tested against Lola 0.7.0lola marketplace→lola marketcommand and corrects Lola repo link toLobsterTrap/lola~/.local/bin— no sudo requiredregctl registry loginfrom install steps (handled by skills at runtime)lola uninstall+lola market rm)Test plan
lola market addcommand against Lola 0.7.0lola install ocp-admin -a claude-code— installs 7 skills, 3 MCPslola listshows installed modulelola uninstall ocp-adminremoves skills and MCP configocp-admin/skills/*/on disk🤖 Generated with Claude Code