Préparez l'utilisation des workflows
Vous devez aussi connaître l'entreprise et le format des workflows Astra avant de les utiliser avec un déploiement en direct.
Introduction
Un workflow est une séquence d'une ou de plusieurs étapes nécessaires à la réalisation d'une tâche ou d'un objectif administratif spécifique. Chaque étape d'un workflow de contrôle Astra est l'une des suivantes :
-
Appel d'API REST (avec des détails tels que des exemples Curl et JSON)
-
Appel d'un autre flux de travail Astra
-
Tâche associée divers (par exemple, prise d'une décision de conception requise)
Ces flux de travail incluent les étapes clés et les paramètres nécessaires à l'exécution de chaque tâche. Ils constituent un point de départ pour la personnalisation de votre environnement d'automatisation.
Un flux de travail ne peut contenir qu'une seule étape. Le format de ces flux de travail à une étape est légèrement différent de celui des flux de travail contenant plusieurs étapes. Par exemple, le nom explicite de l'étape est supprimé. L'action ou l'opération doit être claire en fonction du titre du flux de travail. |
Catégories de flux de travail
Selon votre modèle de déploiement, vous pouvez consulter deux catégories de workflows Astra, Si vous utilisez Astra Control Center, vous devez d'abord les workflows d'infrastructure, puis passer aux workflows de gestion. Avec Astra Control Service, vous pouvez généralement accéder directement aux workflows de gestion.
Les exemples de boucles dans les workflows utilisent l'URL d'Astra Control Service. Vous devez modifier l'URL lorsque vous utilisez le centre de contrôle Astra sur site en fonction de votre environnement. |
Workflows d'infrastructure
Ces workflows sont associés à l'infrastructure Astra, notamment les identifiants, les compartiments et les systèmes de stockage back-end. Elles sont nécessaires avec le centre de contrôle Astra, mais dans la plupart des cas peuvent également être utilisées avec le service de contrôle Astra. Les flux de travail se concentrent sur les tâches requises pour établir et gérer un cluster géré par Astra.
Flux de travail de gestion
Vous pouvez utiliser ces flux de travail après avoir configuré un cluster géré. Les workflows de gestion sont axés sur la protection des applications et sur des opérations telles que la sauvegarde, la restauration et le clonage d'une application.
Paramètres d'entrée communs
Les paramètres d'entrée décrits ci-dessous sont communs à tous les échantillons curl utilisés pour illustrer un appel API REST.
Comme ces paramètres d'entrée sont universellement requis, ils ne sont pas décrits plus en détail dans les flux de travail individuels. Si des paramètres d'entrée supplémentaires sont utilisés pour un exemple de boucle spécifique, ils sont décrits dans la section Paramètres d'entrée supplémentaires. |
Paramètres de chemin
Le chemin du noeud final utilisé avec chaque appel d'API REST inclut les paramètres suivants. Voir aussi "Format d'URL" pour en savoir plus.
- ID de compte
-
Il s'agit de la valeur UUIDv4 identifiant le compte Astra sur lequel l'opération API s'exécute. Voir "Obtenir un jeton API" Pour plus d'informations sur la localisation de votre identifiant de compte.
En-têtes de demande
En fonction de l'appel d'API REST, vous devrez peut-être inclure plusieurs en-têtes de requête.
- Autorisation
-
Tous les appels d'API dans les workflows requièrent un jeton d'API pour identifier l'utilisateur. Vous devez inclure le token dans le
Authorization
en-tête de demande. Voir "Obtenir un jeton API" Pour plus d'informations sur la génération d'un jeton API. - Types de contenu
-
Avec LA PUBLICATION HTTP et LES requêtes PUT où JSON est inclus dans le corps de la demande, vous devez déclarer le type de support en fonction de la ressource Astra. Par exemple, vous pouvez inclure l'en-tête
Content-Type: application/astra-appSnap+json
lors de la création d'un snapshot pour une application gérée. - Accepter
-
Vous pouvez déclarer le type de support spécifique du contenu que vous attendez dans la réponse en fonction de la ressource Astra. Par exemple, vous pouvez inclure l'en-tête
Accept: application/astra-appBackup+json
lors de la liste des sauvegardes pour une application gérée. Cependant, pour plus de simplicité, les échantillons curl dans les flux de production acceptent tous les types de support.
Présentation des jetons et des identificateurs
Le jeton API et les autres valeurs d'ID utilisées avec les exemples de boucles sont opaques sans signification perceptible. Afin d'améliorer la lisibilité des échantillons, les valeurs réelles de jeton et d'ID ne sont pas utilisées. Des mots-clés réservés plus petits sont utilisés, ce qui présente plusieurs avantages :
-
Les échantillons curl et JSON sont plus clairs et plus faciles à comprendre.
-
Comme tous les mots-clés utilisent le même format avec des crochets et des lettres majuscules, vous pouvez rapidement identifier l'emplacement et le contenu à insérer ou extraire.
-
Aucune valeur n'est perdue car les paramètres d'origine ne peuvent pas être copiés et utilisés avec un déploiement réel.
Les variables sont formatées pour être utilisées dans un environnement shell Bash. Chaque variable commence par un signe dollar et est placée entre guillemets si nécessaire. Cela les rend reconnaissables à Bash. La casse supérieure est toujours utilisée pour les noms.
Voici quelques-uns des mots-clés réservés communs utilisés dans les exemples curl. Cette liste n'est pas exhaustive et des mots-clés supplémentaires sont utilisés au besoin. Leur signification devrait être évidente sur la base du contexte.
Mot-clé | Type | Description |
---|---|---|
$ACCOUNT_ID |
Chemin |
Valeur UUIDv4 identifiant le compte sur lequel l'opération API s'exécute. |
$API_TOKEN |
En-tête |
Le jeton porteur identifiant et autorise l'appelant. |
$APP_ID |
Chemin |
Valeur UUIDv4 identifiant l'application pour l'appel d'API. |
En utilisant les exemples avec Bash
Si vous utilisez directement les exemples de boucles de flux de travail, vous devez mettre à jour les variables qu'ils contiennent avec les valeurs appropriées à votre environnement. Vous pouvez modifier manuellement les exemples ou vous appuyer sur le shell de hachage pour effectuer la substitution, comme décrit ci-dessous.
L'un des avantages de Bash est que vous pouvez définir les valeurs de variable une fois dans une session shell au lieu d'une fois par commande curl. |
-
Ouvrez le shell Bash fourni avec Linux ou un système d'exploitation similaire.
-
Définissez les valeurs variables incluses dans l'exemple de boucle que vous souhaitez exécuter. Par exemple :
$API_TOKEN=SGgpXHeco6M8PLxzIlgbztA4k3_eX4UCa842hOXHBFA=
-
Copiez l'exemple de boucle depuis la page de flux de travail et collez-le dans le terminal shell.
-
Appuyez sur ENTER pour effectuer les tâches suivantes :
-
Remplacez les valeurs de variable que vous avez définies.
-
Exécutez la commande curl.
-