Edit This Page

Génération de la documentation de référence pour l'API de fédération Kubernetes

Cette page montre comment générer automatiquement des pages de référence pour l’API de fédération Kubernetes.

• Pré-requis
• Exécution du script update-federation-api-docs.sh
• A suivre

Pré-requis

• Vous devez avoir Git installé.

• Vous devez avoir Golang version 1.9.1 ou ultérieur installé, et votre variable d’environnement $GOPATH doit être définie.

• Vous devez avoir Docker installé.

• Vous devez savoir comment créer une pull request sur un dépôt GitHub. Généralement, cela implique la création d’un fork du dépôt. Pour plus d’informations, voir Création d’une pull request de documentation.

Exécution du script update-federation-api-docs.sh

Si vous ne possédez pas déjà le code source de la fédération Kubernetes, procurez-vous-le maintenant:

mkdir $GOPATH/src
cd $GOPATH/src
go get github.com/kubernetes/federation

Déterminez le répertoire de base de votre dépôt local kubernetes/federation. Par exemple, si vous avez suivi l’étape précédente pour obtenir le code source de la fédération, votre répertoire de base est $GOPATH/src/github.com/kubernetes/federation. Les étapes restantes se réfèrent à votre répertoire de base en tant que <fed-base>.

Exécutez le script de génération de documentation:

cd <fed-base>
hack/update-federation-api-reference-docs.sh

Le script exécute le k8s.gcr.io/gen-swagger-docs image pour générer cet ensemble de documents de référence:

• /docs/api-reference/extensions/v1beta1/operations.html
• /docs/api-reference/extensions/v1beta1/definitions.html
• /docs/api-reference/v1/operations.html
• /docs/api-reference/v1/definitions.html

Les fichiers générés ne sont pas publiés automatiquement. Ils doivent être copiés manuellement sur dépôt kubernetes/website.

Ces fichiers sont publiés à kubernetes.io/docs/reference:

• Federation API v1 Operations
• Federation API v1 Definitions
• Federation API extensions/v1beta1 Operations
• Federation API extensions/v1beta1 Definitions

A suivre

• Génération de documentation de référence pour l’API Kubernetes
• Génération de documentation de référence pour les commandes kubectl
• Génération de pages de référence pour les composants et les outils Kubernetes

Feedback

Cette page est elle utile ?

Thanks for the feedback. If you have a specific, answerable question about how to use Kubernetes, ask it on Stack Overflow. Open an issue in the GitHub repo if you want to report a problem or suggest an improvement.