Dienste: Unterschied zwischen den Versionen

Aus Das Sopra Wiki
Zur Navigation springen Zur Suche springen
(rework in progress)
(Viele Änderungen.)
Zeile 12: Zeile 12:




==Dienste==  
==Dienste==
===Discourse ===
Die folgende Tabelle gibt einen Überblick über alle Dienste die im Sopra zur Verfügung gestellt werden, und deren Nutzen für das Sopra.
[[File:discourse_logo.png|100px|left|link=https://discourse.sopranium.de]]
{| class="wikitable"
|+
!Dienst
!Beschreibung
!Nutzen
|-
| colspan="3" |'''Entwicklung'''
|-
|[[File:gitea_logo.png|100px|link=https://git.sopranium.de|alternativtext=|zentriert]]Gitea
|Siehe [[Gitea]].
|
|-
|[[Datei:Jenkins.png|100px|link=https://www.jenkins.io|alternativtext=|zentriert|


[https://discourse.sopranium.de Discourse] ist eine Open-Source Diskussions-Plattform, deren Funktionalität an Seiten wie [https://stackoverflow.com/ Stackoverflow] oder auch das [https://community.monogame.net/ Monogame-Forum] angelehnt ist.
Jen]]Jenkins
|[https://www.jenkins.io/ Jenkins] ist ein Open-Source Werkzeug zur kontinuierlichen Integration d.h. um autmomatisch jede neue Änderung an einer Software zu kompilieren, Tests und statische Analysen auszuführen, usw.
| Im Sopra baut ein Jenkins jeden Commit, der auf Gitea gepusht wird. Binnen weniger Minuten ist sichtbar:


Hier haben Sie die Möglichkeit öffentlich Fragen an Dozenten, Tutoren und Kommilitonen zu stellen, und natürlich auch zu beantworten.
*Ob alle Dateien eingecheckt wurden, die für den Baul notwendig sind
*Ob die Änderungen zufällig nur auf deinem System gebaut haben (z.B. wegen temporärer Dateien), was alle Teammitglieder aufhalten würde bis  ein Fix comitted wurde
*Fehlermeldungen und der Bauvorgang lassen sich auf [https://jenkins.sopranium.de jenkins.sopranium.de] einsehen.
 
Außerdem erzeugt Jenkins bei Commits auf dem <code>release</code> branch ein Release in Gitea.
|-
|[[Datei:SonarQube icon 256 px.png|100px|link=https://docs.sonarqube.org/|alternativtext=|zentriert]]Sonar
|Sonar ist ein automatisiertes code-review-tool, das bugs, sicherheitslücken und sogar probleme im cleancode-management erkennen kann. Im Softwarepraktikum lassen sich hier außerdemmit dem Tag "Resharper" versehene meldungen anzeigen, die mit den vorgesehenen Resharper Regeln übereinstimmen.
 
 
Mehr informationen zu der Bedeutung der einzelnen Metriken finden sie [https://docs.sonarqube.org/latest/user-guide/metric-definitions/ hier].<br clear="all" />
|
|-
|[[File:grafana_logo.png|100px|link=https://grafana.sopranium.de|alternativtext=|zentriert]]Dashboard
|Auf Ihrem Dashboard finden Sie nützliche Metriken, die Ihnen dabei helfen können einen Überblick über bereits gearbeitete Zeit und geschriebenen Code zu behalten.Insbesondere wird hier auch die Anzahl bereits erreichter Punkte sowie die bisherige durchschnittlich geschätzte Zeit angezeigt.
 
 
Das Dashboard ist mit [https://grafana.com Grafana] realisiert und wird im Moment nur täglich aktualisiert. Zu Beginn des Softwarepraktikums sehen Sie dort noch keine Daten, da diese erst im Laufe der Zeit anfallen.
|
|-
| colspan="3" |Kommunikation
|-
|[[File:discourse_logo.png|100px|link=https://discourse.sopranium.de|alternativtext=|zentriert]]Discourse
|[https://discourse.sopranium.de Discourse] ist eine Open-Source Diskussions-Plattform, deren Funktionalität an Seiten wie [https://stackoverflow.com/ Stackoverflow] oder auch das [https://community.monogame.net/ Monogame-Forum] angelehnt ist.
 
 
Genaueres über die Features finden Sie unter [https://www.discourse.org/features Discourse] oder einfach direkt auf der Seite.
|Hier haben Sie die Möglichkeit öffentlich Fragen an Dozenten, Tutoren und Kommilitonen zu stellen, und natürlich auch zu beantworten.
<br clear="all" />
<br clear="all" />
Was hier hin gehört:
Was hier hin gehört:
*Technische Fragen zur Entwicklungsumgebung
*Technische Fragen zur Entwicklungsumgebung
*Fragen zum Ablauf
*Fragen zum Ablauf
*Fragen zu Formalien und Benotung
*Fragen zu Formalien und Benotung
* Fragen zu Monogame und C#
*Fragen zu Monogame und C#


Was hier nicht hin gehört:
Was hier nicht hin gehört:
Zeile 31: Zeile 71:
*Fragen zu persönlichen Problemen (z.B. HisInOne, Prüfungsamt)
*Fragen zu persönlichen Problemen (z.B. HisInOne, Prüfungsamt)
*Probleme oder Streit mit Tutoren oder anderen Studierenden
*Probleme oder Streit mit Tutoren oder anderen Studierenden
|-
|[[File:mattermost_logo.png|100px|link=https://chat.sopranium.de|alternativtext=|zentriert|MML]]Mattermost
|Mattermost ist eine Open-Source Chat-Plattform die in ihrer Funktionalität an Chatprogramme wie z.B. [https://discord.com/ Discord] oder [https://slack.com Slack] erinnert. Hier steht Ihnen als Gruppe neben den öffentlichen Chaträumen auch ein eigener
Chatraum zur Verfügung.


Genaueres über die Features finden Sie unter [https://www.discourse.org/features Discourse] oder einfach direkt auf der Seite.
===Chat===
[[File:mattermost_logo.png|100px|left|link=https://chat.sopranium.de]]
Wir verwenden [https://mattermost.com Mattermost] als Chat-Plattform. Mattermost ist eine Open-Source Chat-Plattform die in ihrer Funktionalität an Chatprogramme wie z.B. [https://discord.com/ Discord] oder [https://slack.com Slack] erinnert. Hier steht Ihnen als Gruppe neben den öffentlichen Chaträumen auch ein eigener Chatraum zur Verfügung.
Dies eignet sich insbesondere um während dem Entwickeln miteinander zu sprechen und Probleme schnell zu klären.


Mattermost bietet alle Features, die man von derartigen Programmen erwartet, insbesondere auch Android oder iOS Apps.  
Mattermost bietet alle Features, die man von derartigen Programmen erwartet, insbesondere auch Android oder iOS Apps.  
<br clear="all" />
|Wir verwenden [https://mattermost.com Mattermost] als Chat-Plattform.


===Gitea===
*Mattermost eignet sich insbesondere um während dem Entwickeln miteinander zu sprechen und Probleme  schnell zu klären.
[[File:gitea_logo.png|100px|left|link=https://git.sopranium.de]]
*Schnell Kontakt mit den Dozenten, Teammitgliedern oder dem Tutor aufzunehmen z.B. um während der Sprechstunde  einen Videochat auszumachenoder um einfach und unkompliziert eine Frage zu stellen.
Siehe [[Gitea]].
|-
<br clear="all" />
| colspan="3" |Accountverwaltung
 
|-
===Account===
|[[File:keycloak_logo.svg|100px|link=https://sso.sopranium.de|alternativtext=|zentriert|
[[File:keycloak_logo.svg|100px|left|link=https://sso.sopranium.de]]
Wir verwenden zur zentralen Authentifizierung Keycloak. Unter diesem Link können Sie auf Ihre Accountdaten zugreifen und z.B. Ihr Passwort ändern oder 2FA (2-Faktor-Authentifizierung) aktivieren.
 
<br clear="all" />
 
===Dashboard===
[[File:grafana_logo.png|100px|left|link=https://grafana.sopranium.de]]
Auf Ihrem Dashboard finden Sie nützliche Metriken, die Ihnen dabei helfen können einen Überblick über bereits gearbeitete Zeit und geschriebenen Code zu behalten.
Insbesondere wird hier auch die Anzahl bereits erreichter Punkte sowie die bisherige durchschnittlich geschätzte Zeit angezeigt.
 
Das Dashboard ist mit [https://grafana.com Grafana] realisiert und wird im Moment nur täglich aktualisiert. Zu Beginn des Softwarepraktikums sehen Sie dort noch keine Daten, da diese erst im Laufe der Zeit anfallen.
<br clear="all" />
 
===Jenkins===
[[Datei:Jenkins.png|100px|left|link=https://www.jenkins.io]]
Jenkins ist ein open-source automation-server, der es erlaubt Projekte automatisiert zu Bauen und (im Softwarepraktikum auf dem release-branch) Ausführbare Dateien zu kompilieren und zur Verfügung zu stellen.
<br clear="all" />
 
===Sonar===
[[Datei:SonarQube icon 256 px.png|100px|left|link=https://docs.sonarqube.org/]]
Sonar ist ein automatisiertes code-review-tool, das bugs, sicherheitslücken und sogar probleme im cleancode-management erkennen kann.
Im Softwarepraktikum lassen sich hier außerdemmit dem Tag "Resharper" versehene meldungen anzeigen, die mit den vorgesehenen Resharper Regeln übereinstimmen.
Mehr informationen zu der Bedeutung der einzelnen Metriken finden sie [https://docs.sonarqube.org/latest/user-guide/metric-definitions/ hier].
<br clear="all" />




A]]Keycloak
|Wir verwenden zur zentralen Authentifizierung Keycloak. Unter diesem Link können Sie auf Ihre Accountdaten zugreifen und z.B. Ihr Passwort ändern oder 2FA (2-Faktor-Authentifizierung) aktivieren.
|Keycloak sorgt dafür, dass ein Login für alle Dienste funktioniert. Auf der Keycloak Seite kann das Passwort und die Email für Keycloak geändert werden (das ändert nicht unbedingt die Email die in den einzelnen services eingetragen ist).
|}


==Erstbenutzung==
==Erstbenutzung==
Zeile 93: Zeile 109:
<br clear="all" />
<br clear="all" />


=== Gitea===
===Gitea===
[[File:Gitea_signin.png|thumb|300px|left|Einloggen bei Gitea mit Keycloak]]
[[File:Gitea_signin.png|thumb|300px|left|Einloggen bei Gitea mit Keycloak]]
Falls Sie Gitea nicht über [https://services.sopranium.de services.sopranium.de] sondern direkt über [https://git.sopranium.de git.sopranium.de] aufrufen, könnten Sie dieser Login-Maske begegnen. Verwenden Sie hier den Tab "Sign In" und klicken Sie dann unten auf "Sign In With OpenID" um die Authentifizerung via Keycloak zu benutzen.
Falls Sie Gitea nicht über [https://services.sopranium.de services.sopranium.de] sondern direkt über [https://git.sopranium.de git.sopranium.de] aufrufen, könnten Sie dieser Login-Maske begegnen. Verwenden Sie hier den Tab "Sign In" und klicken Sie dann unten auf "Sign In With OpenID" um die Authentifizerung via Keycloak zu benutzen.


<br clear="all" />
<br clear="all" />

Version vom 11. Oktober 2021, 20:07 Uhr

services.sopranium.de

Nach der Gruppeneinteilung erhalten Sie von unseren Diensten eine Reihe von Mails. In der Mail von SoPra Accounts finden Sie einen Link zur Aktualisierung Ihres Accounts auf sso.sopranium.de. Nachdem Sie Ihren Account eingerichtet haben können Sie alle aktuell verfügbaren Dienste über services.sopranium.de erreichen.

Manche von diesen Diensten müssen Sie bei der Erstbenutzung kurz konfigurieren. Diese Konfiguration wird in diesem Artikel beschrieben. Außerdem gibt es hier eine Kurzübersicht über alle aktuell verfügbaren Dienste.

Sollten Sie Probleme bei der Benutzung der Dienste haben, kontaktieren Sie uns bitte via sopra-crew@informatik.uni-freiburg.de.

Melden Sie sich bitte auch falls Sie bereits einen Account bei uns gehabt haben und beide Accounts zusammenführen wollen. Falls Sie die gleichen E-Mailadressen verwendet haben ist dies bereits automatisch passiert.



Dienste

Die folgende Tabelle gibt einen Überblick über alle Dienste die im Sopra zur Verfügung gestellt werden, und deren Nutzen für das Sopra.

Dienst Beschreibung Nutzen
Entwicklung
Gitea
Siehe Gitea.
Jen
Jenkins
Jenkins ist ein Open-Source Werkzeug zur kontinuierlichen Integration d.h. um autmomatisch jede neue Änderung an einer Software zu kompilieren, Tests und statische Analysen auszuführen, usw. Im Sopra baut ein Jenkins jeden Commit, der auf Gitea gepusht wird. Binnen weniger Minuten ist sichtbar:
  • Ob alle Dateien eingecheckt wurden, die für den Baul notwendig sind
  • Ob die Änderungen zufällig nur auf deinem System gebaut haben (z.B. wegen temporärer Dateien), was alle Teammitglieder aufhalten würde bis ein Fix comitted wurde
  • Fehlermeldungen und der Bauvorgang lassen sich auf jenkins.sopranium.de einsehen.

Außerdem erzeugt Jenkins bei Commits auf dem release branch ein Release in Gitea.

Sonar
Sonar ist ein automatisiertes code-review-tool, das bugs, sicherheitslücken und sogar probleme im cleancode-management erkennen kann. Im Softwarepraktikum lassen sich hier außerdemmit dem Tag "Resharper" versehene meldungen anzeigen, die mit den vorgesehenen Resharper Regeln übereinstimmen.


Mehr informationen zu der Bedeutung der einzelnen Metriken finden sie hier.

Dashboard
Auf Ihrem Dashboard finden Sie nützliche Metriken, die Ihnen dabei helfen können einen Überblick über bereits gearbeitete Zeit und geschriebenen Code zu behalten.Insbesondere wird hier auch die Anzahl bereits erreichter Punkte sowie die bisherige durchschnittlich geschätzte Zeit angezeigt.


Das Dashboard ist mit Grafana realisiert und wird im Moment nur täglich aktualisiert. Zu Beginn des Softwarepraktikums sehen Sie dort noch keine Daten, da diese erst im Laufe der Zeit anfallen.

Kommunikation
Discourse
Discourse ist eine Open-Source Diskussions-Plattform, deren Funktionalität an Seiten wie Stackoverflow oder auch das Monogame-Forum angelehnt ist.


Genaueres über die Features finden Sie unter Discourse oder einfach direkt auf der Seite.

Hier haben Sie die Möglichkeit öffentlich Fragen an Dozenten, Tutoren und Kommilitonen zu stellen, und natürlich auch zu beantworten.


Was hier hin gehört:

  • Technische Fragen zur Entwicklungsumgebung
  • Fragen zum Ablauf
  • Fragen zu Formalien und Benotung
  • Fragen zu Monogame und C#

Was hier nicht hin gehört:

  • Fragen zu persönlichen Problemen (z.B. HisInOne, Prüfungsamt)
  • Probleme oder Streit mit Tutoren oder anderen Studierenden
MML
Mattermost
Mattermost ist eine Open-Source Chat-Plattform die in ihrer Funktionalität an Chatprogramme wie z.B. Discord oder Slack erinnert. Hier steht Ihnen als Gruppe neben den öffentlichen Chaträumen auch ein eigener

Chatraum zur Verfügung.


Mattermost bietet alle Features, die man von derartigen Programmen erwartet, insbesondere auch Android oder iOS Apps.

Wir verwenden Mattermost als Chat-Plattform.
  • Mattermost eignet sich insbesondere um während dem Entwickeln miteinander zu sprechen und Probleme schnell zu klären.
  • Schnell Kontakt mit den Dozenten, Teammitgliedern oder dem Tutor aufzunehmen z.B. um während der Sprechstunde einen Videochat auszumachenoder um einfach und unkompliziert eine Frage zu stellen.
Accountverwaltung
A
Keycloak
Wir verwenden zur zentralen Authentifizierung Keycloak. Unter diesem Link können Sie auf Ihre Accountdaten zugreifen und z.B. Ihr Passwort ändern oder 2FA (2-Faktor-Authentifizierung) aktivieren. Keycloak sorgt dafür, dass ein Login für alle Dienste funktioniert. Auf der Keycloak Seite kann das Passwort und die Email für Keycloak geändert werden (das ändert nicht unbedingt die Email die in den einzelnen services eingetragen ist).

Erstbenutzung

Sopra Accounts (Keycloak)

Der Link zur Aktualisierung Ihres Accounts aus der Mail von SoPra Accounts führt Sie in mit den oben stehenden drei Schritten durch die Accounteinrichtung. Sie müssen nur ein Passwort vergeben. Ihre Email-Adresse und ihr Name wurde aus dem Fragebogen zur Gruppeneinteilung übernommen.

Discourse

Discourse's Eingabemaske zur Bestätigung der übermittelten Daten. Sie können hier einfach "Neues Benutzerkonto erstellen" drücken.

Beim ersten Login zeigt Ihnen Discourse eine Eingabemaske in der die von Keycloak übermittelten Daten noch einmal angegeben sind. Sie können hier einfach auf "Neues Benutzerkonto erstellen" drücken.

Gitea

Einloggen bei Gitea mit Keycloak

Falls Sie Gitea nicht über services.sopranium.de sondern direkt über git.sopranium.de aufrufen, könnten Sie dieser Login-Maske begegnen. Verwenden Sie hier den Tab "Sign In" und klicken Sie dann unten auf "Sign In With OpenID" um die Authentifizerung via Keycloak zu benutzen.