Private Anleitungen in Cloud Shell erstellen

Mit Cloud Shell können Sie private Anleitungen erstellen, sodass Sie Anleitungen speziell für Ihre Zielgruppe erstellen können.

Nachdem Sie Anleitungen mithilfe der Anleitungen in Cloud Shell schreiben Anleitung erstellt und den im Leitfaden zum Styleguide beschriebenen Best Practices gefolgt sind: Sie können Ihre Anleitung in einem privaten Git-Repository hosten, um sie Ihren Nutzern zur Verfügung zu stellen.

Sie können einen beliebigen Git-Repository-Hostingdienst verwenden. In dieser Anleitung werden die Schritte mit Secure Source Manager veranschaulicht, einem regional bereitgestellten, für einen einzelnen Mandanten verwalteten Quellcode-Repository, das in Google Cloudgehostet wird, um die Schritte zu veranschaulichen.

Privates Git-Repository erstellen

Secure Source Manager-Instanzen werden in einer verfügbaren Google Cloud Region bereitgestellt und sind über ihre Instanz-URIs zugänglich. Repositories werden in der Secure Source Manager-Instanz über eine Web-UI oder die Secure Source Manager API erstellt.

So erstellen Sie ein Secure Source Manager-Repository zum Hosten Ihrer privaten Anleitung:

  1. Starten Sie das Cloud Shell-Terminal. Verwenden Sie für eine eigenständige Cloud Shell-Sitzung shell.cloud.google.com.

  2. Erstellen Sie eine Secure Source Manager-Instanz, falls Sie noch keine haben:

    gcloud source-manager instances create INSTANCE_ID \
    --region=LOCATION

    Ersetzen Sie Folgendes:

    • INSTANCE_ID: die ID der Secure Source Manager-Instanz.
    • LOCATION: die Region, in der Sie die Instanz erstellen, z. B. us-central1.

    Die Erstellung der Instanz kann bis zu 60 Minuten dauern.

  3. Wenn Sie über die Web-UI auf die Secure Source Manager-Instanz zugreifen möchten, kopieren Sie die folgende URL in die Adressleiste Ihres Browsers:

    INSTANCE_ID-PROJECT_NUMBER.LOCATION.sourcemanager.dev

    Ersetzen Sie PROJECT_NUMBER durch die Projektnummer der Instanz. Google Cloud

  4. Erstellen Sie ein privates Repository:

    gcloud source-manager repos create REPO_ID \
    --instance=INSTANCE_ID \
    --region=LOCATION

    Ersetzen Sie REPO_ID durch die ID des Secure Source Manager-Repositorys.

    Informationen zu den Berechtigungen, die zum Erstellen eines Repositorys erforderlich sind, finden Sie unter Erforderliche Rollen.

  5. Fügen Sie den Secure Source Manager-Authentifizierungshelfer Ihrer globalen Git-Konfiguration hinzu. Weitere Informationen finden Sie unter Anmeldedaten einrichten.

  6. Klonen Sie Ihr Repository in Cloud Shell:

    git clone https://INSTANCE_ID-PROJECT_NUMBER-git.LOCATION.sourcemanager.dev/PROJECT_ID/REPO_ID.git

    Ersetzen Sie PROJECT_ID durch die Projekt-ID der Instanz. Google Cloud

  7. Verschieben Sie Ihre Anleitungsdatei in Ihr lokal erstelltes Repository:

    mv PATH_TO_TUTORIAL REPO_ID/PATH_TO_TUTORIAL

    Ersetzen Sie PATH_TO_TUTORIAL durch den Pfad zu Ihrer privaten Anleitung.

  8. Rufen Sie Ihr lokales Repository auf:

    cd REPO_ID

  9. Fügen Sie die Anleitungsdateien hinzu, führen Sie den Commit durch und laden Sie die Dateien hoch:

    git add .
git commit -m "Add private tutorial to Secure Source Manager"
git push origin main

  10. Sie können Ihr Secure Source Manager-Repository in der Web-UI ansehen. Weitere Informationen finden Sie unter Repositories auflisten und ansehen.

Damit Ihre Nutzer Ihre Anleitung erreichen können, können Sie die Cloud Shell-Funktion „In Cloud Shell öffnen“ verwenden, mit der Sie definieren können, wie Nutzer auf Ihre Anleitung zugreifen. Weitere Informationen zum Anpassen des Links finden Sie in der Anleitung zum Öffnen in Cloud Shell.

Für eine Anleitung, die in einem Secure Source Manager-Repository gehostet wird, müssen Sie den Parameter cloudshell_git_repo mit der HTTPS-URL Ihres Repositorys definieren. Beispiel:

https://ssh.cloud.google.com/cloudshell/editor?cloudshell_git_repo=https://INSTANCE_ID-PROJECT_NUMBER-git.LOCATION.sourcemanager.dev/PROJECT_ID/REPO_ID.git

Sie können diesen Link als Button gestalten und in Ihre Dokumentation einbetten, damit die Nutzer ihn finden. Beispiel:

[![Open in Cloud Shell](https://gstatic.com/cloudssh/images/open-btn.svg)](https://ssh.cloud.google.com/cloudshell/editor?cloudshell_git_repo=https://INSTANCE_ID-PROJECT_NUMBER-git.LOCATION.sourcemanager.dev/PROJECT_ID/REPO_ID.git)

Anleitungen mit Add-on-Tools anpassen

Sie können die privaten Anleitungen weiter anpassen, indem Sie Ihren Nutzern benutzerdefinierte Tools bereitstellen, die mit Ihrer Anleitung arbeiten.

Dazu können Sie ein Docker-Image erstellen, das als benutzerdefinierte Cloud Shell-Umgebung mit allen zusätzlichen Paketen und benutzerdefinierten Konfigurationen dient, die Ihrem Nutzer zur Verfügung gestellt werden.