Jenkins-Plug-in - Installations- und Benutzerhandbuch

EOL-Hinweis: Das CA Agile Central-Plug-in für Jenkins wird nicht mehr erweitert oder behoben, und der Technical Support wird ab Juni 2018 eingestellt.  Bestehende Kunden können die Integration weiterhin verwenden, allerdings empfehlen wir Ihnen, unseren neuen Build-Connector für Jenkins zu verwenden. Der neue Connector unterstützt Pipeline-Jobs, verfügt über einen Vorschaumodus, stellt Protokolldateien bereit und ist die Version, die wir weiterhin erweitern werden.

Übersicht

Das CA Agile Central-Plug-in für Jenkins ermöglicht es Teams, CA Agile Central zu verwenden, um den Build-Zustand für die Projekte, an denen sie arbeiten, anzuzeigen, Diagramme zum Build-Zustand anzuzeigen und die Übergabe von Codierung an Builds nachzuverfolgen. Das Plug-in ermöglicht dies, indem Build-Daten in CA Agile Central aufgefüllt werden.

Wenn das Plug-in mit einem VCS (Version Control System) und einem CA Agile Central-VCS-Connector verwendet wird, werden Builds auch mit Änderungssätzen verknüpft. Der CA Agile Central-VCS-Connector analysiert die Übergabenachricht, und wenn CA Agile Central-Artefakte (z. B. DE27) vorhanden sind, verknüpft der VCS-Connector das Artefakt mit dem Änderungssatz für die Änderung, die an das SCM-System übergeben wurde. Beim nächsten Jenkins-Build verknüpft das Jenkins-Plug-in den Änderungssatz mit dem Build in CA Agile Central. Daraus ergibt sich eine Rückverfolgbarkeit von Story/Defekt → Änderungssatz → Build.

Außerdem können benutzerdefinierte Dashboards erstellt werden, um die Apps "Build-Zustand" und "Rückverfolgbarkeit" anzuzeigen, mit denen Sie den Zustand von kontinuierlichen Build-/Test-Pipelines im gesamten Unternehmen verwalten können.

Dieses Installationshandbuch beinhaltet:

Softwareanforderungen

Jenkins-Support

  • Wir unterstützen derzeit Jenkins 2.7.1. (Aufgrund eines Fehlers in den Jenkins-Versionen 1.598 bis 1.609 können diese Versionen nicht mit diesem Plug-in auf den nachfolgend aufgeführten Plattformen verwendet werden.)
  • Tests wurden unter Ubuntu, CentOS, Mac OS X und Windows Server 2012 durchgeführt. Diese Betriebssysteme werden empfohlen.

Unterstützung von SCM-Systemen

  • SCM-Systeme sind erforderlich, um Änderungssätze mit Build-Objekten in CA Agile Central zu verknüpfen, sodass Storys/Defekte für Builds nachverfolgt werden können.
  • Zur Unterstützung von Git, Subversion und Mercurial zertifiziert.
  • Ein Jenkins-Plug-in für das SCM-System muss in Jenkins installiert sein. Jenkins hat ein integriertes Subversion-Plug-in, und optionale Plug-ins für Git und Mercurial sind auf der Jenkins CI-Website verfügbar.
  • Der CA Agile Central-VCS-Connector muss für das entsprechende SCM installiert sein, damit Änderungssätze in CA Agile Central (Git, Subversion, Mercurial) aufgefüllt werden.
  • Hinweis*** Das Jenkins-Plug-in unterstützt derzeit kein SSO.

Connector-Download

Um den Connector herunterzuladen, befolgen Sie diese Schritte.

Installation

Die Plug-in-Installation umfasst die folgenden grundlegenden Schritte:

  1. Installieren Sie das Ruby Runtime-Plug-in in Jenkins (einmal)
  2. Installieren Sie das CA Agile Central Build Notifier-Plug-in in Jenkins (einmal)
  3. Konfigurieren Sie die globalen Einstellungen des Plug-ins (einmal)
  4. Konfigurieren Sie einen Jenkins-Job, um Build-Ergebnisse in CA Agile Central zu veröffentlichen (für jeden Job)

Einrichten von CA Agile Central

Stellen Sie sicher, dass Ihr Zielobjekt WorkspaceConfiguration den Wert "BuildandChangsetEnabled" auf "Wahr" gesetzt hat.

Ihr CA Agile Central-Arbeitsbereich-Administrator muss dies für Ihren Zielarbeitsbereich aktivieren. Der Connector funktioniert, wenn dies nicht aktiviert ist, aber es werden keine Änderungssatz-/Änderungsinformationen angezeigt, die Ihren Rally-Arbeitselementen (Story, Defekt, Aufgabe) zugeordnet sind.

Der Arbeitsbereich-Administrator muss den Arbeitsbereich bearbeiten und folgendermaßen vorgehen:

  1. Wählen Sie das Setup-Symbol aus.
  2. Wählen Sie die Registerkarte Arbeitsbereiche und Projekte aus.
  3. Wählen Sie auf der Zusammenfassungsseite "Arbeitsbereiche und Projekte" Ihren Arbeitsbereich aus.
  4. Wählen Sie im Drop-down-Menü "Aktionen" die Option "Bearbeiten" aus.
  5. Wählen Sie im Arbeitsbereich-Editor das Kontrollkästchen Build und Änderungssatz aktivieren aus.
  6. Wählen Sie Speichern und schließen aus.

 

Jenkins-Setup

Wenn Sie nicht mit Jenkins-Plug-ins vertraut sind, dann lesen Sie die Dokumentation der Jenkins-Plug-ins, um sich mit dem Konzept und der Installation der Plug-ins in Jenkins vertraut zu machen.

Upgrade des Plug-ins von einer früheren Version auf Version 4.0.1

Wenn Sie das Jenkins-Plug-in für CA Agile Central v4.0.0 oder früher verwendet haben, dann sollten Sie diese Schritte durchführen, bevor Sie Version 4.0.1 des Jenkins-Plug-ins installieren:

  1. Notieren Sie alle Ihre Jenkins-Einstellungen auf globaler Ebene und auf Jobebene. Sie müssen diese Einstellungen nach der Installation des neuen Plug-ins erneut eingeben.
  2. Deinstallieren Sie in Jenkins das CA Agile Central-Plug-in für Jenkins (oder Rally-Plug-in).
  3. Befolgen Sie die unten aufgeführten Anweisungen, um das Plug-in in Jenkins zu installieren.

Installieren des Plug-ins in Jenkins unter Linux, Mac OS X und Windows Server 2012

Dies ist auch in der Readme-Datei enthalten, die im Plug-in bereitgestellt wird.

Sie müssen Jenkins möglicherweise neu starten.

  1. Navigieren Sie in der Jenkins-Benutzerschnittstelle zu Manage Jenkins → Manage Plugins.
  2. Wählen Sie die Registerkarte Advanced aus.
  3. Wählen Sie im Bereich "Upload Plugin" Choose File aus, und wählen Sie dann ruby-runtime-plugin-0.14.hpi aus.
  4. Wählen Sie Upload aus. Jenkins zeigt ein Statusfenster an, in dem die Plug-in-Installation angezeigt wird.
  5. Installieren Sie das Jenkins CA Agile Central Publisher-Plug-in, indem Sie die gleichen Schritte durchführen.
  6. Navigieren Sie zum Fenster "Manage Plugins", und wählen Sie die Registerkarte Advanced aus.
  7. Wählen Sie im Bereich "Upload Plugin" Choose File aus, und wählen Sie dann "agile-central-build-publisher-1.0.1.hpi" aus. Jenkins zeigt ein Statusfenster an, in dem die Plug-in-Installation angezeigt wird.

 

Hinweis: Die Reihenfolge der Schritte ist wichtig. Wenn agile-central-build-publisher vor ruby-runtime-plugin hochgeladen wird, dann installiert Jenkins automatisch Version 0.12 des ruby-runtime-Plugins statt der erforderlichen Version 0.14. Unser Plug-in funktioniert nicht mit der öffentlich verfügbaren Version 0.12 (ruby-runtime-plugin-0.12.hpi) oder Version 0.13, die zuvor von CA Technologies mitgeliefert wurden.

 

Konfiguration

Sobald das Plug-in installiert ist, muss es auf globaler Ebene und auch einmal für jeden Jenkins-Job konfiguriert werden.

Konfigurieren der globalen Einstellungen

  1. Gehen Sie in der Jenkins-Webschnittstelle auf "Manage Jenkins" → "System Configuration".
  2. Füllen Sie im Abschnitt "CA Agile Central Build Publisher" folgende Felder aus:
    • CA Agile Central Server: Geben Sie "rally1.rallydev.com" in das Textfeld ein. Wenn Sie CA Agile Central testen, geben Sie "trial.rallydev.com" ein. Wenn Sie eine On-Premise-Instanz ausführen, geben Sie den Namen Ihres CA Agile Central-Servers ein.
    • CA Agile Central Username und CA Agile Central Password: Der Benutzername und das Kennwort für einen CA Agile Central-Benutzer mit Zugriff auf den Arbeitsbereich, in dem Sie Build-Ergebnisse von Jenkins veröffentlichen möchten.
  3. Wenn Sie über einen Proxy-Server auf CA Agile Central zugreifen, wählen Sie im Abschnitt "CA Agile Central Build Publisher Proxy Settings" die Option "Advanced" aus, um die Felder anzuzeigen, die verwendet werden, um den Proxy anzugeben:
    • Proxy Server: Der Name oder die IP-Adresse des Proxy-Servers.
    • Proxy Port: Die Portnummer, die auf dem Proxy-Server verwendet werden soll.
    • Proxy Username (optional): Ein gültiger Benutzername für den Proxy-Server, falls Authentifizierung erforderlich ist.
    • Proxy Password (optional): Ein gültiges Kennwort für den Proxy Server, falls Authentifizierung erforderlich ist.

Konfigurieren eines Jenkins-Jobs zur Veröffentlichung von Build-Ergebnissen

Ein "free-style"- oder "maven2"-Job im Jenkins kann konfiguriert werden, um eine Build-Definition und ein Build in CA Agile Central zu veröffentlichen. Jedes Projekt in CA Agile Central hat eine oder mehrere Build-Definitionen, die verwendet werden können, um einen Build-Statusindikator zu veröffentlichen.

In Jenkins:

  1. Wählen Sie den Jenkins-Job aus, den Sie zur Veröffentlichung von Build-Ergebnissen in CA Agile Central konfigurieren möchten, und wählen Sie in der oberen linken Ecke die Option "Configure" aus.
  2. Wählen Sie im Bereich "Post-build Actions" die Drop-down-Liste "Add post-build action" aus, und wählen Sie die Option "CA Agile Central Build Publisher" aus.
  3. Geben Sie im Bereich "CA Agile Central Build Publisher" den Namen des CA Agile Central-Arbeitsbereichs und das Projekt ein, in dem die Build-Ergebnisse veröffentlicht werden sollen (Hinweis: Der Benutzer, den Sie in der globalen Konfiguration eingeben, muss Berechtigungen für den von Ihnen angegebenen Arbeitsbereich haben). Bekanntes Problem: Bei einer Veröffentlichung in einem Unterprojekt wird das Projekt auf oberster Ebene als Projekt eingegeben. Das Plug-in zeigt folgenden Fehler an, wenn das Unterprojekt referenziert ist: ERROR: [Rally Publisher] Unable to post Build info to Rally for Test1 build #35, unable to find default project SubProj1
  4. Wählen Sie "Save" auf der Konfigurationsseite aus.

Bei der nächsten Jobausführung sucht das Plug-in in CA Agile Central nach einer Build-Definition mit demselben Namen wie der Jenkins-Job. Wenn sie nicht gefunden wird, dann wird eine Definition erstellt. Bei jeder Jobausführung wird ein Build-Objekt in CA Agile Central erstellt und mit dieser Build-Definition verknüpft.

Wiederholen Sie bei Bedarf diese Schritte, um zusätzliche Jenkins-Jobs zur Veröffentlichung von Ergebnissen für andere CA Agile Central-Projekte zu konfigurieren.

Anzeigen von Build-Informationen in CA Agile Central

Anzeigen von Build-Zuständen in Berichten

Build-Zustandsberichte sind in Rally auf der Seite "Berichte" → "Berichte" verfügbar. Insbesondere sind "Build-Zustand" und "Build-Zustand nach Iteration" verfügbar.

Erstellen von benutzerdefinierten Build-Dashboards

Beim Erstellen von benutzerdefinierten Dashboards können Sie aus vier verschiedenen Build-Dashboard-Apps auswählen, dazu gehören "Build-Zustand", "Build-Zustand nach Iteration", "Build-Rückverfolgbarkeit" und "Build-Dashboard".

Fehlerbehebung

Verwenden Sie folgenden Befehl, um Jenkins im Debug-Modus zu starten und Meldungen anzuzeigen:

java  -Drally.debug="true"  -jar  jenkins.war  --httpPort=9000

Konsolenausgabe

Wenn Probleme mit dem Plug-in auftreten, zeigen Sie die Konsolenausgabe von Ihrem Job oder das Protokoll des Anwendungsservers an, auf dem Jenkins ausgeführt wird. Um die Konsolenausgabe des Jobs anzuzeigen, wählen Sie eine Build-Nummer in der Jenkins-Webschnittstelle aus, und wählen Sie dann auf der daraufhin angezeigten Jenkins-Seite die Option "Console Output" aus.

Tomcat-Serverprotokoll

Wenn Sie Tomcat verwenden, navigieren Sie zu [TOMCAT_INSTALLATIONSVERZEICHNIS]/logs/catalina.out, um das Protokoll des Anwendungsservers anzuzeigen.

Kennwortänderungen

Stellen Sie sicher, dass der CA Agile Central-Benutzername und das Kennwort in der globalen Konfiguration für das Plug-in korrekt eingegeben und nicht geändert wurde.

Objektmodell

Sobald das Jenkins-Plug-in für CA Agile Central ausgeführt wurde, dann sieht die Beziehung zwischen den Datenobjekten innerhalb von CA Agile Central folgendermaßen aus:

Verlauf der Versions-Highlights

  • Kontext-ID-Parameter wurden hinzugefügt.
  • Beim Hudson-Neustart werden globale Einstellungen beibehalten und sind verfügbar.
  • Unterstützung von Build-Definitionen und Build-Objekten in Rally.
  • Unterstützung von Hudson-Versionen bis 1.381.
  • Unterstützung von Maven2-Projekttypen in Hudson.
  • Unterstützung von Git und Perforce als SCM-Optionen.
  • Proxy-Einstellungen für Rally werden beibehalten.
  • Das Feld "Dauer" in Build-Objekten wird mit einem Wert aufgefüllt, der von Jenkins bereitgestellt wird.
  • Debug-Flag wurde hinzugefügt.

Unterstützte Versionen

Version Ende der Unterstützung
Jenkins 2.x und höher N/V
Jenkins 1.642.4 bis 1.651.2 01.12.2016
Jenkins 1.42 bis 1.642.3 01.12.2016
Jenkins 1.41 und frühere Versionen, alle Hudson-Versionen 01.04.2013

Revisionsverlauf

  • 4.0.1 - 18. Mai 2016
    • Fixes:
      • SSL-Fehler bei der Verbindung mit Agile Central. Grund: das alte Plug-in "ruby-runtime-plugin".
  • 4.0.0 - 16. November 2015
    • Verbesserungen:
      • Neugestaltung der Marke.
  • 3.0.6 - 25. Februar 2015
    • Bekannte Probleme:
      • Folgender Fehler tritt auf, wenn ein Unterprojekt in der Build-Konfiguration eingegeben wird:

        ERROR: [Rally Publisher] Unable to post Build info to Rally for Test1 build #35, unable to find default project SubProj1

      • Das Plug-in übersetzt chinesische Zeichen für Projektnamen nicht korrekt.

Versionsverlauf

Version Hinweise Dateien Datum
4.0.1
  • Fix-Abbruch aufgrund eines SSL-Fehlers
Jenkins-Plug-in 4.0.1 18.05.2016
4.0.0
  • Neugestaltung der Marke
Jenkins-Plug-in 4.0.0 16.11.2015
3.0.6
  • Neuerstellung mit neuer Architektur
  • Fehler behoben: Sonderzeichen und Leerzeichen in Projektnamen
Jenkins-Plug-in 3.0.6 28.01.2015
1.0 - 2.4.1 Nicht unterstützt  

Feedback

Benötigen Sie weitere Informationen? Die CA Agile Central-Community ist Ihre zentrale Anlaufstelle für Self-Service und Support. Treten Sie der CA Agile Central-Community bei, um dem CA Agile Central-Support Feedback mitzuteilen oder Fälle zu melden, Antworten zu finden oder mit anderen Benutzern zusammenzuarbeiten.