Aller au contenu principal

Tags des ressources

Les tags sont des paires clé/valeur de chaînes de caractères sensibles à la casse, comme environment=staging, component=api ou pr_preview=125. Ils regroupent les ressources gérées dans un projet sans modifier leur configuration, leurs droits ou leur placement.

Ajoutez ou modifiez les tags dans la section Tags du formulaire de création ou de modification de la ressource, puis utilisez le bouton habituel Create, Update ou Save changes. Conteneurs, jobs, cronjobs, bases de données, gateways, sites web et volumes partagés utilisent les mêmes champs clé/valeur. Pour les jobs ponctuels, la configuration d'exécution reste en lecture seule, mais les tags restent modifiables. Les permissions sont les mêmes que pour gérer la ressource. Les services personnalisés et les poolers, qui n'ont pas de formulaire indépendant dans la console, peuvent recevoir des tags via l'API.

Dans les listes, ouvrez Tags à côté des filtres de recherche, de statut et de type. Choisissez une clé dans Tag key, puis sélectionnez ou saisissez la valeur exacte à faire correspondre dans Value equals. Les suggestions de valeurs appartiennent uniquement à la clé choisie. La saisie réduit les suggestions sans appliquer de filtre : sélectionnez une suggestion ou Use pour appliquer votre propre valeur. Les critères s'affichent sous la forme Tag: environment = "staging". Choisir une autre valeur pour la même clé remplace son critère précédent. La croix retire un critère ; Clear réinitialise tous les filtres. La barre reste visible même sans résultat.

Une colonne Tags compacte indique le nombre de tags sans ajouter de ligne. Ouvrez-la pour lire les paires clé/valeur ou en choisir une comme filtre exact. Les fiches de détail affichent un résumé sous l'en-tête ; dépliez-le pour lire toutes les clés et valeurs. La modification des tags reste dans le formulaire de la ressource.

Tous les filtres doivent correspondre. Les clés et valeurs sont exactes et sensibles à la casse : environment=Staging et environment=staging sont différents. Une ressource accepte 50 tags au maximum. Une clé contient 1 à 128 lettres, chiffres, underscores, points, barres obliques ou tirets ; une valeur contient jusqu'à 256 caractères. Les valeurs vides sont acceptées.

Les tags appartiennent à l'identité de la ressource. Une ressource supprimée puis recréée avec le même nom ne récupère pas ses anciens tags. Leur modification ne redémarre pas les workloads. Les routes, connexions, snapshots et volumes bloc restent gérés par leurs mécanismes parents existants et n'ont pas de tags indépendants.

Ajouter des tags au déploiement​

Incluez un objet tags dans une requête de création de ressource compatible :

{
"name": "preview-api-125",
"tags": { "environment": "preview", "pr_preview": "125", "component": "api" },
"spec": {
"image": "ghcr.io/example/api:pr-125",
"computeClass": "standard",
"resources": { "cpu": 500, "memory": 512 }
}
}

La requête apply/plan d'une stack accepte aussi des tags par défaut. Les tags d'une ressource remplacent entièrement ces valeurs par défaut ; {} les efface. En l'absence de tags explicites et de valeurs par défaut, les tags existants sont conservés. L'export d'une stack contient les tags.

Rechercher par API​

L'API publique expose une liste transversale au projet :

curl --get \
-H "X-Api-Key: $SAILOPS_API_KEY" \
--data-urlencode 'tag=environment=preview' \
--data-urlencode 'tag=pr_preview=125' \
'https://app.sailops.io/api/public/api/v1/resources'

La réponse contient items et, si une autre page existe, nextCursor. Chaque entrée contient id, kind, name, tags, revision, canDelete et éventuellement parentId. Répétez les mêmes filtres avec cursor=nextCursor pour lire la page suivante. limit accepte 1 à 200, avec 100 par défaut. kind=CONTAINER permet de restreindre le type de ressource. Le filtrage précède la pagination. Les ressources supprimées sont exclues.

Remplacez les tags avec l'identifiant et la révision obtenus dans cette liste :

PUT /api/public/api/v1/resources/{resourceId}/tags
X-Api-Key: <project-api-key>
Content-Type: application/json

{"revision": 0, "tags": {"pr_preview": "125", "component": "api"}}

Un objet vide retire tous les tags. Une modification concurrente renvoie un conflit : relisez les tags et la révision avant de réessayer.

Nettoyer un environnement de preview​

Utilisez les filtres de tags de chaque liste pour retrouver les composants de la preview, puis leurs actions habituelles pour les supprimer. Le nettoyage transversal reste accessible par API :

Pour automatiser, lisez toutes les pages correspondantes, conservez leurs identifiants, puis appelez DELETE /api/public/api/v1/resources/{resourceId} pour chaque ressource supprimable. Arrêtez les tâches planifiées et supprimez les consommateurs avant les bases et les volumes partagés. Conservez les identifiants en échec pour les réessayer. L'API refuse de supprimer une nouvelle génération portant le nom d'une ancienne sélection.

La suppression applique les règles propres aux ressources, y compris la suppression des données et des enfants qu'elles possèdent. Les ressources gérées par un parent, les services personnalisés et les applications déployées avant le retrait du Marketplace ne sont pas supprimables individuellement par cet endpoint (canDelete: false). Les applications existantes conservent leurs tags, qui restent consultables et modifiables par API. Les dépendances partagées hors sélection ne sont pas sélectionnées implicitement. Les tags regroupent les ressources ; ils ne déclenchent pas d'expiration automatique.