mirror of https://github.com/docker/docs.git
docs: add language specific guide for c++ (#19903)
* docs: add language specific guide for c++ * docs: add C++ language support to the language index page * docs: Update _index.md * docs: update C++ guide paths * Update content/language/c-plus-plus/containerize.md Co-authored-by: Craig Osterhout <103533812+craig-osterhout@users.noreply.github.com> * Update content/language/c-plus-plus/containerize.md Co-authored-by: Craig Osterhout <103533812+craig-osterhout@users.noreply.github.com> * Update content/language/c-plus-plus/containerize.md Co-authored-by: Craig Osterhout <103533812+craig-osterhout@users.noreply.github.com> * Update content/language/c-plus-plus/containerize.md Co-authored-by: Craig Osterhout <103533812+craig-osterhout@users.noreply.github.com> * Update content/language/c-plus-plus/containerize.md Co-authored-by: Craig Osterhout <103533812+craig-osterhout@users.noreply.github.com> * Update content/language/c-plus-plus/develop.md Co-authored-by: Craig Osterhout <103533812+craig-osterhout@users.noreply.github.com> * Update content/language/c-plus-plus/configure-ci-cd.md Co-authored-by: Craig Osterhout <103533812+craig-osterhout@users.noreply.github.com> * Update _index.md * guides: use /cpp instead of /c-plus-plus Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> * Update content/language/cpp/develop.md Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> * Update content/language/cpp/containerize.md Co-authored-by: Craig Osterhout <103533812+craig-osterhout@users.noreply.github.com> --------- Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> Co-authored-by: Craig Osterhout <103533812+craig-osterhout@users.noreply.github.com> Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
This commit is contained in:
Pradumna Saraf
GitHub
parent
6d238390a6
commit
1b6a6d530e
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
description: Language-specific guides overview
|
||||
keywords: guides, docker, language, node, java, python, R, go, golang, .net
|
||||
keywords: guides, docker, language, node, java, python, R, go, golang, .net, c++
|
||||
title: Language-specific guides overview
|
||||
toc_min: 1
|
||||
toc_max: 2
|
||||
|
|
@ -44,6 +44,9 @@ Learn how to containerize your applications and start developing using Docker. C
|
|||
<div class="flex items-center flex-1 shadow p-4">
|
||||
<a href="/language/dotnet/"><img class="m-auto rounded" src="/language/images/c-sharp.webp" alt="Develop with C#"></a>
|
||||
</div>
|
||||
<div class="flex items-center flex-1 shadow p-4">
|
||||
<a href="/language/cpp/"><img class="m-auto rounded" src="/language/images/cpp.webp" alt="Develop with C++"></a>
|
||||
</div>
|
||||
<div class="flex items-center flex-1 shadow p-4">
|
||||
<a href="/language/rust/"><img class="m-auto rounded" src="/language/images/rust-logo.webp" alt="Develop with Rust"></a>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
description: Containerize and develop C++ applications using Docker.
|
||||
keywords: getting started, c++
|
||||
title: C++ language-specific guide
|
||||
toc_min: 1
|
||||
toc_max: 2
|
||||
---
|
||||
|
||||
The C++ getting started guide teaches you how to create a containerized C++ application using Docker. In this guide, you'll learn how to:
|
||||
|
||||
> **Acknowledgment**
|
||||
>
|
||||
> Docker would like to thank [Pradumna Saraf](https://twitter.com/pradumna_saraf) for his contribution to this guide.
|
||||
|
||||
* Containerize and run a C++ application
|
||||
* Set up a local environment to develop a C++ application using containers
|
||||
* Configure a CI/CD pipeline for a containerized C++ application using GitHub Actions
|
||||
* Deploy your containerized application locally to Kubernetes to test and debug your deployment
|
||||
|
||||
After completing the C++ getting started modules, you should be able to containerize your own C++ application based on the examples and instructions provided in this guide.
|
||||
|
||||
Start by containerizing an existing C++ application.
|
||||
|
||||
{{< button text="Containerize a C++ app" url="containerize.md" >}}
|
||||
|
|
@ -0,0 +1,134 @@
|
|||
---
|
||||
title: Configure CI/CD for your C++ application
|
||||
keywords: ci/cd, github actions, c++, shiny
|
||||
description: Learn how to configure CI/CD using GitHub Actions for your C++ application.
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Complete all the previous sections of this guide, starting with [Containerize a C++ application](containerize.md). You must have a [GitHub](https://github.com/signup) account and a [Docker](https://hub.docker.com/signup) account to complete this section.
|
||||
|
||||
## Overview
|
||||
|
||||
In this section, you'll learn how to set up and use GitHub Actions to build and test your Docker image as well as push it to Docker Hub. You will complete the following steps:
|
||||
|
||||
1. Create a new repository on GitHub.
|
||||
2. Define the GitHub Actions workflow.
|
||||
3. Run the workflow.
|
||||
|
||||
## Step one: Create the repository
|
||||
|
||||
Create a GitHub repository, configure the Docker Hub secrets, and push your source code.
|
||||
|
||||
1. [Create a new repository](https://github.com/new) on GitHub.
|
||||
|
||||
2. Open the repository **Settings**, and go to **Secrets and variables** >
|
||||
**Actions**.
|
||||
|
||||
3. Create a new **Repository secrets** named `DOCKER_USERNAME` and your Docker ID as value.
|
||||
|
||||
4. Create a new [Personal Access Token (PAT)](../../security/for-developers/access-tokens.md/#create-an-access-token) for Docker Hub. You can name this token `docker-tutorial`. Make sure access permissions include Read and Write.
|
||||
|
||||
5. Add the PAT as a second **Repository secrets** in your GitHub repository, with the name
|
||||
`DOCKERHUB_TOKEN`.
|
||||
|
||||
6. In your local repository on your machine, run the following command to change
|
||||
the origin to the repository you just created. Make sure you change
|
||||
`your-username` to your GitHub username and `your-repository` to the name of
|
||||
the repository you created.
|
||||
|
||||
```console
|
||||
$ git remote set-url origin https://github.com/your-username/your-repository.git
|
||||
```
|
||||
|
||||
7. Run the following commands to stage, commit, and push your local repository to GitHub.
|
||||
|
||||
```console
|
||||
$ git add -A
|
||||
$ git commit -m "my commit"
|
||||
$ git push -u origin main
|
||||
```
|
||||
|
||||
## Step two: Set up the workflow
|
||||
|
||||
Set up your GitHub Actions workflow for building, testing, and pushing the image
|
||||
to Docker Hub.
|
||||
|
||||
1. Go to your repository on GitHub and then select the **Actions** tab.
|
||||
|
||||
2. Select **set up a workflow yourself**.
|
||||
|
||||
This takes you to a page for creating a new GitHub actions workflow file in
|
||||
your repository, under `.github/workflows/main.yml` by default.
|
||||
|
||||
3. In the editor window, copy and paste the following YAML configuration and commit the changes.
|
||||
|
||||
```yaml
|
||||
name: ci
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
-
|
||||
name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
-
|
||||
name: Login to Docker Hub
|
||||
uses: docker/login-action@v3
|
||||
with:
|
||||
username: ${{ secrets.DOCKER_USERNAME }}
|
||||
password: ${{ secrets.DOCKERHUB_TOKEN }}
|
||||
-
|
||||
name: Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@v3
|
||||
-
|
||||
name: Build and push
|
||||
uses: docker/build-push-action@v5
|
||||
with:
|
||||
context: .
|
||||
platforms: linux/amd64,linux/arm64
|
||||
push: true
|
||||
tags: ${{ secrets.DOCKER_USERNAME }}/${{ github.event.repository.name }}:latest
|
||||
```
|
||||
|
||||
If your Dockerfile is in a different directory, update the `context` with the path to the directory containing the Dockerfile.
|
||||
|
||||
For more information about the YAML syntax used here, see [Workflow syntax for GitHub Actions](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions).
|
||||
|
||||
## Step three: Run the workflow
|
||||
|
||||
Save the workflow file and run the job.
|
||||
|
||||
1. Select **Commit changes...** and push the changes to the `main` branch.
|
||||
|
||||
After pushing the commit, the workflow starts automatically.
|
||||
|
||||
2. Go to the **Actions** tab. It displays the workflow.
|
||||
|
||||
Selecting the workflow shows you the breakdown of all the steps.
|
||||
|
||||
3. When the workflow is complete, go to your
|
||||
[repositories on Docker Hub](https://hub.docker.com/repositories).
|
||||
|
||||
If you see the new repository in that list, it means the GitHub Actions
|
||||
successfully pushed the image to Docker Hub.
|
||||
|
||||
## Summary
|
||||
|
||||
In this section, you learned how to set up a GitHub Actions workflow for your C++ application.
|
||||
|
||||
Related information:
|
||||
- [Introduction to GitHub Actions](../../build/ci/github-actions/index.md)
|
||||
- [Workflow syntax for GitHub Actions](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions)
|
||||
|
||||
## Next steps
|
||||
|
||||
Next, learn how you can locally test and debug your workloads on Kubernetes before deploying.
|
||||
|
||||
{{< button text="Test your deployment" url="./deploy.md" >}}
|
||||
|
|
@ -0,0 +1,90 @@
|
|||
---
|
||||
title: Containerize a C++ application
|
||||
keywords: C++, containerize, initialize
|
||||
description: Learn how to containerize a C++ application.
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
||||
* You have a [Git client](https://git-scm.com/downloads). The examples in this section use a command-line based Git client, but you can use any client.
|
||||
|
||||
## Overview
|
||||
|
||||
This section walks you through containerizing and running a C++ application.
|
||||
|
||||
## Get the sample application
|
||||
|
||||
Clone the sample application to use with this guide. Open a terminal, change directory to a directory that you want to work in, and run the following command to clone the repository:
|
||||
|
||||
```console
|
||||
$ git clone https://github.com/dockersamples/c-plus-plus-docker.git
|
||||
```
|
||||
|
||||
You should now have the following contents in your `c-plus-plus-docker`
|
||||
directory.
|
||||
|
||||
```text
|
||||
├── c-plus-plus-docker/
|
||||
│ ├── compose.yml
|
||||
│ ├── Dockerfile
|
||||
│ ├── LICENSE
|
||||
│ ├── ok_api.cpp
|
||||
│ └── README.md
|
||||
|
||||
```
|
||||
|
||||
To learn more about the files in the repository, see the following:
|
||||
- [Dockerfile](../../reference/dockerfile.md)
|
||||
- [.dockerignore](../../reference/dockerfile.md#dockerignore-file)
|
||||
- [compose.yml](../../compose/compose-file/_index.md)
|
||||
|
||||
## Run the application
|
||||
|
||||
Inside the `c-plus-plus-docker` directory, run the following command in a
|
||||
terminal.
|
||||
|
||||
```console
|
||||
$ docker compose up --build
|
||||
```
|
||||
|
||||
Open a browser and view the application at [http://localhost:8080](http://localhost:8080). You will see a message `{"Status" : "OK"}` in the browser.
|
||||
|
||||
In the terminal, press `ctrl`+`c` to stop the application.
|
||||
|
||||
### Run the application in the background
|
||||
|
||||
You can run the application detached from the terminal by adding the `-d`
|
||||
option. Inside the `c-plus-plus-docker` directory, run the following command
|
||||
in a terminal.
|
||||
|
||||
```console
|
||||
$ docker compose up --build -d
|
||||
```
|
||||
|
||||
Open a browser and view the application at [http://localhost:8080](http://localhost:8080).
|
||||
|
||||
|
||||
In the terminal, run the following command to stop the application.
|
||||
|
||||
```console
|
||||
$ docker compose down
|
||||
```
|
||||
|
||||
For more information about Compose commands, see the [Compose CLI
|
||||
reference](../../compose/reference/_index.md).
|
||||
|
||||
## Summary
|
||||
|
||||
In this section, you learned how you can containerize and run your C++
|
||||
application using Docker.
|
||||
|
||||
Related information:
|
||||
- [Build with Docker guide](../../build/guide/index.md)
|
||||
- [Docker Compose overview](../../compose/_index.md)
|
||||
|
||||
## Next steps
|
||||
|
||||
In the next section, you'll learn how you can develop your application using
|
||||
containers.
|
||||
|
||||
{{< button text="Develop your application" url="develop.md" >}}
|
||||
|
|
@ -0,0 +1,137 @@
|
|||
---
|
||||
title: Test your C++ deployment
|
||||
keywords: deploy, kubernetes, c++
|
||||
description: Learn how to develop locally using Kubernetes
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Complete all the previous sections of this guide, starting with [Containerize a C++ application](containerize.md).
|
||||
- [Turn on Kubernetes](/desktop/kubernetes/#install-and-turn-on-kubernetes) in Docker Desktop.
|
||||
|
||||
## Overview
|
||||
|
||||
In this section, you'll learn how to use Docker Desktop to deploy your application to a fully-featured Kubernetes environment on your development machine. This allows you to test and debug your workloads on Kubernetes locally before deploying.
|
||||
|
||||
## Create a Kubernetes YAML file
|
||||
|
||||
In your `c-plus-plus-docker` directory, create a file named
|
||||
`docker-kubernetes.yml`. Open the file in an IDE or text editor and add
|
||||
the following contents. Replace `DOCKER_USERNAME/REPO_NAME` with your Docker
|
||||
username and the name of the repository that you created in [Configure CI/CD for
|
||||
your C++ application](configure-ci-cd.md).
|
||||
|
||||
```yaml
|
||||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: docker-c-plus-plus-demo
|
||||
namespace: default
|
||||
spec:
|
||||
replicas: 1
|
||||
selector:
|
||||
matchLabels:
|
||||
service: ok-api
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
service: ok-api
|
||||
spec:
|
||||
containers:
|
||||
- name: ok-api-service
|
||||
image: DOCKER_USERNAME/REPO_NAME
|
||||
imagePullPolicy: Always
|
||||
---
|
||||
apiVersion: v1
|
||||
kind: Service
|
||||
metadata:
|
||||
name: service-entrypoint
|
||||
namespace: default
|
||||
spec:
|
||||
type: NodePort
|
||||
selector:
|
||||
service: ok-api
|
||||
ports:
|
||||
- port: 8080
|
||||
targetPort: 8080
|
||||
nodePort: 30001
|
||||
```
|
||||
|
||||
In this Kubernetes YAML file, there are two objects, separated by the `---`:
|
||||
|
||||
- A Deployment, describing a scalable group of identical pods. In this case,
|
||||
you'll get just one replica, or copy of your pod. That pod, which is
|
||||
described under `template`, has just one container in it. The
|
||||
container is created from the image built by GitHub Actions in [Configure CI/CD for
|
||||
your C++ application](configure-ci-cd.md).
|
||||
- A NodePort service, which will route traffic from port 30001 on your host to
|
||||
port 8080 inside the pods it routes to, allowing you to reach your app
|
||||
from the network.
|
||||
|
||||
To learn more about Kubernetes objects, see the [Kubernetes documentation](https://kubernetes.io/docs/home/).
|
||||
|
||||
## Deploy and check your application
|
||||
|
||||
1. In a terminal, navigate to `c-plus-plus-docker` and deploy your application to
|
||||
Kubernetes.
|
||||
|
||||
```console
|
||||
$ kubectl apply -f docker-kubernetes.yml
|
||||
```
|
||||
|
||||
You should see output that looks like the following, indicating your Kubernetes objects were created successfully.
|
||||
|
||||
```text
|
||||
deployment.apps/docker-c-plus-plus-demo created
|
||||
service/service-entrypoint created
|
||||
```
|
||||
|
||||
2. Make sure everything worked by listing your deployments.
|
||||
|
||||
```console
|
||||
$ kubectl get deployments
|
||||
```
|
||||
|
||||
Your deployment should be listed as follows:
|
||||
|
||||
```shell
|
||||
NAME READY UP-TO-DATE AVAILABLE AGE
|
||||
docker-c-plus-plus-demo 1/1 1 1 10s
|
||||
```
|
||||
|
||||
This indicates all one of the pods you asked for in your YAML are up and running. Do the same check for your services.
|
||||
|
||||
```console
|
||||
$ kubectl get services
|
||||
```
|
||||
|
||||
You should get output like the following.
|
||||
|
||||
```shell
|
||||
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
|
||||
kubernetes ClusterIP 10.96.0.1 <none> 443/TCP 88m
|
||||
service-entrypoint NodePort 10.105.145.223 <none> 8080:30001/TCP 83s
|
||||
```
|
||||
|
||||
In addition to the default `kubernetes` service, you can see your `service-entrypoint` service, accepting traffic on port 30001/TCP.
|
||||
|
||||
3. In a browser, visit the following address. You should see the message `{"Status" : "OK"}`.
|
||||
|
||||
```console
|
||||
http://localhost:30001/
|
||||
```
|
||||
|
||||
4. Run the following command to tear down your application.
|
||||
|
||||
```console
|
||||
$ kubectl delete -f docker-kubernetes.yml
|
||||
```
|
||||
|
||||
## Summary
|
||||
|
||||
In this section, you learned how to use Docker Desktop to deploy your C++ application to a fully-featured Kubernetes environment on your development machine.
|
||||
|
||||
Related information:
|
||||
- [Kubernetes documentation](https://kubernetes.io/docs/home/)
|
||||
- [Deploy on Kubernetes with Docker Desktop](../../desktop/kubernetes.md)
|
||||
- [Swarm mode overview](../../engine/swarm/_index.md)
|
||||
|
|
@ -0,0 +1,73 @@
|
|||
---
|
||||
title: Use containers for C++ development
|
||||
keywords: C++, local, development
|
||||
description: Learn how to develop your C++ application locally.
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Complete [Containerize a C++ application](containerize.md).
|
||||
|
||||
## Overview
|
||||
|
||||
In this section, you'll learn how to set up a development environment for your containerized application. This includes:
|
||||
|
||||
- Configuring Compose to automatically update your running Compose services as you edit and save your code
|
||||
|
||||
## Get the sample application
|
||||
|
||||
Clone the sample application to use with this guide. Open a terminal, change directory to a directory that you want to work in, and run the following command to clone the repository:
|
||||
|
||||
```console
|
||||
$ git clone https://github.com/Pradumnasaraf/c-plus-plus-docker.git
|
||||
```
|
||||
|
||||
## Automatically update services
|
||||
|
||||
Use Compose Watch to automatically update your running Compose services as you
|
||||
edit and save your code. For more details about Compose Watch, see [Use Compose
|
||||
Watch](../../compose/file-watch.md).
|
||||
|
||||
Open your `compose.yml` file in an IDE or text editor and then add the Compose Watch instructions. The following example shows how to add Compose Watch to your `compose.yml` file.
|
||||
|
||||
```yaml {hl_lines="11-14",linenos=true}
|
||||
services:
|
||||
ok-api:
|
||||
image: ok-api
|
||||
build:
|
||||
context: .
|
||||
dockerfile: Dockerfile
|
||||
ports:
|
||||
- "8080:8080"
|
||||
develop:
|
||||
watch:
|
||||
- action: rebuild
|
||||
path: .
|
||||
```
|
||||
|
||||
Run the following command to run your application with Compose Watch.
|
||||
|
||||
```console
|
||||
$ docker compose watch
|
||||
```
|
||||
|
||||
Now, if you modify your `ok_api.cpp` you will see the changes in real time without re-building the image.
|
||||
|
||||
To test it out, open the `ok_api.cpp` file in your favorite text editor and change the message from `{"Status" : "OK"}` to `{"Status" : "Updated"}`. Save the file and refresh your browser at [http://localhost:8080](http://localhost:8080). You should see the updated message.
|
||||
|
||||
Press `ctrl+c` in the terminal to stop your application.
|
||||
|
||||
## Summary
|
||||
|
||||
In this section, you also learned how to use Compose Watch to automatically rebuild and run your container when you update your code.
|
||||
|
||||
Related information:
|
||||
- [Compose file reference](/compose/compose-file/)
|
||||
- [Compose file watch](../../compose/file-watch.md)
|
||||
- [Multi-stage builds](../../build/building/multi-stage.md)
|
||||
|
||||
## Next steps
|
||||
|
||||
In the next section, you'll take a look at how to set up a CI/CD pipeline using GitHub Actions.
|
||||
|
||||
{{< button text="Configure CI/CD" url="configure-ci-cd.md" >}}
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 46 KiB |
|
|
@ -148,6 +148,18 @@ Guides:
|
|||
path: /language/dotnet/configure-ci-cd/
|
||||
- title: "Test your deployment"
|
||||
path: /language/dotnet/deploy/
|
||||
- sectiontitle: C++
|
||||
section:
|
||||
- title: "Overview"
|
||||
path: /language/cpp/
|
||||
- title: "Containerize your app"
|
||||
path: /language/cpp/containerize/
|
||||
- title: "Develop your app"
|
||||
path: /language/cpp/develop/
|
||||
- title: "Configure CI/CD"
|
||||
path: /language/cpp/configure-ci-cd/
|
||||
- title: "Test your deployment"
|
||||
path: /language/cpp/deploy/
|
||||
- sectiontitle: Rust
|
||||
section:
|
||||
- title: "Overview"
|
||||
|
|
|
|||
Loading…
Reference in New Issue