Aktualisieren der Version Protokollierungsagent mit Hilfe einer Helm Tabelle

Sie können die Version Protokollierungsagent mit Hilfe einer Helm Tabelle aktualisieren.

Führen Sie die folgenden Schritte aus, um die Version des Agenten zu aktualisieren, der im Cluster bereitgestellt wird:

Wenn Sie eine frühere Version von Protokollierungsagent installiert haben und die Agentenkonfiguration durch Änderung der config map direkt im Cluster aktualisiert haben, erstellen Sie eine Kopie Ihrer config map aus dem Cluster, bevor Sie den Befehl helm upgrade ausführen. Wenn die Protokollierungsagent aktualisiert wird, werden alle an der Config Map vorgenommenen Änderungen überschrieben.

Vorbereitende Schritte

  • Vergewissern Sie sich, dass Sie Zugriff auf den Kubernetes haben und berechtigt sind, Namespaces zu erstellen und den Agenten bereitzustellen.

  • Erstellen Sie eine Kopie der aktuellen Konfigurationsdatei für den Logging Agent. Führen Sie den folgenden Befehl aus: kubectl get cm logs-agent -n ibm-observe -o yaml > logging-agent-backup-cm.yaml

  • Installieren Sie die folgenden CLIs:

    • Die IBM Cloud CLI, um sich bei der IBM Cloud anzumelden und die IBM Cloud Dienste zu verwalten, wie z.B. die Erstellung eines API-Schlüssels.

    • Die Kubernetes CLI zur Verwaltung von Kubernetes Clustern mit Hilfe von kubectl Befehlen. Weitere Informationen.

    • Die Openshift CLI zur Verwaltung von OpenShift über die Kommandozeile. Weitere Informationen.

  • Lesen Sie mehr über den Protokollierungsagent.

  • Prüfen Sie die verfügbaren Agentenversionen. Weitere Informationen finden Sie unter Prüfen der verfügbaren Agentenversionen. Beachten Sie, dass die Version des Helm mit der Version des Agenten übereinstimmt - wenn Sie z. B. Version 1.3.0 des Agenten verwenden, gibt es ein Helm mit Version 1.3.0, das mit dieser Version einhergeht.

Schritt 1. Aktualisieren Sie die Helm für den Protokollierungsagent

Führen Sie die folgenden Schritte aus, um das Helm mit der Agentenversion zu ändern, die Sie einsetzen möchten:

  1. Aktualisieren Sie die Datei logs-values.yaml, die Sie zur Bereitstellung des Agenten verwendet haben, mit dem folgenden Inhalt:

    Die Datei logs-values.yaml enthält die Konfigurationen, die für Ihre Bereitstellung spezifisch sind.

    Wenn Sie nicht über die Datei logs-values.yaml verfügen, die Sie für die Bereitstellung des Agenten verwendet haben, erstellen Sie eine Datei auf der Grundlage der aktuellen configmap-Konfiguration des Agenten.

    metadata:
      name: "logs-agent"
    image:
      version: "1.6.1"  # Modify the agent version and enter the version that you want to deploy
    
    clusterName: "ENTER_CLUSTER_NAME"     # Enter the name of your cluster. This information is used to improve the metadata and help with your filtering.
    
    additionalMetadata: # add additional metadata, for example:
      region: au-syd
      env: production
      logs-agent-version: 1.6.1     # Enter the agent version that you want to deploy
    
    env:
      # ingestionHost is a required field. For example:
      # ingestionHost: "<logs instance>.ingress.us-east.logs.cloud.ibm.com"
      ingestionHost: "" # required
    
      # If you are using private CSE proxy, then use port number "3443"
      # If you are using private VPE Gateway, then use port number "443"
      # If you are using the public endpoint, then use port number "443"
      ingestionPort: "" # required
    
      iamMode: "TrustedProfile"
      # trustedProfileID - trusted profile id - required for iam trusted profile mode
      trustedProfileID: "" # required if iamMode is set to TrustedProfile
    
    

Schritt 2. Aktualisieren Sie den Agenten

Wenn Sie " iamMode als " IAMAPIKey verwenden, muss der apikey in einem Kubernetes namens " logs-agent mit dem Schlüsselnamen " IAM_API_KEY vorhanden sein. Das Geheimnis kann mit der Helm erstellt werden, indem bei der Helm-Installation die Option " --set secret.iamAPIKey=<your iamAPIKey> angegeben wird. Wenn das Geheimnis manuell erstellt wurde oder wenn Sie " iamMode=TrustedProfile verwenden, lassen Sie diese Option weg.

Führen Sie die folgenden Schritte aus:

  1. Melden Sie sich am Cluster an. Weitere Informationen finden Sie unter Zugriff auf Ihren Cluster.

  2. Aktualisieren Sie den Agenten.

    Wenn Sie eine frühere Version von Protokollierungsagent installiert haben und die Agentenkonfiguration durch Änderung der config map direkt im Cluster aktualisiert haben, erstellen Sie eine Kopie Ihrer config map aus dem Cluster, bevor Sie den Befehl helm upgrade ausführen. Wenn die Protokollierungsagent aktualisiert wird, werden alle an der Config Map vorgenommenen Änderungen überschrieben.

    Wenn Sie ' iamMode=TrustedProfile verwenden, lautet der vollständige Befehl:

    helm upgrade <install-name> oci://icr.io/ibm-observe/logs-agent-helm --version <chart-version> --values <PATH>/logs-values.yaml -n ibm-observe
    

    Wenn Sie ' iamMode=IAMAPIKey verwenden, lautet der vollständige Befehl:

    helm upgrade <install-name> oci://icr.io/ibm-observe/logs-agent-helm --version <chart-version> --values <PATH>/logs-values.yaml -n ibm-observe --set secret.iamAPIKey=<APIKey-value>
    

    Dabei gilt:

    • <install-name> ist der Name der Installation von Helm (logs-agent). Sie können den folgenden Befehl ausführen, um den Namen der Installation zu ermitteln: helm list -n ibm-observe
    • <chart-version> ist die Version der Steuerkarte. Die Helm sollte mit der Version des Agent-Images übereinstimmen. Weitere Informationen finden Sie unter Helm.
    • <PATH> ist der Verzeichnispfad, in dem sich die Datei " logs-values.yaml befindet.
    • <APIKey-value> ist der IAM-Schlüssel, der mit ServiceID verknüpft ist.

    Sie können zum Beispiel den folgenden Befehl von dem Verzeichnis aus ausführen, in dem die Datei " logs-values.yaml verfügbar ist:

    helm upgrade logs-agent oci://icr.io/ibm-observe/logs-agent-helm --version 1.5.0 --values ./logs-values.yaml -n ibm-observe --set secret.iamAPIKey=<secret>
    

    Um den Namen des installierten Agenten und die Diagrammversion zu sehen, können Sie helm list -n NAMESPACE ausführen.

  3. Starten Sie die Agent-Pods neu.

    Bei Kubernetes führen Sie aus:

    kubectl -n ibm-observe rollout restart ds/logs-agent
    

    Für OpenShift führen Sie aus:

    oc -n ibm-observe rollout restart ds/logs-agent
    
  4. Überprüfen Sie, ob alle Pods neu gestartet sind, den Status running haben und keine Fehler melden.

    Bei Kubernetes führen Sie aus:

    kubectl get pods -n ibm-observe
    

    Für OpenShift führen Sie aus:

    oc get pods -n ibm-observe
    

Schritt 3. Überprüfen Sie, ob die Protokolle an Ihr Ziel übermittelt werden

Führen Sie die folgenden Schritte aus:

  1. Rufen Sie die Web-UI für Ihre IBM Cloud Logs auf.

  2. Wenn Ihr Agent korrekt konfiguriert ist, können Sie die Protokolle über die Standard-Dashboard-Ansicht einsehen. Der Protokollierungsagent kennzeichnet Protokolleinträge mit einem Kubernetes-Objekt, das den Clusternamen enthält.

    kubernetes.cluster_name:<CLUSTER_NAME>
    

    Sie können die Abfrage ' kubernetes.cluster_name:<YOUR_CLUSTER_NAME> in Ihrer IBM Cloud Logs Instanz ausführen, um nach Protokollen zu suchen, die von Ihrem Cluster erzeugt werden.