Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FLINK-37408] Update all docker-compose references to docker compose #26239

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

nilmadhab
Copy link
Contributor

@nilmadhab nilmadhab commented Mar 2, 2025

What is the purpose of the change

Replace all instances of "docker-compose" with "docker compose" throughout the Flink documentation to align with Docker's current CLI naming convention.

https://issues.apache.org/jira/browse/FLINK-37408

Brief change log

Replace all instances of "docker-compose" with "docker compose" throughout the Flink documentation

Verifying this change

Please make sure both new and modified tests in this PR follow the conventions for tests defined in our code quality guide.

(Please pick either of the following options)

This change is a trivial rework / code cleanup without any test coverage.

Does this pull request potentially affect one of the following parts:

  • Dependencies (does it add or upgrade a dependency): (no)
  • The public API, i.e., is any changed class annotated with @Public(Evolving): (no)
  • The serializers: (no)
  • The runtime per-record code paths (performance sensitive): no)
  • Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn, ZooKeeper: (no)
  • The S3 file system connector: ( no )

Documentation

  • Does this pull request introduce a new feature? ( no)
  • If yes, how is the feature documented? ( not applicable )

@nilmadhab nilmadhab changed the title Update all docker-compose references to docker compose [FLINK-37408] Update all docker-compose references to docker compose Mar 2, 2025
@nilmadhab nilmadhab marked this pull request as ready for review March 2, 2025 10:05
@flinkbot
Copy link
Collaborator

flinkbot commented Mar 2, 2025

CI report:

Bot commands The @flinkbot bot supports the following commands:
  • @flinkbot run azure re-run the last Azure build

@@ -83,7 +83,7 @@ Job 监控以及资源管理。Flink TaskManager 运行 worker 进程,
环境搭建只需要几步就可以完成,我们将会带你过一遍必要的操作命令,
并说明如何验证我们正在操作的一切都是运行正常的。

你需要在自己的主机上提前安装好 [docker](https://docs.docker.com/) (1.12+) 和
你需要在自己的主机上提前安装好 [docker](https://docs.docker.com/) (20.10+) 和
[docker-compose](https://docs.docker.com/compose/) (2.1+)。
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: docker-compose -> docker compose

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

@@ -89,7 +89,7 @@ output of the Flink job should show 1000 views per page and window.
The playground environment is set up in just a few steps. We will walk you through the necessary
commands and show how to validate that everything is running correctly.

We assume that you have [Docker](https://docs.docker.com/) (1.12+) and
We assume that you have [Docker](https://docs.docker.com/) (20.10+) and
[docker-compose](https://docs.docker.com/compose/) (2.1+) installed on your machine.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: docker-compose -> docker compose

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

@@ -316,7 +316,7 @@ jobs:
maven_repo_folder: ${{ env.MAVEN_REPO_FOLDER }}

- name: "Install missing packages"
run: sudo apt-get install -y net-tools docker-compose zip
run: sudo apt-get install -y net-tools docker compose zip
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this right. We are installing docker-compose not using the command line docker-compose. l suspect that we want to remove the word compose; as we are not installing something called compose. I suggest
run: sudo apt-get install -y net-tools docker zip

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

@nilmadhab
Copy link
Contributor Author

@flinkbot run azure

@nilmadhab
Copy link
Contributor Author

@davidradl any update here ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants