Skip to content

[FLINK-39264][docs] Add docs for application management#27818

Open
eemario wants to merge 1 commit intoapache:masterfrom
eemario:FLIP560-9
Open

[FLINK-39264][docs] Add docs for application management#27818
eemario wants to merge 1 commit intoapache:masterfrom
eemario:FLIP560-9

Conversation

@eemario
Copy link
Contributor

@eemario eemario commented Mar 24, 2026

What is the purpose of the change

This pull request adds docs for application management.

Brief change log

  • Add a new page for application
  • Update outdated descriptions to reflect current functionality

Verifying this change

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)

@flinkbot
Copy link
Collaborator

flinkbot commented Mar 24, 2026

CI report:

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

@eemario eemario changed the title [FLINK-38972][docs] Add docs for application management [FLINK-39264][docs] Add docs for application management Mar 25, 2026
@eemario eemario marked this pull request as ready for review March 25, 2026 03:51
Even after all applications are finished, the cluster (and the JobManager) will
keep running until the session is manually stopped. The lifetime of a Flink
Session Cluster is therefore not bound to the lifetime of any Flink Job.
Session Cluster is therefore not bound to the lifetime of any Flink Application.
Copy link
Contributor

Choose a reason for hiding this comment

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

of any Flink Application. -> of any Flink Application or job.

* **Cluster Lifecycle**: in a Flink Session Cluster, the client connects to a
pre-existing, long-running cluster that can accept multiple job submissions.
Even after all jobs are finished, the cluster (and the JobManager) will
pre-existing, long-running cluster that can accept multiple application submissions.
Copy link
Contributor

Choose a reason for hiding this comment

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

I suggest a hyper link to the definition of application would be useful, or a quick summary.
I wonder if it is still mentioning jobs as well as applications. Or is every job now in an applicaiton?


#### ApplicationResultStore

The ApplicationResultStore is a Flink component that persists the results of terminated
Copy link
Contributor

Choose a reason for hiding this comment

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

It would be worth doing into more detail as to what we mean by Results is this the last checkpoint / savepoint?

**JobManager**

The archiving of completed jobs happens on the JobManager, which uploads the archived job information to a file system directory. You can configure the directory to archive completed jobs in [Flink configuration file]({{< ref "docs/deployment/config#flink-configuration-file" >}}) by setting a directory via `jobmanager.archive.fs.dir`.
The archiving of completed jobs and applications happens on the JobManager, which uploads the archived job and application information to a file system directory. You can configure the directory to archive completed jobs and applications in [Flink configuration file]({{< ref "docs/deployment/config#flink-configuration-file" >}}) by setting a directory via `jobmanager.archive.fs.dir`.
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 different from the application results store - as these are archives - it would be worth contrasting the two if they are different or referring to them in the same way if they are the same.


- `/applications/overview`
- `/applications/<applicationid>`
- `/applications/<applicationid>/jobmanager/config`
Copy link
Contributor

Choose a reason for hiding this comment

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

can you see the jobs that were under an application? This would seem to be the most useful thing you would want to see.


JobManager High Availability (HA) hardens a Flink cluster against JobManager failures.
This feature ensures that a Flink cluster will always continue executing your submitted jobs.
This feature ensures that a Flink cluster will always re-execute your submitted applications that were running at the time of a failure.
Copy link
Contributor

Choose a reason for hiding this comment

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

what about checkpoints?

The HA data will be kept until the respective job either succeeds, is cancelled or fails terminally.
Once this happens, all the HA data, including the metadata stored in the HA services, will be deleted.
In order to recover submitted applications, Flink persists metadata for the applications.
The HA data will be kept until the respective application either succeeds, is cancelled or fails terminally.
Copy link
Contributor

Choose a reason for hiding this comment

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

I am curious what fails terminally might mean - some examples of types of this would be useful.

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.

3 participants