From a3ada20086ac7019fe19dea04953ea5331fd7f48 Mon Sep 17 00:00:00 2001 From: Pascal BASTIEN <pascal.bastien@developpement-durable.gouv.fr> Date: Fri, 24 Mar 2023 16:31:01 +0100 Subject: [PATCH] =?UTF-8?q?runner=20qui=20n''est=20plus=20en=20mode=20exp?= =?UTF-8?q?=C3=A9rimental=20+=20typo=20+=20mise=20en=20page?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 52 ++++++++++++++++++++++++++-------------------------- 1 file changed, 26 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 5c11b22..7f0e54a 100644 --- a/README.md +++ b/README.md @@ -29,36 +29,38 @@ Pour de plus amples informations sur GitLab-forge, une [documentation](https://s - [GitLab Pages](#gitlab-pages) - [Dependency proxy](#dependency-proxy) +## Accès -# Accès - -## Agent du ministère +### Agent du ministère Tous les agents du pôle ministériel ayant une adresse en @developpement-durable.gouv.fr ou @i-carre.net peuvent accéder à Gitlab-forge (à l'aide de l'identifiant et mot de passe de la messagerie) et y créer des projets individuels sous leur profil. **Il est interdit de créer un projet public ou des GitLab Pages sous votre profil individuel GitLab.** Dans ce cas, l'URL est publiée avec votre nom de compte et n'est donc pas pérenne. Par ailleurs, Gitlab-forge n'est pas destiné à publier des projets personnels, ni des GitLab Pages individuels. Un script automatique est exécuté réguliérement pour enlever la visibilité publique sur les projets individuels, ainsi que les Gitlab Pages individuelles. -### Accés aux groupes GitLab +#### Accés aux groupes GitLab Pour rejoindre un groupe ou projet GitLab existant, il faut demander au gestionnaire de groupe ou projet GitLab de vous ajouter dans celui-ci via le menu (*Group information | Project information - members*) **après** que vous vous soyez connecté une première fois à GitLab (sinon le gestionnaire ne verra pas votre compte utilisateur). *Note*: répondre aux invitations par mail ne peut pas fonctionner car les comptes locaux GitLab sont désactivés. S'il n'y a pas encore de groupe GitLab correspondant à votre service, afin de pouvoir travailler en équipe, vous pouvez en demander la création, sur le [portail Architecture et Méthodes](https://portail.centre-serveur.din.developpement-durable.gouv.fr/projects/demande-architecture-et-methode) - *"Faire une demande d'assistance"*, et indiquer obligatoirement : - - la motivation de cette création ; - - le nom du groupe correspondant au service du demandeur ; - - et le *owner* du groupe (l'administrateur) qui aura la possibilité de créer des sous-groupes ou projets au sein de ce groupe ainsi que les permissions. **L'administrateur doit appartenir au service créé, et doit transmettre un accord écrit de la part du responsable hiérarchique de ce service**. Cet administrateur devient alors responsable du fonctionnement de son groupe. -*Note* : pour être administrateur d'un groupe racine (tel qu'une direction par ex.), la demande devra toutefois être validée par la hiérarchie du niveau approprié. Dans ce cas, le responsable GitLab de ce groupe sera *Maintainer* et sera donc owner des sous-groupes crées. +- la motivation de cette création ; +- le nom du groupe correspondant au service du demandeur ; +- et le *owner* du groupe (l'administrateur) qui aura la possibilité de créer des sous-groupes ou projets au sein de ce groupe ainsi que les permissions. **L'administrateur doit appartenir au service créé, et doit transmettre un accord écrit de la part du responsable hiérarchique de ce service**. Cet administrateur devient alors responsable du fonctionnement de son groupe. + +*Note* : pour être administrateur d'un groupe racine (tel qu'une direction par ex.), la demande devra toutefois être validée par la hiérarchie du niveau approprié. Dans ce cas, le responsable GitLab de ce groupe sera *Maintainer* et sera donc automatiquement owner des sous-groupes qu'il créeras. Les groupes et projets peuvent être internes ou privés : - - un groupe ou projet interne est lisible par tous les agents pouvant se connecter à Gitlab-forge ; - - un groupe ou projet privé ne sera accessible qu'aux membres de celui-ci. + +- un groupe ou projet interne est lisible par tous les agents pouvant se connecter à Gitlab-forge ; +- un groupe ou projet privé ne sera accessible qu'aux membres de celui-ci. A votre demande, nous pouvons également créer un sous-groupe du **groupe "[pub](https://gitlab-forge.din.developpement-durable.gouv.fr/pub)" dédié aux groupes publics**. La visibilité des sous-groupes/projets de "pub" pourra être interne, privée ou publique. - - un groupe/projet public est accessible à tout internet sans authentification. -## Personne externe +- un groupe/projet public est accessible à tout internet sans authentification. + +### Personne externe Ce service Gitlab est ouvert en dehors du pôle ministériel, par exemple aux partenaires en charge du développement d'un projet pour le ministère. @@ -70,15 +72,16 @@ Dans ce cas, vous devez demander à votre administrateur Amédée de lui créer Une fois le compte créé, il peut être invité (avec son email ou son nom de compte s'il s'est authentifié une fois) sur les projets au même titre que tout compte interne. -## Accès public +### Accès public Si vous devez publier/partage un groupe ou projet public sur internet sans authentification, vous devez en faire la demande sur le [portail Architecture et Méthodes](https://portail.centre-serveur.din.developpement-durable.gouv.fr/projects/demande-architecture-et-methode) en précisant : + - le nom du groupe correspondant au service du demandeur ; - ainsi que le propriétaire du groupe (l'administrateur) qui aura la possibilité de créer des sous-groupes ou projets (public, interne ou privé) au sein de ce groupe. Seul le groupe racine [/pub](https://gitlab-forge.din.developpement-durable.gouv.fr/pub) est autorisé, par défaut, à contenir des groupes/projets publics. Cela reste possible pour les autres groupes après validation des administrateurs GitLab et une demande sur le [portail Architecture et Méthodes](https://portail.centre-serveur.din.developpement-durable.gouv.fr/projects/demande-architecture-et-methode) en précisant les motivations de l'accès public. -# Sauvegardes +## Sauvegardes Gitlab-forge est sauvegardé une fois par jour avec une rétention d'une semaine sur le BaaS (stockage objet fournis par DIS/GIC). Plus précisement, il y a une sauvegarde par jour ouvert et une sauvegarde le premier week-end du mois. @@ -89,27 +92,26 @@ Plus précisement, il y a une sauvegarde par jour ouvert et une sauvegarde le pr Par ailleurs, les runners et les pages ne sont pas sauvegardés. Ceux-ci pouvant être relancés. -# Fonctionnalités +## Fonctionnalités -## Dépôt git +### Dépôt git Le dépôt est accessible en `https` uniquement. Les utilisateurs doivent créer, puis utiliser [un jeton (token)](https://gitlab-forge.din.developpement-durable.gouv.fr/-/profile/personal_access_tokens) qui sert de mot de passe pour le client git : - login : *login Gitlab-forge* (indiqué en haut à droite lorsque vous êtes connecté) ; - mot de passe : *token* que vous aurez soigneusement noté (s'il est perdu vous pouvez en créer un autre et résiler l'ancien). -## Container Registry +### Container Registry -Le registry de Gitlab-forge est mis à disposition sur _intranet_ et _internet_. +Le registry de Gitlab-forge est mis à disposition sur *intranet* et *internet*. L'URL est affichée dans le menu du projet : *Packages et Registries - Container Registry - CLI Commands* Note: Pensez à activer le nettoyage des images de vos projets dans le menu du projet afin de préserver l'espace disque: Settings -> Clean up image tags -> Clean up image tags. - **Merci d'y faire le ménage réguliérement** afin de ne pas saturer inutilement le disque du serveur et de veiller à créer des images minimalistes, dans la mesure du possible, pour ne pas saturer rapidement le serveur. -## Runner +### Runner Si vous disposez déjà de votre propre runner local ou comptez disposer de votre propre runner, vous pouvez le connecter à Gitlab-forge. @@ -118,13 +120,12 @@ fonctionnalité CI/CD et activer le runner *gitlab-runner-global-selfservice* da De même, un runner dédié peut être mis à disposition d'un groupe d'un service d'**administration centrale** à la demande sur [le portail de demandes Architecture et Méthode](https://portail.centre-serveur.din.developpement-durable.gouv.fr/projects/demande-architecture-et-methode). -### Caractéristiques actuelles du runner mis à disposition +#### Caractéristiques actuelles du runner mis à disposition -- Runner en mode EXPÉRIMENTAL car hébergé sur une instance ECO3 qui n'est pas de la production ; -- Actuellement, il se base sur un [Kubernetes executor](https://docs.gitlab.com/runner/executors/kubernetes.html). Il permet donc de lancer des builds depuis une image de votre choix, mais ne permet pas de faire du Docker-in-Docker ; +- Ce runner partagé se base sur un [Kubernetes executor](https://docs.gitlab.com/runner/executors/kubernetes.html). Il permet donc de lancer des builds depuis une image de votre choix, mais ne permet pas de faire du Docker-in-Docker ; - Pour construire une image, vous pouvez néanmoins utiliser kaniko ou podman. Des exemples d'utilisation sont disponibles sur le projet [Build Containers](https://gitlab-forge.din.developpement-durable.gouv.fr/snum/dam/diverstests/build_containers). -## GitLab Pages +### GitLab Pages Les GitLab pages sont **opérationnelles et en https sur internet**. @@ -132,9 +133,8 @@ L'accessibilité des pages est déterminée au niveau de chaque projet et suivan Les Gitlab pages sont générées par un runner. -## Dependency proxy +### Dependency proxy Vous pouvez activer et utiliser la fonction `Dependency Proxy` pour votre groupe, ce qui évite de multiples téléchargements de la même image sur Docker Hub, à chaque exécution de runner. Note: Pensez à activer le nettoyage du cache du Dependency Proxy dans vos groupes afin de préserver l'espace disque: Packages & Registries -> Storage settings -> Clear the Dependency Proxy cache automatically - -- GitLab