Skip to content

Commit fb848e9

Browse files
authored
fix: improve Harmonia quick start cleanup (#21221)
<!--Delete sections as needed --> ## Description <!-- Tell us what you did and why --> Added additional cleanup steps and other minor improvements to the Harmonia quick start guide. ## Reviews <!-- Notes for reviewers here --> <!-- List applicable reviews (optionally @tag reviewers) --> - [ ] Technical review - [ ] Editorial review - [ ] Product review
1 parent c82547b commit fb848e9

File tree

1 file changed

+40
-23
lines changed

1 file changed

+40
-23
lines changed

content/manuals/harmonia/_index.md

Lines changed: 40 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -85,18 +85,22 @@ You should see the following:
8585

8686
### Step two: Run and remove containers with the newly created cloud engine
8787

88-
1. Run an Nginx container in the cloud engine:
89-
```console
90-
$ docker run -d -p 8080:80 nginx
91-
```
92-
This maps the container's port `80` to the host's port `8080`. If port `8080` is already in use on your host, you can specify a different port.
93-
2. View the Nginx welcome page. Navigate to [`http://localhost:8080/`](http://localhost:8080/).
94-
3. Verify the running container:
95-
- In the **Containers** tab in the Docker Desktop Dashboard, you should see your Nginx container listed.
96-
- Alternatively, list all running containers in the cloud engine via the terminal:
97-
```console
98-
$ docker ps
99-
```
88+
1. Run an Nginx container in the cloud engine:
89+
```console
90+
$ docker run -d --name cloudnginx -p 8080:80 nginx
91+
```
92+
This maps the container's port `80` to the host's port `8080`. If port `8080` is already in use on your host, you can specify a different port.
93+
2. View the Nginx welcome page. Navigate to [`http://localhost:8080/`](http://localhost:8080/).
94+
3. Verify the running container:
95+
- In the **Containers** tab in the Docker Desktop Dashboard, you should see your Nginx container listed.
96+
- Alternatively, list all running containers in the cloud engine via the terminal:
97+
```console
98+
$ docker ps
99+
```
100+
4. Shut down the container:
101+
```console
102+
$ docker kill cloudnginx
103+
```
100104

101105
Running a container with a cloud engine is just as straightforward as running it locally.
102106

@@ -139,8 +143,8 @@ Project Harmonia takes advantage of [Synchronized file shares](/manuals/desktop/
139143
{{< tabs group="method" >}}
140144
{{< tab name="Docker Desktop">}}
141145

142-
1. Clone the [Awesome Compose](https://github.com/docker/awesome-compose) repository.
143-
2. In the Docker Desktop Dashboard, navigate to the **Project Harmonia** view.
146+
1. Clone the [Awesome Compose](https://github.com/docker/awesome-compose) repository.
147+
2. In the Docker Desktop Dashboard, navigate to the **Project Harmonia** view.
144148
3. For the `cloudengine` cloud engine, select the **Actions** menu and then **Manage file syncs**.
145149
4. Select **Create file sync**.
146150
5. Navigate to the `awesome-compose/react-express-mysql` folder and select **Open**.
@@ -149,14 +153,14 @@ Project Harmonia takes advantage of [Synchronized file shares](/manuals/desktop/
149153
```console
150154
$ docker compose up -d
151155
```
152-
8. Test the application by visiting [`http://localhost:3000`](http://localhost:3000/).
156+
8. Test the application by visiting [`http://localhost:3000`](http://localhost:3000/).
153157
You should see the home page. The code for this page is located in `react-express-mysql/frontend/src/App.js`.
154158
9. In an IDE or text editor, open the `App.js` file, change some text, and save. Watch as the code reloads live in your browser.
155159

156160
{{< /tab >}}
157161
{{< tab name="CLI">}}
158162

159-
1. Clone the [Awesome Compose](https://github.com/docker/awesome-compose) repository.
163+
1. Clone the [Awesome Compose](https://github.com/docker/awesome-compose) repository.
160164
2. In your terminal, change into the `awesome-compose/react-express-mysql` directory.
161165
3. Create a file sync for `cloudengine`:
162166
```console
@@ -165,23 +169,24 @@ Project Harmonia takes advantage of [Synchronized file shares](/manuals/desktop/
165169
```console
166170
$ docker compose up -d
167171
```
168-
5. Test the application by visiting [`http://localhost:3000`](http://localhost:3000/).
172+
5. Test the application by visiting [`http://localhost:3000`](http://localhost:3000/).
169173
You should see the home page. The code for this page is located in `react-express-mysql/frontend/src/App.js`.
170174
6. In an IDE or text editor, open the `App.js` file, change some text, and save. Watch as the code reloads live in your browser.
171175

172176
{{< /tab >}}
173177
{{< /tabs >}}
174178

175-
### Step five: Share a container port
179+
### Step five: Share a container port
176180

177181
{{< tabs group="method" >}}
178182
{{< tab name="Docker Desktop">}}
179183

180-
1. Make sure your Docker context is set to `cloudengine`.
181-
2. In the Docker Desktop Dashboard, navigate to the **Containers** view.
182-
3. Select the **lock** icon in the **Ports** column of your running container next to `3000:3000`.
183-
This creates a publicly accessible URL that you can share with teammates.
184-
4. Select the **copy** icon, to copy this URL.
184+
1. Make sure your Docker context is set to `cloudengine`.
185+
2. In the Docker Desktop Dashboard, navigate to the **Containers** view.
186+
3. If necessary, expand the application listing to show all of its containers.
187+
4. Select the **lock** icon in the **Ports** column of your running container next to `3000:3000`.
188+
This creates a publicly accessible URL that you can share with teammates.
189+
5. Select the **copy** icon, to copy this URL.
185190

186191
To view all shared ports for your Docker context, select the **Shared ports** icon in the bottom-right corner of the Docker Desktop Dashboard.
187192

@@ -208,6 +213,12 @@ $ docker harmonia engine share list
208213
{{< tabs group="method" >}}
209214
{{< tab name="Docker Desktop">}}
210215

216+
To stop the running project:
217+
218+
```console
219+
$ docker compose down
220+
```
221+
211222
To remove a file sync session:
212223
1. Navigate to your cloud engine in the **Project Harmonia** view.
213224
2. Select the **Actions** menu and then **Manage file syncs**.
@@ -219,6 +230,12 @@ To remove a cloud engine, navigate to the **Project Harmonia** view and then sel
219230
{{< /tab >}}
220231
{{< tab name="CLI">}}
221232

233+
To stop the running project:
234+
235+
```console
236+
$ docker compose down
237+
```
238+
222239
To remove the file sync session, run:
223240

224241
```console

0 commit comments

Comments
 (0)