Erstellen von Komponenten über den Befehlszeilenclient

Wenn IBM® UrbanCode Deploy keinen Quellkonfigurationstyp für Ihr Buildsystem hat, können Sie den Befehlszeilenclient udclient verwenden, um Komponenten zu verwalten.

Vorbereitende Schritte

Hinweise zur Installation des Clients finden Sie unter Installieren des Befehlszeilenclients.

Informationen zu diesem Vorgang

Wenn Sie den udclient-Client auf diese Weise verwenden, können Sie neue Versionen von Komponenten auf den Server übertragen, Prozesse starten und Links zu externen Quellen hinzufügen sowie viele andere Tasks auf dem IBM UrbanCode Deploy-Server als Teil Ihres Buildprozesses ausführen. Auf diese Weise können Sie mit Ihren Komponenten in IBM UrbanCode Deploy arbeiten, ohne Ihre Build-Technologie zu ändern.

Vorgehensweise

Befolgen Sie diese allgemeinen Schritte, um eine Komponente einzurichten, die den Befehlszeilenclient verwendet:

  1. Erstellen Sie einen oder mehrere Komponenten in IBM UrbanCode Deploy, um die Komponenten Ihres Builds zu repräsentieren. Verwenden Sie die folgenden Parameter im Fenster Neue Komponente erstellen:
    • Wählen Sie im Feld Quellkonfigurationstyp die Option Keine aus.
    • Klicken Sie auf das Kontrollkästchen Versionen automatisch importieren.
    • Füllen Sie die restlichen Felder im Fenster wie üblich aus.
  2. Fügen Sie in den Buildscripts für Ihre Komponente den Code hinzu, der udclient-Clientbefehle aufruft, um eine Komponentenversion zu erstellen und die Artefakte auf den IBM UrbanCode Deploy-Server hochzuladen. In den meisten Fällen verwenden Sie verschiedene Befehle, um die Version zu erstellen. Die folgenden Schritte zeigen Beispiele einiger Befehle, die Sie verwenden können.
    Anmerkung: In diesen Beispielen wird Code in einer Apache Ant-Builddatei verwendet. Insbesondere rufen Sie den udclient-Client mit dem Ant-<exec>-Befehl auf, der externe Programme aufruft. Wenn Sie eine andere Buildtechnologie verwenden, müssen Sie die Beispiele entsprechend Ihrer Buildtechnologie anpassen, um den udclient-Client aufzurufen.
    1. Verwenden Sie den createVersion-Befehl, um die neue Version zu erstellen. Der folgende Beispielcode erstellt eine Version einer Komponente, die als mycomponent bezeichnet wird. Der Versionsname wird auf die Zeitmarke des Builds gesetzt. Die Variablen ${udclient.weburl}, ${udclient.username} und ${udclient.password} stellen die URL des Servers und den Benutzernamen sowie das Kennwort für den Server dar.
      <exec executable="/bin/bash" 
        outputproperty="mycomponent.component.output">
      
        <arg value="/opt/udclient/udclient"/>
      
        <arg value="-weburl"/>
        <arg value="${udclient.weburl}"/>
      
        <arg value="-username"/>
        <arg value="${udclient.username}"/>
      
        <arg value="-password"/>
        <arg value="${udclient.password}"/>
      
        <arg value="createVersion"/>
      
        <arg value="-component"/>
        <arg value="mycomponent"/>
      
        <arg value="-name"/>
        <arg value="${buildTimestamp}"/>
      
      </exec>
    2. Verwenden Sie den addVersionFiles-Befehl, um die Artefakte in die Befehlsversion hochzuladen. Der folgende Beispielcode lädt die Dateien im Ordner ${destdir} in die Version:
      <exec executable="/bin/bash">
      
        <arg value="/opt/udclient/udclient"/>
        
        <arg value="-weburl"/>
        <arg value="${udclient.weburl}"/>
        
        <arg value="-username"/>
        <arg value="${udclient.username}"/>
        
        <arg value="-password"/>
        <arg value="${udclient.password}"/>
        
        <arg value="addVersionFiles"/>
        
        <arg value="-component"/>
        <arg value="mycomponent"/>
        
        <arg value="-version"/>
        <arg value="${buildTimestamp}"/>
        
        <arg value="-base"/>
        <arg value="${destdir}"/>
        
      </exec>
    3. Optional: Fügen Sie Links aus der Komponentenversion hinzu. Mit dem addVersionLink-Befehl können Sie Links aus der Version zu externen Buildressourcen hinzufügen, beispielsweise der Seite, die das Buildergebnis zeigt. Diese Links erscheinen oben auf der Informationsseite für die Komponentenversion. Die folgende Abbildung zeigt eine Komponentenversion mit einem Link zum entsprechenden Buildvorgang und dem entsprechenden Buildergebnis im Quellcode-Managementsystem:
      Eine Komponentenversion mit zwei Links im Links-Abschnitt
      Der folgende Code fügt beispielsweise einen Link zur Buildergebnisseite an der URL http://build.example.com/projects/mycomponent/${buildResultUUID} hinzu:
      <exec executable="/bin/bash">
      
        <arg value="/opt/udclient/udclient"/>
        
        <arg value="-weburl"/>
        <arg value="${udclient.weburl}"/>
        
        <arg value="-username"/>
        <arg value="${udclient.username}"/>
        
        <arg value="-password"/>
        <arg value="${udclient.password}"/>
        
        <arg value="addVersionLink"/>
        
        <arg value="-component"/>
        <arg value="mycomponent"/>
        
        <arg value="-version"/>
        <arg value="${buildTimestamp}"/>
        
        <arg value="-linkName"/>
        <arg value="External build result"/>
        
        <arg value="-link"/>
        <arg value="http://build.example.com/projects/mycomponent/${buildResultUUID}"/>
        
      </exec>

Ergebnisse

Wenn Sie jetzt in Ihrem externen Buildtool einen Build ausführen, erstellt der Buildprozess eine Komponentenversion und lädt die Artefakte für die Version in den IBM UrbanCode Deploy-Server. Ab diesem Punkt können Sie mit der Komponente und der Version auf dem Server normal arbeiten, etwa indem Sie Prozesse mit ihr ausführen.

Sie können auch andere Befehle Ihrem Buildscript hinzufügen. Beispielsweise können Sie Anwendungsprozess mit dem requestApplicationProcess-Befehl starten.


Feedback