Utilisation des pipelines de configuration config-pipelines

Découvrez comment utiliser les pipelines de configuration pour déployer différentes configurations dans AEM as a Cloud Service, telles que les paramètres de transfert de journal, les tâches de maintenance liées à la purge et diverses configurations du réseau de diffusion de contenu.

Vue d’ensemble overview

Un pipeline de configuration Cloud Manager déploie les fichiers de configuration (créés au format YAML) dans un environnement cible. Un certain nombre de fonctionnalités d’AEM as a Cloud Service peuvent être configurées de cette manière, notamment le transfert de journal, les tâches de maintenance liées à la purge et plusieurs fonctionnalités de réseau de diffusion de contenu.

Les pipelines de configuration peuvent être déployés via Cloud Manager pour les types d’environnements de développement, d’évaluation et de production dans les programmes de production (hors environnements de test). Les RDE ne sont pas pris en charge.

Les sections suivantes de ce document donnent un aperçu d’informations importantes concernant la manière dont les pipelines de configuration peuvent être utilisés et la manière dont les configurations doivent être structurées. Il décrit les concepts généraux partagés sur l’ensemble ou un sous-ensemble des fonctionnalités prises en charge par les pipelines de configuration.

Configurations prises en charge configurations

Le tableau suivant propose une liste complète de ces configurations avec des liens vers une documentation dédiée décrivant sa syntaxe de configuration distincte et d’autres informations.

Création et gestion des pipelines de configuration creating-and-managing

Pour plus d’informations sur la création et la configuration des pipelines, voir le document Pipelines CI/CD.

Lors de la création d’un pipeline de configuration dans Cloud Manager, veillez à sélectionner un déploiement ciblé plutôt que le code de pile complet lors de la configuration du pipeline.

Syntaxe commune common-syntax

Chaque fichier de configuration commence par des propriétés qui ressemblent à l’exemple de fragment de code suivant :

  kind: "LogForwarding"
  version: "1"
  metadata:
    envTypes: ["dev"]

Vous pouvez utiliser l’utilitaire yq pour valider localement la mise en forme YAML de votre fichier de configuration (par exemple, yq cdn.yaml).

Structure de dossiers folder-structure

Un dossier nommé /config ou similaire doit se trouver en haut de l’arborescence, avec un fichier YAML supplémentaire quelque part dans une arborescence en dessous.

Par exemple :

/config
  cdn.yaml

ou

/config
  /dev
    cdn.yaml

Les noms de dossiers et de fichiers sous /config sont arbitraires. Cependant, le fichier YAML doit inclure une valeur de propriété kind valide.

En règle générale, les configurations sont déployées dans tous les environnements. Si toutes les valeurs de propriété sont identiques pour chaque environnement, un seul fichier YAML suffit. Cependant, il est courant que les valeurs de propriété diffèrent d’un environnement à l’autre, par exemple lors du test d’un environnement plus faible.

Les sections suivantes illustrent certaines stratégies de structuration des fichiers.

Un seul fichier de configuration pour tous les environnements single-file

La structure du fichier ressemblera à ce qui suit :

/config
  cdn.yaml
  logForwarding.yaml

Utilisez cette structure lorsque la même configuration est suffisante pour tous les environnements et pour tous les types de configuration (CDN, transfert de logs, etc.). Dans ce scénario, la propriété de tableau envTypes inclurait tous les types d’environnements.

   kind: "cdn"
   version: "1"
   metadata:
     envTypes: ["dev", "stage", "prod"]

À l’aide de variables d’environnement de type secret, il est possible que propriétés secrètes varie par environnement, comme illustré par la référence ${{SPLUNK_TOKEN}}

kind: "LogForwarding"
version: "1"
metadata:
  envTypes: ["dev"]
data:
  splunk:
    default:
      enabled: true
      host: "splunk-host.example.com"
      token: "${{SPLUNK_TOKEN}}"
      index: "AEMaaCS"

Un fichier distinct par type d’environnement file-per-env

La structure du fichier ressemblera à ce qui suit :

/config
  cdn-dev.yaml
  cdn-stage.yaml
  cdn-prod.yaml
  logForwarding-dev.yaml
  logForwarding-stage.yaml
  logForwarding-prod.yaml

Utilisez cette structure lorsqu’il peut y avoir des différences dans les valeurs de propriété. Dans les fichiers, on s’attend à ce que la valeur du tableau envTypes corresponde au suffixe, par exemple
cdn-dev.yaml et logForwarding-dev.yaml avec une valeur de ["dev"], cdn-stage.yaml et logForwarding-stage.yaml avec une valeur de ["stage"], etc.

Un dossier par environnement folder-per-env

Dans cette stratégie, il existe un dossier config distinct par environnement, avec un pipeline distinct déclaré dans Cloud Manager pour chacun d’eux.

Cette approche est particulièrement utile si vous disposez de plusieurs environnements de développement, où chacun possède des valeurs de propriété uniques.

La structure du fichier ressemblera à ce qui suit :

/config/dev1
  cdn.yaml
  logForwarding.yaml
/config/dev2
  cdn.yaml
  logForwarding.yaml
/config/prod
  cdn.yaml
  logForwarding.yaml

Une variante de cette approche consiste à conserver une branche distincte par environnement.

Variables d’environnement secrètes secret-env-vars

Pour que les informations sensibles n’aient pas besoin d’être stockées dans le contrôle de code source, les fichiers de configuration prennent en charge les variables d’environnement Cloud Manager de type secret. Pour certaines configurations, y compris le transfert des logs, les variables d’environnement secrètes sont obligatoires pour certaines propriétés.

Le fragment de code ci-dessous est un exemple d’utilisation de la variable d’environnement secrète ${{SPLUNK_TOKEN}} dans la configuration.

kind: "LogForwarding"
version: "1"
metadata:
  envTypes: ["dev"]
data:
  splunk:
    default:
      enabled: true
      host: "splunk-host.example.com"
      token: "${{SPLUNK_TOKEN}}"
      index: "AEMaaCS"

Pour plus d’informations sur l’utilisation des variables d’environnement, voir le document Variables d’environnement Cloud Manager .