//Cloudogu EcoSystem Docs

Cockpit

Das Cockpit ist die Schaltzentrale des Cloudogu EcoSystem. Hier können Dashboards angelegt werden, in denen Widgets Informationen über das Cloudogu EcoSystem darstellen. Für alle Nutzerinnen und Nutzer ist das Dashboard "Welcome to Cloudogu" voreingestellt. Jede Nutzerin und jeder Nutzer hat die Möglichkeit das Cockpit individuell zu gestalten und weitere Dashboards anzulegen. Die angelegten Dashboards können mit anderen Nutzerin und Nutzern geteilt werden.

Dashboards konfigurieren

1. Über das Symbol "Plus" in der oberen Navigationsleiste kann ein neues Dashboard hinzugefügt werden.

2. Das neue Dashboard kann, so wie jedes bestehende Dashboard, mit einem Klick auf den Button in der oberen rechten Ecke (Symbol: Zahnrad) bearbeitet werden. In diesem Menü gibt es die Möglichkeit, das Dashboard zu löschen (Symbol: Eimer), ein neues Widget hinzuzufügen (Symbol: Plus), das Dashboard zu konfigurieren (Symbol: Zahnrad) und die Änderungen zu speichern (Symbol: Pfeil auf Festplatte).

3. Mit einem Klick auf das Symbol für die Einstellungen (Symbol: Zahnrad) öffnet sich ein Menüfenster, in dem der Name und die Struktur des Dashboards festgelegt werden können.

4. Über das Symbol "Plus" kann ein neues Widget zum Dashboard hinzugefügt werden. Nach dem Klick auf das Symbol öffnet sich ein Menüfenster, in dem alle verfügbaren Widgets angezeigt werden. Durch den Klick auf ein Widget wird es dem Dashboard hinzugefügt.

5. Ein neues Widget erscheint zuerst immer oben links. Mit dem Symbol "Pfeil" kann das Widget in einen anderen Bereich verschoben werden. Dafür muss das Symbol angeklickt und mit gedrückter Maustaste an den gewünschten Platz gezogen werden.

6. Über das Symbol "Zahnrad" kann das Widget konfiguriert werden.

7. Nachdem das Dashboard fertig konfiguriert wurde, kann es über den Speichern-Button (Symbol: Pfeil auf Festplatte) oben rechts gespeichert werden.

Shared Dashboards

Über Shared Boards in der oberen Navigationsleiste geben Sie eigene Dashboards für andere Nutzerinnen und Nutzer frei und abonnieren freigegebene, fremde Dashboards für das eigene Cockpit.

Dashboards abonnieren

Im Bereich Shared Dashboards können Sie von anderen Nutzern freigebene Dashboards in Ihr Cockpit abonnieren. In dieser Übersicht sehen Sie den Board-Namen, die Erstellerin oder den Ersteller. Abonnieren Sie das jeweilige Dashboard, indem Sie die Checkbox in der Spalte Add Dashboard aktivieren.

Dashboards de-abonnieren

Wenn Sie ein fremdes Dashboard nicht weiter nutzen wollen, deaktivieren Sie im Bereich Shared Dashboards die jeweilige Checkbox in der Spalte Add Dashboard. Alternativ aktivieren Sie auf dem jeweiligen Dashboard den Konfigurationsmodus (Symbol: Stift im Quadrat)und entfernen das Dashboard (Symbol: Eimer). Sie können das Dashboard jederzeit wieder abonnieren, solange es freigegeben ist.

Eigene Dashboards freigeben

Sie geben ihre selbst erstellten Dashboards für andere Nutzer im Bereich Share my Dashboards frei, indem Sie die Checkbox in der Spalte Share Dashboard aktivieren. Bedenken Sie, dass ihr Dashboard für alle Nutzerinnen und Nutzer der Instanz freigeben wird. Wenn Sie persönlich konfigurierte Widgets auf Ihrem freigegebenen Board nutzen, so werden diese persönlichen Einstellungen für abonnierende Nutzerinnen und Nutzer eventuell anders dargestellt (Beispiel: Im Widget My Redmine Issues sehen andere Nutzer ihre individuellen Redmine-Tickets anstelle Ihrer Tickets. Sollten Sie ein freigegebenes Dashboard löschen, so wird das Dashboard auch bei Nutzerinnen und Nutzern, die dieses abonniert haben, entfernt.

Dashboard-Freigaben zurückziehen

Sie heben eine Dashboard-Freigabe auf, indem Sie im Bereich Share my Dashboards in der Spalte Share Dashboard die jeweilige Checkbox deaktivieren. Das Dashboard ist dann nicht mehr als freigegebenes Dashboard für andere Nutzerinnen und Nutzer verfügbar. Wenn andere Nutzerinnen und Nutzer das Dashboard abonniert haben, so wird es automatisch aus dem Cockpit entfernt. Sie können ein Dashboard jederzeit wieder freigeben, andere Nutzerinnen und Nutzer müssen es dann erneut abonnieren. Wenn sie ein freigegebenes Dashboard löschen, so wird das Dashboard auch bei Nutzerinnen und Nutzern, die dieses abonniert haben, entfernt.

Pinned Dashboards

Pinned Dashboards werden von Administratorinnen und Administratoren vorkonfiguriert und sind im Cockpit aller Nutzerinnen und Nutzer eingebunden. Pinned Dashboards können nur von Administratorinnen und Administratoren verändert, verschoben oder entfernt werden. Sie erkennen Pinned Dashboards am grauen Info-Symbol anstelle des Stiftes im Quadrat. Im Konfigurationsmodus erkennen Sie Pinned Dashboards am Pin-Symbol.

Widgetübersicht

Widgets sind kleine Programme, die Informationen anzeigen können. Im Cloudogu EcoSystem können Sie sich Informationen der jeweiligen Dogus anzeigen lassen. So haben Sie Ihre Anwendungen und Projekte alle auf einem Dashboard im Überblick.

Verfügbarkeit von Widgets

Nachfolgend finden Sie eine Übersicht über die in der Bundescloud verfügbaren Widgets:

Widgets	In der Bundescloud verfügbar
Github	✓
Jenkins	✓
Miscellaneous	✓
Redmine	✓
SCM-Manager	✓
SonarQube	✓
News	✓
Easy Redmine	✓

GitHub

In der Kategorie GitHub stehen Ihnen diese Widgets zur Verfügung:

GitHub Author Mit diesem Widget können Sie sich die Autorinnen und Autoren eines Repositories anzeigen lassen. Diese werden Ihnen in einem Tortendiagramm angezeigt.

1. Geben Sie einen Titel für das Widget an.
2. Geben Sie den Pfad zu dem Repository an.
3. Geben Sie einen Access Token ein. Diesen können Sie sich in Ihrem GitHub-Account erstellen.

Hinweis: Einen Access Token benötigen Sie, wenn Sie sich ein privates Repository anzeigen lassen möchten. Die öffentlichen Repositories stehen Ihnen auch ohne Access Token zur Verfügung.

GitHub Commits Mit diesem Widget können Sie sich die letzten Commits eines Repository anzeigen lassen. Diese werden Ihnen in einer Liste angezeigt.

1. Geben Sie einen Titel für das Widget an.
2. Geben Sie den Pfad zu dem Repository an.
3. Geben Sie einen Access Token ein. Diesen können Sie sich in Ihrem GitHub-Account erstellen.

Hinweis: Einen Access Token benötigen Sie, wenn Sie sich ein privates Repository anzeigen lassen möchten. Die öffentlichen Repositories stehen Ihnen auch ohne Access Token zur Verfügung.

GitHub History Mit diesem Widget können Sie sich die Historie eines Repository anzeigen lassen. Diese wird Ihnen in einem Diagramm angezeigt.

1. Geben Sie einen Titel für das Widget an.
2. Geben Sie den Pfad zu dem Repository an.
3. Geben Sie einen Access Token ein. Diesen können Sie sich in Ihrem GitHub-Account erstellen.

Hinweis: Einen Access Token benötigen Sie, wenn Sie sich ein privates Repository anzeigen lassen möchten. Die öffentlichen Repositories stehen Ihnen auch ohne Access Token zur Verfügung.

GitHub Issues Mit diesem Widget können Sie sich die Issues eines Repository anzeigen lassen. Diese werden Ihnen in einer Liste angezeigt.

1. Geben Sie einen Titel für das Widget an.
2. Geben Sie den Pfad zu dem Repository an.
3. Geben Sie einen Access Token ein. Diesen können Sie sich in Ihrem GitHub-Account erstellen.

Hinweis: Einen Access Token benötigen Sie, wenn Sie sich ein privates Repository anzeigen lassen möchten. Die öffentlichen Repositories stehen Ihnen auch ohne Access Token zur Verfügung.

GitHub Organisation Events Mit diesem Widget können Sie sich die Events einer Organistation anzeigen lassen. Diese werden Ihnen in einer Liste angezeigt.

1. Geben Sie einen Titel für das Widget an.
2. Geben Sie den Namen der Organisation an.
3. Geben Sie einen Access Token ein. Diesen können Sie sich in Ihrem GitHub-Account erstellen.

Hinweis: Einen Access Token benötigen Sie, wenn Sie sich ein privates Repository anzeigen lassen möchten. Die öffentlichen Repositories stehen Ihnen auch ohne Access Token zur Verfügung.

GitHub Repository Events Mit diesem Widget können Sie sich die Events eines Repository anzeigen lassen. Diese werden Ihnen in einer Liste angezeigt.

1. Geben Sie einen Titel für das Widget an.
2. Geben Sie den Pfad zu dem Repository an.
3. Geben Sie einen Access Token ein. Diesen können Sie sich in Ihrem GitHub-Account erstellen.

Hinweis: Einen Access Token benötigen Sie, wenn Sie sich ein privates Repository anzeigen lassen möchten. Die öffentlichen Repositories stehen Ihnen auch ohne Access Token zur Verfügung.

GitHub User Events Mit diesem Widget können Sie sich die Events für eine Nutzerin oder einen Nutzer anzeigen lassen. Diese werden Ihnen in einer Liste angezeigt.

1. Geben Sie einen Titel für das Widget an.
2. Geben Sie einen Username an.
3. Geben Sie den Namen der Organisation an.
4. Geben Sie einen Access Token ein. Diesen können Sie sich in Ihrem GitHub-Account erstellen.

Jenkins

In der Kategorie Jenkins stehen Ihnen diese Widgets zur Verfügung:

Jenkins Build Report Mit diesem Widget können Sie sich die Build Reports für Jenkins-Projekte anzeigen lassen. Diese werden Ihnen in einer Liste angezeigt.

1. Geben Sie einen Titel für das Widget an.
2. Geben Sie den Namen des Projekts an.

Jenkins Global Statistics Mit diesem Widget können Sie sich eine Übersicht zu den Jenkins-Projekten anzeigen lassen. Diese werden Ihnen in einem Diagramm angezeigt.

1. Geben Sie einen Titel für das Widget an.

Miscellaneous

In der Kategorie Miscellaneous stehen Ihnen diese Widgets zur Verfügung:

Clock Mit diesem Widget können Sie sich die Uhrzeit auf dem Dashboard anzeigen lassen.

1. Geben Sie einen Titel für das Widget an.
2. Unter "Time pattern" können Sie das Format der Uhrzeit festlegen.
3. Unter "Date pattern" können Sie das Format des Datums festlegen.

iframe Mit diesem Widget können Sie sich eine andere Webseite auf dem Dashboard anzeigen lassen.

1. Geben Sie einen Titel für das Widget an.
2. Geben Sie eine URL für die Webseite an, die Sie angezeigt haben wollen.
3. Mit Height können Sie die Grö\ss e des iframes einstellen.

Links Mit diesem Widget können Sie sich eine Linkliste auf dem Dashboard anzeigen lassen.

1. Geben Sie einen Titel für das Widget an.
2. Geben Sie einen Namen für den Link an.
3. Geben Sie eine URL für den Link an.
4. Mit "Add" können Sie einen weiteren Link hinzufügen.
5. Mit "Remove" können Sie einen Link aus Ihrer Liste entfernen.

Markdown Mit diesem Widget können Sie sich mit Markdown formatierten Text auf dem Dashboard anzeigen lassen.

1. Geben Sie einen Titel für das Widget an.
2. Geben Sie den Markdown-Text ein.

Project Progress Mit diesem Widget können Sie sich einen Projektstatus auf dem Dashboard anzeigen lassen.

1. Geben Sie einen Titel für das Widget an.
2. Geben Sie einen Namen für das Projekt an.
3. Geben Sie die Zeitspanne für das Projekt an.

Random Message Mit diesem Widget können Sie sich eine zufällige Nachricht auf dem Dashboard anzeigen lassen.

1. Geben Sie einen Titel für das Widget an.

Version Mit diesem Widget können Sie sich die Version des Dashboards anzeigen lassen.

1. Geben Sie einen Titel für das Widget an.

Redmine

In der Kategorie Redmine stehen Ihnen diese Widgets zur Verfügung:

Redmine Custom Queries Mit diesem Widget können Sie sich Ihre selbst definierten Suchanfragen aus dem Redmine auf dem Dashboard anzeigen lassen. Diese werden Ihnen in einer Liste angezeigt.

1. Geben Sie einen Titel für das Widget an.
2. Wählen Sie Ihre definierte Suchanfrage aus.
3. Wählen Sie aus, ob auch geschlossene Tickets angezeigt werden sollen.
4. Mit den Häkchen können Sie auswählen, welche Spalten angezeigt werden sollen.

My Redmine Issues Mit diesem Widget können Sie sich Ihre Tickets aus dem Redmine auf dem Dashboard anzeigen lassen. Diese werden Ihnen in einer Liste angezeigt.

1. Geben Sie einen Titel für das Widget an.

Redmine Burn-down/up Charts Mit diesem Widget können Sie eine grafische Darstellung für den verbleibenden Aufwand in einem Projekt, in Relation zur verbleibenden Zeit erstellen. Die noch zu erledigende Arbeit ("Backlog") wird auf der senkrechten Achse dargestellt, die Zeit auf der waagerechten.

1. Geben Sie einen Titel für das Widget an.
2. Wählen Sie ein Zielprojekt aus.
3. Jetzt können sie einen oder mehrere Filter hinzufügen: 3.1 Fixed Version: Es werden nur Tickets für die ausgewählte Version betrachtet (z. B. Sprint 21/01). Sie können die gewünschte Version per Dropdown-Menü auswählen. 3.2 Assigned To: Es werden nur Tickets für den ausgewählten Beauftragten betrachtet. Hier erfolgt die Angabe als Redmine-User-ID des Beauftragten. Alternativ kann das Keyword me als Eintrag benutzt werden, um nur eigene Tickets zu beachten. 3.3 Tracker: Es werden nur Tickets für den ausgewählte Tracker betrachtet (z. B. nur Feature-Tickets). Sie können einen passenden Tracker per Dropdown-Menü auswählen.
4. Optional: Sie können neben der Visualisierung des echten Arbeitsaufwands auch einen idealen linearen Verlauf durch das Auswählen von show ideal line im Burn-down/up Graph anzeigen lassen.
5. Im Abschnitt Period können Sie Start- und Endzeit der Visualisierung definieren. Wenn sie eine Version mit dem Filter Fixed Version auswählen, wird der Zeitraum automatisch auf die Version angepasst.

EasyRedmine

In der Kategorie EasyRedmine stehen Ihnen dieselben Widgets wie im Redmine zur Verfügung. Die Bedienung ist analog. Der einzige Unterschied zwischen den Widgets von Redmine und EasyRedmine existiert bei dem Custom Queries-Widget. Damit das Cockpit die benutzerdefinierten Anfragen finden und anzeigen kann, müssen diese vorher bei EasyRedmine als projekt-unabhängige Anfragen konfiguriert werden:

SCM-Manager

In der Kategorie SCM-Manager stehen Ihnen diese Widgets zur Verfügung:

SCM Activities Mit diesem Widget können Sie sich die Aktivitäten im SCM-Manager anzeigen lassen. Diese werden Ihnen in einer Liste präsentiert.

1. Geben Sie einen Titel für das Widget an.

Hinweis: Das scm-activity-plugin muss installiert sein.

SCM Commits Mit diesem Widget können Sie sich die Commits eines Repository anzeigen lassen. Diese werden Ihnen in einer Liste angezeigt.

1. Geben Sie einen Titel für das Widget an.
2. Wählen Sie das Repository aus, welches Sie angezeigt haben wollen.

SCM Commits by author Mit diesem Widget können Sie sich die Commits nach Autorin und Autor eines Repository anzeigen lassen. Diese werden Ihnen in einem Tortendiagramm angezeigt.

1. Geben Sie einen Titel für das Widget an.
2. Wählen Sie das Repository aus, welches Sie angezeigt haben wollen.

SCM Commits by month Mit diesem Widget können Sie sich die Commits pro Monat eines Repository anzeigen lassen. Diese werden Ihnen in einem Diagramm angezeigt.

1. Geben Sie einen Titel für das Widget an.
2. Wählen Sie das Repository aus, welches Sie angezeigt haben wollen.

SCM Last Commit Chart Mit diesem Widget können Sie sich die letzten Commits eines Repository anzeigen lassen. Diese werden Ihnen in einem Diagramm angezeigt.

1. Geben Sie einen Titel für das Widget an.
2. Wählen Sie das Repository aus, welches Sie angezeigt haben wollen.

SCM Markdown Mit diesem Widget können Sie sich eine Markdown-Datei eines Repository anzeigen lassen.

1. Geben Sie einen Titel für das Widget an.
2. Wählen Sie das Repository aus, welches Sie angezeigt haben wollen.
3. Wählen Sie den Branch aus, auf dem sich die Datei befindet.
4. Geben Sie den Pfad zu der Markdown-Datei an.

SonarQube

In der Kategorie SonarQube stehen Ihnen diese Widgets zur Verfügung:

Sonar Statistics of all Projects Mit diesem Widget können Sie sich eine Statistik aller SonarQube Projekte anzeigen lassen.

1. Geben Sie einen Titel für das Widget an.
2. Wählen Sie die API-URL.

Sonar Project Compare Mit diesem Widget können Sie sich eine Zusammenfassung von zwei SonarQube Projekten anzeigen lassen, um diese zu vergleichen.

1. Geben Sie einen Titel für das Widget an.
2. Wählen Sie Project 1 und Project 2 aus. Beim Befüllen des Feldes werden entsprechende Projekte aus SonarQube vorgeschlagen.

Sonar Linechart of a Project Mit diesem Widget können Sie sich ein Diagramm von einem SonarQube Projekt anzeigen lassen.

1. Geben Sie einen Titel für das Widget an.
2. Wählen Sie ein Projekt aus. Beim Befüllen des Feldes werden entsprechende Projekte aus SonarQube vorgeschlagen.
3. Geben Sie eine Zeitspanne an.
4. Wählen Sie aus, was Sie angezeigt haben wollen.

Sonar My Issues Mit diesem Widget können Sie sich Ihre zugewiesenen Tickets anzeigen lassen.

1. Geben Sie einen Titel für das Widget an.
2. Wählen Sie eine Sortierung aus.

Sonar Projectquality of a Project Mit diesem Widget können Sie sich eine Zusammenfassung von einem SonarQube Projekt anzeigen lassen.

1. Geben Sie einen Titel für das Widget an.
2. Wählen Sie ein Projekt aus. Beim Befüllen des Feldes werden entsprechende Projekte aus SonarQube vorgeschlagen.