Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gathercole3/dev-env
https://github.com/gathercole3/dev-env
Last synced: 13 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/gathercole3/dev-env
- Owner: gathercole3
- License: mit
- Created: 2017-04-08T11:22:01.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-10-27T10:49:27.000Z (about 4 years ago)
- Last Synced: 2023-09-19T10:53:47.533Z (over 1 year ago)
- Language: Ruby
- Size: 19.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Common Development Environment
This repository contains the code for a development environment that can be used across teams and projects. It is designed to allow collections of applications to be loaded from a separate configuration repository, and maximising consistency between them.
It provides several hooks for applications to take advantage of, including:
* Docker container creation and launching via docker-compose
* Automatic creation of commodity systems such as Postgres or Elasticsearch (with further hooks to allow for initial provisoning such as running SQL, Alembic DB upgrades or Elasticsearch index creation)
## Getting started
### Prerequisites
* **Docker and Docker Compose**. Exactly what toolset you use depends on your OS and personal preferences, but recommended are:
* [Docker For Mac](https://docs.docker.com/docker-for-mac/)
* [Docker for Windows 10](https://docs.docker.com/docker-for-windows/) (See [the wiki](https://github.com/LandRegistry/common-dev-env/wiki/Windows-setup) for more information on getting a working Windows environment set up)
* [Docker CE for Linux](https://docs.docker.com/install/linux/docker-ce/ubuntu/)
* **Git**
* **Ruby 2.3+**
* The `highline` gem must also be installed
### Git/SSH
You must ensure the shell you are starting the dev-env from can access all the necessary Git repositories - namely the config repo and the application repos it specifies. If they are to be accessed via SSH, [this wiki page](https://github.com/LandRegistry/common-dev-env/wiki/Git---SSH-setup) has some proven techniques for generating keys and making them available to the shell.
### Controlling the dev-env
To begin:
1. Start Docker.
1. Using Git, clone this repository into a directory of your choice.
1. Open a terminal in that directory, and run `source run.sh up`
1. If this is the first time you are launching the machine you will be prompted for the url of a configuration repository. Paste it in and press enter.
Other `run.sh` parameters are:
* `halt` - stops all containers
* `reload` - stops all containers then rebuilds and restarts them (including running any commodity fragments)
* `destroy` - stops/removes all containers, removes all built images (i.e. leaving any pulled from Docker Hub) and resets all dev-env configuration files.
* `repair` - sets the Docker-compose configuration to use the fragments from applications in _this_ dev-env instance (in case you are switching between several)
## Usage guide
### Configuration Repository
This is a Git repository that must contain a single file -
`configuration.yml`. The configuration file lists the applications that will be running in the dev-env, and specifies the URL of their Git repository along with which branch/tag should be initially checked out. The name of the application should match the repository name so that things dependent on the directory structure like volume mappings in the app's docker-compose-fragment.yml will work correctly.
[Example](snippets/configuration.yml)
The local application repositories will be pulled and updated on each `up` or `reload`, _unless_ the current checked out branch does not match the one in the configuration. This allows you to create and work in feature branches while remaining in full control of updates and merges.
### Application support
For an application repository to leverage the full power of the dev-env...
#### Docker
Docker containers are used to run all apps. So some files are needed to support that.
##### `/fragments/docker-compose-fragment.yml` (Mandatory)
This is used by the envvironment to construct the application container and then launch it. Standard [Compose file](https://docs.docker.com/compose/compose-file/) structure applies - and all apps must use the same Compose file version - but some recommendations are:
* Container name and service name should match
* Any ports that need to be accessed from the host machine (as opposed to from other containers) should be mapped
* A `volumes` entry should map the path of the app folder to wherever the image expects source files to be (if they are to be accessed dynamically, and not copied in at image build time)
* If the provided log collator is to be used, then a syslog logging driver needs to be present, forwarding to logstash:25826.
Although generally an application should only have itself in it's compose fragment, there is no reason why other containers based on other Docker images cannot also be listed in this file, if they are not provided already by the dev-env.
Note that when including directives such as a Dockerfile build location or host volume mapping for the source code, the Compose context root `.` is considered to be the dev-env's /apps/ folder, not the location of the fragment. Ensure relative paths are set accordingly.
[Example](snippets/docker-compose-fragment.yml)
##### `/Dockerfile`
This is a file that defines the application's Docker image. The Compose fragment should point to this file. Extend an existing image and install/set whatever is needed to ensure that containers created from the image will run. See the [Dockerfile reference](https://docs.docker.com/engine/reference/builder/) for more information.
[Example - Python/Flask](snippets/flask_Dockerfile)
[Example - Java](snippets/java_Dockerfile)
#### Commodities
##### `/configuration.yml` (Mandatory)
This file lives in the root of the application and specifies which commodities the dev-env should create and launch for the application to use.
The list of allowable values is:
* postgres
* db2
* elasticsearch
* elasticsearch5
* nginx
* rabbitmq
* redis
* swagger
* wiremock
Individual commodities may require further files in order to set them up correctly, these are detailed below. Note that unless specified, any fragment files will only be run once. This is controlled by a generated `.commodities.yml` file in the root of the this repository, which you can change to allow the files to be read again - useful if you've had to delete and recreate a commodity container.
[Example](snippets/app_configuration.yml)
##### PostgreSQL
**`/fragments/postgres-init-fragment.sql`**
This file contains any one-off SQL to run in Postgres - at the minimum it will normally be creating a database and an application-specific user.
[Example](snippets/postgres-init-fragment.sql)
If you want to spatially enable your database see the following example:
[Example - Spatial](snippets/spatial_postgres-init-fragment.sql)
The default Postgres port 5432 will be available for connections from other containers and on the host.
**`/manage.py`**
This is a standard Alembic management file - if it exists, then a database migration will be run on every `up` or `reload`.
##### DB2
**`/fragments/db2-init-fragment.sql`**
This file contains any one-off SQL to run in DB2 - at the minimum it will normally be creating a database.
[Example](snippets/db2-init-fragment.sql)
##### ElasticSearch
**`/fragments/elasticsearch-fragment.sh`**
**`/fragments/elasticsearch5-fragment.sh`**
This file is a shell script that contains curl commands to do any setup the app needs in elasticsearch - creating indexes etc. It will be passed a single argument, the host and port, which can be accessed in the script using `$1`.
The ports 9200/9300 and 9202/9302 are exposed on the host for Elasticsearch versions 2 and 5 respectively.
[Example](snippets/elasticsearch-fragment.sh)
##### Nginx
**`/fragments/nginx-fragment.conf`**
This file forms part of an NGINX configration file. It will be merged into the server directive of the main configuration file.
Important - if your app is adding itself as a proxied location{} behind NGINX, NGINX must start AFTER your app, otherwise it will error with a host not found. So your app's docker-compose-fragment.yml must actually specify NGINX as a service and set the depends_on variable with your app's name. Compose will automatically merge this with the dev-env's own NGINX fragment. See the end of the [example Compose fragment](snippets/docker-compose-fragment.yml) for the exact code.
[Example](snippets/nginx-fragment.conf)
##### RabbitMQ
There are no fragments needed when using this. The Management Console will be available on (guest/guest).
##### Redis
There are no fragments needed when using this. Redis will be available at on the host and at inside the Docker network.
You can monitor Redis activity using the CLI:
```shell
bashin redis
redis-cli monitor
```
#### Other files
**`/fragments/custom-provision.sh`**
This file contains anything you want - for example, initial data load. It will be executed on the host, not in the container. It is only ever run once (during the first `run.sh up`), and the file `.custom_provision.yml` is used by the dev-env to keep track of whether they have been run or not. Like `.commodities.yml`, this can be manually modified to trigger another run.
**`/fragments/custom-provision-always.sh`**
This works the same way as `custom-provision.sh` except it is executed on every `run.sh up`.
**`/fragments/host-fragments.yml`**
This file contains details of hosts to be forwarded on the host; if it exists then requests to the second address shall be forwarded to the first address.
[Example](snippets/host-fragments.yml)
**`/fragments/docker-compose--fragment.yml`**
This file can be used to override the default settings for a docker container such as environment variables. It will not be loaded by default but can be applied using the add-to-docker-compose alias.
## Logging
Any messages that get forwarded to the logstash\* container on TCP port 25826 will be output both in the logstash container's own stdout (so `livelogs logstash` can be used to monitor all apps) and in ./logs/log.txt.
\* Note that it is not really logstash, but we kept the container name that for backwards compatibility purposes.
## Hints and Tips
* Ensure that you give Docker enough CPU and memory to run all your apps.
* The `run.sh destroy` command should be a last resort, as you will have to rebuild all images from scratch. Try the `fullreset` alias as that will just remove your app containers and recreate them. They are most likely to be the source of any corruption. Remember to alter `.commodities.yml` and `.custom_provision.yml` if you need to, and `run.sh reload`.
### Useful commands
If you hate typing long commands then the commands below have been added to the dev-env for you:
```bash
status - view the status of all running containers
stop - stop a container
start - start a container
restart - restart a container
logs - view the logs of a container (from the past)
livelogs - view the logs of a container (as they happen)
ex - execute a command in a running container
run - creates a new container and runs the command in it.
remove - remove a container
fullreset - Performs stop, remove then rebuild. Useful if a container (like a database) needs to be wiped. Remember to reset .commodities if you do though to ensure init fragments get rerun
rebuild - checks if a container needs rebuilding and rebuilds/recreates/restarts it if so, otherwise does nothing. Useful if a file has changed that the Dockerfile copies into the image.
bashin - bash in to a container
unit-test - run the unit tests for an application (this expects there to a be a Makefile with a unittest command). If you add -r it will output reports to the test-output folder.
integration-test - run the integration tests for an application (this expects there to a be a Makefile with a integrationtest command).
acceptance-test | acctest - run the acceptance tests run_tests.sh script inside the given container. If using the skeleton, any further parameters will be passed to cucumber.
acceptance-lint | acclint - run the acceptance tests run_linting.sh script inside the given container.
psql - run psql in the postgres container
db2 - run db2 command line in the db2 container
manage - run manage.py commands in a container
alembic - run an alembic db command in a container, with the appropriate environment variables preset
add-to-docker-compose
- looks in fragments folder of loaded apps to search for a new docker-compose-fragment including the provided parameter eg docker-compose-syt2-fragment then runs docker-compose up
```
If you prefer using docker or docker-compose directly then below is list of useful commands (note: if you leave out \ then all containers will be affected):
```bash
docker-compose run --rm - spin up a temporary container and run a command in it
docker-compose rm -v -f - remove a container
docker-compose down --rmi all -v --remove-orphans - stops and removes all containers, data, and images created by up. Don't use `--rmi all` if you want to keep the images.
docker-compose stop|start|restart - (aliases: stop/start/restart) starts, stops or restarts a container (it must already be built and created)
docker exec -it bash - (alias: bashin) gets you into a bash terminal inside a running container (useful for then running psql etc)
```
For those who get bored typing docker-compose you can use the alias dc instead. For example "dc ps" rather than "docker-compose ps".
### Adding Breakpoints to Applications Running in Containers
In order to interact with breakpoints that you add to your applications you need to run the container in the foreground and attach to the container terminal. You do that like so:
```bash
docker-compose stop
docker-compose run --rm --service-ports
```
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available and the changelog, see the [releases page](https://github.com/LandRegistry/common-dev-env/releases).
## Authors
* Simon Chapman ([GitHub](https://github.com/sdchapman))
* Ian Harvey ([GitHub](https://github.com/IWHarvey))
See also the list of [contributors](https://github.com/LandRegistry/common-dev-env/contributors) who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
## Acknowledgments
* Matthew Pease ([GitHub](https://github.com/Skablam)) - for helping create the original internal version