-
Notifications
You must be signed in to change notification settings - Fork 7.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #20511 from docker/published-update
publish updates from main
- Loading branch information
Showing
8 changed files
with
919 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
description: Containerize Ruby on Rails apps using Docker | ||
keywords: Docker, getting started, ruby, language | ||
title: Ruby on Rails language-specific guide | ||
toc_min: 1 | ||
toc_max: 2 | ||
--- | ||
|
||
The Ruby language-specific guide teaches you how to containerize a Ruby on Rails application using Docker. In this guide, you’ll learn how to: | ||
|
||
* Containerize and run a Ruby on Rails application | ||
* Set up a local environment to develop a Ruby on Rails application using containers | ||
* Configure a CI/CD pipeline for a containerized Ruby on Rails application using GitHub Actions | ||
* Deploy your containerized Ruby on Rails application locally to Kubernetes to test and debug your deployment | ||
|
||
Start by containerizing an existing Ruby on Rails application. | ||
|
||
{{< button text="Containerize a Ruby on Rails app" url="containerize.md" >}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,129 @@ | ||
--- | ||
title: Configure CI/CD for your Ruby on Rails application | ||
keywords: ci/cd, github actions, ruby, flask | ||
description: Learn how to configure CI/CD using GitHub Actions for your Ruby on Rails application. | ||
--- | ||
|
||
## Prerequisites | ||
|
||
Complete all the previous sections of this guide, starting with [Containerize a Ruby on Rails 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 credentials, 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 variable** 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 **Repository secret** 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. | ||
|
||
```yaml | ||
name: ci | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- | ||
name: Login to Docker Hub | ||
uses: docker/login-action@v3 | ||
with: | ||
username: ${{ vars.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@v6 | ||
with: | ||
platforms: linux/amd64 | ||
push: true | ||
tags: ${{ vars.DOCKER_USERNAME }}/${{ github.event.repository.name }}:latest | ||
``` | ||
For more information about the YAML syntax for `docker/build-push-action`, | ||
refer to the [GitHub Action README](https://github.com/docker/build-push-action/blob/master/README.md). | ||
|
||
## 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 Ruby on Rails 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" >}} |
Oops, something went wrong.