Cockpit
The cockpit is the control center of the Cloudogu EcoSystem. Here, dashboards can be created in which widgets display information about the Cloudogu EcoSystem. The dashboard "Welcome to Cloudogu" is preset for all users. Each user has the option to customize the cockpit and create additional dashboards. The created dashboards can be shared with other users.
Configure dashboards
- A new dashboard can be added via the "Plus" icon in the top navigation bar.
- the new dashboard can be edited, just like any existing dashboard, by clicking on the button in the upper right corner (icon: gear). In this menu there is the possibility to delete the dashboard (icon: bucket), add a new widget (icon: plus), configure the dashboard (icon: gear) and save the changes (icon: arrow on disk).
- click on the settings icon (icon: cogwheel) to open a menu window where you can define the name and the structure of the dashboard.
- via the symbol "Plus" a new widget can be added to the dashboard. After clicking on the icon, a menu window will open showing all available widgets. Clicking on a widget will add it to the dashboard.
- a new widget always appears at the top left first. With the symbol "arrow" the widget can be moved to another area. To do this, click on the icon and drag it to the desired location while holding down the mouse button.
- the widget can be configured by clicking the "cogwheel" icon.
After the dashboard has been configured, it can be saved by clicking the Save button (icon: arrow on disk) in the upper right corner.
Shared Dashboards
Via Shared Boards in the upper navigation bar you share your own dashboards with other users and subscribe to shared, third-party dashboards for your own cockpit.
Subscribe to dashboards
In the Shared Dashboards section, you can subscribe to dashboards shared by other users in your cockpit. In this overview, you can see the board name, creator. Subscribe to the respective dashboard by activating the checkbox in the Add Dashboard column.
Unsubscribe dashboards
If you do not want to continue using a third-party dashboard, deactivate the respective checkbox in the Add Dashboard column in the Shared Dashboards area. Alternatively, activate the configuration mode on the respective dashboard (icon: pencil in the square)and remove the dashboard (icon: bucket). You can subscribe to the dashboard again at any time as long as it is shared.
Share your own dashboards
You share your self-created dashboards with other users in the Share my Dashboards section by checking the checkbox in the Share Dashboard column. Keep in mind that their dashboard will be shared with all users of the instance. If you use personally configured widgets on your shared board, these personal settings may be displayed differently to subscribing users (example: In the My Redmine Issues widget, other users will see their individual Redmine tickets instead of your tickets. If you delete a shared dashboard, the dashboard will also be removed for users who have subscribed to it.
Retract dashboard shares
You revoke a dashboard share by unchecking the respective checkbox in the Share Dashboard column in the Share my Dashboards section. The dashboard is then no longer available as a shared dashboard to other users. If other users have subscribed to the dashboard, it is automatically removed from the Cockpit. You can share a dashboard again at any time, but other users will have to subscribe to it again. If you delete a shared dashboard, the dashboard will also be removed from users who have subscribed to it.
Pinned Dashboards
Pinned dashboards are preconfigured by administrators and are included in the cockpit of all users. Pinned dashboards can only be changed, moved or removed by administrators. You can recognize pinned dashboards by the gray info icon instead of the pencil in the square.
In configuration mode you can recognize pinned dashboards by the pin icon.
Widget overview
Widgets are small programs that can display information. In Cloudogu EcoSystem, you can display information of the respective dogus. This way you can have an overview of all your applications and projects on one dashboard.
Availability of widgets
Below you will find an overview of the widgets available in the Bundescloud:
Widgets | Available in the Bundescloud |
---|---|
Github | ✓ |
Jenkins | ✓ |
Miscellaneous | ✓ |
Redmine | ✓ |
SCM Manager | ✓ |
SonarQube | ✓ |
News | ✓ |
Easy Redmine | ✓ |
GitHub
In the GitHub category, these widgets are available:
GitHub Author This widget allows you to view the authors of a repository. They will be displayed to you in a pie chart.
- specify a title for the widget. Enter the path to the repository. 3.
- enter an access token. You can create this in your GitHub account.
Note: You need an Access Token if you want to display a private repository. The public repositories are also available without an Access Token.
GitHub Commits. With this widget you can display the latest commits of a repository. These will be displayed to you in a list.
Enter a title for the widget. 2. Enter the path to the repository. 3.
- enter an access token. You can create this in your GitHub account.
Note: You need an Access Token if you want to display a private repository. The public repositories are also available without an Access Token.
GitHub History This widget allows you to view the history of a repository. This will be displayed to you in a graph.
- specify a title for the widget. Specify the path to the repository. 3.
- enter an access token. You can create this in your GitHub account.
Note: You need an Access Token if you want to display a private repository. The public repositories are also available without an Access Token.
GitHub Issues With this widget you can display the issues of a repository. These will be displayed to you in a list.
Enter a title for the widget. 2. Enter the path to the repository. 3.
- enter an access token. You can create this in your GitHub account.
Note: You need an Access Token if you want to display a private repository. The public repositories are also available without an Access Token.
GitHub Organization Events. With this widget you can display the events of an Organistation. These will be displayed to you in a list.
- specify a title for the widget. Enter the name of the organization. 3.
- enter an access token. You can create this in your GitHub account.
Note: You need an Access Token if you want to display a private repository. The public repositories are also available without an Access Token.
GitHub Repository Events. With this widget you can display the events of a repository. These will be displayed to you in a list.
Enter a title for the widget. 2. Enter the path to the repository. 3.
- enter an access token. You can create this in your GitHub account.
Note: You need an Access Token if you want to display a private repository. The public repositories are also available without an Access Token.
GitHub User Events. This widget allows you to view the events for a user. These will be displayed to you in a list.
- specify a title for the widget.
- enter a username. Enter the name of the organization. 4.
- enter an access token. You can create this in your GitHub account.
Jenkins
These widgets are available in the Jenkins category:
Jenkins Build Report This widget allows you to view build reports for Jenkins projects. These will be displayed to you in a list.
- specify a title for the widget.
- specify the name of the project.
Jenkins Global Statistics This widget allows you to view an overview of Jenkins projects. These will be displayed to you in a graph.
- specify a title for the widget.
Miscellaneous
In the Miscellaneous category these widgets are available:
Clock This widget allows you to display the time on the dashboard.
- specify a title for the widget.
- under "Time pattern" you can set the format of the time. Under "Date pattern" you can set the format of the date.
iframe This widget allows you to display a different web page on the dashboard.
- specify a title for the widget.
- enter a URL for the web page you want to have displayed.
- use Height to set the height of the iframe.
Links This widget allows you to display a list of links on the dashboard.
- specify a title for the widget. Enter a name for the link. 3. Enter a URL for the link. 4. You can add another link with "Add". 5. Remove" allows you to remove a link from your list.
Markdown This widget allows you to display text formatted with Markdown on the dashboard.
- specify a title for the widget.
- enter the Markdown text.
Project Progress Use this widget to display a project status on the dashboard.
- specify a title for the widget. Enter a name for the project. 3.
- specify the time span for the project.
Random Message This widget allows you to display a random message on the dashboard.
- specify a title for the widget.
Version Use this widget to display the version of the dashboard.
- specify a title for the widget.
Redmine
In the Redmine category these widgets are available:
Redmine Custom Queries With this widget you can display your self-defined queries from Redmine on the dashboard. These will be displayed to you in a list.
- enter a title for the widget. Select your defined search query. 3.
- select if you want closed tickets to be displayed as well.
- use the checkboxes to select which columns should be displayed.
My Redmine Issues This widget allows you to display your tickets from Redmine on the dashboard. These will be displayed to you in a list.
- specify a title for the widget.
Redmine Burn-down/up Charts This widget allows you to create a graphical representation for the remaining effort in a project, in relation to the remaining time. The work remaining to be done ("backlog") is shown on the vertical axis, and the time is shown on the horizontal axis.
Enter a title for the widget. 2.
- select a target project.
- now you can add one or more filters:
3.1 Fixed Version: Only tickets for the selected version will be considered (e.g. Sprint 21/01). You can select the desired version via dropdown menu.
3.2 Assigned To: Only tickets for the selected assignee will be considered. Here the specification is made as the redmine user ID of the assignee. Alternatively, the keyword 'me' can be used as entry to consider only own tickets.
3.3 Tracker: Only tickets for the selected tracker will be considered (e.g. only feature tickets). You can select a suitable tracker via dropdown menu.
4 Optional: In addition to visualizing the real workload, you can also display an ideal linear progression by selecting
show ideal line
in the burn-down/up graph. - in the section
period
you can define start and end time of the visualization. If you select a version with the filterfixed version
, the period will be automatically adjusted to the version.
EasyRedmine
In the EasyRedmine category, the same widgets are available as in Redmine. The operation is analogous. The only difference between the Redmine and EasyRedmine widgets exists in the 'Custom Queries' widget. In order for the Cockpit to find and display the custom queries, they have to be configured as project-independent queries in EasyRedmine beforehand:
SCM Manager
These widgets are available in the SCM Manager category:
SCM Activities With this widget you can display the activities in the SCM Manager. These will be presented to you in a list.
- specify a title for the widget.
Note: The scm-activity-plugin must be installed.
SCM Commits With this widget you can display the commits of a repository. These are displayed in a list.
Enter a title for the widget. 2.
- select the repository you want to display.
SCM Commits by author This widget allows you to display the commits by author of a repository. These will be displayed to you in a pie chart.
Enter a title for the widget. 2.
- select the repository you want to display.
SCM Commits by month With this widget you can display the commits per month of a repository. These will be displayed to you in a graph.
Enter a title for the widget. 2.
- select the repository you want to display.
SCM Last Commit Chart With this widget you can display the last commits of a repository. These will be displayed to you in a chart.
Enter a title for the widget. 2.
- select the repository you want to display.
SCM Markdown This widget allows you to display a Markdown file of a repository.
Enter a title for the widget. 2. Select the repository you want to display. 3. Select the branch where the file is located. 4.
- specify the path to the Markdown file.
SonarQube
In the SonarQube category these widgets are available:
Sonar Statistics of all Projects This widget allows you to view statistics of all SonarQube projects.
Enter a title for the widget. 2.
- select the API URL.
Sonar Project Compare This widget allows you to view a summary of two SonarQube projects to compare them.
Enter a title for the widget. 2. Select Project 1 and Project 2. When filling the field, corresponding projects from SonarQube will be suggested.
Sonar Linechart of a Project Use this widget to display a chart of a SonarQube project.
Enter a title for the widget. 2.
- select a project. When filling the field, corresponding projects from SonarQube will be suggested. Specify a time period. 4. Select what you want to be displayed.
Sonar My Issues Use this widget to display your assigned tickets.
- specify a title for the widget.
- select a sort order.
Sonar Projectquality of a Project. Use this widget to display a summary of a SonarQube project.
Enter a title for the widget. 2. Select a project. When filling the field, corresponding projects from SonarQube will be suggested.