├── .docker └── docker-compose.yaml ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── backend ├── Dockerfile ├── go.mod ├── go.sum └── main.go ├── compose-dev.yaml ├── db └── password.txt ├── docker-compose.yaml └── proxy ├── Dockerfile └── conf /.docker/docker-compose.yaml: -------------------------------------------------------------------------------- 1 | version: "3.7" 2 | services: 3 | backend: 4 | build: 5 | context: backend 6 | target: development 7 | secrets: 8 | - db-password 9 | depends_on: 10 | - db 11 | db: 12 | image: mariadb 13 | restart: always 14 | healthcheck: 15 | test: [ "CMD", "mysqladmin", "ping", "-h", "127.0.0.1", "--silent" ] 16 | interval: 3s 17 | retries: 5 18 | start_period: 30s 19 | secrets: 20 | - db-password 21 | volumes: 22 | - db-data:/var/lib/mysql 23 | environment: 24 | - MYSQL_DATABASE=example 25 | - MYSQL_ROOT_PASSWORD_FILE=/run/secrets/db-password 26 | expose: 27 | - 3306 28 | proxy: 29 | build: proxy 30 | ports: 31 | - 8080:80 32 | depends_on: 33 | - backend 34 | volumes: 35 | db-data: 36 | secrets: 37 | db-password: 38 | file: db/password.txt 39 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contribution guidelines 2 | 3 | Since this project is intended to support a specific use case, contributions are limited to bug fixes or security issues. If you have a question, feel free to open an issue! 4 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # compose-dev-env 2 | Example used to try a Compose application with Docker Dev Environments. 3 | 4 | This example is based on the `nginx-golang-mysql` sample of [`awesome-compose` repository](https://github.com/docker/awesome-compose/). 5 | 6 | ## Compose sample application 7 | ### Go server with an Nginx proxy and a MariaDB database 8 | 9 | Project structure: 10 | ``` 11 | . 12 | ├── backend 13 | │   ├── Dockerfile 14 | │   ├── go.mod 15 | │   └── main.go 16 | ├── db 17 | │   └── password.txt 18 | ├── docker-compose.yaml 19 | ├── proxy 20 | │   ├── conf 21 | │   └── Dockerfile 22 | └── README.md 23 | ``` 24 | 25 | [_.docker/docker-compose.yaml_](.docker/docker-compose.yaml) 26 | ``` 27 | services: 28 | backend: 29 | build: backend 30 | ... 31 | db: 32 | image: mariadb 33 | ... 34 | proxy: 35 | build: proxy 36 | ports: 37 | - 8080:80 38 | ... 39 | ``` 40 | The compose file defines an application with three services `proxy`, `backend` and `db`. 41 | When deploying the application, docker-compose maps port 80 of the proxy service container to port 8080 of the host as specified in the file. 42 | Make sure port 8080 on the host is not already being in use. 43 | 44 | ## Deploy with docker-compose 45 | 46 | ``` 47 | $ docker-compose up -d 48 | Creating network "compose-dev-env_default" with the default driver 49 | Creating volume "compose-dev-env_db-data" with default driver 50 | Building backend 51 | Step 1/8 : FROM golang:1.13-alpine AS build 52 | 1.13-alpine: Pulling from library/golang 53 | ... 54 | Successfully built 5f7c899f9b49 55 | Creating compose-dev-env_db_1 ... done 56 | Creating compose-dev-env_backend_1 ... done 57 | Creating compose-dev-env_proxy_1 ... done 58 | ``` 59 | 60 | ## Expected result 61 | 62 | Listing containers must show three containers running and the port mapping as below: 63 | ``` 64 | $ docker ps 65 | CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES 66 | d6752b317e6d compose-dev-env_proxy "nginx -g 'daemon of…" About a minute ago Up About a minute 0.0.0.0:8080->80/tcp, :::80->80/tcp compose-dev-env_proxy_1 67 | 70bf9182ea52 compose-dev-env_backend "/server" About a minute ago Up About a minute 8000/tcp compose-dev-env_backend_1 68 | c67de604799d mariadb "docker-entrypoint.s…" About a minute ago Up About a minute 3306/tcp compose-dev-env_db_1 69 | ``` 70 | 71 | After the application starts, navigate to `http://localhost:8080` in your web browser or run: 72 | ``` 73 | $ curl localhost:8080 74 | ["Blog post #0","Blog post #1","Blog post #2","Blog post #3","Blog post #4"] 75 | ``` 76 | 77 | Stop and remove the containers 78 | ``` 79 | $ docker-compose down 80 | ``` 81 | 82 | -------------------------------------------------------------------------------- /backend/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM golang:1.16 AS build 2 | WORKDIR /go/src/github.com/org/repo 3 | COPY . . 4 | 5 | ENV CGO_ENABLED=0 6 | RUN go build -o server . 7 | 8 | FROM build AS development 9 | RUN apt-get update \ 10 | && apt-get install -y git 11 | CMD ["go", "run", "main.go"] 12 | 13 | FROM alpine:3.12 14 | EXPOSE 8000 15 | COPY --from=build /go/src/github.com/org/repo/server /server 16 | CMD ["/server"] 17 | -------------------------------------------------------------------------------- /backend/go.mod: -------------------------------------------------------------------------------- 1 | module github.com/org/repo 2 | 3 | go 1.13 4 | 5 | require ( 6 | github.com/go-sql-driver/mysql v1.3.0 7 | github.com/gorilla/context v1.1.1 // indirect 8 | github.com/gorilla/handlers v1.3.0 9 | github.com/gorilla/mux v1.6.2 10 | ) 11 | -------------------------------------------------------------------------------- /backend/go.sum: -------------------------------------------------------------------------------- 1 | github.com/go-sql-driver/mysql v1.3.0 h1:pgwjLi/dvffoP9aabwkT3AKpXQM93QARkjFhDDqC1UE= 2 | github.com/go-sql-driver/mysql v1.3.0/go.mod h1:zAC/RDZ24gD3HViQzih4MyKcchzm+sOG5ZlKdlhCg5w= 3 | github.com/gorilla/context v1.1.1 h1:AWwleXJkX/nhcU9bZSnZoi3h/qGYqQAGhq6zZe/aQW8= 4 | github.com/gorilla/context v1.1.1/go.mod h1:kBGZzfjB9CEq2AlWe17Uuf7NDRt0dE0s8S51q0aT7Yg= 5 | github.com/gorilla/handlers v1.3.0 h1:tsg9qP3mjt1h4Roxp+M1paRjrVBfPSOpBuVclh6YluI= 6 | github.com/gorilla/handlers v1.3.0/go.mod h1:Qkdc/uu4tH4g6mTK6auzZ766c4CA0Ng8+o/OAirnOIQ= 7 | github.com/gorilla/mux v1.6.2 h1:Pgr17XVTNXAk3q/r4CpKzC5xBM/qW1uVLV+IhRZpIIk= 8 | github.com/gorilla/mux v1.6.2/go.mod h1:1lud6UwP+6orDFRuTfBEV8e9/aOM/c4fVVCaMa2zaAs= 9 | -------------------------------------------------------------------------------- /backend/main.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "database/sql" 5 | "encoding/json" 6 | "fmt" 7 | "io/ioutil" 8 | "log" 9 | "net/http" 10 | "os" 11 | "time" 12 | 13 | _ "github.com/go-sql-driver/mysql" 14 | "github.com/gorilla/handlers" 15 | "github.com/gorilla/mux" 16 | ) 17 | 18 | func connect() (*sql.DB, error) { 19 | bin, err := ioutil.ReadFile("/run/secrets/db-password") 20 | if err != nil { 21 | return nil, err 22 | } 23 | return sql.Open("mysql", fmt.Sprintf("root:%s@tcp(db:3306)/example", string(bin))) 24 | } 25 | 26 | func blogHandler(w http.ResponseWriter, r *http.Request) { 27 | db, err := connect() 28 | if err != nil { 29 | w.WriteHeader(500) 30 | return 31 | } 32 | defer db.Close() 33 | 34 | rows, err := db.Query("SELECT title FROM blog") 35 | if err != nil { 36 | w.WriteHeader(500) 37 | return 38 | } 39 | var titles []string 40 | for rows.Next() { 41 | var title string 42 | err = rows.Scan(&title) 43 | titles = append(titles, title) 44 | } 45 | json.NewEncoder(w).Encode(titles) 46 | } 47 | 48 | func main() { 49 | log.Print("Prepare db...") 50 | if err := prepare(); err != nil { 51 | log.Fatal(err) 52 | } 53 | 54 | log.Print("Listening 8000") 55 | r := mux.NewRouter() 56 | r.HandleFunc("/", blogHandler) 57 | log.Fatal(http.ListenAndServe(":8000", handlers.LoggingHandler(os.Stdout, r))) 58 | } 59 | 60 | func prepare() error { 61 | db, err := connect() 62 | if err != nil { 63 | return err 64 | } 65 | defer db.Close() 66 | 67 | for i := 0; i < 60; i++ { 68 | if err := db.Ping(); err == nil { 69 | break 70 | } 71 | time.Sleep(time.Second) 72 | } 73 | 74 | if _, err := db.Exec("DROP TABLE IF EXISTS blog"); err != nil { 75 | return err 76 | } 77 | 78 | if _, err := db.Exec("CREATE TABLE IF NOT EXISTS blog (id int NOT NULL AUTO_INCREMENT, title varchar(255), PRIMARY KEY (id))"); err != nil { 79 | return err 80 | } 81 | 82 | for i := 0; i < 5; i++ { 83 | if _, err := db.Exec("INSERT INTO blog (title) VALUES (?);", fmt.Sprintf("Blog post #%d", i)); err != nil { 84 | return err 85 | } 86 | } 87 | return nil 88 | } 89 | -------------------------------------------------------------------------------- /compose-dev.yaml: -------------------------------------------------------------------------------- 1 | services: 2 | backend: 3 | build: 4 | context: backend 5 | target: development 6 | secrets: 7 | - db-password 8 | depends_on: 9 | - db 10 | db: 11 | image: mariadb 12 | restart: always 13 | healthcheck: 14 | test: [ "CMD", "mysqladmin", "ping", "-h", "127.0.0.1", "--silent" ] 15 | interval: 3s 16 | retries: 5 17 | start_period: 30s 18 | secrets: 19 | - db-password 20 | volumes: 21 | - db-data:/var/lib/mysql 22 | environment: 23 | - MYSQL_DATABASE=example 24 | - MYSQL_ROOT_PASSWORD_FILE=/run/secrets/db-password 25 | expose: 26 | - 3306 27 | proxy: 28 | build: proxy 29 | ports: 30 | - 8080:80 31 | depends_on: 32 | - backend 33 | volumes: 34 | db-data: 35 | secrets: 36 | db-password: 37 | file: db/password.txt 38 | -------------------------------------------------------------------------------- /db/password.txt: -------------------------------------------------------------------------------- 1 | db-q5n2g -------------------------------------------------------------------------------- /docker-compose.yaml: -------------------------------------------------------------------------------- 1 | services: 2 | backend: 3 | build: backend 4 | secrets: 5 | - db-password 6 | depends_on: 7 | - db 8 | db: 9 | image: mariadb 10 | restart: always 11 | secrets: 12 | - db-password 13 | volumes: 14 | - db-data:/var/lib/mysql 15 | environment: 16 | - MYSQL_DATABASE=example 17 | - MYSQL_ROOT_PASSWORD_FILE=/run/secrets/db-password 18 | expose: 19 | - 3306 20 | proxy: 21 | build: proxy 22 | ports: 23 | - 8080:80 24 | depends_on: 25 | - backend 26 | volumes: 27 | db-data: 28 | secrets: 29 | db-password: 30 | file: db/password.txt 31 | -------------------------------------------------------------------------------- /proxy/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM nginx:1.21 2 | 3 | RUN apt-get update \ 4 | && apt-get install -y git 5 | 6 | COPY conf /etc/nginx/conf.d/default.conf 7 | -------------------------------------------------------------------------------- /proxy/conf: -------------------------------------------------------------------------------- 1 | server { 2 | listen 80; 3 | server_name localhost; 4 | location / { 5 | proxy_pass http://backend:8000; 6 | } 7 | 8 | } 9 | --------------------------------------------------------------------------------