Questa pagina è stata tradotta dall'API Cloud Translation.

Esegui la migrazione di Apigee hybrid a Helm da apigeectl

Questo strumento di migrazione aiuta a eseguire la migrazione di un cluster ibrido basato su apigeectl a un cluster ibrido basato su Helm. Questo strumento non esegue alcuna sostituzione effettiva dei componenti del cluster. È idempotente e può essere eseguito più volte sullo stesso cluster, preparando ogni volta un sottoinsieme di componenti e organizzazioni.

Puoi eseguire la migrazione di tutti i componenti apigee contemporaneamente e le operazioni di upgrade di Helm possono essere eseguite per singolo componente dopo l'esecuzione dello strumento.

Consulta Installazione e gestione di Apigee hybrid con i grafici Helm per informazioni sulla gestione dei cluster ibridi di cui hai eseguito la migrazione alla gestione Helm con questo strumento.

Prerequisiti

Helm versione 3.10+.
Un file kubeconfig funzionante che punta a un cluster con un'installazione di Apigee hybrid 1.12 funzionante.
Autorizzazioni per modificare metadati e annotazioni sulle risorse Kubernetes dei componenti ibridi di cui vuoi eseguire la migrazione.

Ambito

Questo strumento supporta le seguenti opzioni in fase di runtime:

Personalizzazione dello spazio dei nomi per apigee risorse. Spazio dei nomi predefinito: apigee
Migrazione solo dei componenti ibridi selezionati. Impostazione predefinita: viene eseguita la migrazione di tutti i componenti
Migrazione di una sola organizzazione
Migrazione di un solo ambiente
Solo migrazione di un singolo gruppo di ambienti (apigee-virtualhost)
Personalizzazione dei nomi delle release Helm per organizzazioni, envs e gruppi env.

Limitazioni

Questo strumento non supporta la personalizzazione dei nomi delle release di Helm per i seguenti componenti ibridi: apigee-operator, apigee-datastore, apigee-redis, apigee-telemetry e apigee-ingress-manager.
Le personalizzazioni interattive apportate ai nomi delle release di Helm per organizzazioni, envs ed env-groups non vengono mantenute automaticamente tra le esecuzioni. Puoi modificare il file temporaneo e fornirlo come opzione nelle esecuzioni successive.
I filtri Env e env-group vengono eseguiti solo per nome. In alcuni casi, ciò potrebbe comportare la migrazione di più env ed env-groups in cluster multi-organizzazione.

Ad esempio, in un cluster a più organizzazioni con organizzazioni org1 e org2, se l'ambiente prod è presente in entrambe le organizzazioni e viene specificato solo --env=prod, verrà eseguita la migrazione di entrambi gli ambienti. Se vuoi eseguire la migrazione di un solo ambiente, devi specificare anche un filtro dell'organizzazione --org=org1 o --org=org2.

Utilizzo

Sintassi

apigee-helm-migration [--apigee-namespace=] [--components=] [--dry-run] [--env=org1] [--env-group=org2] [--org=baz] [--kubeconfig=] [-y] [-v] [-f /path/to/releaseNames.yaml]

Nomi release Helm generate

Ogni grafico Helm di cui viene eseguito il deployment in un cluster deve avere un nome release, che deve essere univoco all'interno di uno spazio dei nomi. I nomi delle release Helm non hanno convenzioni di denominazione o restrizioni in relazione al nome del grafico. Lo strumento di migrazione genera nomi univoci per le release di Helm per ogni componente.

Grafico	Cluster a organizzazione singola	Cluster multiorganizzazione
`apigee-operator`	`operator`	`operator`
`apigee-datastore`	`datastore`	`datastore`
`apigee-telemetry`	`telemetry`	`telemetry`
`apigee-redis`	`redis`	`redis`
`apigee-ingress-manager`	`ingress-manager`	`ingress-manager`
`apigee-org`	`ORG_NAME`	`ORG_NAME`
`apigee-env`	`ENV_NAME[-env[-n]]⁽¹⁾`	`ORG_NAME-ENV_NAME[-env[-n]]`⁽¹⁾
`apigee-virtualhost (envgroup)`	`VH_NAME[-env-group[-n]]`⁽¹⁾	`ORG_NAME-VH_NAME[-env-group[-n]]`⁽¹⁾
⁽¹⁾ I nomi hanno il suffisso `-env` o `-env-group` se il nome generato è in conflitto con un altro nome generato. A questi elementi viene aggiunto il suffisso `-1` o `-2 …` se continuano a essere in conflitto.

Personalizzazione dei nomi delle release Helm

Lo strumento di migrazione consente la personalizzazione interattiva dei nomi delle release di Helm. Se vuoi personalizzare i nomi delle release di Helm in modo non interattivo:

Esegui lo strumento una volta ed esci al primo prompt per creare un file temporaneo contenente i nomi delle release generati automaticamente. Dovresti vedere una riga simile a:
```
INFO: 21:32:56 using temp file for release names:  /tmp/apigee-helm-migration-1229129207-releaseNames
```
Sposta o copia e modifica questo file. Puoi passare il file modificato con l'opzione -f quando esegui lo strumento di migrazione. I nomi delle release generati automaticamente hanno il seguente aspetto:
```
orgs:
  example-apigee-org:
    helmReleaseName: example-apigee-org
    envs:
      prod:
        helmReleaseName: prod
    envGroups:
      prod-envgroup:
        helmReleaseName: prod-envgroup
```
Per personalizzare i nomi delle release Helm per un'organizzazione, un env o un envgroup, modifica il campo helmReleaseName dell'oggetto. Ad esempio, per rinominare la release dell'organizzazione in custom-org, la release env in custom-env e la release envgroup in custom-group, il file risultante ha il seguente aspetto:
```
orgs:
  example-apigee-org:
    helmReleaseName: custom-org
    envs:
      prod:
        helmReleaseName: custom-env
    envGroups:
      prod-envgroup:
        helmReleaseName: custom-group
```

Utilizzo di spazi dei nomi personalizzati

Apigee hybrid viene eseguito in due spazi dei nomi Kubernetes:

apigee-system: il componente apigee-operator viene sempre eseguito nello spazio dei nomi apigee-system. Lo strumento di migrazione Helm aggiorna il componente apigee-operator nello spazio dei nomi apigee-system a prescindere da quanto specificato con il flag --apigee-namespace.
apigee: tutti i componenti ibridi, tranne apigee-operator, vengono eseguiti in questo spazio dei nomi. apigee è il nome predefinito. Per questi componenti puoi utilizzare qualsiasi spazio dei nomi personalizzato.
Se utilizzi uno spazio dei nomi personalizzato, devi specificarlo con il flag --apigee-namespace my_custom_namespace quando esegui lo strumento di migrazione di Helm.

Devi anche aggiungere la proprietà di primo livello namespace: my_custom_namespace al file degli override.

Istruzioni

Individua lo strumento di migrazione.

Lo strumento di migrazione è incluso nel pacchetto apigeectl in /tools/migration/.

Estrai i file compressi utilizzando uno dei seguenti comandi:

Mac:

tar -xzf apigee-helm-migration_1.0.2_mac_64.tar.gz

Linux:

tar -xzf apigee-helm-migration_1.0.2_linux_64.tar.gz

Windows:

tar -xzf apigee-helm-migration_1.0.2_windows_64.zip

Esegui lo strumento di migrazione. Se le opzioni predefinite sono accettabili, è sufficiente eseguire lo strumento senza argomenti e approvare il prompt se i nomi delle release Helm generati sono soddisfacenti. Di seguito sono riportati alcuni scenari di esempio:

Un'installazione semplice, che utilizza kubeconfig (~/.kube/config), lo spazio dei nomi predefinito apigee e i nomi delle release Helm predefiniti.

Il seguente comando dovrebbe essere sufficiente per la maggior parte delle installazioni, se non per tutte. Le operazioni di upgrade di Helm possono essere eseguite per singolo componente dopo l'esecuzione dello strumento.
```
./apigee-helm-migration
```
Migrazione di tutti i componenti utilizzando uno spazio dei nomi personalizzato:
```
./apigee-helm-migration --apigee-namespace my_custom_namespace
```

Esegui la migrazione solo dei componenti operator e datastore:

./apigee-helm-migration --components operator,datastore

  INFO: 00:22:48 using kubeconfig file  /usr/local/google/home/example/.kube/config
  INFO: 00:22:48 namespace for apigee resources:
  INFO: 00:22:48 	 apigee
  INFO: 00:22:48 processing all organizations in cluster
  INFO: 00:22:48 Components to migrate:
  INFO: 00:22:48 	 operator,datastore
  INFO: 00:22:48 dry-run:
  INFO: 00:22:48 	 false
  Continue with patching apigee resources for Helm migration? [y/n]: y
  INFO: 00:22:52 Processing component:  operator
  INFO: 00:22:54 Processing component:  datastore
  INFO: 00:22:55 Migration successful!

Puntare a un file kubeconfig specifico e specificare un nome diverso per lo spazio dei nomi apigee.
```
./apigee-helm-migration --kubeconfig /abs/path/to/kubeconf --namespace org1_namespace
```
Migrazione di tutti i componenti, ma di una sola organizzazione:
```
./apigee-helm-migration --org=some-test-org
```

Di seguito è riportato un esempio di output da una migrazione riuscita:

INFO: 21:32:55 using kubeconfig file  /usr/local/google/home/example/.kube/config
INFO: 21:32:55 namespace for apigee resources:
INFO: 21:32:55 	 apigee
INFO: 21:32:55 processing all organizations in cluster
INFO: 21:32:55 processing all components
INFO: 21:32:55 dry-run:
INFO: 21:32:55 	 false
INFO: 21:32:55 cluster Apigee information:
INFO: 21:32:55 Apigee Organizations found:
INFO: 21:32:56 	 example-hybrid-dev
INFO: 21:32:56 Apigee Environments found (org: env):
INFO: 21:32:56 	 example-hybrid-dev : prod
INFO: 21:32:56 Apigee EnvGroups(apigeerouteconfigs) found (org: envGroup):
INFO: 21:32:56 	 example-hybrid-dev : prod-envgroup
INFO: 21:32:56 using temp file for release names:  /tmp/apigee-helm-migration-1229129207-releaseNames
INFO: 21:32:56 Helm release names for Apigee orgs/envs/envgroups:
orgs:
example-hybrid-dev:
helmReleaseName: example-hybrid-dev
envs:
  prod:
    helmReleaseName: prod
envGroups:
  prod-envgroup:
    helmReleaseName: prod-envgroup
Make changes to the release names for Apigee orgs/env/envgroups? [y/n]: n
Continue with patching apigee resources for Helm migration? [y/n]: y
INFO: 21:32:59 Processing component:  operator
INFO: 21:33:01 Processing component:  datastore
INFO: 21:33:01 Processing component:  redis
INFO: 21:33:02 Processing component:  ingress-manager
INFO: 21:33:02 Processing component:  telemetry
INFO: 21:33:03 Processing component:  orgs
INFO: 21:33:05 Processing component:  envs
INFO: 21:33:06 Processing component:  env-groups
INFO: 21:33:07 Migration successful!

Potenziali errori:

Errore durante l'analisi del file dei nomi delle release: controlla il file dei nomi delle release passato.
Risorse non trovate: verifica che Apigee hybrid sia completamente installato e di disporre delle autorizzazioni per accedere alle risorse apigee.

Modifiche alle proprietà di configurazione

Apporta le seguenti modifiche ai file di override:

Cambia ingressGateways in apigeeIngressGateway. Il file degli override deve contenere almeno:

apigeeIngressGateway:
  image:
    url: "PATH_TO_REPOSITORY/apigee-asm-ingress"
    tag: "tag"

Ad esempio:

apigeeIngressGateway:
  image:
    url: "gcr.io/apigee-release/hybrid/apigee-asm-ingress"
    tag: "1.17.8-asm.20-distroless"

Leggi apigeeIngressGateway

Le proprietà per abilitare Workload Identity sono state modificate:
- gcp.workloadIdentity.enabled sostituisce gcp.workloadIdentityEnabled.
- Se utilizzi un solo account di servizio per tutti i componenti, puoi specificarlo con: gcp.workloadIdentity.gsa. Ad esempio:
```
gcp:
  workloadIdentity:
    enabled: true
    gsa: "apigee-non-prod@my-hybrid-project.iam.gserviceaccount.com"
```
- Se utilizzi un account di servizio separato per ogni componente (lo standard per la maggior parte delle installazioni di produzione), specifica l'account di servizio con la proprietà gsa del componente. Ad esempio:
```
logger:
  gsa: "apigee-logger@my-hybrid-project.iam.gserviceaccount.com"
```
Vedi: gcp.workloadIdentity.enabled, gcp.federatedWorkloadIdentity.enabled, Attivare Workload Identity su GKE o Attivare la federazione delle identità per i carichi di lavoro su AKS ed EKS.

Risoluzione dei problemi

Nella release ibrida v1.12 esiste un problema noto con lo strumento di migrazione di Helm. Fino a quando il problema non verrà risolto, il backup e ripristino di Cassandra richiede passaggi aggiuntivi.

Puoi procedere nel seguente modo:

Prima o dopo l'esecuzione dello strumento di migrazione
Prima di installare i grafici Helm

Per installare la patch per la soluzione alternativa:

Assicurati che il tuo kubeconfig attuale punti al cluster di cui vuoi eseguire la migrazione. Puoi eseguire questi passaggi da qualsiasi directory.

Crea un file denominato migration-operator-patch.yaml con il seguente contenuto:

# migration-operator-patch.yaml
metadata:
  annotations:
    meta.helm.sh/release-name: operator
    meta.helm.sh/release-namespace: apigee-system
  labels:
    app.kubernetes.io/managed-by: Helm

Crea un file denominato migration-datastore-patch.yaml con i seguenti contenuti:

# migration-datastore-patch.yaml
metadata:
  annotations:
    meta.helm.sh/release-name: datastore
    meta.helm.sh/release-namespace: apigee
  labels:
    app.kubernetes.io/managed-by: Helm

Esegui i seguenti comandi kubectl:

kubectl patch clusterrole apigee-cassandra-backup --patch-file ./migration-operator-patch.yaml
kubectl patch clusterrole apigee-cassandra-restore --patch-file ./migration-operator-patch.yaml
kubectl patch clusterrolebinding apigee-cassandra-backup --patch-file ./migration-operator-patch.yaml
kubectl patch clusterrolebinding apigee-cassandra-restore --patch-file ./migration-operator-patch.yaml
kubectl patch -n apigee cronjob apigee-cassandra-backup --patch-file ./migration-datastore-patch.yaml
kubectl patch -n apigee certificate apigee-cassandra-backup-tls --patch-file ./migration-datastore-patch.yaml --type merge
kubectl patch -n apigee secret apigee-cassandra-backup-svc-account --patch-file ./migration-datastore-patch.yaml
kubectl patch -n apigee secret apigee-cassandra-backup-key-file --patch-file ./migration-datastore-patch.yaml
kubectl patch -n apigee ServiceAccount apigee-cassandra-backup-sa --patch-file ./migration-datastore-patch.yaml
kubectl patch -n apigee job apigee-cassandra-restore --patch-file ./migration-datastore-patch.yaml
kubectl patch -n apigee certificate apigee-cassandra-restore-tls --patch-file ./migration-datastore-patch.yaml --type merge
kubectl patch -n apigee secret apigee-cassandra-restore-svc-account --patch-file ./migration-datastore-patch.yaml
kubectl patch -n apigee secret apigee-cassandra-restore-key-file --patch-file ./migration-datastore-patch.yaml
kubectl patch -n apigee ServiceAccount apigee-cassandra-restore-sa --patch-file ./migration-datastore-patch.yaml

Nota: puoi ignorare gli eventuali errori not found.

Esegui la pulizia dei file patch utilizzando i seguenti comandi:

rm migration-operator-patch.yaml
rm migration-datastore-patch.yaml

Passaggio successivo

Continua l'installazione dei grafici Helm ibridi Apigee con le istruzioni in Installare e gestire Apigee hybrid con i grafici Helm.

Importante: quando segui le istruzioni per il cluster migrato, devi omettere il flag ‑‑atomic da tutti i comandi Helm per evitare di eliminare accidentalmente le risorse in caso di errore del comando helm upgrade.

Output di -help

./apigee-helm-migration --help

Usage of ./apigee-helm-migration:
  -apigee-namespace string
      namespace used for apigee resources (default "apigee")
  -components string
      CSV of components to migrate. If empty then all components are migrated. Valid values are: operator,datastore,redis,ingress-manager,telemetry,orgs,envs,env-groups
  -dry-run
      perform a dry-run
  -env string
      restrict migration to a singular supplied env. If empty then all envs detected in the cluster are migrated
  -env-group string
      restrict migration to a singular supplied envGroup. If empty then all envGroups detected in the cluster are migrated
  -kubeconfig string
      (optional) absolute path to the kubeconfig file (default "/usr/local/google/home/example/.kube/config")
  -org string
      restrict migration to a singular supplied org. If empty then all orgs detected in the cluster are migrated
  -v	Increased logging verbosity
  -y	don't prompt for confirmation or for configuration of Helm releases