Gestione dei componenti del piano di runtime

Version 1.12 (latest)

Versioni supportate:

• v1.12 (più recente)                        
• v1.11                         
• v1.10                                        
• Elenco delle versioni supportate

Versioni non supportate:

• v1.9                                         
• v1.8                                         
• v1.7                                         
• v1.6                                         
• v1.5                                         
• v1.4                                         
• v1.3                                         
• v1.2                                         
• v1.1                                         

Questo argomento spiega come configurare e gestire i componenti del piano di runtime ibridi di Apigee. Per un elenco dei componenti del piano di runtime che puoi configurare, consulta Panoramica della configurazione del servizio di runtime.

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 consente di eseguire l'override dei valori di configurazione predefiniti in base alle esigenze, configurare gli ambienti, fare riferimento a certificati TLS e chiavi degli account di servizio, assegnare pool di nodi Kubernetes a componenti ibridi specifici e così via.

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.

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 utilizza Helm per eseguire l'upgrade del grafico corrispondente al componente. Il seguente grafico mostra quali grafici corrispondono a quali componenti ibridi Apigee:

Ambito	Componenti	Grafico Helm
Operatore Apigee	Operatore Apigee	apigee-operator
Spazio di archiviazione	Cassandra	apigee-datastore
Archiviazione in memoria	Redis	apigee-redis
Report	Metriche Logger	apigee-telemetry
In entrata	Gateway Apigee Ingress	apigee-ingress-manager
Organization (Organizzazione)	Agente Apigee Connect MART UDCA Watcher	apigee-org
Ambiente	Sincronizzatore runtime	apigee-env
Gruppo di ambienti	virtualhost	apigee-virtualhost

Ad esempio, per modificare il conteggio delle repliche sul processore di messaggi, segui questi passaggi:

1. Apri il file OVERRIDES.yaml. Assicurati di utilizzare lo stesso file di override utilizzato per installare il runtime ibrido nel cluster.
2. Individua l'elemento runtime nel file. Ad esempio:

   ...
   runtime:
     nodeSelector:
       key: cloud.google.com/gke-nodepool
       value: apigee-runtime
     replicaCountMin: 1
     replicaCountMax: 2
   ...

3. Modifica le proprietà del conteggio delle repliche in base alle tue esigenze. Ad esempio:

   ...
   runtime:
     nodeSelector:
       key: cloud.google.com/gke-nodepool
       value: apigee-runtime
     replicaCountMin: 2
     replicaCountMax: 20
   ...

4. Applica le modifiche con il grafico apigee-org:

     helm upgrade ORG_NAME apigee-org/ \
       --namespace apigee \
       --atomic \
       -f OVERRIDES_FILE.yaml
     

   Nota: se viene visualizzato un errore che dice Error: UPGRADE FAILED: "ORG_NAME" has no deployed releases, sostituisci upgrade con install e riprova a eseguire il comando.

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:

ao.image.pullPolicy

Nel file degli override, le proprietà sono formattate nel formato YAML corretto. Per l'esempio precedente, l'elemento ao 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à ao.image.pullPolicy su Always, individua questa stanza YAML nel file degli override e impostala come segue:

ao:
  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.

L'utilizzo di un esempio predefinito esegue l'override dei file

Quando installi per la prima volta il runtime ibrido, Apigee consiglia di utilizzare uno dei pre-configured example overrides files. Questi esempi forniscono un insieme completo di proprietà di configurazione per scenari di installazione specifici, ad esempio per l'impostazione di un'installazione di produzione o di test. Devi solo fornire i valori appropriati per le proprietà e applicare il file degli override al cluster. Per ulteriori informazioni, consulta il Passaggio 6: crea gli override.

Ricorda che, quando inizi, ti consigliamo di utilizzare uno degli esempi di file di override. Gli esempi forniscono tutte le impostazioni di configurazione necessarie per configurare un cluster funzionante, inclusi i commenti che spiegano quali valori devi fornire. Quando tutto funziona, puoi sempre tornare indietro e apportare modifiche alla configurazione, se necessario.

Informazioni sulle impostazioni predefinite di configurazione

Apigee mantiene la configurazione predefinita dei componenti nel file HYBRID_ROOT_DIR/config/values.yaml. I file di override seguono la stessa struttura YAML di values.yaml.

In genere 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, gli override vengono uniti ai valori predefiniti per creare la configurazione completa del cluster Kubernetes. Vedi anche Testare la configurazione unita.

Il seguente codice mostra la configurazione predefinita per il componente mart in values.yaml. Tieni presente che alcuni valori hanno valori predefiniti, mentre altri, come sslCertPath e sslKeyPath, no. Devi fornire i valori mancanti nel file degli override, come spiegato nella procedura di installazione. Se vuoi modificare i valori predefiniti, assicurati che siano modificabili controllando la sezione Riferimento proprietà di configurazione.

...
mart:
  replicaCountMin: 2
  replicaCountMax: 4
  targetCPUUtilizationPercentage: 75
  terminationGracePeriodSeconds: 30
  sslCertPath:
  sslKeyPath:
  hostAlias:
  nodeSelector:
    key:
    value:
  revision: blue
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-mart-server"
    tag: "1.3.6"
    pullPolicy: IfNotPresent
  resources:
    requests:
      cpu: 500m
      memory: 512Mi
  initCheckCF:
    resources:
      requests:
        cpu: 10m
  livenessProbe:
    timeoutSeconds: 1
    failureThreshold: 12
    periodSeconds: 5
    initialDelaySeconds: 15
  readinessProbe:
    timeoutSeconds: 1
    successThreshold: 1
    failureThreshold: 2
    periodSeconds: 5
    initialDelaySeconds: 15
  metricsURL: "/v1/server/metrics"
  cwcAppend: |
...

Se vuoi modificare le impostazioni predefinite di un componente e quest'ultimo non è già presente nel file degli override, puoi copiare il relativo YAML da values.yaml nel file degli override e modificarlo da lì.

Non modificare mai direttamente values.yaml; utilizza sempre un file di override per specificare le proprietà di configurazione.

Annotazioni personalizzate

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

• cassandra
• connectAgent
• logger
• mart
• metrics
• runtime
• synchronizer
• udca
• watcher

Per aggiungere un'annotazione personalizzata, aggiungi una stanza al file OVERRIDES.yaml per il rispettivo componente.

L'esempio seguente illustra come specificare un'annotazione nei pod runtime:

runtime:
  annotations:
    businessunit: "bu1"

Testa la configurazione unita

Puoi utilizzare il flag --dry-run per testare il file di configurazione unito 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. È inoltre buona norma testare la configurazione e archiviarla nel controllo del codice sorgente, in modo da avere un riferimento delle risorse installate e configurate nel cluster.

kubectl apply -k  apigee-operator/etc/crds/default/
      

helm upgrade operator apigee-operator/ \
  --install \
  --namespace apigee-system \
  --atomic \
  -f OVERRIDES_FILE.yaml \
  --dry-run

helm upgrade ingress-manager apigee-ingress-manager/ /
  --install \
  --namespace apigee \
  --atomic \
  -f OVERRIDES_FILE.yaml \
  --dry-run

Crea più file di override in base alle esigenze

Puoi creare tutti i file di override che vuoi, 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 di test. Puoi quindi gestire questi file nel tuo sistema di controllo del codice sorgente.

Ad esempio:

helm upgrade test-1-env apigee-env/ \
  --namespace apigee \
  --atomic \
  --set env=test-1-env \
  -f test-1-env-overrides.yaml

Nota: se viene visualizzato un errore che dice Error: UPGRADE FAILED: "test-1-env" has no deployed releases, sostituisci upgrade con install e riprova a eseguire il comando.

Elimina i componenti del piano di runtime specifici dell'ibrido

I componenti del piano di runtime includono synchronizer, mart, runtime, cassandra e udca.

Per eliminare dal cluster i componenti del piano di runtime specifici dell'ibrido, utilizza il comando helm delete. Assicurati di specificare lo stesso file di override che hai utilizzato per installare i componenti di runtime.

Ad esempio:

Se utilizzi Helm, devi eliminare ogni componente singolarmente. Ad esempio, per eliminare il componente cassandra, utilizza il seguente comando:

helm -n apigee delete datastore

Nell'esempio precedente, il componente datastore è stato installato con il nome "datastore". Se lo hai installato con un nome diverso, devi fornire quel nome per eliminare il componente. Ad esempio, se hai installato il grafico apigee-datastore con helm install my-cassandra-storage apigee-datastore/. lo elimineresti con il seguente comando:

helm delete -n apigee my-cassandra-storage

Per ricreare uno o più componenti specifici (il gruppo di ambienti in questo esempio):

helm upgrade ENV_GROUP apigee-virtualhost/ \
  --install \
  --namespace apigee \
  --atomic \
  --set envgroup=ENV_GROUP_NAME \
  -f OVERRIDES_FILE.yaml