secret_manager

`app.contrib.gcp.secret_manager`

Módulo de Python para Google Secret Manager.

Para más información, te recomendamos leer la documentación del Proyecto.

`get_secret_info(name)`

Obtiene la información de un secreto consultando sus metadatos, No confundir con la función get_secret_value.

Parameters:

Name	Type	Description	Default
`name`	`str`	el nombre del secreto	required

Returns:

Type	Description
`Optional[dict[str, Any]]`	un diccionario con información del screto ó `None` en caso de error

Examples:

1 2	`... get_secret_info("my_awesome_secret_name")`

`get_secret_value(name, version='latest')`

Obtiene el valor de un secreto, No confundir con la función get_secret_info.

Parameters:

Name	Type	Description	Default
`name`	`str`	nombre del secreto a consultar	required
`version`	`str`	versión del secreto, por defecto `latest`.	`'latest'`

Returns:

Type	Description
`Optional[dict[str, Any]]`	un diccionario con información del screto ó `None` en caso de error

Examples:

...
# ejemplo 1 obtiene la última versión del secreto
get_secret_value("my_awesome_secret_name")

# ejemplo 2 obtiene la última versión del secreto
get_secret_value("my_awesome_secret_name", "latest")

# ejemplo 3 obtiene la versión "3" del secreto
get_secret_value("my_awesome_secret_name", "3")

`create_secret(secret_id)`

Crea un nuevo secreto con el nombre dado.

Parameters:

Name	Type	Description	Default
`secret_id`	`str`	el nombre para el secreto	required

Notes

Un secreto es una envoltura lógica de una colección de versiones del secreto en sí. Es decir, esta función no almacena el contenido de un secreto, sino que crea el contenedor para una versión.

Si desea almacenar un valor utilice la función add_secret_version.

Returns:

Type	Description
`Optional[Any]`	información del secreto creado ó `None` en caso
`Optional[Any]`	de error

Examples:

1 2	`... create_secret("my_awesome_secret_id")`

`add_secret_version(secret_id, data)`

Agrega una versión a un secreto existente, no confundir con la función create_secret.

Parameters:

Name	Type	Description	Default
`secret_id`	`str`	el identificador del secreto	required
`data`	`str`	la información a almacenar	required

Notes

esta función necesita un rol de roles/secretmanager.admin.

Returns:

Type	Description
`Optional[Any]`	información del secreto actualizado ó `None` en caso de error

Examples:

1 2	`... add_secret_version("my_awesome_secret_id", "super secret data")`

`list_secrets()`

Obtiene una lista de los secretos del proyecto.

Returns:

Type	Description
`Optional[list[str]]`	una lista con la información de los secretos ó `None` en caso de error

Examples:

1 2	`... list_secrets()`

`remove_secret(secret_name)`

Elimina un secreto.

Parameters:

Name	Type	Description	Default
`secret_name`	`str`	nombre del secreto a eliminar	required

Notes

Utilice con precaución, esta opción no se puede deshacer.

este método necesita un rol de roles/secretmanager.admin.

Examples:

1 2	`... remove_secret("my_awesome_secret_name")`