Configuration des objets globaux pour l' Orchestration Pipelines
Utilisez des objets globaux pour créer des constantes configurables afin de configurer votre pipeline lors de l'exécution. Utilisez des paramètres ou des variables utilisateur dans les pipelines pour spécifier des valeurs lors de l'exécution, plutôt que de les coder en dur. Contrairement aux paramètres de pipeline, les variables utilisateur peuvent être définies dynamiquement pendant le flux.
En savoir plus sur la création:
Paramètres de pipeline
Utilisez les paramètres de pipeline pour spécifier une valeur lors de l'exécution du pipeline. Par exemple, si vous souhaitez qu'un utilisateur entre un espace de déploiement pour la sortie de pipeline, utilisez un paramètre pour demander le nom de l'espace à utiliser lors de l'exécution du pipeline. La spécification de la valeur du paramètre chaque fois que vous exécutez le travail vous aide à utiliser les ressources appropriées.
A propos des paramètres de pipeline:
- peut être affectée en tant que valeur de noeud ou pour le travail de pipeline.
- peut être affecté à n'importe quel noeud et un indicateur de statut vous alerte.
- peut être utilisé pour plusieurs noeuds.
Définition d'un paramètre de pipeline
- Créez un paramètre de pipeline à partir du panneau de configuration de noeud de la barre d'outils.
- Entrez un nom et une description facultative. Le nom doit être un serpent minuscule avec des lettres minuscules, des chiffres et des traits de soulignement. Par exemple,
lower_snake_case_with_numbers_123est un nom valide. Le nom doit commencer par une lettre. Si le nom n'est pas conforme, vous obtenez une erreur 404 lorsque vous tentez d'exécuter le pipeline. - Affectez un type de paramètre. En fonction du type de paramètre, vous devrez peut-être fournir plus de détails ou affecter une valeur par défaut.
- Cliquez sur Ajouter à la liste pour sauvegarder le paramètre de pipeline.
-Vous pouvez définir un paramètre individuel ou créer un ensemble de paramètres. Les paramètres que vous définissez individuellement peuvent également être ajoutés à un ensemble.
-Il est possible d'utiliser un paramètre de pipeline de manière à générer des résultats non pris en charge dans un pipeline. Si vous affectez un paramètre avec un actif générique comme valeur, vous pouvez sélectionner un actif comme valeur de paramètre qui n'est pas prise en charge par le noeud Copier l'actif .
Types de paramètre
Les types de paramètre sont catégorisés comme suit:
- De base: inclut des types de données pour structurer l'entrée dans un pipeline ou des options permettant de gérer la création d'un espace ou d'un actif en double.
- Ressource: permet de sélectionner un projet, un catalogue, un espace ou un actif.
- Instance: pour la sélection d'une instance d'apprentissage automatique ou d'une instance Cloud Object Storage .
- Autre: pour spécifier des détails, tels que le mode de création ou la règle d'erreur.
Exemple d'utilisation de types de pipeline
Pour créer un paramètre de type Chemin:
- Créez un ensemble de paramètres appelé MASTER_PARAMETER_SET.
- Créez un paramètre appelé
file_pathet définissez le type sur Chemin. - Définissez la valeur de
file_pathsurmnts/workspace/masterdir. Vous pouvez définir la valeur de plusieurs manières:- Sélectionner une ressource: recherchez le fichier dans vos portées à l'aide de l'interface utilisateur.
- Entrez la valeur: texte valide pour le chemin relatif du fichier, par exemple
/mnts/sender.txt.
- Faites glisser le noeud Attendre le fichier sur l'espace de travail et définissez la valeur Emplacement du fichier sur
MASTER_PARAMETER_SET.file_path. - Connectez le Attendre le fichier au noeud Exécuter le script Bash afin que ce dernier s'exécute après le premier.
- Facultatif: testez votre variable de paramètre:
- Ajoutez le paramètre de variable d'environnement à votre ensemble de paramètres MASTER_PARAMETER_SET , par exemple
FILE_PATH. - Collez la commande suivante dans le code de script du script Run Bash:
echo File: $FILE_PATH cat $FILE_PATH
- Ajoutez le paramètre de variable d'environnement à votre ensemble de paramètres MASTER_PARAMETER_SET , par exemple
- Exécutez le pipeline. Le chemin
mnts/workspace/masterdirse trouve dans les deux journaux d'exécution des noeuds pour voir s'ils ont été transmis.
Paramètres chiffrés
Vous pouvez fournir des valeurs secrètes aux paramètres de travail pour garantir la confidentialité et la sécurité de vos données. En utilisant le type de paramètre chiffré, vous pouvez fournir des valeurs de paramètre localement et les valeurs de paramètre ne sont jamais exposées ou écrites dans des sources externes.
Planification de l'utilisation de données chiffrées
Les types de données chiffrées sont conservés en interne en tant que paramètres. Lorsque vous le transmettez en tant que variable d'environnement, il est stocké en tant que fichier monté temporairement.
Lorsque vous prévoyez d'utiliser le type de données chiffré, tenez compte des types de données chiffrés suivants:
- sont disponibles uniquement pour les paramètres de pipeline, les valeurs d'ensemble de paramètres et les variables d'environnement.
- doit être une valeur unique (aucune liste chiffrée).
Meilleures pratiques pour l'utilisation de données chiffrées
- N'utilisez pas de valeurs par défaut pour les types de données chiffrées car ces valeurs sont stockées sous forme chiffrée.
- Par conséquent, utilisez les types d'entrée et de sortie de données dans le Générateur de formules. Les valeurs chiffrées qui sont fournies sous forme d'expressions produisant un littéral chaîne (par exemple, "ma valeur confidentielle") sont utilisées en tant que texte en clair.
Exemple d'utilisation de paramètres chiffrés
- Créez un ensemble de paramètres appelé MASTER_PARAMETER_SET.
- Créez un paramètre appelé
dummy_passet définissez le type sur Chiffré. - Définissez la valeur de
dummy_passsur n'importe quelle valeur. - Faites glisser le noeud Exécuter le script Bash sur l'espace de travail.
- Ajoutez une variable d'environnement appelée DB2PASSWORD et affectez sa valeur à MASTER_PARAMETER_SET.dummy_pass.
- Facultatif: testez votre variable de paramètre:
- Collez la commande suivante dans le code de script du script Run Bash:
PARAM_VAL=$(<"$DB2PASSWORD") echo $PARAM_VAL
- Collez la commande suivante dans le code de script du script Run Bash:
- Exécutez le pipeline. Consultez le mot de passe factice dans le journal du noeud Exécuter le script Bash et
PARAM_VALse voit désormais attribuer la valeur$DB2PASSWORD.
Configuration d'un noeud avec un paramètre de pipeline
Lorsque vous configurez un noeud avec un paramètre de pipeline, vous pouvez choisir un paramètre de pipeline existant ou en créer un nouveau dans le cadre de la configuration d'un noeud.
Par exemple :
- Créez un paramètre de pipeline appelé creationmode et enregistrez-le dans la liste des paramètres.
- Configurez un noeud Créer un espace de déploiement et cliquez pour ouvrir le panneau de configuration.
- Choisissez le Paramètre de pipeline comme entrée pour l'option Mode de création .
- Choisissez le paramètre de pipeline creationmode et sauvegardez la configuration.
Lorsque vous exécutez le flux, le paramètre de pipeline est affecté lors de la création de l'espace.
Ensembles de paramètres
Les ensembles de paramètres sont un groupe de paramètres associés à utiliser dans un pipeline. Par exemple, vous pouvez créer un ensemble de paramètres à utiliser dans un environnement de test et un autre à utiliser dans un environnement de production.
Les ensembles de paramètres peuvent être créés en tant qu'actif de projet. Les ensembles de paramètres créés dans le projet sont alors disponibles pour être utilisés dans les pipelines de ce projet.
Création d'un ensemble de paramètres en tant qu'actif de projet
Vous pouvez créer un ensemble de paramètres en tant qu'actif de projet réutilisable à utiliser dans des pipelines.
- Ouvrez un projet existant ou créez un projet.
- Cliquez sur « Nouvel élément » > « Définir des ensembles de paramètres réutilisables ».
- Attribuez un nom à l'ensemble et spécifiez les détails de chaque paramètre de l'ensemble, notamment:
- Nom du paramètre
- Type de données
- Invite
- Valeur par défaut
- Vous pouvez éventuellement créer des ensembles de valeurs pour les paramètres de l'ensemble de paramètres. Les ensembles de valeurs peuvent être des valeurs différentes pour différents contextes. Par exemple, vous pouvez créer un ensemble de valeurs de test avec des valeurs pour un environnement de test et un ensemble de valeurs de production.
- Sauvegardez l'ensemble de paramètres après avoir créé tous les paramètres, s. Il peut être utilisé dans les pipelines créés dans ce projet.
Ajout d'un ensemble de paramètres à utiliser dans un pipeline
Pour ajouter un ensemble de paramètres à partir d'un projet:
- Cliquez sur l'icône des objets globaux et accédez à l' onglet Ensembles de paramètres.
- Cliquez sur Ajouter un ensemble de paramètres pour ajouter des ensembles de paramètres à partir de votre projet que vous souhaitez utiliser dans votre pipeline.
- Vous pouvez ajouter ou supprimer des ensembles de paramètres de la liste. Les ensembles de paramètres que vous spécifiez pour une utilisation dans votre pipeline deviennent disponibles lorsque vous affectez des paramètres en tant qu'entrée dans le pipeline.
Création d'un ensemble de paramètres à partir de la liste de paramètres dans votre pipeline
Vous pouvez créer un ensemble de paramètres à partir de la liste des paramètres de votre pipeline
- Cliquez sur l'icône des objets globaux et ouvrez les paramètres de pipeline.
- Sélectionnez les paramètres de votre choix dans l'ensemble, puis cliquez sur l'icône Sauvegarder en tant qu'ensemble de paramètres .
- Entrez un nom et une description facultative pour l'ensemble.
- Sauvegardez pour ajouter l'ensemble de paramètres à utiliser dans votre pipeline.
Utilisation d'un ensemble de paramètres dans un pipeline
Pour utiliser un ensemble de paramètres:
- Choisissez Affecter un paramètre de pipeline comme type d'entrée à partir d'une feuille de propriétés de noeud.
- Choisissez le paramètre à affecter. Une liste affiche tous les paramètres disponibles du type pour cette entrée. Les paramètres disponibles peuvent être des paramètres individuels et des paramètres définis dans le cadre d'un ensemble. Le nom de l'ensemble de paramètres précède le nom du paramètre. Par exemple, Parameter_set_name.Parameter_name.
- Exécutez le pipeline et sélectionnez une valeur définie pour la valeur correspondante (si disponible), affectez une valeur au paramètre ou acceptez la valeur par défaut.
Utilisation des ensembles de paramètres par défaut du projet
Un projet peut avoir un ensemble de paramètres nommé PROJDEF. Cet ensemble de paramètres contient les paramètres et les valeurs de variable d'environnement d'un travail ou d'une exécution de travail Pipelines. Comme il s'agit d'un ensemble de paramètres, vous pouvez utiliser l'interface utilisateur de l'ensemble de paramètres existant pour gérer ces variables. L'ensemble de paramètres peut être importé dans d'autres projets.
Méfiez-vous des PROJDEF:
- Vous pouvez référencer une valeur d'ensemble de paramètres PROJDEF avec la valeur PROJDEF du paramètre de pipeline.
- La valeur PROJDEF est prise en charge pour les paramètres de tous les types, mais uniquement pour les variables d'environnement définies par l'utilisateur PROJDEF chiffrées et de type chaîne.
- Les paramètres de l'ensemble de paramètres PROJDEF doivent utiliser le même nom que les paramètres de pipeline ayant la valeur PROJDEF.
Pour utiliser PROJDEF dans un projet:
Créez l'ensemble de paramètres PROJDEF.
Ajoutez le paramètre à votre jeu de paramètres PROJDEF, par exemple
$DB2_USERID.Ajoutez une variable définie par l'utilisateur portant le même nom dans votre flux de pipelines.
Ajoutez une variable définie par l'utilisateur portant le même nom dans votre flux de pipelines.
Cliquez sur Editer les paramètres locaux ou sur Editer l'ensemble de paramètres pour ce travail en fonction de l'endroit où votre variable est créée.
Cliquez sur Assign PROJDEF dans le menu déroulant Valeur dérivée de pour la variable. Si PROJDEF n'est pas disponible, l'option de menu n'apparaît pas.
Facultatif: Pour entrer une valeur de variable à partir d'une autre méthode, cliquez sur l'icône de déconnexion.
Pour affecter PROJDEF à tous les paramètres d'un ensemble:
- Editez vos ensembles de valeurs en cliquant sur Editer les valeurs pour ce travail ou une valeur similaire.
- Cliquez sur la liste déroulante Ensemble de paramètres source .
- Sélectionnez PROJDEF.
Edition d'un ensemble de paramètres dans un travail
Si vous utilisez un ensemble de paramètres lorsque vous définissez un travail, vous pouvez choisir un ensemble de valeurs pour remplir les variables avec les valeurs de cet ensemble. Si vous modifiez et sauvegardez les valeurs, puis éditez le travail et sauvegardez les modifications, les valeurs par défaut des ensembles de paramètres sont rétablies.
Variables utilisateur
Créez des variables utilisateur pour affecter des valeurs lors de l'exécution du flux. Contrairement aux paramètres de pipeline, les variables utilisateur peuvent être modifiées lors du traitement.
Définition d'une variable utilisateur
Vous pouvez créer des variables utilisateur à utiliser dans votre pipeline. Les variables utilisateur, telles que les paramètres, sont définies au niveau global et ne sont spécifiques à aucun noeud. La valeur initiale d'une variable utilisateur doit être définie lorsque vous la définissez et ne peut pas être définie dynamiquement en tant que résultat d'une sortie de noeud. Lorsque vous définissez une variable utilisateur, vous pouvez utiliser le noeud Définir des variables utilisateur pour la mettre à jour avec la sortie du noeud.
Pour créer une variable utilisateur:
- Créez une variable à partir du panneau de configuration du noeud Mettre à jour la variable ou de la barre d'outils.
- Entrez un nom et une description facultative. Le nom doit être un serpent minuscule avec des lettres minuscules, des chiffres et des traits de soulignement. Par exemple, lower_snake_case_with_numbers_123 est un nom valide. Le nom doit commencer par une lettre. Si le nom n'est pas conforme, vous obtenez une erreur 404 lorsque vous tentez d'exécuter le pipeline.
- Complétez la définition de la variable, y compris le choix d'un type de variable et d'un type d'entrée.
- Cochez l'option Rendre la valeur de la variable utilisateur disponible comme résultat du pipeline. L'option active l'utilisation de la valeur en tant que sortie à partir de tout noeud Exécuter le travail de pipeline qui s'exécute dans ce pipeline. Pour plus d'informations sur l'utilisation, voir Variables utilisateur dans les résultats de pipeline .
- Cliquez sur Ajouter pour ajouter la variable à la liste. Il est désormais disponible pour être utilisé dans un noeud.
Variables utilisateur dans les résultats de pipeline
Si une variable utilisateur peut être utilisée en conséquence, elle devient disponible en tant que sortie dans tous les travaux associés à ce pipeline.
Un cas d'utilisation courant consiste à pouvoir utiliser une valeur calculée dans un pipeline à partir d'un autre pipeline qui l'exécute. Vous pouvez stocker le nom de fichier dans une variable utilisateur, puis exécuter ce pipeline à partir d'un autre pipeline avec le nom de fichier comme entrée dans un script Bash.
Configurer les caractéristiques de la carte
Les fonctions suivantes sont activées par la mise à jour des paramètres de la carte de configuration.
Configuration de la limite de taille pour une variable utilisateur
Vous pouvez modifier la taille des variables utilisateur dans votre mappe de configuration de pipelines.
- Ouvrez votre mappe de configuration en exécutant la commande
kubectl edit -n <namespace> configmap watson-pipelines-configoùnamespaceest votre espace de nom d'instance Cloud Pak for Data . - Définissez la valeur de
user_variables_size_limitavec la valeur au format de quantité Kubernetes . - Redémarrez vos pods Tekton en exécutant la commande
kubectl -n <namespace> delete pod -l 'app=tekton-extensions-controller'.
Définir un fuseau horaire
Vous pouvez définir le fuseau horaire dans votre mappe de configuration.
- Ouvrez votre mappe de configuration en exécutant la commande
kubectl edit -n <namespace> configmap watson-pipelines-configoùnamespaceest votre espace de nom d'instance Cloud Pak for Data . - Définissez la valeur de votre fuseau horaire avec l'exemple de code suivant:
apiVersion: v1 kind: ConfigMap metadata: name: watson-pipelines-config namespace: zen data: default_container_env: | - name: TZ value: America/New_York - Définissez la valeur de votre fuseau horaire dans Pipelines CR :
oc patch wspipelines wspipelines-cr -p '{"spec":{"timezone":"America/New_York"}}' --type=merge - Attendez la fin de la réconciliation avec :
oc get wspipelines wspipelines-cr