diff --git a/ocp-admin/.catalog/deploy_and_use.md b/ocp-admin/.catalog/deploy_and_use.md index 4a4461fe..a360afaa 100644 --- a/ocp-admin/.catalog/deploy_and_use.md +++ b/ocp-admin/.catalog/deploy_and_use.md @@ -3,52 +3,81 @@ Golden sources: skills/*/SKILL.md, README.md, AGENTS.md --> +## 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) + - [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 +- 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 + +```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 -### Environment setup +# Install the ocp-admin pack (replace claude-code with your AI assistant) +# Valid targets: claude-code, copilot-cli, copilot-vscode, cursor, gemini-cli, opencode +lola install ocp-admin -a claude-code +``` -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. -**Assisted Installer + managed clusters** (`openshift-self-managed`, `openshift-ocm-managed`): +Verify the installation: ```bash -export OFFLINE_TOKEN="your-offline-api-token" +lola list ``` -**Multi-cluster kube report** (`openshift-administration`): +### 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.** + +**For cluster creation and inventory** (`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 KUBECONFIG="/path/to/your/kubeconfig" +export OFFLINE_TOKEN="" ``` -### Installation (Lola) +**For cluster operations and reporting** (`openshift-administration`): ```bash -lola install -f ocp-admin +export KUBECONFIG="/path/to/your/kubeconfig" ``` -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`). -### Installation (Claude Code) +### Step 3: Use the skills -```bash -lola install -f ocp-admin -a claude-code -``` +The pack provides 7 skills. See the [ocp-admin README](../README.md) for the full list with descriptions and usage examples. + +### Uninstall -### Installation (Cursor) +Remove the skill pack from your project: ```bash -lola install -f ocp-admin -a cursor +lola uninstall ocp-admin ``` -### MCP configuration +To also remove the marketplace registry: -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. - -**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 +```