Skip to content

Commit 0b01183

Browse files
commit111lionello
andauthored
Apply suggestions from code review
Co-authored-by: Lio李歐 <[email protected]>
1 parent 6dd6d01 commit 0b01183

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

docs/concepts/compose.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This file format may look familiar to you if you've come across `docker-compose.
1212

1313
## How It Works
1414

15-
You can create a `compose.yaml` file in the root of your project, or use the [`defang generate`](../tutorials/generate-new-code-using-ai.mdx) command to create one for you (along with other resources). This file is used to define your application's [services](./services.md) and how they run. You can edit this file to add more services or change the configuration of existing services.
15+
You can create a `compose.yaml` file in the root of your project, or use the [`defang generate`](../tutorials/generate-new-code-using-ai.mdx) command to create one for you (along with other resources). This file is used to define your application's [services](./services.md) and how they run. You can edit this file to add more services or change the configuration of services.
1616

1717
When you run `defang compose up`, Defang will read your `compose.yaml` file and [deploy](./deployments.md) the services named in that file to the cloud.
1818

@@ -22,14 +22,14 @@ Here is a basic `compose.yaml` file that contains all the required properties fo
2222
```yaml
2323
services:
2424
service-example:
25-
image: nginx:latest # use one of: an image (shown on this line) or a build (shown below)
25+
image: nginx:latest # use one of: image (shown on this line) or build (shown below)
2626
# build:
2727
# context: .
2828
# dockerfile: Dockerfile
2929
ports:
3030
- mode: ingress # specify ports to expose
3131
target: 8080
32-
published: 80
32+
published: 8080 # this is useful for running locally
3333

3434
```
3535
@@ -73,7 +73,7 @@ The version of the Compose file format being used. This property is now obsolete
7373
```
7474

7575
### `volumes`
76-
(Unsupported)
76+
(Not yet supported)
7777

7878
The volume mounts for a container, reusable across services. This feature is not currently supported by Defang.
7979

@@ -138,7 +138,7 @@ deploy:
138138
```
139139

140140
### `depends_on`
141-
(Unsupported)
141+
(Not yet supported)
142142

143143
This property describes startup dependencies between services. This feature is currently unsupported by Defang, but can be useful in local developments such as Docker.
144144

@@ -170,10 +170,10 @@ For sensitive environment variables (or secret values), you should list the vari
170170

171171
[This property](https://github.com/compose-spec/compose-spec/blob/main/05-services.md#healthcheck) describes a check that will be run to determine whether or not a service's containers are "healthy". It works in the same way, and has the same default values, as the [HEALTHCHECK Dockerfile instruction](https://docs.docker.com/engine/reference/builder/#healthcheck) set by the service's Docker image. Your Compose file can override the values set in the Dockerfile.
172172

173-
When using Defang, your compose file must have a healthcheck if you want to expose a port—even if your Dockerfile already contains one.
173+
When using Defang, your Compose file must have a healthcheck if you want to expose an `ingress` port—even if your Dockerfile already contains one.
174174

175175
:::note
176-
`curl` is commonly used for containers with a `slim`-based image, and `wget` is used for containers with an `alpine`-based image.
176+
`curl` is commonly used for containers with an Ubuntu-based image, and `wget` is used for containers with an `alpine`-based image.
177177
:::
178178

179179
```yaml
@@ -232,7 +232,7 @@ The ports to expose. The default port mode is `ingress`.
232232
ports:
233233
- mode: ingress
234234
target: 80
235-
published: 8080
235+
published: 80
236236
```
237237

238238
:::info

0 commit comments

Comments
 (0)