Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
abhisek committed Mar 8, 2020
1 parent 4b169d5 commit c46360e
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 40 deletions.
45 changes: 5 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
37 changes: 37 additions & 0 deletions doc/production-ops.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit c46360e

Please sign in to comment.