Actualización de la versión Agente de registro mediante un gráfico Helm

Puede actualizar la versión Agente de registro utilizando un gráfico Helm.

Complete los siguientes pasos para actualizar la versión del agente que está desplegado en el clúster:

Si ha instalado una versión anterior de Agente de registro y ha actualizado la configuración del agente modificando el mapa de configuración directamente en el clúster, haga una copia de su mapa de configuración desde el clúster antes de ejecutar el comando helm upgrade. Cuando se actualice Agente de registro, se sobrescribirá cualquier cambio realizado en el mapa de configuración.

Antes de empezar

  • Asegúrese de tener acceso al clúster Kubernetes con permisos para crear namespaces y desplegar el agente.

  • Tome una copia del mapa de configuración actual para el agente de registro. Ejecute: kubectl get cm logs-agent -n ibm-observe -o yaml > logging-agent-backup-cm.yaml

  • Instalación de las CLI siguientes:

    • La CLI de ' IBM Cloud ' para iniciar sesión en ' IBM Cloud y gestionar los servicios de ' IBM Cloud ', como crear una clave API.

    • La CLI Kubernetes para gestionar clusters Kubernetes utilizando comandos kubectl. Más información.

    • La CLI de Openshift para gestionar clústeres OpenShift desde la línea de comandos. Más información.

  • Lea sobre el Agente de registro.

  • Compruebe las versiones de agente disponibles. Para más información, consulte Comprobar las versiones de agente disponibles. Tenga en cuenta que la versión del gráfico ' Helm ' coincidirá con la versión del agente - por ejemplo, si está utilizando la versión ' 1.3.0 del agente hay un gráfico ' Helm ' con la versión ' 1.3.0 ' que acompaña a esa versión.

Paso 1. Actualizar el archivo de valores del gráfico Helm para el Agente de registro

Complete los siguientes pasos para modificar el gráfico de Helm con la versión del agente que planea desplegar:

  1. Actualice el archivo logs-values.yaml que utilizó para desplegar el agente con el siguiente contenido:

    El archivo logs-values.yaml contiene las configuraciones específicas de su implantación.

    Si no dispone del fichero logs-values.yaml que utilizó para desplegar el agente, cree uno basado en la configuración actual del configmap del agente.

    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
    
    

Paso 2. Actualizar el agente

Si utiliza el " iamMode " como " IAMAPIKey, el apikey debe estar presente en un secreto Kubernetes denominado " logs-agent " con el nombre de clave " IAM_API_KEY. El secreto puede crearse utilizando el gráfico de Helm incluyendo la opción ' --set secret.iamAPIKey=<your iamAPIKey> ' al ejecutar la instalación de helm. Si el secreto se ha creado manualmente o si utiliza " iamMode=TrustedProfile ", no incluya esta opción.

Complete los pasossiguientes:

  1. Inicie una sesión en el clúster. Para más información, consulte Acceda a su clúster.

  2. Actualiza el agente.

    Si ha instalado una versión anterior de Agente de registro y ha actualizado la configuración del agente modificando el mapa de configuración directamente en el clúster, haga una copia de su mapa de configuración desde el clúster antes de ejecutar el comando helm upgrade. Cuando se actualice Agente de registro, se sobrescribirá cualquier cambio realizado en el mapa de configuración.

    Si está utilizando el ' iamMode=TrustedProfile entonces el comando completo es:

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

    Si está utilizando el ' iamMode=IAMAPIKey entonces el comando completo es:

    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>
    

    donde:

    • <install-name> es el nombre de la instalación de Helm (logs-agent). Puede ejecutar el siguiente comando para obtener el nombre de la instalación: helm list -n ibm-observe
    • <chart-version> es la versión del gráfico del timón. La versión del gráfico de Helm debe coincidir con la versión de la imagen del agente. Para más información, consulte las versiones de los gráficos deHelm.
    • <PATH> es la ruta del directorio donde se encuentra el archivo ' logs-values.yaml '.
    • <APIKey-value> es el apikey de IAM asociado al ServiceID.

    Por ejemplo, puede ejecutar el siguiente comando desde el directorio en el que esté disponible el archivo " logs-values.yaml ":

    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>
    

    Para ver el nombre del agente instalado y la versión del gráfico, puede ejecutar helm list -n NAMESPACE.

  3. Reinicie los pods de agentes.

    Para clústeres Kubernetes, ejecute:

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

    Para clústeres OpenShift, ejecute:

    oc -n ibm-observe rollout restart ds/logs-agent
    
  4. Compruebe que todos los pods se han reiniciado, en estado running, y no informan de errores.

    Para clústeres Kubernetes, ejecute:

    kubectl get pods -n ibm-observe
    

    Para clústeres OpenShift, ejecute:

    oc get pods -n ibm-observe
    

Paso 3. Compruebe que los registros se envían al destino deseado

Complete los pasossiguientes:

  1. Vaya a la interfaz web de su instancia IBM Cloud Logs.

  2. Cuando su agente esté correctamente configurado, podrá ver los registros a través de la vista predeterminada del panel de control. El Agente de registro etiqueta los registros de log con un objeto kubernetes que incluye el nombre del clúster.

    kubernetes.cluster_name:<CLUSTER_NAME>
    

    Puede ejecutar la consulta ' kubernetes.cluster_name:<YOUR_CLUSTER_NAME> en su instancia IBM Cloud Logs para buscar los registros generados por su clúster.