Personalizzare 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 di il piano di migrazione viene utilizzato 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 di deployment.

Prima di iniziare

Questo argomento presuppone che tu abbia già creato una migrazione e che tu abbia 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 esigenze e salva le modifiche.

Esamina i dettagli del piano di migrazione e le indicazioni per aggiungere informazioni, se necessario. Nello specifico, valuta la possibilità di apportare modifiche alle seguenti sezioni.

Specifica l'immagine Docker

Nel piano di migrazione, generiamo un tag dell'immagine della community Docker in base alla versione di Tomcat, alla versione di Java e al fornitore di Java.

  • Versione Tomcat: la versione di Tomcat viene rilevata e convertita in una versione principale (le versioni minori non sono supportate). Se non rileviamo un tomcat , allora baseImage.name contiene una stringa vuota.
  • Versione Java: la versione Java dipende dal parametro java-version. Per impostazione predefinita è impostato su 11.
  • 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 il fornitore Java temurin è tomcat:9.0-jre11-temurin.

Nel piano di migrazione, il campo baseImage.name rappresenta il tag dell'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 il tuo Docker puoi modificare baseImage.name nel piano di migrazione utilizzando seguente formato:

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 del contenitore.

Aggiorna percorso di installazione Tomcat

Durante il processo di migrazione, se l'immagine di destinazione ha un'immagine non predefinita Percorso CATALINA_HOME, dopodiché 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.

Personalizzare utente e gruppo

Durante il processo di migrazione, se l'immagine di destinazione viene eseguita con un altro utente e un gruppo di root:root, puoi specificare un utente e un gruppo personalizzati in cui 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 di Tomcat, un processo di rilevamento esegue la scansione del server rispetto alle diverse applicazioni rilevate.

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

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

    Per impostazione predefinita, tutti i percorsi e i certificati sensibili individuati 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 all'immagine container. Per escludere un file o una directory dal container: immagine, aggiungi il percorso a questo elenco.

  • sensitiveDataPaths: elenca tutti i percorsi e i certificati sensibili rilevati dalla procedura 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 si trovano in CATALINA_HOME.

La migrazione a Containers crea un file di archivio aggiuntivo con configurazioni dei log modificate e converte tutti gli aggiunti di tipo di file in aggiunti della console. Puoi utilizzare i contenuti di questo archivio come riferimento per attivare la raccolta e lo streaming dei log 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 in 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 al numero massimo di Java heap. Il valore consigliato per requests è il 150% di Xmx.

Per visualizzare il valore di Xmx, esegui il seguente comando:

ps aux | grep catalina

Se nel piano di migrazione sono stati definiti limiti di memoria, il Dockerfile che è stato generato insieme ad altri elementi dopo una migrazione riuscita 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. In questo modo, la dimensione dell'allocazione dell'heap Java di Tomcat può cambiare in base a qualsiasi modifica del limite di memoria del pod.

Imposta le variabili di ambiente di Tomcat

Se vuoi impostare CATALINA_OPTS nel file Dockerfile generato insieme ad altri elementi dopo una migrazione riuscita, puoi prima aggiungere il campo catalinaOpts nel piano di migrazione. La 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 nei tuoi 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 di Tomcat utilizzando lo script setenv.sh, che si trova nella cartella /bin sul server Tomcat. Per maggiori informazioni informazioni sulle variabili di ambiente Tomcat, consulta 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 riposo e lo stato di disponibilità dei contenitori gestiti specificando le sonde nel piano di migrazione del server web Tomcat. Il monitoraggio dei controlli di salute può contribuire a ridurre i tempi di inattività dei container sottoposti a migrazione e a fornire un monitoraggio migliore.

Gli stati di integrità sconosciuti possono causare un peggioramento della disponibilità, falsi positivi il monitoraggio della disponibilità e la potenziale perdita di dati. Senza un probe di integrità, kubelet può solo assumere l'integrità di un contenitore e potrebbe inviare traffico a un'istanza del contenitore non pronta. Ciò può causare una perdita di traffico. Kubelet potrebbe anche non rilevare i contenitori in stato di blocco e non riavviarli.

Una sonda di stato funziona eseguendo una piccola istruzione basata su script all'avvio del container. Lo script verifica la presenza di condizioni riuscite, ovvero definita dal tipo di probe utilizzato, per ogni periodo. Il periodo è definito nel piano di migrazione in base a un campo periodSeconds. Puoi eseguire o definire questi script manualmente.

Per scoprire 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, che vengono probe-v1-core definito nel riferimento probe-v1-core e condividono la stessa funzione dei campi corrispondenti 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à vengono utilizzati per sapere quando un container è pronto per iniziare ad accettare il traffico. Per iniziare a inviare traffico a un pod solo quando un 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 avvia che ricevono traffico dopo l'esito positivo del probe.

Dopo il rilevamento, la configurazione del probe viene aggiunta al piano di migrazione. La i probe possono essere utilizzati nella loro configurazione predefinita, come illustrato di seguito esempio. Per disattivare i controlli, 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 contenitore utilizzando una sonda. Ogni probe deve definire esattamente uno di questi quattro meccanismi:

  • exec: esegue un comando specificato all'interno del container. L'esecuzione è considerata riuscita se il codice di stato di uscita è 0.
  • grpc: esegue una chiamata di procedura remota utilizzando "gRPC". I controlli "gRPC" sono una funzionalità alpha.
  • httpGet: esegue una richiesta GET HTTP sull'IP del pod su una porta e un percorso specificati. La richiesta è considerata riuscita se il codice di stato è maggiore o uguale a 200 e minore di 400.
  • tcpSocket: esegue un controllo TCP sull'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 controllo di idoneità, utilizzando al contempo il controllo di attività predefinito, definisci un controllo di idoneità all'esecuzione e uno script che implementi la logica.

Verifica la configurazione del clustering di Tomcat

Il clustering di Tomcat viene utilizzato per replicare le informazioni sulla sessione su tutti i nodi Tomcat, il che ti consente di chiamare uno qualsiasi dei server di applicazioni di backend e di non perdere le informazioni sulla sessione del client. Per saperne di più sulla configurazione del clustering, consulta la guida pratica sulla replica di cluster/sessione nella documentazione di Tomcat.

La classe di clustering Tomcat si chiama SimpleTcpListener e utilizza il multicast di messaggi cardiaci per il rilevamento dei pari. Gli ambienti cloud non supportano il multicast, quindi devi modificare la configurazione del clustering o rimuoverla, se possibile.

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

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

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

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

    • Provider Kubernetes: di seguito è riportata una configurazione di esempio 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: usa DNSMembershipProvider per usare le API DNS. per la peer discovery. Di seguito è riportata una configurazione di esempio per un DNS. fornitore:

      <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 deve essere modificato da statico in modo da utilizzare il nome del pod. In questo modo viene configurato Tomcat per aggiungere un suffisso al cookie di sessione con il nome del pod. Questo può essere utilizzato dal bilanciatore del carico frontend per indirizzare il traffico all'infrastruttura Tomcat POD. Modifica il valore nel file server.xml in modo da utilizzare quanto segue:

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

Verifica la configurazione del proxy Tomcat

Se Tomcat è configurato per funzionare dietro un proxy inverso o utilizza 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 le seguenti modifiche alla configurazione proxy inversa:

  • Disattiva configurazione proxy:se l'applicazione di cui è stata eseguita la migrazione non è più viene eseguito dietro un proxy inverso, puoi disabilitare la configurazione del proxy rimuovendo proxyName e proxyPort dalla configurazione del connettore.
  • Esegui la migrazione del proxy: esegui la migrazione della VM proxy e mantieni tutte le configurazioni di 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 di cui è stata eseguita la migrazione. Questo procedura 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 un 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 un Cloud Service Mesh con il bilanciamento del carico Cloud: se utilizzi GKE Enterprise, puoi scegliere di esporre la tua 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à del proxy nel nuovo ambiente. Quando il server proxy non è disponibile, scegli una delle seguenti modifiche di configurazione del proxy:

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

Passaggi successivi