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.

Sign up for GitHub

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

Jump to bottom

[FLINK-25532] Improve Documentation of Flink Docker-Compose #18725

Merged
merged 2 commits into from Feb 16, 2022
Merged

[FLINK-25532] Improve Documentation of Flink Docker-Compose #18725

merged 2 commits into from Feb 16, 2022

Conversation

knaufk
Copy link
Contributor

@knaufk knaufk commented Feb 11, 2022

What is the purpose of the change

This change improves the documentatino of running Flink using docker-compose. In particular, it adds an example using the SQL Client.

Brief change log

(for example:)

  • add example for running a session cluster with sql-client using docker-compose
  • drop documentation of docker swarm because it has lost relevance
  • restructure docker docs a bit to give the page a bit more structure

Verifying this change

  • build the docs

@flinkbot
Copy link
Collaborator

Thanks a lot for your contribution to the Apache Flink project. I'm the @flinkbot. I help the community
to review your pull request. We will use this comment to track the progress of the review.

Automated Checks

Last check on commit b97354d (Fri Feb 11 10:27:36 UTC 2022)

Warnings:

  • Documentation files were touched, but no docs/content.zh/ files: Update Chinese documentation or file Jira ticket.
  • This pull request references an unassigned Jira ticket. According to the code contribution guide, tickets need to be assigned before starting with the implementation work.

Mention the bot in a comment to re-run the automated checks.

Review Progress

  • ❓ 1. The [description] looks good.
  • ❓ 2. There is [consensus] that the contribution should go into to Flink.
  • ❓ 3. Needs [attention] from.
  • ❓ 4. The change fits into the overall [architecture].
  • ❓ 5. Overall code [quality] is good.

Please see the Pull Request Review Guide for a full explanation of the review process.


The Bot is tracking the review progress through labels. Labels are applied according to the order of the review items. For consensus, approval by a Flink committer of PMC member is required Bot commands
The @flinkbot bot supports the following commands:

  • @flinkbot approve description to approve one or more aspects (aspects: description, consensus, architecture and quality)
  • @flinkbot approve all to approve all aspects
  • @flinkbot approve-until architecture to approve everything until architecture
  • @flinkbot attention @username1 [@username2 ..] to require somebody's attention
  • @flinkbot disapprove architecture to remove an approval you gave earlier

@flinkbot
Copy link
Collaborator

flinkbot commented Feb 11, 2022 •
edited

CI report:

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

MartijnVisser
MartijnVisser reviewed Feb 14, 2022
View reviewed changes
Copy link
Contributor

@MartijnVisser MartijnVisser 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 PR. Just a couple of minor things, but looking good otherwise.

docs/content/docs/deployment/resource-providers/standalone/docker.md Show resolved Hide resolved
docs/content/docs/deployment/resource-providers/standalone/docker.md Show resolved Hide resolved
docs/content/docs/deployment/resource-providers/standalone/docker.md Outdated Show resolved Hide resolved
docs/content/docs/deployment/resource-providers/standalone/docker.md
$ docker run \
--env ENABLE_BUILT_IN_PLUGINS=flink-plugin1.jar;flink-plugin2.jar \
flink:{{< stable >}}{{< version >}}-scala{{< scala_version >}}{{< /stable >}}{{< unstable >}}latest{{< /unstable >}} <jobmanager|standalone-job|taskmanager>
<a id="app-cluster-yml">`docker-compose.yml`</a> for *Application Mode*.
Copy link
Contributor

Choose a reason for hiding this comment

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

This results in a clickable link, but you can't download or do anything with it.

Copy link
Contributor Author

@knaufk knaufk Feb 16, 2022 •
edited

Choose a reason for hiding this comment

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

I think this was only meant as an anchor.

docs/content/docs/deployment/resource-providers/standalone/docker.md

In Session Mode you use docker-compose to spin up a long-running Flink Cluster to which you can then submit Jobs.

<a id="session-cluster-yml">`docker-compose.yml`</a> for *Session Mode*:
Copy link
Contributor

Choose a reason for hiding this comment

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

Same comment as above

Copy link
Contributor Author

@knaufk knaufk Feb 16, 2022 •
edited

Choose a reason for hiding this comment

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

I think this was only meant as an anchor.

docs/content/docs/deployment/resource-providers/standalone/docker.md
### Enabling Python
In this example, you spin up a long-running session cluster and a Flink SQL CLI which uses this clusters to submit jobs to.

<a id="session-cluster-sql-yaml">`docker-compose.yml`</a> for Flink SQL Client with *Session Cluster*:
Copy link
Contributor

Choose a reason for hiding this comment

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

Same comment as above

Copy link
Contributor Author

@knaufk knaufk Feb 16, 2022 •
edited

Choose a reason for hiding this comment

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

I think this was only meant as an anchor.

docs/content/docs/deployment/resource-providers/standalone/docker.md Show resolved Hide resolved
MartijnVisser
MartijnVisser approved these changes Feb 16, 2022
View reviewed changes
Copy link
Contributor

@MartijnVisser MartijnVisser 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 fixes, LGTM

@knaufk knaufk merged commit 2c792d0 into apache:master Feb 16, 2022
MrWhiteSike pushed a commit to MrWhiteSike/flink that referenced this pull request Mar 3, 2022
@knaufk @MrWhiteSike
[FLINK-25532] Improve Documentation of Flink Docker-Compose (apache#1…
cbf8154 
…8725)

* [FLINK-25532] add Flink SQL Client example to docker-compose docs

* [hotfix] restructure docker docs and remove docker swarm
JasonLeeCoding pushed a commit to JasonLeeCoding/flink that referenced this pull request May 27, 2022
@knaufk @JasonLeeCoding
[FLINK-25532] Improve Documentation of Flink Docker-Compose (apache#1…
962da05 
…8725)

* [FLINK-25532] add Flink SQL Client example to docker-compose docs

* [hotfix] restructure docker docs and remove docker swarm
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MartijnVisser MartijnVisser MartijnVisser approved these changes

Assignees
No one assigned
Labels
component=TableSQL/Client
Projects
None yet
Milestone
No milestone
4 participants
@knaufk @flinkbot @MartijnVisser @rmetzger