docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

get-started: simplify workshop intro, update node version 

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
This commit is contained in:
David Karlsson 2024-10-31 16:31:00 +01:00
parent 1ef9019754
commit 158beace56
1 changed files with 32 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

104
content/get-started/workshop/02_our_app.md
View File

@ -2,10 +2,12 @@
title: Containerize an application title: Containerize an application
weight: 20 weight: 20
linkTitle: "Part 1: Containerize an application" linkTitle: "Part 1: Containerize an application"
keywords: dockerfile example, Containerize an application, run docker file, running keywords: |
dockerfile example, Containerize an application, run docker file, running
docker file, how to run dockerfile, example dockerfile, how to create a docker container, docker file, how to run dockerfile, example dockerfile, how to create a docker container,
create dockerfile, simple dockerfile, creating containers create dockerfile, simple dockerfile, creating containers
description: Follow this step-by-step guide to learn how to create and run a containerized description: |
Follow this step-by-step guide to learn how to create and run a containerized
application using Docker application using Docker
aliases: aliases:
- /get-started/part2/ - /get-started/part2/
@ -49,68 +51,13 @@ Before you can run the application, you need to get the application source code
To build the image, you'll need to use a Dockerfile. A Dockerfile is simply a text-based file with no file extension that contains a script of instructions. Docker uses this script to build a container image. To build the image, you'll need to use a Dockerfile. A Dockerfile is simply a text-based file with no file extension that contains a script of instructions. Docker uses this script to build a container image.
1. In the `getting-started-app` directory, the same location as the `package.json` file, create a file named `Dockerfile`. You can use the following commands to create a Dockerfile based on your operating system. 1. In the `getting-started-app` directory, the same location as the
`package.json` file, create a file named `Dockerfile` with the following contents:
{{< tabs >}}
{{< tab name="Mac / Linux / Windows (Git Bash)" >}}
In the terminal, run the following commands.
Make sure you're in the `getting-started-app` directory. Replace `/path/to/getting-started-app` with the path to your `getting-started-app` directory.
```console
$ cd /path/to/getting-started-app
```
Create an empty file named `Dockerfile`.
```console
$ touch Dockerfile
```
{{< /tab >}}
{{< tab name="Windows (Command Prompt)" >}}
In the Windows Command Prompt, run the following commands.
Make sure you're in the `getting-started-app` directory. Replace `\path\to\getting-started-app` with the path to your `getting-started-app` directory.
```console
$ cd \path\to\getting-started-app
```
Create an empty file named `Dockerfile`.
```console
$ type nul > Dockerfile
```
{{< /tab >}}
{{< tab name="Windows (PowerShell)" >}}
In PowerShell, run the following commands.
Make sure you're in the `getting-started-app` directory. Replace `\path\to\getting-started-app` with the path to your `getting-started-app` directory.
```console
$ cd \path\to\getting-started-app
```
Create an empty file named `Dockerfile`.
```powershell
$ New-Item -Path . -Name Dockerfile -ItemType File
```
{{< /tab >}}
{{< /tabs >}}
2. Using a text editor or code editor, add the following contents to the Dockerfile:
```dockerfile ```dockerfile
# syntax=docker/dockerfile:1 # syntax=docker/dockerfile:1
FROM node:18-alpine FROM node:lts-alpine
WORKDIR /app WORKDIR /app
COPY . . COPY . .
RUN yarn install --production RUN yarn install --production
@ -118,7 +65,12 @@ To build the image, you'll need to use a Dockerfile. A Dockerfile is simply a te
EXPOSE 3000 EXPOSE 3000
``` ```
3. Build the image using the following commands: This Dockerfile starts off with a `node:lts-alpine` base image, a
light-weight Linux image that comes with Node.js and the Yarn package
manager pre-installed. It copies all of the source code into the image,
installs the necessary dependencies, and starts the application.
2. Build the image using the following commands:
In the terminal, make sure you're in the `getting-started-app` directory. Replace `/path/to/getting-started-app` with the path to your `getting-started-app` directory. In the terminal, make sure you're in the `getting-started-app` directory. Replace `/path/to/getting-started-app` with the path to your `getting-started-app` directory.
@ -127,11 +79,12 @@ To build the image, you'll need to use a Dockerfile. A Dockerfile is simply a te
``` ```
Build the image. Build the image.
```console ```console
$ docker build -t getting-started . $ docker build -t getting-started .
``` ```
The `docker build` command uses the Dockerfile to build a new image. You might have noticed that Docker downloaded a lot of "layers". This is because you instructed the builder that you wanted to start from the `node:18-alpine` image. But, since you didn't have that on your machine, Docker needed to download the image. The `docker build` command uses the Dockerfile to build a new image. You might have noticed that Docker downloaded a lot of "layers". This is because you instructed the builder that you wanted to start from the `node:lts-alpine` image. But, since you didn't have that on your machine, Docker needed to download the image.
After Docker downloaded the image, the instructions from the Dockerfile copied in your application and used `yarn` to install your application's dependencies. The `CMD` directive specifies the default command to run when starting a container from this image. After Docker downloaded the image, the instructions from the Dockerfile copied in your application and used `yarn` to install your application's dependencies. The `CMD` directive specifies the default command to run when starting a container from this image.
@ -146,30 +99,27 @@ Now that you have an image, you can run the application in a container using the
1. Run your container using the `docker run` command and specify the name of the image you just created: 1. Run your container using the `docker run` command and specify the name of the image you just created:
```console ```console
$ docker run -dp 127.0.0.1:3000:3000 getting-started $ docker run -d -p 127.0.0.1:3000:3000 getting-started
``` ```
The `-d` flag (short for `--detach`) runs the container in the background. The `-d` flag (short for `--detach`) runs the container in the background.
This means that Docker starts your container and returns you to the terminal This means that Docker starts your container and returns you to the terminal
prompt. You can verify that a container is running by viewing it in Docker prompt.
Dashboard under **Containers**, or by running `docker ps` in the terminal.
The `-p` flag (short for `--publish`) creates a port mapping between the host The `-p` flag (short for `--publish`) creates a port mapping between the
and the container. The `-p` flag takes a string value in the format of host and the container. The `-p` flag takes a string value in the format of
`HOST:CONTAINER`, where `HOST` is the address on the host, and `CONTAINER` is `HOST:CONTAINER`, where `HOST` is the address on the host, and `CONTAINER`
the port on the container. The command publishes the container's port 3000 to is the port on the container. The command publishes the container's port
`127.0.0.1:3000` (`localhost:3000`) on the host. Without the port mapping, 3000 to `127.0.0.1:3000` (`localhost:3000`) on the host. Without the port
you wouldn't be able to access the application from the host. mapping, you wouldn't be able to access the application from the host.
2. After a few seconds, open your web browser to [http://localhost:3000](http://localhost:3000). 2. After a few seconds, open your web browser to [http://localhost:3000](http://localhost:3000).
You should see your app. You should see your app.
![Empty todo list](images/todo-list-empty.webp) ![Empty todo list](images/todo-list-empty.webp)
3. Add an item or two and see that it works as you expect. You can mark items as complete and remove them. Your frontend is successfully storing items in the backend. 3. Add an item or two and see that it works as you expect. You can mark items as complete and remove them. Your frontend is successfully storing items in the backend.
At this point, you have a running todo list manager with a few items. At this point, you have a running todo list manager with a few items.
If you take a quick look at your containers, you should see at least one container running that's using the `getting-started` image and on port `3000`. To see your containers, you can use the CLI or Docker Desktop's graphical interface. If you take a quick look at your containers, you should see at least one container running that's using the `getting-started` image and on port `3000`. To see your containers, you can use the CLI or Docker Desktop's graphical interface.
@ -177,12 +127,14 @@ If you take a quick look at your containers, you should see at least one contain
{{< tabs >}} {{< tabs >}}
{{< tab name="CLI" >}} {{< tab name="CLI" >}}
Run the following `docker ps` command in a terminal to list your containers. Run the `docker ps` command in a terminal to list your containers.
```console ```console
$ docker ps $ docker ps
``` ```
Output similar to the following should appear. Output similar to the following should appear.
```console ```console
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
df784548666d getting-started "docker-entrypoint.s…" 2 minutes ago Up 2 minutes 127.0.0.1:3000->3000/tcp priceless_mcclintock df784548666d getting-started "docker-entrypoint.s…" 2 minutes ago Up 2 minutes 127.0.0.1:3000->3000/tcp priceless_mcclintock
@ -204,8 +156,8 @@ In this section, you learned the basics about creating a Dockerfile to build an
Related information: Related information:
- [Dockerfile reference](/reference/dockerfile/) - [Dockerfile reference](/reference/dockerfile/)
- [docker CLI reference](/reference/cli/docker/) - [docker CLI reference](/reference/cli/docker/)
## Next steps ## Next steps