Skip to content

docs: rewrite ocp-admin deploy & use instructions - #150

Open
r2dedios wants to merge 3 commits into
RHEcosystemAppEng:mainfrom
r2dedios:docs/ocp-admin-deploy-and-use
Open

docs: rewrite ocp-admin deploy & use instructions#150
r2dedios wants to merge 3 commits into
RHEcosystemAppEng:mainfrom
r2dedios:docs/ocp-admin-deploy-and-use

Conversation

@r2dedios

@r2dedios r2dedios commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Rewrites ocp-admin/.catalog/deploy_and_use.md with validated, step-by-step installation instructions tested against Lola 0.7.0
  • Lists all 6 Lola-supported AI CLIs (claude-code, copilot-cli, copilot-vscode, cursor, gemini-cli, openclaw, opencode) instead of assuming Claude Code
  • Fixes lola marketplacelola market command and corrects Lola repo link to LobsterTrap/lola
  • Adds OS-specific setup sections for Linux (Fedora/RHEL) and macOS
  • Installs CLI tools (regctl, cosign, syft) to ~/.local/bin — no sudo required
  • Removes regctl registry login from install steps (handled by skills at runtime)
  • Replaces inline skills table with a redirect to the pack README
  • Adds uninstall instructions (lola uninstall + lola market rm)
  • Adds Developer Preview notice

Test plan

  • Validated lola market add command against Lola 0.7.0
  • Validated lola install ocp-admin -a claude-code — installs 7 skills, 3 MCPs
  • Validated lola list shows installed module
  • Validated lola uninstall ocp-admin removes skills and MCP config
  • Verified 7 skills in table match ocp-admin/skills/*/ on disk

🤖 Generated with Claude Code

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>
@r2dedios
r2dedios requested a review from dmartinol as a code owner August 3, 2026 12:54
@r2dedios r2dedios self-assigned this Aug 3, 2026
@r2dedios r2dedios added the documentation Improvements or additions to documentation label Aug 3, 2026

@dmartinol dmartinol left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread ocp-admin/.catalog/deploy_and_use.md Outdated
Comment thread ocp-admin/.catalog/deploy_and_use.md Outdated
Golden sources: skills/*/SKILL.md, README.md, AGENTS.md, mcps.json
-->

## Deploy and use

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The 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/)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could update them again, but the docs update is becoming urgent

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The 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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread ocp-admin/.catalog/deploy_and_use.md Outdated
- Remove OS-specific setup section entirely
- Move security skill dependencies to prerequisites as links
- Keep install/uninstall and dev-preview banner
@r2dedios

r2dedios commented Aug 4, 2026

Copy link
Copy Markdown
Contributor Author

@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)
@dmartinol

Copy link
Copy Markdown
Collaborator

@dmartinol I updated the doc following your feedback. Please take a look

If you want this to be merged, pls confirm it's not affecting the generation of agentic-catalog pages.

@r2dedios

r2dedios commented Aug 5, 2026

Copy link
Copy Markdown
Contributor Author

I updated the catalog script for generating the gh pages poiting to agentic-plugins repo and it worked well.

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

@r2dedios
r2dedios requested a review from TomerFi August 6, 2026 15:30

@TomerFi TomerFi left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @r2dedios ! This is great work! We should do this for all the plugins, I just have some small comments.

- [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)

@TomerFi TomerFi Aug 7, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [OpenCode](https://github.com/opencode-ai/opencode)
- [OpenCode](https://opencode.ai/)

@TomerFi TomerFi Aug 7, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The 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.

- **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)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [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)

@TomerFi TomerFi Aug 7, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The 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.

- 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)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [GitHub Copilot](https://docs.github.com/en/copilot) (CLI or VS Code)
- [GitHub Copilot](https://github.com/features/copilot) (CLI or VS Code)

@TomerFi TomerFi Aug 7, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The 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
- [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`):

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@TomerFi TomerFi Aug 7, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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`).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
lola market rm rh-agentic-collection
lola market rm rh-agentic-plugins

@TomerFi TomerFi Aug 7, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Depending on your response to #150 (comment).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants