You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+22-39
Original file line number
Diff line number
Diff line change
@@ -11,22 +11,13 @@ It provides several hooks for applications to take advantage of, including:
11
11
12
12
### Prerequisites
13
13
14
-
#### Recommended setup
15
-
16
14
***Docker and Docker Compose**. Exactly what toolset you use depends on your OS and personal preferences, but recommended are:
17
15
*[Docker For Mac](https://docs.docker.com/docker-for-mac/)
18
16
*[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)
19
17
*[Docker CE for Linux](https://docs.docker.com/install/linux/docker-ce/ubuntu/)
20
18
***Git**
21
19
***Ruby 2.5+**
22
20
23
-
#### Alternative setup
24
-
25
-
***Vagrant** (v2+)
26
-
***VirtualBox** (v6+)
27
-
28
-
A Vagrantfile is provided so `vagrant up` will result in a virtual machine containing all the prerequisites from the Recommended setup above. From there, just `vagrant ssh` in and use the dev-env as you would natively.
29
-
30
21
### Git/SSH
31
22
32
23
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.
@@ -115,25 +106,21 @@ This file specifies which commodities the dev-env should create and launch for t
115
106
116
107
The list of allowable commodity values is:
117
108
118
-
1. postgres
119
-
2. postgres-9.6
120
-
3. postgres-13
121
-
4. db2_devc (**Warning:** source image deprecated by IBM; use db2_community instead)
122
-
5. db2_community
123
-
6. elasticsearch
124
-
7. elasticsearch5
125
-
8. nginx
126
-
9. rabbitmq
127
-
10. redis
128
-
11. swagger
129
-
12. wiremock
130
-
13. squid
131
-
14. auth
132
-
15. cadence
133
-
16. cadence-web
134
-
17. activemq
135
-
18. ibmmq
136
-
19. localstack
109
+
1. postgres-13
110
+
2. db2_community
111
+
4. elasticsearch5
112
+
5. nginx
113
+
6. rabbitmq
114
+
7. redis
115
+
8. swagger
116
+
9. wiremock
117
+
10. squid
118
+
11. auth
119
+
12. cadence
120
+
13. cadence-web
121
+
14. activemq
122
+
15. ibmmq
123
+
16. localstack
137
124
138
125
* The file may optionally also indicate that one or more services are resource intensive ("expensive") when starting up. The dev env will start those containers seperately - 3 at a time - and wait until each are declared healthy (or crash and get restarted 10 times) before starting any more. This requires a healthcheck command specified here or in the Dockerfile/docker-compose-fragment (in which case just use 'docker' in this file).
139
126
* If one of these expensive services prefers another one to be considered "healthy" before a startup attempt is made (such as a database, to ensure immediate connectivity and no expensive restarts) then the dependent service can be specified here, with a healthcheck command following the same rules as above.
@@ -156,35 +143,31 @@ If you want to spatially enable your database see the following example:
The default Postgres port 5432 will be available for connections from other containers and on the host. Postgres 9.6 will be exposed on port 5433, Postgres 13 on 5434.
146
+
The default Postgres port 5432 will be available for connections from other containers. Port 5434 is exposed for external connections from the host.
160
147
161
148
**`/manage.py`**
162
149
163
-
This is a standard Alembic management file - if it exists, then a database migration will be run on every `up` or `reload`. This can be disabled by setting the key `perform_alembic_migration` to `false` in `configuration.yml` - for example if the file does not actually relate to Alembic, or you do your own migration during app startup.
164
-
165
-
##### DB2
150
+
This is a standard Alembic management file - if it exists, then a database migration will be run on every `up` or `reload`. This functionality can be enabled by setting the key `perform_alembic_migration` to `true` in `configuration.yml`. It is recommended however that you do your own migration during app startup.
166
151
167
-
`db2_community` (DB2 Community Edition 11.5) is recommended over `db2_devc` (DB2 Developer C 11.0)
152
+
##### DB2 Community
168
153
169
-
Note that DB2 Developer C is exposed on the host ports 50001/55001 and DB2 Community on 50002/55002 to avoid port clashes.
154
+
Note that DB2 Community is exposed on 30002/35002 to avoid port clashes.
170
155
171
-
**`/fragments/db2-devc-init-fragment.sql`**
172
156
**`/fragments/db2-community-init-fragment.sql`**
173
157
174
158
This file contains any one-off SQL to run in DB2 - at the minimum it will normally be creating a database.
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`.
184
167
185
-
The ports 9200/9300 and 9202/9302 are exposed on the host for Elasticsearch versions 2 and 5 respectively.
0 commit comments