Beispiel-Repository einrichten

Ein Beispiel-Repository ist ein Git-Repository mit benutzerdefinierten Beispielen, die Sie erstellt haben, damit Ihr Team Anwendungen entwickeln kann.

Dies bedeutet, dass Sie innerhalb einer Organisation oder einem Team benutzerdefinierte Beispiel-Repositories mit Cloud Code einrichten können, der für Ihre Organisation angepasst ist, um einen Standardsatz an Startanwendungen, Diensten und Infrastrukturkonfigurationen anderer zur Verfügung zu stellen. verwenden. Dies erleichtert die Anbindung neuer Projekte an den bevorzugten technischen Stack und die technischen Standards Ihrer Organisation. Außerdem werden am Anfang des Entwicklungszyklus Best Practices ins Leben gerufen.

Ein Beispiel-Repository kann ein vorhandenes Repository mit Beispielanwendungen sein, die Sie bereits erstellt haben, oder ein ganz neuer Satz von Stichproben, die andere verwenden sollen. Sie müssen dem Repository nur eine Beispieldeskriptordatei hinzufügen, um sie mit Cloud Code zu importieren.

Diese können Sie dann ganz einfach mit Ihrem Team teilen. Sie benötigen Cloud Code und die Git-URL des Beispiel-Repositorys, die verwendet werden soll. Bei privaten Git-Repositories können nur Mitglieder mit Zugriff auf das Repository die zugrunde liegenden benutzerdefinierten Stichproben verwenden.

Ein Beispiel für die Einrichtung eines Beispiel-Repositorys finden Sie in diesem Repository.

Neues Beispiel-Repository erstellen

Wenn Sie ein neues Beispiel-Repository erstellen möchten, gehen Sie so vor:

  1. Erstellen Sie ein neues Git-Repository.

    Ihr Git-Repository kann entweder remote oder auf Ihrem lokalen Computer gehostet werden. In diesem Beispiel wird das neue GitHub-Repository "custom-sample-repo" verwendet.

    Oberfläche zur Erstellung von GitHub-Repositories mit ausgefülltem Repository-Feld und der Bezeichnung "custom-sample-repo".

  2. Fügen Sie diesem Repository Beispielverzeichnisse hinzu.

    Ihre Beispielverzeichnisse können alles enthalten und sich an beliebiger Stelle im Repository befinden. In diesem Beispiel wurden "example-world" und "kubernetes-custom-sample" zu "custom-sample-repo" hinzugefügt.

    Es wird dringend empfohlen, eine Readme-Datei mit Anweisungen zur Verwendung Ihrer benutzerdefinierten Stichproben zu verwenden.

    "custom-sample-repo" mit den beiden zugrunde liegenden Beispielverzeichnissen "hello-world" und "kubernetes-custom-sample"

  3. Beispiel-Deskriptordatei erstellen:

    Eine Beispieldeskriptordatei stellt Cloud Code mit Informationen zu Ihrem Beispiel bereit, um die Anwendung korrekt zu erstellen. Diese Datei muss .cctemplate in Ihrem Stammverzeichnis haben und das Schema im Abschnitt Beispiel für Deskriptordatei definiert haben.

Vorhandenes Repository verwenden

Wenn Sie ein vorhandenes Repository verwenden möchten, müssen Sie trotzdem eine Beispieldeskriptordatei erstellen. Diese Datei stellt Cloud Code mit Informationen zu Ihrem Beispiel bereit, um die Anwendung korrekt zu erstellen.

Ihre Beispieldeskriptordatei muss .cctemplate in Ihrem Stammverzeichnis haben und das Schema im Abschnitt Beispiel für Deskriptordatei definieren.

Beispiel für Schema-Deskriptor

Key Description Typ
metadata Metadaten, die von Cloud Code zum Lesen verwendet werden Das Metadatenschema stimmt. Metadaten
Vorlagen Array von Stichproben in einem Repository. Objekte in diesem Array müssen mit dem Beispielschema übereinstimmen. Array<Beispiel>
Name (optional) Name des Beispiel-Repositorys. String

Beispiel

{
   "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."
      }
   ]
}

Beispielschema

Key Description Typ
Pfad Hier befindet sich die Stichprobe in einem Repository.

Der Pfad wird so behandelt, als sei es vom Stammverzeichnis des Repositorys abhängig.

String
name Name einer Stichprobe.

Dies wird in einer IDE angezeigt, wenn ein Beispiel für eine Anwendung als Basis ausgewählt wird.

String
Beschreibung (optional) Beschreibung einer Stichprobe.

Dies wird in einer IDE angezeigt, wenn ein Beispiel für eine Anwendung als Basis ausgewählt wird.

String

Beispiel

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

Metadatenschema

Key Description Typ
version Die Version des verwendeten Beispielschemas. Aktuell ist die einzige gültige Version 1. String

Beispiel

{
   "version":"1"
}

Support

Wenn Sie uns Feedback geben möchten, können Sie Probleme auf GitHub melden oder eine Frage in Stack Overflow stellen.