Documentation OpenShift

VérifiéSûr

Recherche et lecture de la documentation OpenShift Container Platform au format Markdown. Utilisez-la pour des questions sur les fonctionnalités, la configuration, l'installation, le dépannage, les opérateurs, les routes, les services, etc.

Spar Skills Guide Bot
DocumentationDébutant
25/07/2026
Claude CodeCursorCodex
#openshift#docs-search#kubernetes#reference#cluster-admin

Recommandé pour

Synthèse automatique

Recherche et lit localement la documentation OpenShift Container Platform convertie en Markdown, en s'appuyant sur un index AGENTS.md par version.

Points forts

  • Oriente la recherche via un index AGENTS.md propre à chaque version, ce qui évite de parcourir l'arborescence à l'aveugle
  • Privilégie explicitement la lecture des fichiers de documentation plutôt que les connaissances pré-entraînées, souvent obsolètes
  • Couvre les sujets OCP courants : operators, routes, services, oc, RBAC, réseau, stockage et administration de cluster
  • Reste en lecture seule avec des commandes Bash limitées (cat, grep, find, ls)

Limites

  • Ne fonctionne que sur les versions de documentation déjà générées et présentes dans docs/ (via make docs VERSION=X.Y)
  • Ne consulte pas de cluster réel : aucune vérification de l'état ou de la configuration effective
  • Dépend de la présence locale du dépôt et de l'index AGENTS.md à jour
Quand l'utiliser

À utiliser dès qu'une question porte sur une fonctionnalité, une procédure d'installation ou un dépannage spécifique à OpenShift Container Platform.

Quand l'éviter

À éviter pour interroger un cluster en direct, pour Kubernetes upstream sans lien avec OCP, ou si la documentation locale n'a pas été générée pour la version visée.

Analyse de sécurité

Sûr
Score qualité84/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.

Points d'attention
  • •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.
Comment cette analyse est faite

Exemples

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.

Du fichier au premier essai

Le téléchargement contient exactement le contenu affiché sur cette fiche. Cette copie peut différer de la dernière version du dépôt source.

Consulter la source et ses fichiers annexes

Ce téléchargement contient uniquement SKILL.md. Les scripts, références, modèles et dépendances éventuels ne sont pas inclus. Récupérez les fichiers nécessaires depuis la source en conservant leur arborescence avant de poursuivre.

1. Télécharger le fichier

Télécharger SKILL.md

Depuis la racine d’un projet de test, enregistrez le fichier sous .skill-downloads/openshift-documentation-mrzxupnn/SKILL.md, ou utilisez la commande suivante. Ce dossier sert à examiner la skill avant son installation.

Commande pour macOS/Linux ou WSL : un shell POSIX et curl sont nécessaires. Sous Windows sans WSL, utilisez le bouton de téléchargement et créez le dossier manuellement.

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. Vérifier les prérequis

Lisez SKILL.md avant de l’utiliser. Si le fichier cite des scripts ou services externes, examinez-les et préparez les accès nécessaires dans votre environnement de test.

Outils déclarés par l’auteur (à vérifier dans votre agent) : Bash(cat:*,grep:*,find:*,ls:*)

Aucune section de prérequis reconnue dans ce fichier. Cela ne signifie pas qu’il est autonome : les bibliothèques, outils et accès peuvent être cités ailleurs dans le contenu ou dans le dépôt source.

Les plateformes de la fiche sont des indications du catalogue. Les chemins ci-dessous suivent la documentation des outils ; ils ne prouvent pas que cette skill y a été exécutée. Aucune version minimale de ces outils n’est attestée pour cette fiche.

3. Charger la skill

Après vérification, copiez le dossier complet dans le projet avec l’une des commandes ci-dessous, puis ouvrez une nouvelle session de l’outil. La commande s’arrête si un dossier du même nom existe déjà : comparez les fichiers avant de le remplacer.

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 doit déjà être installé. La procédure locale install/read est contrôlée avec OpenSkills 1.5.0, qui exige Node.js ≥ 20.6.0. Aucun slug du catalogue n’est résolu automatiquement.

Installation officielle d’OpenSkills
openskills install './.skill-downloads/openshift-documentation-mrzxupnn'

openskills read 'openshift-documentation-mrzxupnn'

La lecture doit afficher le contenu du fichier installé et son dossier de base. Elle ne lance ni la skill ni ses dépendances.

Pour un agent qui lit AGENTS.md, synchronisez ensuite l’index. Cette commande modifie AGENTS.md : relisez le diff avant de l’utiliser.

openskills sync

Mode manuel ou autre outil : joignez SKILL.md à une conversation, ou ouvrez-le dans un agent capable de lire les fichiers. Ajoutez les ressources annexes nécessaires. Il n’existe pas de dossier universel reconnu par tous les outils.

4. Faire un premier essai

Utilisez une entrée courte et fictive : un endpoint d’API, un petit document ou un brief d’interface. Dans une nouvelle conversation, joignez le fichier ou donnez son chemin à l’agent, puis adaptez cette demande :

Lis .skill-downloads/openshift-documentation-mrzxupnn/SKILL.md et applique ses instructions à cet exemple : [décrire une entrée de test]. Indique les fichiers, dépendances ou accès qui manquent. Produis le résultat demandé par la skill sans inventer de données ni exécuter de script non examiné.

Résultat attendu : une sortie correspondant aux instructions de la skill, ou une liste précise des prérequis manquants. Une simple confirmation de lecture ne valide pas le premier usage. Si une ressource externe est indisponible, ce parcours reste à tester.

Skills similaires