Concevoir un Runbook avec Visual Designer
Utiliser le concepteur visuel pour concevoir et créer des blocs d'exécution personnalisés dans Fleet Application Management. Le concepteur fournit une interface de glisser-déposer avec une option pour ajouter du code afin que vous puissiez créer et modifier des runbooks plus facilement. Runbook peut être écrit en YAML ou JSON. Cependant, vous pouvez créer un runbook sans avoir à le créer en JSON natif ou YAML à l'aide du concepteur visuel.
Avec le concepteur visuel, vous pouvez effectuer les tâches suivantes :
- Concevez un classeur à l'aide de ses composants.
- Rationalisez l'exécution du runbook.
- Configurez des instructions conditionnelles avec le générateur de conditions.
- Configurez les exécutions de tâches conditionnelles en fonction des composants du produit, des variables d'entrée et de sortie, ou des deux.
- Configurez la gestion des erreurs.
- Illustrer les runbooks fournis par Fleet Application Management.
- Clonez des runbooks illustrés pour vous aider à créer des runbooks personnalisés dans lesquels vous ajoutez votre code en mode source ou concepteur.
Lorsque vous créez un runbook, le concepteur visuel valide votre travail et génère automatiquement du code. Vous pouvez consulter le code généré ou l'exporter pour le développement local. Après avoir créé le runbook, vous pouvez l'enregistrer, le publier et examiner les résultats sur la console.
- Le panneau actions situé à droite contient les onglets Composants et Propriétés.
- Le canvas au centre est un espace réservé dans lequel vous concevez le runbook. Vous pouvez faire glisser les composants à partir du volet d'actions, tels que des groupes de ressources parallèles ou non dynamiques, et faire glisser des tâches vers ces groupes. Vous pouvez modifier l'ordre des composants du canevas en les plaçant dans l'ordre dans lequel vous souhaitez exécuter les tâches, ou sélectionner des actions pour configurer les propriétés ou gérer les erreurs.
Le canevas contient également l'icône de modification en regard de chaque composant de tâche pour afficher et modifier la tâche de bloc d'exécution.
Pour afficher le code YAML ou JSON généré automatiquement pour le guide d'exploitation lorsque vous utilisez le concepteur visuel, sélectionnez Vue de code sur le canevas. Lorsque vous mettez à jour le fichier YAML ou JSON, les modifications sont automatiquement générées en mode concepteur.
Volet Actions
Dans le volet Actions, vous pouvez sélectionner les composants à faire glisser dans la zone de travail du canevas. Le panneau contient les éléments suivants :
Onglet Composants
Pour ajouter une tâche, vous devez d'abord ajouter un groupe de ressources parallèle ou non simultané. Une tâche doit se trouver dans un groupe. Pour plus d'informations sur l'utilisation des types de groupe, voir Création d'un guide d'exploitation.
- Nouvelle tâche : utilisez ce bouton pour créer des tâches pour un bloc d'exécution. Vous pouvez maintenant ajouter une tâche qui peut exécuter un script en spécifiant le type d'action en tant que script.
- Groupe de tâches parallèle : toutes les tâches faisant partie d'un groupe de tâches parallèle sont exécutées en parallèle sur une ressource (ressources de calcul et de base de données) faisant partie d'un parc.
Par exemple, si un parc dispose de deux ressources et de deux tâches (task1 et task2) faisant partie du groupe de tâches parallèles, task1 et task2 s'exécutent en parallèle sur resource1 et resource2.
- Groupe de ressources parallèle : toutes les tâches faisant partie d'un groupe de ressources parallèle sont exécutées en parallèle sur les ressources (ressources de calcul et de base de données) faisant partie d'un parc. Au sein d'une ressource, les tâches qui font partie d'un groupe de ressources parallèle s'exécutent séquentiellement.
Par exemple, si un parc comporte deux ressources et deux tâches (task1 et task2) qui font partie du groupe de ressources parallèle, task1 et task2 sont exécutées de manière séquentielle sur resource1 et resource2, et l'exécution sur resource1 et resource2 se produit en parallèle.
- Groupe de ressources non simultané : toutes les tâches faisant partie d'un groupe de ressources non simultanées sont exécutées de manière séquentielle sur les ressources (ressources de calcul et de base de données) faisant partie d'un parc. Au sein d'une ressource, les tâches qui font partie d'un groupe de ressources non simultanées sont exécutées de manière séquentielle.
Par exemple, si un parc comporte deux ressources et deux tâches (task1 et task2) qui font partie du groupe de ressources non simultanées, task1 et task2 sont exécutées de manière séquentielle sur resource1. Une fois les tâches resource1 terminées, task1 et task2 sont exécutés de manière séquentielle sur resource2.
Onglet Propriétés
L'onglet Propriétés fournit des paramètres pour contrôler les instructions conditionnelles et configurer la gestion des erreurs des composants que vous ajoutez au canevas. Une fois que vous avez ajouté un composant à la zone de travail sur le canevas sous Tâches ou Annuler les tâches, configurez-le en fonction de votre cas d'emploi. Sélectionnez l'icône de propriétés (
) du composant pour configurer ses propriétés et options. Vous pouvez également voir le code YAML ou JSON en sélectionnant Vue Code. Les propriétés sont disponibles pour un guide d'exploitation, des groupes et des tâches.
Propriétés du guide d'exploitation
Les deux propriétés d'un guide d'exploitation sont les suivantes :
- En cas d'échec des tâches : l'option que vous sélectionnez pour cette propriété est la valeur par défaut pour tous les groupes et tâches d'un bloc d'exécution.
- Exécuter le : l'option que vous sélectionnez décrit où et comment les tâches sont exécutées. Elle peut impliquer des instances programmées, des environnements auto-hébergés ou des instances sélectionnées en fonction des résultats des tâches précédentes. Les sous-propriétés de Exécuter le sont les suivantes :
- Instances spécifiées par la planification : cette propriété est utilisée pour l'exécution conditionnelle d'un guide d'exploitation sur une cible lorsque la condition renvoie la valeur True. Il est mieux adapté à la gestion des workflows de pile de produits au sein d'un guide d'exploitation.
- Instance auto-hébergée : cette propriété vous aide à localiser et à sélectionner une instance auto-hébergée pour les tâches de post-provisionnement.
- Instance spécifiée par la tâche précédente : cette propriété indique que l'exécution d'une tâche dépend de la réalisation d'une tâche précédente.
Propriétés du groupe
Les cinq propriétés d'un groupe sont les suivantes :
- En cas d'échec : l'option que vous sélectionnez pour cette propriété détermine l'ensemble d'actions suivant si l'une des tâches d'un groupe échoue. L'exécution du guide d'exécution sur la cible se poursuit si vous sélectionnez Continuer, l'exécution du guide d'exécution de produit sur la cible s'arrête et l'exécution du guide d'exécution de la pile de produits sur le groupe d'actions s'arrête si vous sélectionnez Abandonner, et l'exécution du guide d'exécution passe à l'étape d'annulation si vous sélectionnez Annuler. En fonction de la portée de l'annulation (rollback), l'action d'annulation (rollback) peut être effectuée au niveau de la cible ou du groupe d'actions.
- Condition préalable : spécifie la condition à l'aide des variables d'entrée de la tâche en cours et des variables de sortie de toutes les tâches précédentes. Une tâche est exécutée sur la cible uniquement si la condition est vérifiée.
- Exécuter le : indique la condition à l'aide du nom de produit cible (pour le classeur de la pile de produits), des propriétés de produit et du nom de composant, ainsi que des propriétés de composant d'une cible. Une tâche est exécutée sur la cible uniquement si la condition est vérifiée.
Par exemple, dans le guide d'exécution de la pile de produits Oracle WebLogic Server et Java Patching, pour exécuter une tâche uniquement sur la cible Oracle WebLogic Server si sa valeur de propriété java_version est
1.8.0_391et si le composant ADMIN_SERVER est disponible, entrez la condition suivante.target.product.name == "Oracle Weblogic Server" AND target.product.properties.java_home == "1.8.0_391" AND target.product.components.ADMIN_SERVER.properties.Server == "AdminServer" - Mettre en pause l'exécution : option qui arrête l'exécution du bloc d'exécution jusqu'à ce que vous interveniez ou que la durée définie expire. La pause se produit avant l'exécution d'une tâche.
- Notification : vous informe à l'aide du service OCI Notification du statut de la tâche.
Propriétés de tâche
Les tâches incluent une propriété supplémentaire par rapport à un groupe. La description du bien est la suivante :
Mise en correspondance de variables de sortie : pour le type de tâche Exécuter un script, la sortie des journaux de script est analysée pour évaluer la valeur de la VARIABLE d'entrée avec une correspondance de modèle $$VARIABLE=VALUE$$.
- Cochez la case Output Variable et ajoutez une variable de sortie. L'exécution du script Fleet Application Management garantit que la variable de sortie est remplie.
- Dans la tâche suivante, cochez la case Input Variable et ajoutez une variable d'entrée.
- Mettez le nom de la variable d'entrée en correspondance avec le nom de la variable de sortie des tâches précédentes à l'aide de la mise en correspondance de variables de sortie.
Le script Fleet Application Management analyse désormais les journaux de sortie pour identifier un modèle tel que $$VARIABLE=VALUE$$.
Onglet Bibliothèque
L'onglet Bibliothèque des tâches fournit une liste des tâches réutilisables prêtes à l'emploi qui existent dans Fleet Application Management ou que vous avez créées. Vous pouvez utiliser l'icône de poignée de glisser-déplacer (
) dans le coin droit d'une tâche pour la faire glisser dans la zone de travail du guide d'exploitation sur le canevas. La bibliothèque affiche uniquement les tâches pertinentes pour un guide d'exploitation en fonction de la pile de produits ou de produits et du type de système d'exploitation.
Tâches d'annulation
Pour annuler une tâche définie en cas d'échec, vous pouvez ajouter un groupe, puis ajouter les tâches à annuler dans l'espace réservé Annuler les tâches dans la zone de travail du canevas. Pour annuler, assurez-vous de sélectionner la propriété de tâche On Failure en tant que Rollback sous Tasks pour la tâche spécifique.
Vous pouvez définir l'annulation sur des niveaux cible ou de groupe d'actions. Cette portée signifie que Fleet Application Management exécute les tâches d'annulation sur une cible spécifique ou sur tous les groupes de cibles. Les tâches d'annulation s'exécutent sur la cible et échouent si vous définissez la portée d'une cible, tandis que les tâches d'annulation s'exécutent sur tous les groupes de cibles si vous définissez la portée d'un groupe d'actions.
Canevas
Après avoir déterminé une action à ajouter au concepteur visuel, faites glisser un composant dans la zone de travail du canevas. Pour modifier l'ordre des composants, utilisez l'icône de poignée de glisser-déplacer () dans le coin droit d'un composant pour le faire glisser vers un autre emplacement de la zone de travail du guide d'exploitation. Cette nouvelle action est ajoutée à la zone de travail et son code est généré automatiquement.
raccourcis clavier pour la navigation
| raccourci clavier | Action |
|---|---|
| Tab | Accédez au focus sur l'élément de classeur suivant. |
| Shift+Tab | Naviguez jusqu'à l'élément de classeur précédent. |
| Touches fléchées | Déplacez un composant après celui-ci sur le canevas. Exemples :
|
| Barre d'espace ou entrée/entrée | Sélectionnez un composant dans l'onglet Composants ou Propriétés, ou un élément de bloc d'exécution. |
| Echap | Annuler le déplacement d'un composant sur le canevas ou toute action avant qu'il ne soit déclenché. |
| Barre d'espace ou entrée | Déclencher une activité appropriée lorsque l'accent est mis sur l'un des composants, propriétés ou éléments du classeur d'exécution. Exemples :
|