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

[Backport 1.6][FLINK-10001][docs] Update Docker and Kubernetes documentation #6562

Closed

Conversation

tillrohrmann
Copy link
Contributor

What is the purpose of the change

Backport of #6561 for release-1.6.

This PR updates Flink's Docker and Kubernetes documentation to include the job mode for containers. Moreover, it introduces a new github_branch markdown variable which can be used to reference the corresponding Github branch.

cc @GJL, @azagrebin

Verifying this change

Tested documentation manually

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, Yarn/Mesos, 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)

@tillrohrmann tillrohrmann force-pushed the extendK8sDocumentation16 branch 5 times, most recently from 0eb61b2 to 83f5875 Compare August 16, 2018 08:34
* a Deployment for a single Jobmanager
* a Deployment for a pool of Taskmanagers
* a Service exposing the Jobmanager's RPC and UI ports
<div class="alert alert-info">
Copy link
Member

Choose a reason for hiding this comment

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

I'd use

<div class="alert alert-info" markdown="span">
  <strong>Note:</strong> If using MiniKube please make sure to execute `minikube ssh 'sudo ip link set docker0
  promisc on'` before deploying a Flink cluster. Otherwise Flink components are not able to self reference
  themselves through a Kubernetes service. 
</div>

to make sure that the formatting is always consistent.
`...` compiles to <code class="highlighter-rouge">...</code> in our current setup.


The Flink job cluster image needs to contain the user code jars of the job for which the cluster is started.
Therefore, one needs to build a dedicated container image for every job.
Please follow these [instructions]({{ site.baseurl }}/ops/deployment/docker.html#docker-images-1).
Copy link
Member

Choose a reason for hiding this comment

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

One could link to https://github.com/apache/flink/blob/release-1.6/flink-container/docker/README.md#build directly. docker.html#docker-images-1 doesn't add much information.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

true, will change it.

@tillrohrmann
Copy link
Contributor Author

Thanks for the review @GJL. I've addressed your comments.

@GJL
Copy link
Member

GJL commented Aug 16, 2018

I think it's good to go.

asfgit pushed a commit that referenced this pull request Aug 17, 2018
…ocker and K8s

[FLINK-10001][docs] Add documentation for job cluster deployment on K8s

This closes #6562.
@tillrohrmann
Copy link
Contributor Author

Manually merged.

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