https://github.com/preaction/env-elope
Easily manage multiple runtime environments and configurations
https://github.com/preaction/env-elope
Last synced: about 1 year ago
JSON representation
Easily manage multiple runtime environments and configurations
- Host: GitHub
- URL: https://github.com/preaction/env-elope
- Owner: preaction
- License: other
- Created: 2015-02-14T19:44:47.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2016-09-03T01:09:08.000Z (almost 10 years ago)
- Last Synced: 2024-04-17T21:17:01.193Z (about 2 years ago)
- Language: Perl
- Size: 19.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README
- Changelog: CHANGES
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
NAME
Env::Elope - Configure projects in multiple environments
VERSION
version 0.001
SYNOPSIS
# lib/My/Project.pm
use Env::Elope qw( dist_env_dir );
my $config = dist_env_dir( 'My-Project' )->child( 'db.yml' );
# share/env/dev/db.yml
db_server: dev.example.com
# share/env/prd/db.yml
db_server: example.com
# On a command line:
$ elope dev run_my_project
$ elope prd run_my_project
DESCRIPTION
Elope helps to manage multiple environments through configuration
directories and environment variables. Using the "elope" command-line
script, a program can be run in any environment, choosing all the right
configuration for that environment.
SETUP
To set up Elope, you need:
A config directory named for each environment
The configuration directories should be in each distribution's
"share/env" directory and should have the same name as the
environment they configure. So "share/env/dev" will be our "dev"
environment, and "share/env/prod" our "prod" environment.
The "elope" command-line utility
The elope utility will source in the envrc file for the current
environment and then run the command. The elope utility sets the
"ELOPE_ENV" environment variable that chooses which config directory
to use.
An envrc file named for each environment
After installing the elope utility, you must make a directory for
your envrc files. If you installed elope to /opt/bin/elope, you
should make a directory /opt/etc/envrc and put your envrc files
there.
An envrc file should be named the same as the environment, and
should export environment variables like "PATH" and
"LD_LIBRARY_PATH", or maybe configure a Perl local::lib.
# /opt/etc/envrc/dev
# Now that 5.20.2 is released, lets use it in dev to try it
PATH=/usr/perlbrew/perls/5.20.2/bin:$PATH
eval $( perl -Mlocal::lib=/opt/envs/dev )
# /opt/etc/envrc/prod
# We haven't upgrade to 5.20.2 yet in prod
PATH=/usr/perlbrew/perls/5.20.1/bin:$PATH
eval $( perl -Mlocal::lib=/opt/envs/prod )
USING
Now that we have our envrc and our config dirs, we can run our scripts
with the elope command:
# Install one of our modules in dev
$ elope dev perl Build.PL
$ ./Build install
# Run its tests using the dev configuration
$ elope dev prove -lr t
# Run our server
$ elope dev morbo bin/my-mojo-app -l 'http://*:8080'
If we switch "dev" to "prod" in any of the above commands, we are
running them in production.
SUBROUTINES
dist_env_dir DIST, OPTIONS
Get the configuration directory for the given "DIST". Returns a
Path::Tiny object with the given dist path.
Configuration directories are located in a distribution's "share/env/"
directory. Which directory is chosen is based on the "ELOPE_ENV"
environment variable.
"OPTIONS" is a set of key/value pairs for options with the following
keys:
env - Set the environment name, overriding the current environment
AUTHOR
Doug Bell
COPYRIGHT AND LICENSE
This software is copyright (c) 2015 by Doug Bell.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.