envers

envers

Envers 스테이징, 개발 및 생산과 같은 다양한 배포 단계에 대한 환경 변수를 관리하고 버전으로 관리하도록 설계된 명령 줄 도구 (CLI)입니다. 환경 별 구성을 처리 할 수있는 안전하고 체계적인 방법을 제공합니다.

특징

• 암호화 환경 변수 : GIT 저장소에 안전하게 저장할 수있는 환경 변수를 저장하는 암호화 된 파일을 생성합니다.
• 그룹 기반 구성 : Prod, Dev 등과 같은 다른 그룹/프로파일에 대한 변수를 정의 할 수 있습니다.
• 파일 기반 변수 정의 : 각 파일의 특정 변수가있는 여러 환경 파일 (.env)을 지원합니다.
• CLI 구동 : 환경 변수 초안을 작성하고 암호화 된 파일에 배포하는 데 도움이되는 CLI 명령 제공
• 사양 관리 : 각 릴리스에는 해당 릴리스 내의 모든 그룹/프로필에 적용되는 정의 된 사양이 있습니다.
• 환경 파일 생성 : 명령을 사용하여 특정 버전 및 그룹/프로파일에 대한 .env 파일을 생성 할 수 있습니다.

설치

TBD

용법

다음은 envers 의 초기 부하 명령입니다.

• envers init : envers 환경을 초기화하십시오.
• envers deploy <spec version number> : 사양 파일에서 특정 버전을 배포합니다.
• envers draft <spec version number> : 사양 파일에서 새 버전 드래프트를 만듭니다. 이 명령의 일부 변형 :
  • 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> : 새 컨텐츠 추가.
• envers profile load --profile prod --spec <spec version> : 특정 환경 프로필을 파일에로드

envers init .envers/.specs.yaml 에서 사양 파일을 만듭니다.

envers deploy .envers/.data.lock 파일을 만듭니다. 이 파일은 envers Command에 의해 자동으로 생성되며 암호화됩니다.

./.envers/.specs.yaml 의 초기 버전은 다음과 같습니다.

 version : 0.1 # the envers spec version
releases :

보시다시피 정보가 너무 많지 않습니다. 새 버전을 작성하려면 다음 명령을 실행할 수 있습니다.

$ envers draft 1.0

이 명령 후에 .envers/specs.yaml 파일은 다음과 같아야합니다.

 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

이제 첫 번째 버전의 환경 변수를 배포 할 수 있습니다.

$ envers deploy 1.0

버전이 배포되면 모든 새 사양을 .envers/data.lock 으로 자동으로 생성합니다.

각 프로필 및 사양 버전의 모든 변수는 .envers/data.lock 에 저장되며 어떤 이유로 든이 파일을 변경해서는 안됩니다.

마지막으로 base 프로파일의 환경 변수를 만들 수 있습니다.

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

envers 프롬프트를 통해 버전 1.0 에 대한 사양에 정의 된 각 변수의 값을 묻습니다.

로드맵

• 자세한 사양 및 컨텐츠 관리 기능.
• 버전 및 그룹 관리의 향상.
• Makim 및 Sugar와의 통합.

기여

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

특허

BSD-Clause 3