Gestione dei componenti del piano di runtime

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

Informazioni sul file delle sostituzioni

La prima volta che installi il runtime ibrida in un cluster, devi creare un file di override della configurazione. Questo file ti consente di fornire i valori delle proprietà obbligatorie necessari per installare la versione ibrida, ad esempio il nome del progetto Google, il nome dell'organizzazione, i dettagli dell'ambiente, i file del certificato e così via. Puoi anche ignorare determinati valori predefiniti per la maggior parte dei componenti ibridi nel file delle sostituzioni. Per un elenco completo delle proprietà configurabili, consulta il riferimento per le proprietà di configurazione.

I passaggi di installazione dell'architettura ibrida illustrano la procedura di creazione di un file di override e di applicazione della configurazione a un cluster. Se vuoi modificare la configurazione in un secondo momento, modifica il file di override che hai creato e riapplicalo. Consulta 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 delle sostituzioni e applica le modifiche con apigeectl. Per un elenco completo delle proprietà configurabili, consulta il riferimento per le proprietà di configurazione.

Ad esempio, per attivare il componente logger, aggiorna il file delle sostituzioni e riapplicalo:

  1. Apri il file delle sostituzioni. 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 di log. Per informazioni sui parametri di ambito, come --telemetry, consulta Ambiti per l'applicazione di apigeectl.

Quali proprietà di configurazione puoi modificare?

Puoi trovare l'elenco completo delle proprietà configurabili nel riferimento per le proprietà di configurazione. Il riferimento elenca solo le proprietà che puoi modificare. Se provi a modificare una proprietà non presente nel riferimento, la modifica viene ignorata.

Come utilizzare il riferimento alla configurazione

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

authz.image.pullPolicy

Nel file delle sostituzioni, le proprietà sono formattate in YAML corretto. Nell'esempio riportato sopra, l'elemento authz di primo livello è rientrato a sinistra e le proprietà degli elementi secondari sono rientrate sotto. Inoltre, YAML richiede 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 delle sostituzioni e impostala come segue:

authz:
  image:
    pullPolicy: Always

Un altro esempio è la proprietà cassandra.auth.admin.password (indicata nel riferimento per le proprietà di configurazione) utilizzata per impostare la password di amministrazione di Cassandra. Per modificarlo, individua il seguente codice YAML nel file delle sostituzioni e impostalo come segue:

cassandra:
  auth:
    admin:
      password: abc123

Ricorda che il riferimento per le proprietà di configurazione descrive tutte le proprietà che puoi impostare sui componenti del piano di runtime ibrida. Segui lo schema spiegato sopra per modificare questi elementi nel file delle sostituzioni prima di applicare le modifiche al cluster.

Informazioni sui valori predefiniti della configurazione

Apigee gestisce 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 presenti in values.yaml. Ricorda che non tutte le proprietà sono modificabili. Quando applichi una configurazione a un cluster, le sostituzioni vengono unite alle impostazioni predefinite per creare la configurazione completa del cluster Kubernetes.

Utilizzo di file di override di esempio predefiniti

Apigee fornisce un insieme di file di override di esempio per aiutarti a configurare il deployment ibrido. È buona prassi copiare e modificare il file delle sostituzioni che corrisponde maggiormente ai requisiti di installazione.

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

File di override di esempio Descrizione
overrides-small.yaml Questo esempio è ideale per iniziare rapidamente. Utilizza l'impronta minima consigliata per avviare i componenti runtime ibrida. Questa configurazione di esempio si basa 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 più elevato di risorse per gestire il traffico aggiuntivo. Cassandra utilizza dischi SSD per le prestazioni. In questo ambiente, è consigliabile che gli utenti installino componenti con stato e senza stato su nodi separati. Consulta 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 proprietà per l'impostazione di chiavi di crittografia, password e altro ancora. I singoli componenti hanno un minimo di due repliche.
private-overrides.yaml Questo esempio illustra come utilizzare le immagini di un repository di immagini privato. Consulta Utilizzare un repository di immagini privato.

Annotazioni personalizzate

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

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

runtime:
  annotations:
    businessunit: "bu1"

Utilizzare i dry run per testare le modifiche alla configurazione

Puoi utilizzare il flag --dry-run con apigeectl per testare il file di configurazione delle sostituzioni senza applicarlo effettivamente al cluster. Questa opzione è utile per il debug di un problema di installazione perché mostra esattamente cosa 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 versione 1.17 e precedenti:

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

kubectl versione 1.18 e 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 dei file 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

Eliminare i componenti di runtime

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

Eliminazione di un ambiente

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