Gestione dei componenti del piano di runtime

Questo argomento spiega come configurare e gestire i componenti del piano di runtime ibridi di Apigee.

Informazioni sul file degli override

La prima volta che installi il runtime ibrido in un cluster, devi creare un file di sostituzione della configurazione. Questo file ti consente di fornire i valori delle proprietà obbligatori necessari per installare il modello ibrido, ad esempio il nome del progetto Google, il nome dell'organizzazione, i dettagli dell'ambiente, i file di certificati e così via. Puoi anche eseguire l'override di determinati valori predefiniti per la maggior parte dei componenti ibridi nel file degli override. Per un elenco completo delle proprietà configurabili, consulta la documentazione di riferimento sulle proprietà di configurazione.

La procedura di installazione ibrida illustra il processo di creazione di un file di override e di applicazione della configurazione a un cluster. Se vuoi cambiare la configurazione in un secondo momento, modifica il file degli override che hai creato e applicalo di nuovo. Consulta la sezione Apportare una modifica alla configurazione.

Apportare una modifica alla configurazione

Per apportare una modifica alla configurazione di un componente del piano di runtime ibrido, modifica il file degli override e applica le modifiche con apigeectl. Per un elenco completo delle proprietà configurabili, consulta la documentazione di riferimento sulle proprietà di configurazione.

Ad esempio, per attivare il componente logger, aggiorna il file degli override e applicalo di nuovo:

  1. Apri il file degli override. Assicurati di utilizzare lo stesso file di override utilizzato per installare il runtime ibrido nel cluster.
  2. Individua l'elemento logger nel file. Ad esempio: 
    ...
logger:
  enabled: false
...
  3. Modifica il valore della proprietà in true: 
    ...
  logger:
  enabled: true
...
  4. Utilizza apigeectl per applicare la modifica al cluster: 
    $APIGEECTL_HOME/apigeectl apply -f $HYBRID_FILES/overrides/OVERRIDES.yaml --telemetry

    Il flag --telemetry indica a apigeectl di aggiornare solo il componente logger. Per informazioni sui parametri di definizione dell'ambito, come --telemetry, consulta Ambiti per l'applicazione di apigeectl.

Quali proprietà di configurazione puoi modificare?

Puoi trovare l'elenco completo delle proprietà configurabili nella sezione Informazioni di riferimento sulle proprietà di configurazione. Il riferimento elenca solo le proprietà che puoi modificare. Se tenti di modificare una proprietà che non è nel riferimento, la modifica viene ignorata.

Come utilizzare il riferimento alla configurazione

Il riferimento delle proprietà di configurazione utilizza la notazione punto per descrivere gli elementi di configurazione, dove il primo elemento è il nome dell'elemento di primo livello seguito dalle proprietà e dalle proprietà secondarie. Ad esempio:

authz.image.pullPolicy

Nel file degli override, le proprietà sono formattate nel formato YAML corretto. Per l'esempio precedente, l'elemento authz di primo livello è rientrato a sinistra, mentre le proprietà dell'elemento secondario sono rientrate sotto. Inoltre, YAML richiede i due punti alla fine di ogni elemento e sottoelemento.

Ad esempio, per impostare la proprietà authz.image.pullPolicy su Always, individua questa stanza YAML nel file degli override e impostala come segue:

authz:
  image:
    pullPolicy: Always

Per un altro esempio, la proprietà cassandra.auth.admin.password (indicata in Riferimento proprietà di configurazione) viene utilizzata per impostare la password dell'amministratore di Cassandra. Per modificarlo, individua il seguente YAML nel file degli override e impostalo come segue:

cassandra:
  auth:
    admin:
      password: abc123

Ricorda che il riferimento delle proprietà di configurazione descrive tutte le proprietà che puoi impostare sui componenti ibridi del piano di runtime. Segui il pattern spiegato in precedenza per modificare questi elementi nel file degli override prima di applicare le modifiche al cluster.

Informazioni sulle impostazioni predefinite di configurazione

Apigee mantiene la configurazione predefinita dei componenti nel file $HYBRID_FILES/config/values.yaml. Questo file specifica i valori predefiniti, se possibile, per ogni componente ibrido.

I file di override seguono la stessa struttura YAML di values.yaml. Tuttavia, un file di override include solo un sottoinsieme delle proprietà di configurazione trovate in values.yaml. Ricorda che non tutte le proprietà sono modificabili. Quando applichi una configurazione a un cluster, gli override vengono uniti ai valori predefiniti per creare la configurazione completa del cluster Kubernetes.

Utilizzare i file di override predefiniti di esempio

Apigee fornisce una serie di file di esempio per l'override, per guidarti nella configurazione del deployment ibrido. È buona norma copiare e modificare il file degli override che più si avvicina ai requisiti di installazione.

I seguenti esempi sono inclusi nella directory $APIGEECTL_HOME/examples:

File di esempio con override Descrizione
overrides-small.yaml Questo esempio è ideale per iniziare rapidamente. Utilizza l'ingombro minimo consigliato per avviare i componenti di runtime ibridi. Questa configurazione di esempio fa affidamento il più possibile su impostazioni e valori predefiniti. Tutte le repliche minime sono impostate su 1.
overrides-medium.yaml Questo esempio è un buon punto di partenza per gli ambienti di test e QA. Ai singoli componenti è stato concesso un livello di risorse superiore per gestire il traffico aggiuntivo. Cassandra utilizza i dischi SSD per le prestazioni. In questo ambiente, consigliamo agli utenti di installare componenti stateful e stateless su nodi separati. Vedi Configurare i nodi dedicati.
overrides-large.yaml Questo esempio è un buon punto di partenza per ambienti ad alte prestazioni come pre-produzione e produzione. L'esempio include le proprietà per l'impostazione di chiavi di crittografia, password e altro. I singoli componenti hanno un minimo di due repliche.
private-overrides.yaml Questo esempio illustra come utilizzare le immagini da un repository di immagini privato. Vedi Utilizzare un repository di immagini private.

Annotazioni personalizzate

Le annotazioni sono mappe chiave/valore utilizzate per collegare i metadati ai pod Kubernetes. Puoi creare annotazioni personalizzate per le seguenti proprietà dei componenti ibridi elencate in Riferimento alle proprietà di configurazione:

Per aggiungere un'annotazione personalizzata per la coppia nome/valore, apri il file degli override e aggiungi una stanza annotations per il rispettivo componente, quindi applica la modifica con apigeectl. Ad esempio:

runtime:
  annotations:
    businessunit: "bu1"

Usa dry run per testare le modifiche alla configurazione

Puoi utilizzare il flag --dry-run con apigeectl per testare il file di configurazione degli override senza applicarlo effettivamente al cluster. Questa opzione è utile per il debug di un problema di installazione, perché mostra esattamente ciò che verrà applicato al cluster.

In Apigee hybrid, la sintassi del flag --dry-run dipende dalla versione di kubectl in esecuzione. Controlla la versione di kubectl con il comando seguente:

kubectl version

kubectl 1.17 e versioni precedenti:

$APIGEECTL_HOME/apigeectl init -f $HYBRID_FILES/overrides/OVERRIDES.yaml --dry-run=true

kubectl 1.18 e versioni successive:

  $APIGEECTL_HOME/apigeectl init -f $HYBRID_FILES/overrides/OVERRIDES.yaml --dry-run=client

Crea più file di override in base alle esigenze

Puoi creare più file di override, ognuno dei quali soddisfa un requisito specifico. Ad esempio, potresti avere un file di override che ottimizza il cluster per la produzione e un altro per la creazione di un cluster per i test. Puoi quindi gestire questi file nel tuo sistema di controllo del codice sorgente.

Utilizza il comando apigeectl apply per applicare un file di override al cluster. Ad esempio:

$APIGEECTL_HOME/apigeectl apply  -f $HYBRID_FILES/overrides/test_env_override.yaml

Elimina i componenti di runtime

Il comando apigeectl delete fornisce flag che consentono di eliminare tutti o un sottoinsieme dei componenti di runtime ibridi installati. Per maggiori dettagli, sull'utilizzo dei comandi, consulta la pagina di riferimento apigeectl. Vedi anche Disinstallare il runtime ibrido.

Eliminazione di un ambiente

Per eliminare completamente un ambiente, devi rimuovere sia il piano di runtime (locale) che di gestione (cloud). Per maggiori dettagli, vedi Eliminare gli ambienti.