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

Update table_api.md with modern Docker Compose syntax #26235

Closed
wants to merge 1 commit into from

Conversation

nilmadhab
Copy link
Contributor

@nilmadhab nilmadhab commented Feb 28, 2025

docker-compose can be replaced by docker compose

What is the purpose of the change

(For example: This pull request makes task deployment go through the blob server, rather than through RPC. That way we avoid re-transferring them on each deployment (during recovery).)

This PR updates the docker commands in the Table API tutorial documentation to use the modern Docker Compose syntax. It replaces the legacy docker-compose commands with the new docker compose format (without hyphen) which is now the recommended approach.
Changes include:

Replace docker-compose build with docker compose build
Replace docker-compose up -d with docker compose up -d
Replace docker-compose exec commands with docker compose exec

This change helps users avoid the "command not found: docker-compose" errors when following the tutorial with newer Docker installations, as Docker has integrated Compose directly as a plugin rather than as a separate binary.

Brief change log

(for example:)

  • The TaskInfo is stored in the blob store on job creation time as a persistent artifact
  • Deployments RPC transmits only the blob storage reference
  • TaskManagers retrieve the TaskInfo from the blob cache

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 )

docker-compose can be replaced by docker compose
@nilmadhab nilmadhab changed the title Update table_api.md Update table_api.md with modern Docker Compose syntax Feb 28, 2025
@flinkbot
Copy link
Collaborator

flinkbot commented Feb 28, 2025

CI report:

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

Copy link
Contributor

@snuyanzin snuyanzin left a comment

Choose a reason for hiding this comment

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

Thanks for the contribution.

  1. Every PR/commit should start with prefix either [hotfix] or [FLINK-<jira_issue_number>].

  2. What is the reason to have this commit based on Jan 2024 (more than 1 year old)? As a result wrong ci was started for that.

  3. It doesn't make sense to have changes only in one place while there is a huge variety of other places using docker-compose.

  4. Also it would make sense to have in docs what was tested. Currently existing tests use docker-compose. So would make sense to change both with tests

@nilmadhab nilmadhab changed the base branch from release-1.16 to master March 1, 2025 17:45
@nilmadhab nilmadhab requested a review from snuyanzin March 1, 2025 17:46
@nilmadhab nilmadhab changed the base branch from master to release-1.0 March 1, 2025 18:06
@nilmadhab nilmadhab changed the base branch from release-1.0 to release-1.16 March 2, 2025 09:25
@nilmadhab
Copy link
Contributor Author

Thanks for the contribution.

  1. Every PR/commit should start with prefix either [hotfix] or [FLINK-<jira_issue_number>].
  2. What is the reason to have this commit based on Jan 2024 (more than 1 year old)? As a result wrong ci was started for that.
  3. It doesn't make sense to have changes only in one place while there is a huge variety of other places using docker-compose.
  4. Also it would make sense to have in docs what was tested. Currently existing tests use docker-compose. So would make sense to change both with tests

I have created a Jira ticket, please assign it to me, I will update it in all places.

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

@nilmadhab
Copy link
Contributor Author

#26239

@snuyanzin
Copy link
Contributor

do we still need this PR if another PR was raised an this one is based on 1.16 which is not supported anymore?

@nilmadhab
Copy link
Contributor Author

do we still need this PR if another PR was raised an this one is based on 1.16 which is not supported anymore?

Yes this can be closed. Closing now

@nilmadhab nilmadhab closed this Mar 3, 2025
@nilmadhab nilmadhab deleted the patch-1 branch March 3, 2025 10:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants