DATABASE_URL- The database url to store build, release information. This has no default. Must be a postgres 9.5+ instance. See create.sql in sql folder for creating the tables and schema.
AUTH_KEY- A shared secret simple authentication, this should be used in all API calls in the Authorization header.ENCRYPT_KEY- A private key used to encrypt secretive information in postgres. This has no default.BLACKLIST_ENV- A comma delimited list of socs keywords causing config vars to be redacted, defaults to 'PASS,KEY,SECRET,PRIVATE,TOKEN'APPKIT_API_URL- Public URI (https://somehost/) for the appkit api in front of this api, generally appkit api url that handles user account/authorization (defaults to http://localhost:5000)APPKIT_UI_URL- Public URI (https://somehost/) for the appkit ui used by developers.
BUILD_SHUTTLE_URL- The build shuttle is a small footprint API that manages specific build system such as jenkins. (see https://github.com/akkeris/buildshuttle). This has no default.DEFAULT_GITHUB_USERNAME- When watching github source control, use this default username if none is provided. (should be set withDEFAULT_GITHUB_TOKEN)DEFAULT_GITHUB_TOKEN- When watching github source control, use this default token if none is provided. (should be set withDEFAULT_GITHUB_USERNAME)
ALAMO_APP_CONTROLLER_URL- The API url for this host, defaults to http://localhost:5000[STACKNAME]_STACK_API- The URI for the stack api by the name of STACKNAME, for example if a stack exists called FOO the uri for the stack api must be set at FOO_STACK_API[REGIONNAME]_REGION_API- The URI for the regional api by the name of REGIONNAME, for example if a region exists called us-seattle the uri for the stack api must be set at US_SEATTLE_REGION_APIDOCKER_REGISTRY_HOST- The host for storing image sources. E.g., docker.hostname.com, This has no default.DOCKER_REPO- The repo in DOCKER_REGISTRY_HOST to store gold master build images (changing this also requires changing jenkins_build_template.xml and existing build templates in jenkins). This has no default.DYNO_DEFAULT_SIZE- The default dyno size to use. The set default isscoutif no other is specified.
PROMETHEUS_METRICS_URL- The url to connect to for metric information stored in prometheus. This has no default.LOG_SHUTTLE_URL- The log shuttle url for log drains (https://github.com/akkeris/logshuttle). This has no default.LOG_SESSION_URL- The log session url for log sessions (https://github.com/akkeris/logshuttle). This has no default.INFLUXDB_METRICS_URL- The URL to the influxdb that holds running metrics for service, count and other http information. This has no default.
TWILIO_AUTH_KEY- The master sid:token for the twilio account.ANOMALY_METRICS_DRAIN- The syslog drain end point for the opentsdb custom metrics collector. This has no default.PAPERTRAIL_DRAIN- The syslog standard drain end point for papertrail. This has no default.
npm install
Prior to running, ensure all of the prior environment variables are properly setup in the ENV.
npm start
There are some additional options that should be set when developing locally or testing. Some of these are optional. The tests that run are integration tests that require real services setup. See the setting up section above for additional required environment variables.
NGROK_TOKEN- When testing a public URI is needed to test callbacks from other integrated systems, get a token at www.ngrok.com and place it in this envirionment variable.ONE_PROCESS_MODE- When developing locally this must be set, it imports what normally would be in the worker into the main process. Just set it to trueTEST_MODE- Similar to ONE_PROCESS_MODE this should be set when running the automated tests, while ONE_PROCESS_MODE should be set when developing locally. Just set it to trueALAMO_BASE_DOMAIN- This should be in the format of .some.example.com, This is the base domain to use for newly created apps.SITE_BASE_DOMAIN- This is the site base domain such as.example.com.CODACY_PROJECT_TOKEN- While optional this is useful when running test coverage to report the results to www.codacy.com.MARU_STACK_API- Set to the alamo api, MARU is the name of our test clusterUS_SEATTLE_REGION_API- Set to the alamo api, US_SEATTLE is the name of our test region.
Then run:
cat sql/create.sql | psql $DATABASE_URL
cat sql/create_testing.sql | psql $DATABASE_URL
Then to run the entire test suite:
npm test
OR, run an individual test manually:
./node_modules/.bin/_mocha test/[test_to_run.js]
The alamo app controller uses a simple key based authorization via http in the "Authorization" header. For example if your AUTH_KEY is fugazi then you would pass in Authorization: fugazi with all your http requests to authenticate it. In addition a X-Username is required which contains the username or email address of the user taking the action. Note that this api is not intended to be exposed directly to people but other systems, developers interface through appkit-api project which handles permissions and passes requests through.
To help decouple actions events my be emited by a central bus within the common.js file. The exported module will have a globally unique (across one dyno instance) "lifecycle" object that implements an Event Emitter pattern in node. The following events are emitted:
preview-createdbuild-status-changerelease-startedrelease-successfulrelease-failedreleasedgit-event
Note these are not the same concept as web hooks nor should they be confused with that. In addition there is a lifecycle.js file which is not the same concept as this (just unfortunately named the same).