Se usó la API de Cloud Translation para traducir esta página.

Administra secretos en la configuración del recopilador de OpenTelemetry compilado por Google

Configurar algunos componentes, como receptores o exportadores, podría requerir que proporciones secretos, como contraseñas. Puedes incluir estos secretos como texto sin formato en los archivos de configuración del recopilador. Sin embargo, estos secretos se incluyen en los registros del sistema que escribe el recopilador y se transmiten a Cloud Logging, lo que expone los secretos más allá del nodo o la máquina virtual (VM) en la que se ejecuta el recopilador.

A partir de la versión 0.126.0 del recopilador compilado por Google, puedes usar un proveedor de OpenTelemetry integrado en Secret Manager para eliminar los secretos de texto sin formato en tus archivos de configuración.

Un proveedor es un componente de configuración de OpenTelemetry, análogo a los componentes de receptor y procesador. Cada proveedor tiene un tipo, y cada tipo de proveedor asigna un identificador específico en la configuración a un valor.

El proveedor googlesecretmanager asigna identificadores de Secret Manager a los secretos, como contraseñas, tokens y claves de API, que almacenaste en Secret Manager. El uso del proveedor googlesecretmanager ofrece los siguientes beneficios:

Seguridad mejorada: Tus archivos de configuración no contienen información sensible, como contraseñas. Los secretos reales se almacenan en Secret Manager, un servicio diseñado específicamente para almacenar, acceder y administrar datos sensibles de forma segura.
Menor riesgo de exposición: Secret Manager recupera secretos durante la inicialización del recopilador de OpenTelemetry integrado en Google, lo que evita que los secretos de texto sin formato se registren accidentalmente en los registros.

Antes de comenzar

Para usar el proveedor googlesecretmanager, debes habilitar la API de Secret Manager y permitir el acceso a ella, como se describe en los siguientes pasos:

After installing the Google Cloud CLI, initialize it by running the following command:
```
gcloud init
```
If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.
Configura el proyecto predeterminado para Google Cloud CLI:
```
gcloud config set project PROJECT_ID
```
Antes de ejecutar el comando anterior, reemplaza la variable PROJECT_ID por el identificador de tu proyecto Google Cloud .
Enable the Secret Manager API:
```
gcloud services enable secretmanager.googleapis.com
```
Actualiza los permisos de acceso de OAuth para que tu instancia incluya el permiso requerido para Secret Manager, https://www.googleapis.com/auth/cloud-platform:
```
gcloud compute instances set-service-account "INSTANCE_ID" \
  --service-account "SERVICE_ACCT_EMAIL" \
  --scopes "https://www.googleapis.com/auth/cloud-platform"
```
Antes de ejecutar el comando anterior, reemplaza las siguientes variables:
- INSTANCE_ID: Es el identificador de tu VM.
- SERVICE_ACCT_EMAIL: Es la dirección de la cuenta de servicio asociada a la VM.
Para obtener más información, consulta Accede a la API de Secret Manager.
Otorga al usuario que administra las configuraciones del recopilador de OpenTelemetry integrado en Google los permisos necesarios para crear y administrar secretos. El rol de Identity and Access Management roles/secretManager.secretAdmin incluye los permisos necesarios:
```
gcloud projects add-iam-policy-binding PROJECT_ID \
  --member="user:USER_EMAIL" \
  --role=roles/secretManager.secretAdmin
```
Antes de ejecutar el comando anterior, reemplaza las siguientes variables:
- PROJECT_ID: Es el identificador de tu proyecto de Google Cloud .
- USER_EMAIL: Es la dirección del usuario al que se le otorga el rol.
Otorga a la cuenta de servicio asociada con la VM los permisos que necesita para acceder a los secretos. El rol de Identity and Access Management roles/secretManager.secretAccessor incluye los permisos necesarios:
```
gcloud projects add-iam-policy-binding PROJECT_ID \
  --member="serviceAccount:SERVICE_ACCT_EMAIL" \
  --role=roles/secretManager.secretAccessor
```
Antes de ejecutar el comando anterior, reemplaza las siguientes variables:
- PROJECT_ID: Es el identificador de tu proyecto de Google Cloud .
- SERVICE_ACCT_EMAIL: Es la dirección de la cuenta de servicio asociada a la VM.

Reemplaza los secretos de texto simple por secretos administrados

Para eliminar el uso de secretos de texto no encriptado en tus archivos de configuración con Secret Manager y el proveedor googlesecretmanager, haz lo siguiente:

Crea un secreto en Secret Manager para cada secreto de texto sin formato en tus archivos de configuración.
Reemplaza cada secreto de texto sin formato en tus archivos de configuración por una referencia al secreto correspondiente en Secret Manager.

Por ejemplo, si usas un exportador de http, tu archivo de configuración podría incluir una entrada como la siguiente:

exporters:
  logging:
    loglevel: debug
  http:
    endpoint: "https://example.com/api/metrics"
    headers:
      X-API-Key: plaintext-secret

En este ejemplo, deseas colocar la cadena plaintext-secret en Secret Manager y, luego, reemplazar el secreto de texto simple por una referencia al secreto administrado.

Crea secretos de Secret Manager para secretos de texto sin formato

plaintext-secret

echo -n "plaintext-secret" | gcloud secrets create SECRET_NAME \
    --replication-policy="automatic" \
    --data-file=-

Antes de ejecutar el comando anterior, reemplaza las siguientes variables:

plaintext-secret: Reemplaza este texto por tu secreto de texto simple.
SECRET_NAME: Reemplaza este valor por un nombre significativo para tu secreto.

El nombre del recurso completamente calificado de tu nuevo secreto tiene el siguiente formato, con un VERSION de 1:

projects/PROJECT_ID/secrets/SECRET_NAME/versions/VERSION

Para obtener más información sobre cómo almacenar secretos, crear versiones de ellos y acceder a ellos en Secret Manager, consulta Crea un secreto.

Reemplaza los secretos de texto sin formato

Para actualizar tus archivos de configuración, reemplaza cada secreto de texto sin formato por una referencia al proveedor de googlesecretmanager y al nombre del recurso del secreto administrado, como se muestra en el siguiente ejemplo:

exporters:
  logging:
    loglevel: debug
  http:
    endpoint: "https://example.com/api/metrics"
    headers:
      X-API-Key: ${googlesecretmanager:projects/PROJECT_ID/secrets/SECRET_NAME/versions/VERSION}

Más información

googlesecretmanager

repositorio opentelemetry-collector-contrib

Administra secretos en la configuración del recopilador de OpenTelemetry compilado por Google Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.