Configurer un exemple de dépôt

Un exemple de dépôt est un dépôt Git contenant des exemples personnalisés que votre équipe peut utiliser pour développer des applications.

Ainsi, au sein d'une organisation ou d'une équipe, vous pouvez configurer des exemples de dépôts avec Cloud Code, personnalisés pour votre organisation, afin d'offrir un ensemble standard d'applications, de services et de configurations d'infrastructure standards. . Cela permet d'aligner de nouveaux projets avec les normes et standards techniques de votre organisation, et favorise l'intégration de bonnes pratiques au début du cycle de développement.

Un exemple de dépôt peut être un dépôt existant d'exemples d'applications que vous avez déjà créés ou un nouvel ensemble d'échantillons que d'autres utilisateurs pourront utiliser. Il vous suffit d'ajouter un exemple de fichier de descripteur au dépôt pour l'importer avec Cloud Code.

Une fois prêts, les exemples de dépôts sont faciles à partager avec votre équipe. vous aurez besoin de Cloud Code et de l'URL Git de l'exemple de dépôt à utiliser. Pour les dépôts Git privés, seuls les membres ayant accès au dépôt peuvent utiliser les exemples personnalisés sous-jacents.

Pour voir un exemple de configuration d'un exemple de dépôt, consultez ce dépôt.

Créer un exemple de dépôt

Si vous souhaitez créer un autre dépôt d'exemple à utiliser, procédez comme suit:

  1. Créez un dépôt Git.

    Votre dépôt Git peut être hébergé à distance ou en ligne sur votre ordinateur local. Cet exemple utilise un tout nouveau dépôt GitHub, "custom-sample-repo".

    Interface de création de dépôt GitHub avec le champ de nom de dépôt renseigné avec "custom-sample-repo"

  2. Ajoutez des exemples de répertoires à ce dépôt.

    Vos exemples de répertoires peuvent contenir n'importe quel élément et se trouver n'importe où dans le dépôt. Dans cet exemple, deux exemples de répertoires "hello-world" et "kubernetes-custom-sample" ont été ajoutés à "custom-sample-repo".

    Nous vous recommandons vivement d'utiliser un fichier README contenant des instructions relatives à l'utilisation de vos exemples personnalisés.

    "custom-sample-repo" avec deux répertoires d'exemples sous-jacents, "hello-world" et "kubernetes-custom-sample"

  3. Créez un exemple de fichier descripteur.

    Un exemple de fichier descripteur fournit à Cloud Code des informations sur votre exemple pour créer correctement votre application. Ce fichier doit être nommé .cctemplate, situé dans votre répertoire racine, et le schéma doit être défini dans la section Exemple de schéma de fichier descripteur.

Utiliser un dépôt existant

Si vous souhaitez utiliser un dépôt existant, vous devez quand même créer un exemple de fichier descripteur. Ce fichier fournit à Cloud Code des informations sur votre exemple pour créer correctement votre application.

Votre fichier d'exemple de descripteur doit être nommé .cctemplate, situé dans votre répertoire racine, et le schéma doit être défini dans la section Exemple de schéma de fichier descripteur.

Exemple de schéma de descripteur

Key (Clé) Description Type
metadata Métadonnées utilisées par Cloud Code pour la lecture. Conforme au schéma de métadonnées. Métadonnées
modèles Tableau d'échantillons contenus dans un dépôt. Les objets de ce tableau doivent être conformes à l'exemple de schéma. Tableau<Exemple>
name (facultatif) Nom de l'exemple de dépôt. Chaîne

Exemple

{
   "metadata":{
      "version":"1"
   },
   "name": "My Sample Repository",
   "templates":[
      {
         "path":"/path/to/sample1_location",
         "name":"My Sample 1",
         "description":"The first sample of its name."
      },
      {
         "path":"/path/to/sample2_location",
         "name":"My Sample 2",
         "description":"The sequel."
      }
   ]
}

Exemple de schéma

Key (Clé) Description Type
chemin d'accès Où se trouve l'exemple dans un dépôt.

Le chemin d'accès est interprété comme provenant de la racine du dépôt.

Chaîne
nom Nom d'un échantillon.

Ceci s'affiche dans un IDE lors de la sélection d'un échantillon sur lequel baser une application.

Chaîne
description (facultatif) Description d'un exemple.

Ceci s'affiche dans un IDE lors de la sélection d'un échantillon sur lequel baser une application.

Chaîne

Exemple

{
   "path":"path/to/sample1",
   "name":"My Sample 1",
   "description":"The first sample of its name."
}

Schéma des métadonnées

Key (Clé) Description Type
version Version de l'exemple de schéma utilisé. Actuellement, la seule version valide est 1. Chaîne

Exemple

{
   "version":"1"
}

Assistance

Pour envoyer vos commentaires, signalez tout problème sur GitHub ou posez une question sur Stack Overflow.