envers

Faire des amorces

Envers est un outil de ligne de commande (CLI) conçu pour gérer et version des variables d'environnement pour différentes étapes de déploiement telles que la mise en scène, le développement et la production. Il fournit un moyen sécurisé et organisé de gérer les configurations spécifiques à l'environnement.

Caractéristiques

• Variables d'environnement cryptant: crée des fichiers chiffrés qui stockent des variables d'environnement qui peuvent être stockées en toute sécurité dans un référentiel Git
• Configurations basées sur des groupes: permet de définir des variables pour différents groupes / profils comme Prod, Dev, etc.
• Définitions de variables basées sur des fichiers: prend en charge plusieurs fichiers d'environnement (.env) avec des variables spécifiques pour chaque fichier.
• CLI-CLI: Fournissez des commandes CLI qui aident à créer des brouillons pour les variables environnementales et le déployer dans des fichiers cryptés
• Gestion des spécifications: chaque version a une spécification définie qui s'applique à tous les groupes / profils de cette version.
• Génération de fichiers d'environnement: permet de générer des fichiers .env pour des versions et des groupes / profils spécifiques à l'aide de commandes.

Installation

TBD

Usage

Vous trouverez ci-dessous les sous-commandes initiales pour envers :

• envers init : Initialisez l'environnement envers .
• envers deploy <spec version number> : Déployez une version spécifique à partir du fichier SPEC.
• envers draft <spec version number> : Créez une nouvelle version de version dans le fichier Spec. Quelques variantes de cette commande:
  • 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> : Ajouter un nouveau contenu.
• envers profile load --profile prod --spec <spec version> : Chargez un profil d'environnement spécifique dans les fichiers

envers init crée le fichier de spécifications sur .envers/.specs.yaml .

envers deploy crée le fichier .envers/.data.lock . Ce fichier est généré automatiquement par la commande envers , et il est chiffré.

La version initiale de ./.envers/.specs.yaml ressemblerait à ceci:

 version : 0.1 # the envers spec version
releases :

Comme vous pouvez le voir, il n'a pas trop d'informations. Si vous souhaitez rédiger une nouvelle version, vous pouvez exécuter la commande suivante:

$ envers draft 1.0

Après cette commande, le fichier .envers/specs.yaml devrait ressembler à ceci:

 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

Maintenant, vous pouvez déployer votre première version des variables d'environnement:

$ envers deploy 1.0

Lorsqu'une version est déployée, elle crée automatiquement toutes les nouvelles spécifications dans le .envers/data.lock .

Toutes les variables pour le profil et la version spécifique sont stockées dans .envers/data.lock , et ce fichier ne doit pas être modifié pour aucune raison.

Enfin, nous pouvons créer les variables d'environnement pour le profil base :

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

envers vous demandera via Inviter la valeur de chaque variable définie dans la spécification de la version 1.0 .

Feuille de route

• Fonctions détaillées de gestion des spécifications et de contenu.
• Améliorations dans le versioning et la gestion des groupes.
• Intégration avec Makim et Sugar.

Contributif

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

Licence

BSD-CLAUSE 3