Créer et gérer des workspaces

Ce guide pratique vous montre comment créer et gérer des workspaces dans la plateforme Atlas.

Prérequis

  • Avoir un compte sur la plateforme Atlas
  • Être administrateur d'organisation ou avoir les droits nécessaires pour créer et gérer des workspaces
  • Avoir accès au dépôt GitOps de votre organisation

Structure du dépôt d'organisation

Le dépôt GitOps de votre organisation est structuré de la manière suivante :

  • resources/ : Dossier contenant les définitions des workspaces

Note : Seules les ressources appartenant au groupe org.fabrique.social.gouv.fr (comme Workspace) sont autorisées dans ce dépôt. Les ressources doivent exister dans l'espace de noms approprié de l'organisation. Il est recommandé d'omettre le champ metadata.namespace pour utiliser l'espace de noms par défaut.

Note importante sur l'évolution future : Ce dépôt est conçu comme un détail d'implémentation. À terme, toutes les modifications seront effectuées via le portail utilisateur ou par automatisation. Néanmoins, les utilisateurs peuvent manipuler directement le dépôt sous leur propre responsabilité.

Création d'un workspace

1. Cloner le dépôt GitOps de votre organisation

1
2
git clone <URL du dépôt de votre organisation>
cd <nom du dépôt>

2. Créer un fichier YAML pour le workspace

Créez un nouveau fichier YAML dans le dossier resources du dépôt. Nommez-le de manière significative, par exemple mon-projet-workspace.yaml.

1
2
mkdir -p resources
touch resources/mon-projet-workspace.yaml

Important : Les ressources doivent être déclarées dans le dossier resources/. Seules les ressources appartenant au groupe org.fabrique.social.gouv.fr (comme Workspace) sont autorisées.

3. Définir la configuration du workspace

Ouvrez le fichier mon-projet-workspace.yaml dans votre éditeur préféré et ajoutez la configuration suivante :

1
2
3
4
5
6
7
apiVersion: organization.fabrique.social.gouv.fr/v1alpha1
kind: Workspace
metadata:
  name: mon-projet-workspace
spec:
  parameters:
    name: "mon-projet-workspace"

Assurez-vous de remplacer mon-projet-workspace par un nom significatif pour votre projet.

4. Pousser les changements vers le dépôt

1
2
3
git add resources/mon-projet-workspace.yaml
git commit -m "Ajout du workspace pour mon-projet"
git push

5. Vérifier la création du workspace

Une fois les changements poussés, ArgoCD détectera automatiquement les modifications et créera le workspace. Vous pouvez vérifier l'état de la création dans ArgoCD.

  1. Accédez à ArgoCD via l'interface Atlas
  2. Recherchez l'application correspondant à votre organisation
  3. Vérifiez que le workspace a été créé avec succès

Accès au dépôt du workspace

Une fois le workspace créé, un nouveau dépôt Git sera créé pour ce workspace. Vous pouvez trouver l'URL de ce dépôt dans le statut du workspace :

  1. Dans ArgoCD, cliquez sur le workspace que vous venez de créer
  2. Dans l'onglet "Status", vous trouverez l'URL du dépôt Git du workspace

Modification d'un workspace

La modification d'un workspace se fait en modifiant le fichier YAML correspondant dans le dépôt de l'organisation.

1. Cloner le dépôt GitOps de votre organisation (si ce n'est pas déjà fait)

1
2
git clone <URL du dépôt de votre organisation>
cd <nom du dépôt>

2. Modifier le fichier YAML du workspace

Ouvrez le fichier resources/mon-projet-workspace.yaml dans votre éditeur préféré et modifiez la configuration selon vos besoins.

3. Pousser les changements vers le dépôt

1
2
3
git add resources/mon-projet-workspace.yaml
git commit -m "Modification du workspace pour mon-projet"
git push

4. Vérifier la mise à jour du workspace

Une fois les changements poussés, ArgoCD détectera automatiquement les modifications et mettra à jour le workspace. Vous pouvez vérifier l'état de la mise à jour dans ArgoCD.

Suppression d'un workspace

La suppression d'un workspace se fait en supprimant le fichier YAML correspondant du dépôt de l'organisation.

Attention : La suppression d'un workspace entraînera également la suppression de toutes les ressources associées à ce workspace. Assurez-vous de sauvegarder toutes les données importantes avant de supprimer un workspace.

1. Cloner le dépôt GitOps de votre organisation (si ce n'est pas déjà fait)

1
2
git clone <URL du dépôt de votre organisation>
cd <nom du dépôt>

2. Supprimer le fichier YAML du workspace

1
2
3
git rm resources/mon-projet-workspace.yaml
git commit -m "Suppression du workspace pour mon-projet"
git push

3. Vérifier la suppression du workspace

Une fois les changements poussés, ArgoCD détectera automatiquement les modifications et supprimera le workspace. Vous pouvez vérifier l'état de la suppression dans ArgoCD.

Gestion des accès au workspace

La gestion des accès au workspace se fait via Keycloak. Seuls les administrateurs de la plateforme et les administrateurs d'organisation peuvent attribuer des rôles aux utilisateurs sur les workspaces.

Attribution d'un rôle d'administrateur de workspace

  1. Accédez à Keycloak via l'interface Atlas
  2. Naviguez vers le realm correspondant à votre organisation
  3. Sélectionnez l'utilisateur auquel vous souhaitez attribuer le rôle d'administrateur de workspace
  4. Dans l'onglet "Role Mappings", attribuez le rôle d'administrateur de workspace

Bonnes pratiques

  • Nommage : Utilisez des noms significatifs pour vos workspaces, qui reflètent le projet ou l'application qu'ils contiennent.
  • Documentation : Documentez vos workspaces en ajoutant des commentaires dans les fichiers YAML et en créant un fichier README dans le dépôt du workspace.
  • Organisation : Organisez vos workspaces de manière logique, en regroupant les projets liés dans la même organisation.
  • Contrôle d'accès : Limitez l'accès aux workspaces aux personnes qui en ont besoin, en suivant le principe du moindre privilège.
  • Versionnement : Utilisez Git pour versionner vos workspaces et suivre les changements.

Résolution des problèmes courants

Le workspace n'apparaît pas dans ArgoCD

  • Vérifiez que vous avez bien poussé les changements vers le dépôt
  • Vérifiez que le fichier YAML est correctement formaté
  • Vérifiez que vous avez les droits nécessaires pour créer un workspace

Erreur lors de la création du workspace

  • Vérifiez les logs dans ArgoCD pour identifier l'erreur
  • Assurez-vous que le nom du workspace est unique
  • Contactez l'administrateur de la plateforme si le problème persiste

Impossible d'accéder au dépôt du workspace

  • Vérifiez que le workspace a été créé avec succès
  • Vérifiez que vous avez les droits nécessaires pour accéder au dépôt
  • Contactez l'administrateur de la plateforme si le problème persiste

Paramètres d’affichage

Choisissez un thème pour personnaliser l’apparence du site.