Docs Worker Pool

As part of the Docs Tools Next Generation Project, the Docs Worker Pool seeks to make the build process for developers both easier and more scalable for developers.

Build and Run Docker Image

docker build --tag=workerpool .
docker run \
	--env MONGO_ATLAS_USERNAME \
	--env MONGO_ATLAS_PASSWORD \
	--env AWS_ACCESS_KEY_ID \
	--env AWS_SECRET_ACCESS_KEY \
	--env GITHUB_BOT_USERNAME \
	--env GITHUB_BOT_PASSWORD \
	--env DB_NAME \
	--env XLARGE \
	--env SNOOTY_ENV \
	--env FASTLY_TOKEN \
	--env FASTLY_DOCHUB_MAP \
	--env FASTLY_SERVICE_ID \
	workerpool

• MONGO_ATLAS_USERNAME and MONGO_ATLAS_PASSWORD is username/password of atlas database
• AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY are needed for uploading to S3 via mut
• GITHUB_BOT_USERNAME and GITHUB_BOT_PASSWORD are needed so builder can access private repos
• DBNAME allows the indication of a pool database (pool, pool_test)
• XLARGE true or false indicates whether this instance will run on an XLARGE server or not
• SNOOTY_ENV indicates whether the build environment is stage, prod, or dev
• FASTLY_TOKEN is needed for connecting to the Fastly edge dictionary
• FASTLY_DOCHUB_MAP is the id of the redirect map that we publish dochub links to
• FASTLY_SERVICE_ID is the id of the service used for dochub

If you are running a local version of the docker image for testing, we have a separate staging environment setup. Testing in this environment is automated through the "stage" branch. Add the following env variables to the docker run command:

--env DB_NAME

Run Tests

cd worker 
npm install --dev
npm test  // runs ~ jest --detectOpenHandles --coverage

Run Linter

cd worker 
npm install --dev
./node_modules/.bin/eslint .

See the spec doc for more details.