Gestione dei componenti del piano di runtime

Questo argomento spiega come configurare e gestire Apigee hybrid componenti del piano di runtime. Per un elenco dei per componenti del piano di runtime che puoi configurare, consulta Servizio di runtime panoramica della configurazione.

Informazioni sul file degli override

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

La procedura di installazione ibrida illustra la procedura di creazione un file di override e di applicare la configurazione a un cluster. Se vuoi modificare la configurazione in un secondo momento, modifica il file degli override creato e applicarlo di nuovo.

Apportare una modifica alla configurazione

Per apportare una modifica alla configurazione di un componente del piano di runtime ibrido, modificare il file di override e e applicare le modifiche con Helm o apigeectl a seconda dello strumento di gestione.

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

  1. Apri il tuo OVERRIDES.yaml file. Assicurati di utilizzare lo stesso file di override che è stato 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: 4
    ...
  4. Helm

    Applica le modifiche con il grafico apigee-org:

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

    apigeectl

    Utilizza apigeectl per applicare la modifica al cluster:

    apigeectl apply -f ./OVERRIDES.yaml --org --env ENV_NAME

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 è riferimento, la modifica viene ignorata.

Come utilizzare il riferimento alla configurazione

Il riferimento 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 e le proprietà dell'elemento secondario sono rientrate sotto di esso. Inoltre, YAML richiede i due punti la fine di ogni elemento e sottoelemento.

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

ao:
  image:
    pullPolicy: Always

Per un altro esempio, la proprietà cassandra.auth.admin.password (così come è elencato in Riferimento proprietà di configurazione) viene utilizzato per impostare la proprietà di Cassandra password di amministratore. Per modificarlo, individua il seguente YAML nel file degli override e imposta come segue:

cassandra:
  auth:
    admin:
      password: abc123

Ricorda che il Riferimento proprietà di configurazione descrive tutte le proprietà che puoi impostare. sui componenti del piano di runtime ibrido. Segui lo schema 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 l'esempio preconfigurato sostituisce i file. Questi esempi forniscono un insieme completo proprietà per scenari di installazione specifici, come la configurazione di un'installazione di produzione o di test. Devi solo fornire i valori appropriati per le proprietà e applica il file degli override al cluster. Per ulteriori informazioni, vedi il Passaggio 6: configura il cluster.

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 lo stesso YAML struttura: values.yaml.

In genere un file di override include solo un sottoinsieme delle proprietà di configurazione presenti in values.yaml. Ricorda: non tutte le proprietà sono modificabili. Quando applichi una configurazione a un cluster, gli override vengono uniti ai valori predefiniti per creare l'ambiente Kubernetes completo e la configurazione del cluster. Vedi anche Testa la configurazione unita.

Il seguente codice mostra la configurazione predefinita per il componente mart come rilevato in values.yaml. Nota alcuni valori hanno valori predefiniti, mentre altri, come sslCertPath e sslKeyPath no. Devi indicare questi valori mancanti nei di override, come spiegato nella procedura di installazione. Se vuoi modificare uno qualsiasi dei valori predefiniti, assicurati che sono modificabili consultando 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 desideri modificare le impostazioni predefinite di un componente che viene non è già presente nel file degli override, puoi copiare il relativo YAML da values.yaml nel tuo esegue l'override del file e lo modifica da lì.

File di esempio con override

Apigee fornisce un set di file di esempio per gli override ti guideranno nella configurazione del deployment ibrido. È una buona pratica per copiare e modificare il file degli override che più si avvicina ai requisiti di installazione.

I seguenti esempi sono inclusi nel directory HYBRID_ROOT_DIR/examples:

File di esempio con override Descrizione
overrides-small.yaml Questo esempio è ideale per iniziare rapidamente. Utilizza l'impronta minima consigliata per avviare i componenti di runtime ibridi. Questa configurazione di esempio si basa su il più possibile sulle impostazioni e sui 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. Singoli componenti dispone di un livello più elevato di risorse per gestire traffico aggiuntivo. Cassandra utilizza dischi SSD per migliorare le prestazioni. In questo ambiente, è consigliabile che gli utenti installino stateful e stateless su nodi separati. Vedi Configura 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 chiavi di crittografia, password e altro. I singoli componenti hanno un minimo di due repliche.

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 delle proprietà di configurazione:

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

L'esempio seguente illustra come è possibile specificare un'annotazione in runtime pod:

runtime:
  annotations:
    businessunit: "bu1"

Testa la configurazione unita

Puoi utilizzare il flag --dry-run per testare l'unione di configurazione senza applicarlo effettivamente al cluster. Questa opzione è utile per il debug di un problema di installazione perché ti mostra esattamente cosa verrà applicato al cluster. È buona norma anche testare la configurazione e memorizzarla del codice sorgente, in modo che tu abbia un riferimento delle risorse installate e configurati nel cluster.

Helm

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

apigeectl

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

Per ulteriori informazioni, vedi apigeectl.

Crea più file di override in base alle esigenze

Puoi creare tutti i file di override che vuoi, ognuno dei quali pubblica una specifica requisito. Ad esempio, potresti avere un file di override che ottimizza il cluster per 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

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

apigeectl

$APIGEECTL_HOME/apigeectl apply -f test-1-env-overrides.yaml --env test-1-env

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 per ibrido, utilizza Comandi helm delete o apigeectl delete. Assicurati di specificare lo stesso file di override che hai utilizzato per installare i componenti di runtime.

Ad esempio:

Helm

Se utilizzi Helm, devi eliminare ogni componente singolarmente. Ad esempio, per eliminare cassandra, usa questo comando:
helm -n apigee 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 di strumento di authoring. Ad esempio, se hai installato il grafico apigee-datastore con helm install my-cassandra-storage apigee-datastore/. lo elimineresti con seguente comando:

helm delete -n apigee my-cassandra-storage

apigeectl

Con apigeectl puoi eliminare tutti i componenti di runtime contemporaneamente o limitare l'ambito di eliminare un componente alla volta. Ad esempio, per eliminare tutti i componenti contemporaneamente:
$APIGEECTL_HOME/apigeectl delete -f OVERRIDES_FILE.yaml

Per eliminare il componente cassandra:

$APIGEECTL_HOME/apigeectl delete -f OVERRIDES_FILE.yaml --datastore

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

Helm

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

apigeectl

$APIGEECTL_HOME/apigeectl apply -f OVERRIDES_FILE.yaml --env ENV_NAME --settings virtualhosts