Administra secretos con Secret Manager en Cloud Code para VS Code

Con la integración de Secret Manager de Cloud Code, puedes crear, ver, actualizar y usar secretos dentro de tu IDE y sin tenerlos en tu base de código.

En esta página, se describe cómo acceder a Secret Manager en tu IDE y cómo comenzar a crear y administrar secretos.

Habilita la API de Secret Manager

Cuando se administran secretos con Cloud Code, estos se almacenan de forma segura en Secret Manager y se pueden recuperar de manera programática cuando los necesites. Todo lo que necesitas es la API de Secret Manager habilitada y los permisos adecuados para administrar secretos:

  1. Asegúrate de trabajar en el proyecto en el que se encuentra el código de tu aplicación. El secreto debe estar en el mismo proyecto que el código de la aplicación.

  2. Haz clic en Cloud Code y, luego, expande el explorador de Secret Manager.

  3. Si no habilitaste la API de Secret Manager, haz clic en Habilitar la API de Secret Manager en el explorador de Secret Manager.

Crea secretos

Para crear un secreto con el explorador de Secret Manager, sigue estos pasos:

  1. En tu IDE, haz clic en Cloud Code y, luego, expande el explorador Secret Manager.

  2. Haz clic en agregar Crear Secret en el explorador de Secret Manager.

    En el cuadro de diálogo Crear secreto, configura el proyecto, el nombre, el valor y la región del secreto, y especifica las etiquetas a fin de organizarlos.

Como alternativa, puedes crear un secreto mediante el editor:

  1. Abre un archivo que contenga texto que quieras almacenar como secreto en el editor.
  2. Destaca el texto que se almacenará como secreto, haz clic con el botón derecho y, luego, en Crear Secret en Secret Manager.
  3. En el cuadro de diálogo Crear Secret, personaliza el proyecto, el nombre, el valor, la región y las etiquetas del secreto.

Crea versiones nuevas de los Secrets

Para crear una versión nueva de un secreto con Secret Manager, sigue estos pasos:

  1. Haz clic con el botón derecho en un secreto existente y elige Create Secret Version.

  2. En el cuadro de diálogo Crear versión, configura el valor nuevo de tu secreto existente mediante el campo Valor del secreto o mediante la importación de un archivo.

  3. Para quitar todas las versiones anteriores del secreto y mantener solo la versión nueva que creas, selecciona Inhabilitar todas las versiones anteriores.

  4. Haz clic en Crear versión. Se agregó tu versión, y puedes ver la versión más reciente del secreto y las versiones anteriores enumeradas en los menús desplegables Versiones.

Como alternativa, puedes crear una versión nueva de un secreto en el editor:

  1. En el editor, abre un archivo y destaca el texto que quieres almacenar como secreto.

  2. Haz clic con el botón derecho en el texto destacado y, luego, selecciona Add Version to Secret in Secret Manager.

Administra versiones de los secretos

Para habilitar, inhabilitar o destruir una versión de un secreto, haz clic con el botón derecho en el secreto y selecciona el comando de la acción que deseas realizar. Para las versiones habilitadas de los secretos, también puedes ver el valor de la versión.

Ver secretos

Para ver los secretos, en el explorador de Secret Manager, selecciona uno de la lista. Los detalles del secreto, como el nombre, la política de replicación, la marca de tiempo de creación y el ID del recurso, se enumeran debajo del nombre del secreto.

Ver secretos en la consola de Google Cloud

Como alternativa, puedes ver los Secrets en la consola de Google Cloud. Para ello, haz clic con el botón derecho en el Secret en el explorador de Secret Manager y, luego, en Abrir en la consola de Cloud.

Haz clic con el botón derecho en Secret en Secret Manager para ver la opción Abrir en la consola de Google Cloud. El menú desplegable de propiedades también se puede ver en la vista de Secret Manager.

Ver secretos en Kubernetes Explorer

Para ver secretos en el explorador de Kubernetes, sigue estos pasos:

  1. Haz clic en Cloud Code y, luego, expande el explorador de Kubernetes.
  2. Expande tu clúster y, luego, Secretos.
  3. Expande el secreto para ver sus detalles.

Accede a los secretos desde tu aplicación

Una vez que creaste el secreto, puedes incluirlo en tu código y configurar la autenticación.

Para acceder a un secreto desde tu aplicación, haz lo siguiente:

  1. Instala la biblioteca cliente del administrador de Secret Manager.

    1. Haz clic en Cloud Code y, luego, expande el explorador de API de Cloud.

    2. Expande Seguridad de Cloud > API de Secret Manager y, luego, sigue las instrucciones de la sección Instalar biblioteca cliente para el lenguaje que uses.

  2. Incluye y personaliza el fragmento de código relevante en el código de tu aplicación.

    A fin de obtener el nombre de la versión de tu secreto para usarlo en tu código, puedes seleccionar el secreto en el panel de Secret Manager, hacer clic con el botón derecho y elegir Copiar ID de recurso.

  3. Para completar la configuración de autenticación, sigue la guía de autenticación de las bibliotecas cliente:

    • Desarrollo local: Si desarrollas en un clúster local (como minikube o Docker Desktop) o en un emulador local, debes completar los pasos ilustrados en la sección de desarrollo local relevantes para tu flujo de trabajo.
    • Desarrollo remoto: Si usas un clúster de GKE o un servicio de Cloud Run en tu aplicación, debes completar los pasos ilustrados en la sección Desarrollo remoto que son relevantes para tu flujo de trabajo, incluidas las instrucciones específicas de Secret Manager a fin de configurar los roles necesarios en tu cuenta de servicio.

Agrega un secreto como variable de entorno

Para agregar un secreto de Kubernetes existente a la implementación como una variable de entorno, sigue estos pasos:

  1. Haz clic en Cloud Code y, luego, expande el explorador de Kubernetes.
  2. Expande tu clúster de minikube y, luego, expande Secrets (Secretos).
  3. Haz clic con el botón derecho en un secreto que representa un objeto de implementación y, luego, haz clic en Agregar Secret como variable del entorno.

Activa un secreto como volumen

Para activar un secreto de Kubernetes existente como un volumen en el contenedor de la implementación, sigue estos pasos:

  1. Haz clic en Cloud Code y, luego, expande el explorador de Kubernetes.
  2. Expande tu clúster de minikube y, luego, expande Secrets (Secretos).
  3. Haz clic con el botón derecho en un secreto que representa un objeto de implementación y, luego, en Activar un Secret como volumen.

Borrar secretos

Para borrar un secreto con Secret Manager en Cloud Code, sigue estos pasos:

  1. Haz clic en Cloud Code y, luego, expande el explorador Secret Manager.

  2. Haz clic con el botón derecho en un secreto existente y selecciona Abrir en la consola de Cloud.

  3. En la página Detalles del secreto, haz clic en BORRAR y sigue las indicaciones para borrarlo.

Obtener asistencia

Para enviar comentarios, informa problemas en GitHub o haz preguntas en Stack Overflow.