Gestione dei componenti del piano di runtime

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

Informazioni sul file di override

La prima volta che installi il runtime ibrido in un cluster, devi creare un file di override della configurazione. Questo file consente di sostituire i valori di configurazione predefiniti in base alle esigenze, configurare gli ambienti, fare riferimento ai certificati TLS e alle chiavi dell'account di servizio, assegnare i pool di nodi Kubernetes a componenti ibridi specifici e così via.

I passaggi di installazione ibrida descrivono il processo di creazione di un file di override e l'applicazione della configurazione a un cluster. Se vuoi modificare la configurazione in un secondo momento, modifica il file di 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 di override e utilizza Helm per eseguire l'upgrade del grafico corrispondente al componente. Il seguente grafico mostra a quali componenti di Apigee Hybrid corrispondono i grafici:

Ad esempio, per modificare il conteggio delle repliche nel 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 repliche in base alle esigenze. Ad esempio:

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

4. Esegui l'upgrade dell'ambiente.

Devi installare un ambiente alla volta. Specifica l'ambiente con --set env=ENV_NAME.

Prova:

helm upgrade ENV_RELEASE_NAME apigee-env/ \
--install \
--namespace APIGEE_NAMESPACE \
--set env=ENV_NAME \
-f OVERRIDES_FILE \
--dry-run=server

• ENV_RELEASE_NAME è il nome con cui hai installato in precedenza il grafico apigee-env. Nella versione ibrida 1.10, in genere è apigee-env-ENV_NAME. In Hybrid v1.11 e versioni successive, in genere è ENV_NAME.
• ENV_NAME è il nome dell'ambiente di cui stai eseguendo l'upgrade.
• OVERRIDES_FILE è il nuovo file di override per la versione 1.13.4
5. Esegui l'upgrade del grafico:

helm upgrade ENV_RELEASE_NAME apigee-env/ \
--install \
--namespace APIGEE_NAMESPACE \
--set env=ENV_NAME \
-f OVERRIDES_FILE

6. Verifica che sia attivo e funzionante controllando lo stato dell'ambiente corrispondente:

kubectl -n APIGEE_NAMESPACE get apigeeenv

NAME                          STATE       AGE   GATEWAYTYPE
apigee-org1-dev-xxx            running     2d

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 con punti 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 di override, le proprietà sono formattate in formato YAML corretto. Per l'esempio precedente, l'elemento ao di primo livello è rientrato a sinistra e le proprietà degli elementi secondari sono rientrate al suo interno. 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 sezione YAML nel file di override e impostala come segue:

ao:
  image:
    pullPolicy: Always

Un altro esempio è la proprietà cassandra.auth.admin.password (come è elencata in Riferimento per le proprietà di configurazione), che viene utilizzata per impostare la password di amministrazione di Cassandra. Per modificarlo, individua il seguente codice YAML nel file di override 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 ibrido. Segui il pattern spiegato sopra per modificare questi elementi nel file di override prima di applicare le modifiche al cluster.

Utilizzo di file di override di esempi predefiniti

Quando installi per la prima volta l'ambiente di runtime ibrido, Apigee consiglia di utilizzare uno dei file di override di esempio preconfigurati. Questi esempi forniscono un insieme completo di proprietà di configurazione per scenari di installazione specifici, ad esempio per la configurazione di un'installazione di produzione o di test. Tutto ciò che devi fare è fornire valori appropriati per le proprietà e applicare il file di override al cluster. Per ulteriori informazioni, consulta Passaggio 6: crea gli override.

Informazioni sui valori predefiniti di configurazione

Apigee gestisce 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.

Un file di override in genere 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. Consulta anche Testare la configurazione unita.

Il seguente codice mostra la configurazione predefinita del componente mart come si trova in values.yaml. Tieni presente che alcuni valori hanno valori predefiniti, mentre altri come sslCertPath e sslKeyPath non ne hanno. Devi fornire questi valori mancanti nel file di override, come spiegato nella procedura di installazione. Se vuoi modificare uno dei valori predefiniti, assicurati che siano modificabili consultando il riferimento alle 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.13.4"
    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 i valori predefiniti di un componente e questo non è già presente nel file di override, puoi copiare il relativo YAML da values.yaml nel file di override e modificarlo lì.

Annotazioni personalizzate

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

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

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

Il seguente esempio mostra come specificare un'annotazione nei pod runtime:

runtime:
  annotations:
    businessunit: "bu1"

Testare 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 cosa verrà applicato al cluster. È anche una buona pratica 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_NAMESPACE \
  --atomic \
  -f OVERRIDES_FILE.yaml \
  --dry-run=server

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

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_NAMESPACE \
  --atomic \
  --set env=test-1-env \
  -f test-1-env-overrides.yaml

Eliminare i componenti del piano di runtime specifici per hybrid

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

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

Ad esempio:

Utilizzando Helm, devi eliminare ogni componente singolarmente. Ad esempio, per eliminare il componente cassandra, utilizza questo comando:

helm -n APIGEE_NAMESPACE delete datastore

Nell'esempio precedente, il componente datastore è stato installato con il nome "datastore". Se l'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 comando seguente:

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_NAMESPACE \
  --atomic \
  --set envgroup=ENV_GROUP_NAME \
  -f OVERRIDES_FILE.yaml