Configurazione di OSGi per Adobe Experience Manager as a Cloud Service configuring-osgi-for-aem-as-a-cloud-service

OSGi è un elemento fondamentale nello stack tecnologico di Adobe Experience Manager (AEM). Viene utilizzato per controllare i bundle compositi dell'AEM e le sue configurazioni.

OSGi fornisce le primitive standardizzate che consentono di creare applicazioni partendo da componenti piccoli, riutilizzabili e collaborativi. Questi componenti possono essere composti in un’applicazione e distribuiti. Questo consente di gestire facilmente i bundle OSGi che possono essere arrestati, installati e avviati singolarmente. Le interdipendenze vengono gestite automaticamente. Ogni componente OSGi è contenuto in uno dei vari bundle. Per ulteriori informazioni, vedere la specifica OSGi.

Puoi gestire le impostazioni di configurazione per i componenti OSGi tramite i file di configurazione che fanno parte di un progetto di codice AEM.

File di configurazione OSGi osgi-configuration-files

Le modifiche alla configurazione sono definite nei pacchetti di codice del progetto AEM (ui.config) come file di configurazione (.cfg.json) nelle cartelle di configurazione specifiche in modalità di esecuzione:

/apps/example/config.<runmode>

Il formato dei file di configurazione OSGi è basato su JSON e utilizza il formato .cfg.json definito dal progetto Apache Sling.

Le configurazioni OSGi eseguono il targeting dei componenti OSGi tramite il PID (Persistent Identity), che per impostazione predefinita corrisponde al nome della classe Java™ del componente OSGi. Ad esempio, per fornire la configurazione OSGi per un servizio OSGi implementato da:

com.example.workflow.impl.ApprovalWorkflow.java

un file di configurazione OSGi è definito in:

/apps/example/config/com.example.workflow.impl.ApprovalWorkflow.cfg.json

segue il formato di configurazione OSGi cfg.json.

Risoluzione runmode runmode-resolution

Configurazioni OSGi specifiche possono essere indirizzate a istanze AEM specifiche utilizzando modalità di esecuzione. Per utilizzare runmode, creare cartelle di configurazione in /apps/example (dove ad esempio è il nome del progetto), nel formato:

/apps/example/config.<author|publish>.<dev|stage|prod>/

Tutte le configurazioni OSGi in tali cartelle vengono utilizzate se le modalità di esecuzione definite nel nome della cartella di configurazione corrispondono a quelle utilizzate dall’AEM.

Ad esempio, se l'AEM utilizza le modalità di esecuzione Author e Dev, vengono applicati i nodi di configurazione in /apps/example/config.author/ e /apps/example/config.author.dev/, mentre i nodi di configurazione in /apps/example/config.publish/ e /apps/example/config.author.stage/ non vengono applicati.

Se sono applicabili più configurazioni per lo stesso PID, viene applicata la configurazione con il maggior numero di modalità di esecuzione corrispondenti.

La granularità di questa regola è a livello PID. Ciò significa che non è possibile definire alcune proprietà per lo stesso PID in /apps/example/config.author/ e altre più specifiche in /apps/example/config.author.dev/ per lo stesso PID. La configurazione con il maggior numero di modalità di esecuzione corrispondenti è efficace per l’intero PID.

Quando si sviluppa localmente, un parametro di avvio in modalità di esecuzione, -r, viene utilizzato per specificare la configurazione OSGI in modalità di esecuzione.

$ java -jar aem-sdk-quickstart-xxxx.x.xxx.xxxx-xxxx.jar -r publish,dev

Verifica delle modalità di esecuzione

Le modalità di esecuzione di AEM as a Cloud Service sono ben definite in base al tipo di ambiente e al servizio. Rivedi l'elenco completo delle modalità di esecuzione di AEM as a Cloud Service disponibili.

I valori di configurazione OSGi specificati dalla modalità di esecuzione possono essere verificati da:

La vista risultante mostra tutte le configurazioni dei componenti OSGi per i livelli selezionati con i relativi valori di configurazione OSGi applicabili. È possibile fare riferimento a questi valori con i valori di configurazione OSGi nel codice sorgente del progetto AEM in /apps/example/osgiconfig/config.<runmode(s)>.

Per verificare che vengano applicati i valori di configurazione OSGi appropriati:

Tipi di valori di configurazione OSGi types-of-osgi-configuration-values

Esistono tre varietà di valori di configurazione OSGi che possono essere utilizzati con Adobe Experience Manager as a Cloud Service.

Come scegliere il tipo di valore di configurazione OSGi appropriato how-to-choose-the-appropriate-osgi-configuration-value-type

Nel caso comune di OSGi, vengono utilizzati i valori di configurazione OSGi in linea. Le configurazioni specifiche dell’ambiente vengono utilizzate solo per casi d’uso specifici in cui un valore differisce tra ambienti di sviluppo.

Le configurazioni specifiche per l’ambiente estendono le configurazioni OSGi tradizionali definite in modo statico che contengono valori in linea, consentendo di gestire i valori di configurazione OSGi esternamente tramite l’API Cloud Manager. È importante capire quando deve essere utilizzato l’approccio comune e tradizionale per definire i valori in linea e memorizzarli in Git, anziché astrarre i valori in configurazioni specifiche per l’ambiente.

Le seguenti indicazioni spiegano quando utilizzare configurazioni non segrete e segrete specifiche per l’ambiente:

Quando utilizzare i valori di configurazione in linea when-to-use-inline-configuration-values

I valori delle configurazioni in linea sono considerati l’approccio standard e devono essere utilizzati quando possibile. Le configurazioni in linea offrono i vantaggi di:

Quando definisci un valore di configurazione OSGi, inizia con valori in linea e seleziona solo configurazioni segrete o specifiche dell’ambiente, se necessario per il caso d’uso.

Quando utilizzare valori di configurazione non segreti specifici dell’ambiente when-to-use-non-secret-environment-specific-configuration-values

Utilizzare solo configurazioni specifiche dell'ambiente ($[env:ENV_VAR_NAME]) per valori di configurazione non segreti quando i valori variano per il livello di anteprima o variano tra gli ambienti di sviluppo. Ciò include le istanze di sviluppo locali e qualsiasi ambiente di sviluppo Adobe Experience Manager as a Cloud Service. A parte l’impostazione di valori univoci per il livello di anteprima, evita di utilizzare configurazioni non segrete specifiche dell’ambiente per gli ambienti Adobe Experience Manager as a Cloud Service Stage o Production.

Quando utilizzare i valori di configurazione segreti specifici dell’ambiente when-to-use-secret-environment-specific-configuration-values

Adobe Experience Manager as a Cloud Service richiede l'utilizzo di configurazioni specifiche dell'ambiente ($[secret:SECRET_VAR_NAME]) per tutti i valori di configurazione OSGi segreti, ad esempio password, chiavi API private o qualsiasi altro valore che non può essere archiviato in Git per motivi di sicurezza.

Utilizza configurazioni segrete specifiche per l’ambiente per archiviare il valore dei segreti in tutti gli ambienti Adobe Experience Manager as a Cloud Service, inclusi Stage e Produzione.

Creazione di configurazioni OSGi creating-osgi-configurations

Esistono due modi per creare configurazioni OSGi, come descritto di seguito. Il primo approccio è in genere utilizzato per configurare componenti OSGi personalizzati con proprietà e valori OSGi noti da parte dello sviluppatore e il secondo per i componenti OSGi forniti dall’AEM.

Scrittura delle configurazioni OSGi writing-osgi-configurations

I file di configurazione OSGi in formato JSON possono essere scritti manualmente nel progetto AEM. Questo è spesso il modo più rapido per creare configurazioni OSGi per componenti OSGi noti, in particolare componenti OSGi personalizzati progettati e sviluppati dallo stesso sviluppatore che definisce le configurazioni. Questo approccio può essere utilizzato anche per copiare/incollare e aggiornare configurazioni per lo stesso componente OSGi in varie cartelle in modalità di esecuzione.

Generazione di configurazioni OSGi tramite QuickStart per SDK AEM generating-osgi-configurations-using-the-aem-sdk-quickstart

La console web AEM di Quickstart Jar per AEM SDK può essere utilizzata per configurare i componenti OSGi ed esportare le configurazioni OSGi come JSON. Questo è utile per configurare i componenti OSGi forniti dall’AEM le cui proprietà OSGi e i relativi formati di valore potrebbero non essere ben compresi dallo sviluppatore che definisce le configurazioni OSGi nel progetto AEM.

Formati delle proprietà di configurazione OSGi osgi-configuration-property-formats

Valori in linea inline-values

I valori in linea sono formattati come coppie nome-valore standard, seguendo la sintassi JSON standard. Ad esempio:

{
   "my_var1": "val",
   "my_var2": [ "abc", "def" ],
   "my_var3": 500
}

Valori di configurazione specifici per l’ambiente environment-specific-configuration-values

La configurazione OSGi deve assegnare un segnaposto per la variabile da definire in base all’ambiente:

use $[env:ENV_VAR_NAME]

I clienti devono utilizzare questa tecnica solo per le proprietà di configurazione OSGi relative al proprio codice personalizzato; non deve essere utilizzata per sostituire la configurazione OSGi definita da Adobe.

Valori di configurazione segreti secret-configuration-values

La configurazione OSGi deve assegnare un segnaposto per il segreto da definire in base all’ambiente:

use $[secret:SECRET_VAR_NAME]

Denominazione variabile variable-naming

Quanto segue si applica sia ai valori di configurazione specifici dell’ambiente che a quelli segreti.

I nomi delle variabili devono rispettare le seguenti regole:

I valori per le variabili non devono superare i 2048 caratteri.

Valori predefiniti default-values

Quanto segue si applica sia ai valori di configurazione specifici dell’ambiente che a quelli segreti.

Se non viene impostato alcun valore per ambiente, in fase di runtime il segnaposto non viene sostituito e viene lasciato sul posto poiché non si è verificata alcuna interpolazione. Per evitare questo problema, è possibile fornire un valore predefinito come parte del segnaposto con la seguente sintassi:

$[env:ENV_VAR_NAME;default=<value>]

Con un valore predefinito fornito, il segnaposto viene sostituito con il valore per ambiente, se fornito, o con il valore predefinito fornito.

Sviluppo locale local-development

Quanto segue si applica sia ai valori di configurazione specifici dell’ambiente che a quelli segreti.

Le variabili possono essere definite nell’ambiente locale in modo che vengano rilevate dall’AEM locale in fase di runtime. Ad esempio, su Linux®:

export ENV_VAR_NAME=my_value

Si consiglia di scrivere un semplice script bash che imposti le variabili di ambiente utilizzate nelle configurazioni e di eseguirlo prima di avviare l’AEM. Strumenti come https://direnv.net/ aiutano a semplificare questo approccio. A seconda del tipo di valori, potrebbero essere archiviati nella gestione del codice sorgente, se possono essere condivisi tra tutti.

I valori per i segreti vengono letti dai file. Pertanto, per ogni segnaposto che utilizza un segreto, è necessario creare un file di testo contenente il valore segreto.

Ad esempio, se si utilizza $[secret:server_password], è necessario creare un file di testo denominato server_password. Tutti questi file segreti devono essere archiviati nella stessa directory e la proprietà del framework org.apache.felix.configadmin.plugin.interpolation.secretsdir deve essere configurata con tale directory locale.

org.apache.felix.configadmin.plugin.interpolation.secretsdir è una proprietà del framework Sling; pertanto questa proprietà non è impostata nella console felix (https://experienceleague.adobe.com/system/console?lang=it), ma nel file sling.properties utilizzato all'avvio del sistema. Questo file si trova nel sottodir /conf della cartella Jar/install estratta (crx-quickstart/conf).

esempio: aggiungi questa riga alla fine del file 'crx-quickstart/conf/sling.properties' per configurare 'crx-quickstart/secretsdir' come cartella segreta:

org.apache.felix.configadmin.plugin.interpolation.secretsdir=${sling.home}/secretsdir

Configurazione Author e Publish author-vs-publish-configuration

Se una proprietà OSGi richiede valori diversi per Author e Publish:

Esempi di configurazione configuration-examples

Negli esempi seguenti, supponiamo che ci siano tre ambienti di sviluppo, oltre agli ambienti di stage e di produzione.

Esempio 1

L'intento è che il valore della proprietà OSGi my_var1 sia lo stesso per stage e prod, ma differisca per ciascuno dei tre ambienti di sviluppo.

{
 "my_var1": "val",
 "my_var2": "abc",
 "my_var3": 500
}

{
 "my_var1" : "$[env:my_var1]"
 "my_var2": "abc",
 "my_var3": 500
}

Esempio 2

L'obiettivo è quello di differenziare il valore della proprietà OSGi my_var1 per stage, prod e per ciascuno dei tre ambienti di sviluppo. Pertanto, è necessario chiamare l'API Cloud Manager per impostare il valore per my_var1 per ogni ambiente di sviluppo.

{
 "my_var1": "val1",
 "my_var2": "abc",
 "my_var3": 500
}

{
 "my_var1": "val2",
 "my_var2": "abc",
 "my_var3": 500
}

{
 "my_var1" : "$[env:my_var1]"
 "my_var2": "abc",
 "my_var3": 500
}

Esempio 3

L'obiettivo è che il valore della proprietà OSGi my_var1 sia lo stesso per gli ambienti di staging, produzione e solo per uno degli ambienti di sviluppo, ma differisca per gli altri due. In questo caso, è necessario chiamare l'API Cloud Manager per impostare il valore di my_var1 per ciascuno degli ambienti di sviluppo, incluso per l'ambiente di sviluppo che deve avere lo stesso valore di stage e produzione. Non erediterà il valore impostato nella cartella config.

{
 "my_var1": "val1",
 "my_var2": "abc",
 "my_var3": 500
}

{
 "my_var1" : "$[env:my_var1]"
 "my_var2": "abc",
 "my_var3": 500
}

Un altro modo per eseguire questa operazione consiste nell'impostare un valore predefinito per il token di sostituzione nella cartella config.dev in modo che sia lo stesso valore della cartella config.

{
 "my_var1": "val1",
 "my_var2": "abc",
 "my_var3": 500
}

{
 "my_var1": "$[env:my_var1;default=val1]"
 "my_var2": "abc",
 "my_var3": 500
}

Formato API Cloud Manager per l’impostazione delle proprietà cloud-manager-api-format-for-setting-properties

Per informazioni sull'API Cloud Manager e sulla relativa configurazione, vedere Adobe Cloud Manager sul sito Web Adobe Developer.

Impostazione dei valori tramite API setting-values-via-api

Una chiamata all’API distribuisce le nuove variabili e i nuovi valori in un ambiente Cloud, in modo simile a una tipica pipeline di distribuzione del codice del cliente. I servizi di authoring e pubblicazione vengono riavviati e fanno riferimento ai nuovi valori, in genere dopo alcuni minuti.

PATCH /program/{programId}/environment/{environmentId}/variables

[
        {
                "name" : "MY_VAR1",
                "value" : "plaintext value",
                "type" : "string"  <---default
        },
        {
                "name" : "MY_VAR2",
                "value" : "<secret value>",
                "type" : "secretString"
        }
]

Recupero valori tramite API getting-values-via-api

GET /program/{programId}/environment/{environmentId}/variables

Per ulteriori informazioni, vedere API Cloud Manager.

Eliminazione dei valori tramite API deleting-values-via-api

PATCH /program/{programId}/environment/{environmentId}/variables

Per eliminare una variabile, includerla con un valore vuoto.

Per ulteriori informazioni, vedere API Cloud Manager.

Recupero valori tramite la riga di comando getting-values-via-cli

$ aio cloudmanager:list-environment-variables ENVIRONMENT_ID
Name     Type         Value
MY_VAR1  string       plaintext value
MY_VAR2  secretString ****

Impostazione dei valori tramite la riga di comando setting-values-via-cli

$ aio cloudmanager:set-environment-variables ENVIRONMENT_ID --variable MY_VAR1 "plaintext value" --secret MY_VAR2 "some secret value"

Eliminazione dei valori tramite la riga di comando deleting-values-via-cli

$ aio cloudmanager:set-environment-variables ENVIRONMENT_ID --delete MY_VAR1 MY_VAR2

Numero di variabili number-of-variables

È possibile dichiarare fino a 200 variabili per ambiente.

Considerazioni sull’implementazione per valori di configurazione segreti e specifici dell’ambiente deployment-considerations-for-secret-and-environment-specific-configuration-values

Poiché i valori di configurazione segreti e specifici dell’ambiente si trovano al di fuori di Git e pertanto non fanno parte dei meccanismi formali di distribuzione di Adobe Experience Manager as a Cloud Service, il cliente deve gestire, gestire e integrare nel processo di distribuzione di Adobe Experience Manager as a Cloud Service.

Come accennato in precedenza, la chiamata all’API distribuisce le nuove variabili e i nuovi valori negli ambienti Cloud, in modo simile a una tipica pipeline di distribuzione del codice del cliente. I servizi di authoring e pubblicazione vengono riavviati e fanno riferimento ai nuovi valori, in genere dopo alcuni minuti. I gate e i test di qualità eseguiti da Cloud Manager durante una distribuzione regolare del codice non vengono eseguiti durante questo processo.

In genere, i clienti chiamano l’API per impostare le variabili di ambiente prima di distribuire il codice che si basa su di esse in Cloud Manager. In alcune situazioni, potrebbe essere utile modificare una variabile esistente dopo la distribuzione del codice.

In alcuni casi, la distribuzione pianificata del codice del cliente si basa su variabili esistenti per l’immissione di nuovi valori, il che non sarebbe appropriato per il codice corrente. Se questo è un problema, si raccomanda di apportare modifiche variabili in modo additivo. Per farlo, crea nuovi nomi di variabili invece di modificare solo il valore delle variabili precedenti in modo che il codice precedente non faccia mai riferimento al nuovo valore. Quindi, quando la nuova versione del cliente appare stabile, è possibile scegliere di rimuovere i valori precedenti.

Analogamente, poiché i valori di una variabile non sono sottoposti a controllo delle versioni, un rollback del codice potrebbe causarne il riferimento a valori più recenti che causano problemi. Anche la strategia sulle variabili aggiuntive menzionata in precedenza può essere d'aiuto in questo contesto.

Questa strategia aggiuntiva per le variabili è utile anche per gli scenari di disaster recovery in cui se il codice di diversi giorni prima deve essere ridistribuito, i nomi e i valori delle variabili a cui fa riferimento rimarranno intatti. Questo si basa su una strategia in cui un cliente attende alcuni giorni prima di rimuovere tali variabili meno recenti, altrimenti il codice precedente non avrebbe variabili appropriate a cui fare riferimento.