Docs

Catalogue

À quoi sert cet écran

Le Catalogue est le registre de tout ce que votre organisation construit et exploite : composants, systèmes, APIs et les équipes qui les possèdent. C’est la réponse à « qu’est-ce que ce service, qui en est responsable, et où vit sa documentation ? »

Tout ce qui se trouve dans Explore est une vue sur ces mêmes données.

Avant de commencer

Pour faire ceci Il vous faut
Parcourir le catalogue l’accès en lecture au catalogue

Les entrées proviennent de Settings › Development › Projects. Un catalogue vide traduit un défaut d’enregistrement, pas une page cassée.

Ouvrir l’écran

  1. Explore › Catalog dans la barre latérale. C’est aussi la page d’accueil de la plateforme.

URL directe : /catalog

L’interface

📸 Capture d’écran : La liste du catalogue. Repères : (1) le sélecteur de type, (2) les filtres propriétaire et type, (3) le champ de recherche, (4) le nom et le propriétaire d’une ligne, (5) les onglets d’une page d’entité.

# Élément Ce qu’il fait Quand l’utiliser
1 Sélecteur de type Composants, systèmes, APIs, ressources Restreindre à ce que vous cherchez
2 Filtres Propriétaire, type, cycle de vie Retrouver le travail d’une équipe
3 Recherche Texte libre sur noms et descriptions Quand vous connaissez à peu près le nom
4 Ligne Nom, propriétaire, type Parcourir
5 Onglets d’entité Docs, APIs, dépendances, et onglets de plugins comme Helm Review Tout sur un élément

La colonne propriétaire est l’information la plus utile de la page. Un composant sans propriétaire est un composant pour lequel personne n’a accepté de répondre aux questions.

Procédures

Trouver un service et son propriétaire

  1. Explore › Catalog.
  2. Recherchez le nom, ou filtrez par type.
  3. Ouvrez-le. Le propriétaire figure sur la page d’entité, et ses onglets portent la documentation, les APIs et les dépendances.

Voir ce que possède une équipe

Filtrez par propriétaire. C’est la même question que traite Architecture visuellement ; la liste vaut mieux quand vous voulez compter plutôt que regarder.

Scénario

Vous êtes appelé pour un service dont vous n’avez jamais entendu parler.

  1. Explore › Catalog, recherchez le nom du service depuis l’alerte.
  2. Lisez le propriétaire. S’il y en a un, vous savez désormais qui réveiller — ou qui prévenir au matin.
  3. Ouvrez l’entité. Son onglet Docs est l’endroit où vivrait un runbook, s’il en existe un.
  4. Consultez les onglets API et dépendances pour voir qui l’appelle. Cela vous dit jusqu’où porte le problème avant même tout diagnostic.
  5. Passez à Deploy pour ses environnements, et à Architecture s’il vous faut l’image plutôt que la liste.
  6. Si l’entrée n’a aucun propriétaire, c’est le constat à remonter une fois l’incident clos. Un service sans propriétaire dans le catalogue est la façon dont une astreinte à 3 h du matin devient le travail de personne.

En cas de problème

Symptôme Cause Comment vérifier Solution
Un service n’est pas listé Il n’est pas enregistré Projets Enregistrez-le
Une entrée n’a pas de propriétaire Son système n’a pas de groupe propriétaire La page d’entité Renseignez le propriétaire sur le système
L’onglet Docs est vide Aucune documentation TechDocs pour cette entité Docs Ajoutez de la documentation au dépôt
Le catalogue est entièrement vide Rien d’enregistré, ou vous n’avez pas l’accès en lecture Access Explorer Enregistrez des entrées ; vérifiez les permissions
Une entrée récemment enregistrée est absente Le catalogue se rafraîchit périodiquement — Attendez le prochain rafraîchissement

Pour aller plus loin