diff --git a/README.md b/README.md index 810da4b..54176b9 100644 --- a/README.md +++ b/README.md @@ -10,55 +10,20 @@ This repository contains source code of application used to run https://null.co. * [Developer Testing](doc/testing.md) * [Development Environment Setup with Vagrant](doc/vagrant.md) * [Exposing API Services](doc/exposing-api-services.md) +* [Production Ops](doc/production-ops.md) -## Production +## Development Environment -Production deployment is triggered through Git release tag of format: - -``` -release-x.x.x -``` - -The `x.x.x` conforms to semantic versioning. - -Push a release through git - -``` -git tag -a -m "Release for XYZ" release-X.Y.Z -git push origin --tags -``` - -### Production Environment - -The entire deployment, including secrets are managed through Bitbucket pipeline. -Refer to `bitbucket-pipelines.yml` for detail. - -Secrets are available during build process as part of Bitbucket pipeline environment variable. - -### Manual Build - -Look at `prodrun.sh` - -### Stop Containers - -``` -docker rm --force `docker ps -q` -``` - -**NOTE:** The above command will stop all running containers in the system - -## Developer Environment - -Bring up full stack +Bring up core web app for development ``` docker-compose up ``` -Bring up on web app +Bring up full stack ``` -docker-compose -f docker-compose-app.yml up +docker-compose -f docker-compose-full-stack.yml up ``` ## SSL/TLS diff --git a/doc/production-ops.md b/doc/production-ops.md new file mode 100644 index 0000000..d8ea476 --- /dev/null +++ b/doc/production-ops.md @@ -0,0 +1,37 @@ +# Production Operations + +## Production + +Production deployment is triggered through Git release tag of format: + +``` +release-x.x.x +``` + +The `x.x.x` conforms to semantic versioning. + +Push a release through git + +``` +git tag -a -m "Release for XYZ" release-X.Y.Z +git push origin --tags +``` + +### Production Environment + +The entire deployment, including secrets are managed through Bitbucket pipeline. +Refer to `bitbucket-pipelines.yml` for detail. + +Secrets are available during build process as part of Bitbucket pipeline environment variable. + +### Manual Build + +Look at `prodrun.sh` + +### Stop Containers + +``` +docker rm --force `docker ps -q` +``` + +**NOTE:** The above command will stop all running containers in the system \ No newline at end of file