Un secreto es un valor privado que se almacena en el backend de Atlas y permanece oculto a los usuarios. Los secretos son útiles para almacenar información confidencial, como una clave API o un identificador interno.
No se puede leer directamente el valor de un secreto después de definirlo. En su lugar, se vincula el secreto a otro. Valor y,a continuación, acceda al valor desde una función de activación.
Define un secreto
Puede definir un nuevo secreto desde la interfaz de usuario o mediante la CLI de App Services.
En Atlas, vaya a la Triggers Página para su proyecto.
Si aún no aparece, se debe seleccionar la organización que contiene el proyecto en el menú Organizations de la barra de navegación.
Si aún no se muestra, seleccione su proyecto en el menú Projects de la barra de navegación.
En la barra lateral, haz clic en Triggers en la sección Streaming Data.
El Se muestra la páginade activadores.
Nombra el valor secreto
Introduzca un nombre para el secreto. Este nombre se usará para referirse al secreto en las funciones y debe ser único dentro del proyecto.
Nota
Restricciones de nombres secretos
Los nombres de valor no pueden superar los 64 caracteres y solo pueden contener letras ASCII, números, guiones bajos y guiones. El primer carácter debe ser una letra o un número.
Autenticar un usuario de MongoDB Atlas
Utilice su clave API de administración de MongoDB Atlas para iniciar sesión en la CLI de App Services:
appservices login --api-key="<API KEY>" --private-api-key="<PRIVATE KEY>"
Extraiga los últimos archivos de configuración de su aplicación
Ejecute el siguiente comando para obtener una copia local de sus archivos de configuración:
appservices pull --remote=<App ID>
De forma predeterminada, el comando extrae los archivos al directorio de trabajo actual. Puede especificar una ruta de directorio con el comando opcional --local bandera.
Implementar sus cambios
Ejecute el siguiente comando para implementar sus cambios:
appservices push
Ver secretos
Puede ver una lista de todos los secretos de una aplicación desde la interfaz de usuario o utilizando la CLI de App Services.
Desde la página Triggers, haga clic en el enlace Linked App Service: Triggers.
En la barra lateral, haz clic en Values en la sección Build.
La tabla enumera todos los valores, incluidos los secretos, e indica el tipo de cada valor en su fila.
Para enumerar los nombres e identificaciones de todos los secretos, ejecute el siguiente comando:
appservices secrets list --app=<Your App ID>
Actualizar un secreto
Puede actualizar un secreto desde la interfaz de usuario o mediante la CLI de App Services.
Para actualizar un Secret desde la Interfaz de Usuario de Atlas:
Desde la página Triggers, haga clic en el enlace Linked App Service: Triggers.
En la barra lateral, haz clic en Values en la sección Build.
Busque el valor que desea actualizar en la tabla, abra su menú Actions y seleccione Edit Secret.
Puede cambiar tanto el nombre como el valor del secreto.
Haga clic en Save y luego, si es necesario, implemente los cambios.
Para actualizar el valor de un secreto mediante la CLI de App Services, ejecute el siguiente comando:
appservices secrets update --app=<Your App ID> \ --secret="<Secret ID or Name>" \ --name="<Updated Secret Name>" \ --value="<Updated Value>"
Utilice un secreto
No puedes leer directamente el valor de un secreto después de definirlo.
Para utilizar un secreto en una función de activación:
Crea un nuevo valor que se vincule al secreto.
Utilice el módulo context.values para acceder al valor del secreto en su función.
Borrar un secreto
Puedes eliminar un secreto desde la interfaz de usuario o mediante la CLI de App Services.
Para eliminar un secreto de la interfaz de usuario de Atlas:
Desde la página Triggers, haga clic en el enlace Linked App Service: Triggers.
En la barra lateral, haz clic en Values en la sección Build.
Busque el valor que desea eliminar en la tabla, abra su menú Actions y seleccione Delete Secret.
Confirme que desea eliminar el secreto.
Para eliminar un secreto mediante la CLI de App Services, ejecute el siguiente comando:
appservices secrets delete --app=<Your App ID> --secret=<Secret ID>
Tip
Puede eliminar varios secretos con un solo comando especificando sus valores name o id como una lista separada por comas.
appservices secrets delete --app=<Your App ID> \ --secret=some-api-key,609af850b78eca4a8db4303f,another-key