Personalizza il piano di migrazione per i server Tomcat

Ti consigliamo di esaminare il file del piano di migrazione risultante dalla creazione di una migrazione. Personalizza il file prima di eseguire la migrazione. I dettagli del piano di migrazione vengono utilizzati per estrarre gli artefatti dei container dei carichi di lavoro dall'origine.

Questa sezione descrive i contenuti della migrazione e i tipi di personalizzazioni che potresti prendere in considerazione prima di eseguire la migrazione e generare gli artefatti del deployment.

Prima di iniziare

Questo argomento presuppone che tu abbia già creato una migrazione e acquistato il file del piano di migrazione.

Modifica il piano di migrazione

Dopo aver copiato e analizzato il file system, puoi trovare il piano di migrazione nella nuova directory creata nel percorso di output specificato: ANALYSIS_OUTPUT_PATH/config.yaml.

Modifica il piano di migrazione in base alle tue esigenze e salva le modifiche.

Esamina i dettagli del piano di migrazione e le indicazioni per aggiungere informazioni, se necessario. In particolare, prendi in considerazione le modifiche apportate alle seguenti sezioni.

Specifica l'immagine Docker

Nel piano di migrazione, generiamo un tag immagine della community Docker basato sulla versione di Tomcat, sulla versione Java e sul fornitore di Java.

  • Versione Tomcat: la versione Tomcat viene rilevata e convertita a una versione principale (le versioni secondarie non sono supportate). Se non viene rilevata una versione di Tomcat, baseImage.name contiene una stringa vuota.
  • Versione Java: la versione Java dipende dal parametro java-version. È impostata su 11 per impostazione predefinita.
  • Fornitore Java: il fornitore Java è impostato su una costante: temurin.

Ad esempio, il tag dell'immagine della community Docker generato per Tomcat versione 9.0, Java versione 11 e fornitore Java temurin è tomcat:9.0-jre11-temurin.

Nel piano di migrazione, il campo baseImage.name rappresenta il tag immagine Docker utilizzato come base dell'immagine container.

Le versioni Tomcat e Java originali rilevate sulla VM di origine sono contenute in discovery-report.yaml generato dal rilevamento iniziale.

Se vuoi cambiare l'immagine della community Docker o fornire la tua immagine Docker, puoi modificare baseImage.name nel piano di migrazione utilizzando il formato seguente:

tomcatServers:
    - name: latest
      . . .
      images:
        - name: tomcat-latest
          . . .
          baseImage:
            name: BASE_IMAGE_NAME

Sostituisci BASE_IMAGE_NAME con l'immagine Docker che vuoi utilizzare come base dell'immagine container.

Aggiorna percorso di installazione Tomcat

Durante il processo di migrazione, se l'immagine di destinazione ha un percorso CATALINA_HOME non predefinito, puoi specificare un percorso CATALINA_HOME personalizzato. Modifica il campo catalinaHome di destinazione direttamente nel piano di migrazione:

tomcatServers:
  - name: latest
    . . .
    images:
      - name: tomcat-latest
        . . .
        baseImage:
          name: BASE_IMAGE_NAME
          catalinaHome: PATH

Sostituisci PATH con il percorso di installazione di Tomcat.

Personalizza utente e gruppo

Durante il processo di migrazione, se l'immagine di destinazione viene eseguita con un utente e un gruppo diversi da root:root, puoi specificare un utente e un gruppo personalizzati in base al quale vuoi eseguire l'applicazione. Modifica l'utente e il gruppo direttamente nel piano di migrazione:

tomcatServers:
  - name: latest
    . . .
    images:
      - name: tomcat-latest
        . . .
        userName: USERNAME
        groupName: GROUP_NAME

Sostituisci quanto segue:

  • USERNAME: il nome utente che vuoi utilizzare
  • GROUP_NAME: il nome del gruppo che vuoi utilizzare

Configura SSL

Quando crei una nuova migrazione Tomcat, un processo di rilevamento analizza il server e cerca le diverse applicazioni rilevate.

Dopo il rilevamento, i seguenti campi vengono compilati automaticamente nel piano di migrazione:

  • excludeFiles: elenca i file e le directory da escludere dalla migrazione.

    Per impostazione predefinita, tutti i percorsi e i certificati sensibili situati durante il rilevamento vengono aggiunti automaticamente a questo campo ed esclusi dalla migrazione. Se rimuovi un percorso dall'elenco, il file o la directory vengono caricati nell'immagine container. Per escludere un file o una directory dall'immagine container, aggiungi il percorso a questo elenco.

  • sensitiveDataPaths: elenca tutti i percorsi e i certificati sensibili individuati dal processo di rilevamento.

    Per caricare i certificati nel repository, imposta il campo includeSensitiveData su true:

    # Sensitive data which will be filtered out of the container image.
# If includeSensitiveData is set to true the sensitive data will be mounted on the container.

includeSensitiveData: true
tomcatServers:
- name: latest
  catalinaBase: /opt/tomcat/latest
  catalinaHome: /opt/tomcat/latest
  # Exclude files from migration.
  excludeFiles:
  - /usr/local/ssl/server.pem
  - /usr/home/tomcat/keystore
  - /usr/home/tomcat/truststore
  images:
  - name: tomcat-latest
    ...
    # If set to true, sensitive data specified in sensitiveDataPaths will be uploaded to the artifacts repository.
    sensitiveDataPaths:
    - /usr/local/ssl/server.pem
    - /usr/home/tomcat/keystore
    - /usr/home/tomcat/truststore

    Al termine della migrazione, i secret vengono aggiunti al file secret secrets.yaml nel repository degli artefatti.

Logging delle app web

Migrate to Containers supporta il logging con log4j v2, logback e log4j v1.x che risiedono in CATALINA_HOME.

Migrate to Containers crea un file di archivio aggiuntivo con configurazioni di log modificate e converti tutti gli appender dei tipi di file negli appender della console. Puoi utilizzare i contenuti di questo archivio come riferimento per abilitare la raccolta di log e trasmetterli in una soluzione di raccolta dei log (come Google Cloud Logging).

Allocazione della memoria

Durante il processo di migrazione, puoi specificare i limiti di memoria delle applicazioni di cui è stata eseguita la migrazione nei singoli container. Modifica i limiti di memoria direttamente nel piano di migrazione utilizzando il seguente formato:

tomcatServers:
    - name: latest
      . . .
      images:
        - name: tomcat-latest
          . . .
          resources:
            memory:
              limit: 2048M
              requests: 1280M

Il valore consigliato per limit è il 200% di Xmx, che corrisponde alla dimensione massima dell'heap Java. Il valore consigliato per requests è il 150% di Xmx.

Per vedere il valore di Xmx, esegui questo comando:

ps aux | grep catalina

Se nel piano di migrazione sono stati definiti limiti di memoria, il Dockerfile generato insieme ad altri artefatti dopo una migrazione riflette la tua dichiarazione:

FROM tomcat:8.5-jdk11-openjdk

# Add JVM environment variables for tomcat
ENV CATALINA_OPTS="${CATALINA_OPTS} -XX:MaxRAMPercentage=50.0 -XX:InitialRAMPercentage=50.0 -XX:+UseContainerSupport <additional variables>"

Definisce la dimensione iniziale e quella massima in modo che corrisponda al 50% del valore limite. Ciò consente a la dimensione di allocazione heap di Tomcat Java di cambiare in base a qualsiasi modifica al limite di memoria del pod.

Imposta le variabili di ambiente Tomcat

Se vuoi impostare CATALINA_OPTS nel Dockerfile generato insieme ad altri artefatti dopo una migrazione riuscita, puoi prima aggiungere il campo catalinaOpts nel piano di migrazione. L'esempio seguente mostra un campo catalinaOpts aggiornato:

tomcatServers:
    - name: latest
      . . .
      images:
        - name: tomcat-latest
          . . .
          resources:
            . . .
          catalinaOpts: "-Xss10M"

Migrate to Containers analizza i dati catalinaOpts nel Dockerfile. L'esempio seguente mostra l'output dell'analisi:

FROM 8.5-jdk11-openjdk-slim

## setenv.sh script detected.
## Modify env variables on the script and add definitions to the migrated
## tomcat server, if needed (less recommended than adding env variables directly
## to CATALINA_OPTS) by uncomment the line below
#ADD --chown=root:root setenv.sh /usr/local/tomcat/bin/setenv.sh

# Add JVM environment variables for the tomcat server
ENV CATALINA_OPTS="${CATALINA_OPTS} -XX:MaxRAMPercentage=50.0 -XX:InitialRAMPercentage=50.0 -Xss10M"

Puoi anche impostare le variabili di ambiente Tomcat utilizzando lo script setenv.sh, che si trova nella cartella /bin sul tuo server Tomcat. Per ulteriori informazioni sulle variabili di ambiente Tomcat, consulta la documentazione di Tomcat.

Se scegli di utilizzare setenv.sh per impostare le variabili di ambiente Tomcat, devi modificare il Dockerfile.

Imposta probe di integrità Tomcat

Puoi monitorare il tempo di inattività e lo stato di pronto dei container gestiti specificando probe nel piano di migrazione del server web Tomcat. Il monitoraggio del probe di integrità può aiutare a ridurre i tempi di inattività dei container di cui è stata eseguita la migrazione e a fornire un monitoraggio migliore.

Gli stati di integrità sconosciuti possono comportare un peggioramento della disponibilità, un monitoraggio dei falsi positivi della disponibilità e una potenziale perdita di dati. Senza un probe di integrità, kubelet può solo assumere l'integrità di un container e inviare traffico a un'istanza di container non pronta. Ciò può causare una perdita di traffico. Inoltre, kubelet potrebbe non rilevare i container in stato bloccato e non li riavvia.

Un probe di integrità funziona eseguendo una piccola istruzione basata su script all'avvio del container. Lo script verifica ogni periodo la presenza di condizioni con esito positivo, definite dal tipo di probe utilizzato. Il periodo è definito nel piano di migrazione da un campo periodSeconds. Puoi eseguire o definire questi script manualmente.

Per saperne di più sui probe kubelet, consulta Configurare probe di attività, idoneità e avvio nella documentazione di Kubernetes.

Sono disponibili due tipi di probe da configurare, entrambi probe-v1-core definiti in probe-v1-corereference e condividono la stessa funzione dei campi corrispondenti di container-v1-core

  • Probe di attività: i probe di attività vengono utilizzati per sapere quando riavviare un container.

  • Probe di idoneità: i probe di idoneità sono utilizzati per sapere quando un container è pronto per iniziare ad accettare traffico. Per iniziare a inviare traffico a un pod solo quando il probe ha esito positivo, specifica un probe di idoneità. Un probe di idoneità potrebbe agire in modo simile a un probe di attività, ma un probe di idoneità nelle specifiche indica che un pod si avvia senza ricevere traffico e inizia a riceverlo solo dopo l'esito positivo del probe.

Dopo il rilevamento, la configurazione del probe viene aggiunta al piano di migrazione. I probe possono essere utilizzati nella configurazione predefinita, come mostrato nell'esempio seguente. Per disattivare i probe, rimuovi la sezione probes dal file YAML.

tomcatServers:
- name: latest
  images:
  - name: tomcat-latest
    ports:
    - 8080
    probes:
      livenessProbe:
        tcpSocket:
          port: 8080
      readinessProbe:
        tcpSocket:
          port: 8080

Puoi cambiare questo piano di migrazione in modo che utilizzi un endpoint HTTP Tomcat esistente.

tomcatServers:
- name: latest
  images:
  - name: tomcat-latest
    ports:
    - 8080
    probes:
      livenessProbe:
       httpGet:
          path: /healthz
          port: 8080
          httpHeaders:
          - name: Custom-Header
            value: Awesome
        initialDelaySeconds: 3
        periodSeconds: 3
      readinessProbe:
        httpGet:
        tcpSocket:
          port: 8080

Esistono quattro modi predefiniti per controllare un container con un probe. Ogni probe deve definire esattamente uno di questi quattro meccanismi:

  • exec: esegue un comando specificato all'interno del container. L'esecuzione viene considerata riuscita se il codice di stato dell'uscita è 0.
  • grpc: esegue una chiamata di procedura remota utilizzando "gRPC". I probe "gRPC" sono una funzionalità alfa.
  • httpGet: esegue una richiesta GET HTTP sull'indirizzo IP del pod su una porta e un percorso specificati. La richiesta viene considerata riuscita se il codice di stato è maggiore o uguale a 200 e inferiore a 400.
  • tcpSocket: esegue un controllo TCP rispetto all'indirizzo IP del pod su una porta specificata. La diagnostica viene considerata riuscita se la porta è aperta.

Per impostazione predefinita, un piano di migrazione abilita il metodo di probe tcpSocket. Utilizza la configurazione manuale del piano di migrazione per utilizzare metodi di probe diversi. Puoi anche definire comandi e script personalizzati tramite il piano di migrazione.

Per aggiungere dipendenze esterne per il probe di idoneità, mentre utilizzi il probe di attività predefinito, definisci un probe di idoneità exec e uno script che implementi la logica.

Verifica la configurazione del clustering Tomcat

Il clustering Tomcat viene utilizzato per replicare le informazioni di sessione tra tutti i nodi Tomcat, in modo da poter chiamare qualsiasi server delle applicazioni di backend senza perdere le informazioni sulla sessione client. Per ulteriori informazioni sulla configurazione del clustering, consulta Istruzioni per la replica di cluster/sessioni nella documentazione Tomcat.

La classe di clustering Tomcat si chiama SimpleTcpListener, che utilizza messaggi heartbeat multicast per il rilevamento tra pari. Gli ambienti cloud non supportano il multicast, quindi devi modificare o rimuovere la configurazione del clustering, se possibile.

Quando un bilanciatore del carico è configurato per eseguire e mantenere una sessione fissa sul server Tomcat di backend, può utilizzare la proprietà jvmRoute configurata nella configurazione server.xml Engine.

Se l'ambiente di origine utilizza una configurazione di clustering non supportata, modifica il file server.xml per disabilitare la configurazione oppure utilizza una configurazione supportata.

  • Tomcat 8.5 o versioni successive: il clustering deve essere disabilitato su Tomcat 8.5. Per disabilitare il clustering, devi commentare la sezione <Cluster … /> in server.xml.

  • Tomcat 9 o versioni successive: in Tomcat 9 o versioni successive, puoi abilitare la classe Cluster utilizzando KubernetesMembershipService. KubernetesMembershipService è una classe specifica di Kubernetes, che usa le API Kubernetes per il rilevamento peer.

    • Provider Kubernetes: di seguito è riportato un esempio di configurazione per un provider Kubernetes:

      <Cluster className="org.apache.catalina.ha.tcp.SimpleTcpCluster">
<Channel className="org.apache.catalina.tribes.group.GroupChannel">
<Membership className="org.apache.catalina.tribes.membership.cloud.CloudMembershipService" membershipProviderClassName="org.apache.catalina.tribes.membership.cloud.KubernetesMembershipProvider"/>
</Channel>
</Cluster>

    • Provider DNS: utilizza DNSMembershipProvider per utilizzare le API DNS per il rilevamento peer. Di seguito è riportata una configurazione di esempio per un provider DNS:

      <Cluster className="org.apache.catalina.ha.tcp.SimpleTcpCluster">
<Channel className="org.apache.catalina.tribes.group.GroupChannel">
<Membership className="org.apache.catalina.tribes.membership.cloud.CloudMembershipService" membershipProviderClassName="org.apache.catalina.tribes.membership.cloud.DNSMembershipProvider"/>
</Channel>
</Cluster>

    • jvmRoute: quando il bilanciatore del carico si basa su un valore jvmRoute, il valore dovrebbe essere modificato da statico all'utilizzo del nome del pod. In questo modo, Tomcat viene configurato per aggiungere un suffisso al cookie di sessione con il nome del pod. Può essere utilizzato dal bilanciatore del carico frontend per indirizzare il traffico al POD Tomcat corretto. Modifica il valore nel file server.xml per utilizzare quanto segue:

      <Engine name="Catalina" defaultHost="localhost" jvmRoute="${HOSTNAME}">

Verifica la configurazione del proxy Tomcat

Se Tomcat è configurato per essere eseguito dietro un proxy inverso o utilizzando diverse impostazioni di configurazione del proxy nella sezione Connector di server.xml, devi verificare che le stesse configurazioni del proxy siano ancora applicabili dopo la migrazione per l'esecuzione in Kubernetes.

Per eseguire un'applicazione Tomcat containerizzata funzionale, scegli una delle seguenti modifiche alla configurazione proxy inversa:

  • Disabilita configurazione proxy: se l'applicazione di cui è stata eseguita la migrazione non viene più eseguita con un proxy inverso, puoi disattivare la configurazione del proxy rimuovendo proxyName e proxyPort dalla configurazione del connettore.
  • Esegui la migrazione del proxy: esegui la migrazione della VM proxy e conserva tutte le configurazioni Tomcat esistenti.

  • Configura Ingress per sostituire il proxy inverso: se non è stata implementata alcuna logica personalizzata o sofisticata per il proxy inverso, puoi configurare una risorsa Ingress per esporre l'applicazione Tomcat migrata. Questo processo utilizza lo stesso FQDN utilizzato prima della migrazione. Per configurare una risorsa Ingress, devi verificare che il tuo servizio Kubernetes Tomcat sia di type: Nodeport. Di seguito è riportata una configurazione di esempio di una risorsa Ingress:

    apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: my-tomcat-ingress
spec:
  rules:
  - host: APP_DOMAIN
    http:
      paths:
      - pathType: ImplementationSpecific
        backend:
          service:
            name: my-tomcat-service
            port:
              name: my-tomcat-port

  • Configura Cloud Service Mesh con Cloud Load Balancing: se utilizzi GKE Enterprise, puoi scegliere di esporre l'applicazione utilizzando Cloud Service Mesh. Per scoprire di più sull'esposizione delle applicazioni mesh di servizi, consulta Da perimetrale al mesh: esposizione delle applicazioni mesh di servizi tramite GKE Ingress.

Verifica la configurazione del proxy Java

Durante la migrazione ai container, devi verificare la disponibilità dei server proxy nel nuovo ambiente. Quando il server proxy non è disponibile, scegli una delle seguenti modifiche alla configurazione del proxy:

  • Disabilita proxying:se il proxy originale non è più in uso, disattiva la configurazione del proxy. Rimuovi tutte le impostazioni del proxy dallo script setenv.sh o dal file di configurazione in cui sono gestite sul server Tomcat.
  • Modifica le impostazioni del proxy: se il tuo ambiente Kubernetes utilizza un proxy in uscita diverso, puoi modificare le impostazioni del proxy in setenv.sh o in un altro file, in modo che puntino al nuovo proxy.

Passaggi successivi