envers

Incrustación

Envers es una herramienta de línea de comandos (CLI) diseñada para administrar y versiones de entorno de versiones para diferentes etapas de implementación, como puesta en escena, desarrollo y producción. Proporciona una forma segura y organizada de manejar configuraciones específicas del entorno.

Características

• Variables de entorno en cifrado: crea archivos encriptados que almacenan variables de entorno que se pueden almacenar de manera segura en un repositorio de GIT
• Configuraciones basadas en grupos: permite definir variables para diferentes grupos/perfiles como prod, desarrollo, etc.
• Definiciones variables basadas en archivos: admite múltiples archivos de entorno (.env) con variables específicas para cada archivo.
• CLI-Driven: Proporcione comandos CLI que ayuden a crear borradores para las variables de entorno e implementarlo en archivos cifrados
• Gestión de especificaciones: cada versión tiene una especificación definida que se aplica a todos los grupos/perfiles dentro de esa versión.
• Generación de archivos de entorno: habilita la generación de archivos .env para versiones y grupos/perfiles específicos utilizando comandos.

Instalación

TBD

Uso

A continuación se muestran los subcomandos iniciales para envers :

• envers init : Inicializar el entorno envers .
• envers deploy <spec version number> : implementa una versión específica del archivo de especificaciones.
• envers draft <spec version number> : cree un nuevo borrador de versión en el archivo de especificaciones. Algunas variantes de este comando:
  • envers draft <spec version number> --from <previous spec version number>
  • envers draft <spec version number> --from-env .env
• envers profile-set --profile <profile_name> --spec <version_number> : Agregar contenido nuevo.
• envers profile load --profile prod --spec <spec version> : Cargue un perfil de entorno específico a los archivos

envers init crea el archivo de especificaciones en .envers/.specs.yaml .

envers deploy crea el archivo .envers/.data.lock . Este archivo se genera automáticamente por el comando envers , y está encriptado.

La versión inicial de ./.envers/.specs.yaml se vería así:

 version : 0.1 # the envers spec version
releases :

Como puede ver, no tiene demasiada información. Si desea redactar una nueva versión, puede ejecutar el siguiente comando:

$ envers draft 1.0

Después de este comando, el archivo .envers/specs.yaml debe verse así:

 version : 0.1 # the spec version
releases :
  # placeholder: the version for the environment variables.
  #   if the status is draft, feel free to change the version number
  1.0 :
    # status attribute is handled by command line, don't change it manually
    status : draft # options are: draft, cancelled, deployed
    # placeholder: update help with the real help text
    help :
    # placeholder: a list of available profiles (groups) for this version.
    #   at least one profile is required for the deploying
    profiles :
      - base
    # define the spec for that version, this spec should be used for all
    # profiles (groups) inside this version
    spec :
      # define the env file or any other kind of environment file to be used,
      # for now it just has support for .env files
      files :
        # placeholder: change `.env` to the correct dotenv file relative path
        .env :
          type : dotenv # default
          # `vars` is a dictionary for the environment variables
          # this defines the variables and some metadata, but not the real
          # value, because it is just the definition of the spec.
          vars :
            # placeholder: ENV is just a variable name, replace it by your real
            # environment variable
            ENV :
              type : string # options are: string, int, bool, path
              default : dev # in the case that the variable is not defined

Ahora, puede implementar su primera versión de las variables de entorno:

$ envers deploy 1.0

Cuando se implementa una versión, crea automáticamente todas las nuevas especificaciones en .envers/data.lock .

Todas las variables para cada perfil y la versión de especificación se almacenan en .envers/data.lock , y este archivo no debe cambiarse por ningún motivo.

Finalmente, podemos crear las variables de entorno para el perfil base :

$ envers profile set --profile base --spec 1.0

envers le preguntará a través del valor del valor para cada variable definida en la especificación para la versión 1.0 .

Hoja de ruta

• Las funcionalidades detalladas de especificaciones y gestión de contenido.
• Mejoras en versiones y gestión de grupos.
• Integración con Makim y Sugar.

Que contribuye

https://osl-incubator.github.io/envers

Licencia

BSD-cláusula 3