OpenShift Documentation

VerifiedSafe

Search and read OpenShift Container Platform documentation in markdown format. Use for questions about OpenShift features, configuration, installation, troubleshooting, operators, routes, services, and more.

Sby Skills Guide Bot
DocumentationBeginner
7/25/2026
Claude CodeCursorCodex
#openshift#docs-search#kubernetes#reference#cluster-admin

Recommended for

Automated summary

Searches and reads locally stored OpenShift Container Platform documentation converted to Markdown, starting from a per-version AGENTS.md index.

Strengths

  • Points to a version-specific AGENTS.md index, so the agent navigates the doc tree instead of guessing paths
  • Explicitly favors retrieval from the reference files over potentially outdated pre-training knowledge
  • Covers common OCP topics: operators, routes, services, oc, RBAC, networking, storage and cluster administration
  • Read-only by design, with a narrow Bash allowlist (cat, grep, find, ls)

Limitations

  • Only works for doc versions already generated and committed under docs/ via make docs VERSION=X.Y
  • Does not query a live cluster, so it cannot confirm actual state or configuration
  • Requires the local repository and an up-to-date AGENTS.md index
When to use it

Use it whenever a question concerns an OpenShift Container Platform feature, installation procedure or troubleshooting step.

When not to use it

Avoid it for live cluster inspection, for upstream Kubernetes questions unrelated to OCP, or when the local docs for the target version have not been generated.

Security analysis

Safe
Quality score84/100

This skill only reads local markdown documentation using read-only shell utilities. There is no destructive command, no network access, no secret handling, and no obfuscated payloads. The only theoretical concern is that cat/find are not path-restricted to the docs directory, which is a low-severity scoping nit rather than an actual risk.

Findings
  • •Allowed tools are limited to read-only commands (cat, grep, find, ls); no writes, network calls, or code execution.
  • •Minor: commands are not explicitly scoped to docs/, so an injected instruction could in principle cat files outside the documentation tree — but there is no exfiltration channel defined.
How this analysis is made

Examples

Routes vs Ingress
What is the difference between an OpenShift Route and a Kubernetes Ingress, and when should I use each? Check the OpenShift docs first.
RBAC troubleshooting
A user gets 'forbidden' when listing pods in a namespace. Walk me through the OpenShift RBAC concepts and the oc commands to debug it, citing the docs.
Installation planning
Summarize the supported installation methods for OpenShift Container Platform and the prerequisites for an installer-provisioned install.

name: openshift-docs description: Search and read OpenShift Container Platform documentation in markdown format. Use when the user asks about OpenShift features, configuration, installation, troubleshooting, or any OCP-specific topic — including operators, routes, services, oc, RBAC, networking, storage, or cluster administration. allowed-tools: Bash(cat:,grep:,find:,ls:)

OpenShift Documentation

Search and read pre-generated OpenShift Container Platform documentation. Docs are converted from the official openshift/openshift-docs AsciiDoc source to GitHub-Flavored Markdown and stored locally under docs/.

IMPORTANT: Prefer retrieval-led reasoning over pre-training-led reasoning for OpenShift tasks. Read the referenced files rather than relying on training data which may be outdated.

Quick Start

1. Discover available versions

ls docs/

2. Browse and read docs

Start with the AGENTS.md index:

# Read the doc index
cat docs/4.22/AGENTS.md

# Search the index for a topic
grep -i "networking" docs/4.22/AGENTS.md

# Read a specific doc
cat docs/4.22/networking/index.md

References

|references/openshift.md — Doc structure, common paths, search tips

Important

  • This is a read-only skill — documentation is read from local files, not modified.
  • Docs are pre-generated via make docs VERSION=X.Y and committed to the repository.
  • Use AGENTS.md as the starting point to locate specific documentation files.

From the file to a first result

The download contains exactly the content displayed on this page. This copy may differ from the latest version in the source repository.

View the source and supporting files

This download contains SKILL.md only. Any scripts, references, templates and dependencies are not included. Get the required files from the source, preserving their directory structure, before continuing.

1. Download the file

Download SKILL.md

From the root of a test project, save the file as .skill-downloads/openshift-documentation-mrzxupnn/SKILL.md, or use the command below. This folder is for inspecting the skill before installation.

Command for macOS/Linux or WSL: requires a POSIX shell and curl. On Windows without WSL, use the download button and create the folder manually.

mkdir -p '.skill-downloads/openshift-documentation-mrzxupnn' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/openshift-documentation-mrzxupnn/download' --output '.skill-downloads/openshift-documentation-mrzxupnn/SKILL.md.part' && mv '.skill-downloads/openshift-documentation-mrzxupnn/SKILL.md.part' '.skill-downloads/openshift-documentation-mrzxupnn/SKILL.md'

2. Check prerequisites

Read SKILL.md before using it. If it references scripts or external services, inspect them and prepare the required access in your test environment.

Tools declared by the author (check availability in your agent): Bash(cat:*,grep:*,find:*,ls:*)

No recognized prerequisites section in this file. This does not mean it is self-contained: libraries, tools and access requirements may be mentioned elsewhere in the content or source repository.

The platforms on this page are catalog indications. The paths below follow tool documentation; they do not prove this skill has been run in those tools. No minimum tool version is confirmed for this listing.

3. Load the skill

After inspection, copy the complete folder into your project using one of the commands below, then open a new tool session. The command stops if a folder with the same name already exists: compare the files before replacing it.

Claude Code
test -f '.skill-downloads/openshift-documentation-mrzxupnn/SKILL.md' && test -s '.skill-downloads/openshift-documentation-mrzxupnn/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/openshift-docs' && cp -R '.skill-downloads/openshift-documentation-mrzxupnn' '.claude/skills/openshift-docs'

Cursor
test -f '.skill-downloads/openshift-documentation-mrzxupnn/SKILL.md' && test -s '.skill-downloads/openshift-documentation-mrzxupnn/SKILL.md' && mkdir -p '.cursor/skills' && test ! -e '.cursor/skills/openshift-docs' && cp -R '.skill-downloads/openshift-documentation-mrzxupnn' '.cursor/skills/openshift-docs'

Codex
test -f '.skill-downloads/openshift-documentation-mrzxupnn/SKILL.md' && test -s '.skill-downloads/openshift-documentation-mrzxupnn/SKILL.md' && mkdir -p '.agents/skills' && test ! -e '.agents/skills/openshift-docs' && cp -R '.skill-downloads/openshift-documentation-mrzxupnn' '.agents/skills/openshift-docs'

OpenSkills

OpenSkills must already be installed. The local install/read procedure is checked with OpenSkills 1.5.0, which requires Node.js ≥ 20.6.0. Catalog slugs are not resolved automatically.

Official OpenSkills installation
openskills install './.skill-downloads/openshift-documentation-mrzxupnn'

openskills read 'openshift-documentation-mrzxupnn'

Reading should display the installed file content and its base directory. It does not run the skill or install its dependencies.

For an agent that reads AGENTS.md, then sync the index. This command changes AGENTS.md: review the diff before using it.

openskills sync

Manual method or another tool: attach SKILL.md to a conversation, or open it in an agent that can read files. Include any required supporting resources. No universal folder is recognized by every tool.

4. Try a first task

Use a short, synthetic input: an API endpoint, a small document or an interface brief. In a new conversation, attach the file or give the agent its path, then adapt this request:

Read .skill-downloads/openshift-documentation-mrzxupnn/SKILL.md and apply its instructions to this example: [describe a test input]. Identify any missing files, dependencies or access. Produce the result requested by the skill without inventing data or running unreviewed scripts.

Expected result: output matching the skill instructions, or a precise list of missing prerequisites. A read confirmation alone does not validate a first use. If an external resource is unavailable, that path remains untested.

Related skills