Documentation

Groupes, labels et filtres

Organisez les processus dans un groupe d'affichage et utilisez les labels pour filtrer les démarrages.

Pourquoi utiliser des groupes et des labels

Les groupes et labels permettent de ne démarrer qu’une partie d’un workspace. C’est utile quand un seul vectron.toml couvre:

  • les processus applicatifs
  • les processus ops ou monitoring
  • des expérimentations optionnelles
  • des dépendances temporaires

Utilisez chaque champ pour un rôle différent:

  • group est le groupe optionnel unique d’un processus. Il est utilisé par la vue groupes de la TUI et par les filtres de groupes.
  • labels est une liste optionnelle. Les labels servent uniquement aux filtres de démarrage.

Groupe de processus

[[process]]
name = "web"
command = "npm run dev"
group = "frontend"
labels = ["public"]

La TUI continue d’afficher les processus par groupe ou par processus. Les labels ne créent pas de groupes dans la TUI.

Désactiver des groupes ou labels par défaut

Utilisez global.disabled_groups ou global.disabled_labels quand certains processus doivent rester inactifs sauf réactivation explicite.

[global]
disabled_groups = ["experiments"]
disabled_labels = ["optional"]

Par exemple, gardez Storybook hors du démarrage par défaut mais autorisez une activation explicite:

[global]
disabled_labels = ["optional"]

[[process]]
name = "storybook"
command = "npm run storybook"
group = "frontend"
labels = ["optional"]
vectron start --enable-labels optional
vectron check --enable-labels optional

Le label optional n’agit que sur le filtrage au démarrage. La vue groupes de la TUI utilise toujours group = "frontend" et ne crée pas de groupe optional.

Filtres à l’exécution

Pour les groupes, Vectron supporte:

  • --only-groups
  • --skip-groups
  • --enable-groups

Pour les labels, Vectron supporte:

  • --only-labels
  • --skip-labels
  • --enable-labels

Les filtres only et skip s’appliquent à start. enable-groups et enable-labels s’appliquent aussi à check.

Quand des filtres de groupes et de labels sont combinés, un processus doit satisfaire les deux dimensions:

vectron start --only-groups frontend --only-labels public

Pattern pratique

  • utilisez group pour le bucket principal dans la TUI, comme frontend, backend ou monitoring
  • utilisez labels pour des filtres de démarrage transverses, comme public, jobs ou optional
  • gardez les services essentiels hors des groupes et labels désactivés
  • documentez l’intention de chaque groupe et label pour votre équipe