Web User Interface¶
The Application Manager user interface (UI) is available alongside its REST API.
By default, you can reach it by navigating to
[container] is the address of the container running Application Manager.
More information on accessing Application Manager.
Where the REST API is meant for integrating Application Manager with infrastructure components, the UI is meant for interaction by humans to control and track deployments. Its overarching goals are to simplify some of the domain concepts, allow quick changes to be made to resources, and to give actionable insight into the current state of Application Manager.
By default, the web UI will redirect you to the default namespace. You can work with resources in other namespaces by manually setting the respective namespace in the URL, e.g. by replacing
https://appmgr/#/namespaces/default/deployments with your desired namespace.
The UI will pick this up and do all requests against the respective namespace.
Deployments are one of the main concepts of Application Manager. When opening the UI, the first page shows an overview list of all available deployments, including their current and desired status. Creating new deployments through the UI is straightforward. Click on “Create Deployment” in the top right, and go through the creation form.
Clicking on a deployment on the overview page opens the deployment detail page.
The deployment detail page and all its sub-pages share an action bar. It contains the primary actions you can take on a deployment: modification, lifecycle control (start, suspend, cancel), savepointing, and forking, as well as links to external services (i.e., Apache Flink, logging, and metrics).
Some buttons and links are automatically disabled if their actions are not available. For example, you can only delete a deployment if it is not running.
Pressing the “Savepoint” button will trigger a savepoint in Flink.
The “Fork” button creates a copy of the current deployment.
- Below the action bar, there are four different tabs:
- “Overview” lists the currently active configuration, including resource limits and the Flink configuration.
- “Events” shows the Event Log of the current deployment
- “Jobs” lists all Flink jobs (past and potentially running ones) created from the deployment.
- “Savepoints” lists all savepoints created for this deployment.
On both the deployment overview page and the deployment detail page, Application Manager is always showing the current status of a deployment. Due to the declarative nature of the system, we are always showing the “desired” and “current” state of a deployment.
On the deployment detail page, the status box shows additional information when the current state is in “transitioning”.
The event tab shows the Event Log of the current deployment. At the top there is a input field for filtering events from the table.
In the table below we show the time of the event, a human readable message, and an action drop-down for events associated with a job. The event log is useful for following state transitions or checking what happened with a earlier deployment.
New events are indicated by a different background color in the overview table, and a small indicator on the “Events” tab shows the number of unread events.
The jobs tab lists all (past and currently running) Flink jobs created from the deployment. Each row in the jobs table is clickable. This opens a window listing the configuration that was effective for the job, and all savepoints created for that job. Also, there are links to the metrics and logging integration. The link to the logging system will only show the logs from that job.
The savepoints tab lists all savepoints created for this deployment. The table on that page links to the specific job that was running when the savepoint was created.
The action button can be used to perform the following tasks:
- Copy URI to Clipboard: This copies the location of the savepoint files into the clipboard. The location is based on the configured
state.savepoints.dirof the Flink configuration of the deployment. This URI can be used to access the savepoint location outside of Application Manager.
- Reset to Savepoint: Invoking this action performs the following steps:
- The selected savepoint is copied, so that it becomes the “latest” savepoint. This step does not physically copy the savepoint files, it just creates an additional representation of a savepoint in Application Manager.
- If the “Start from Savepoint” field is set to “LATEST”, Application Manager will reset the state of the currently running job to the state of the savepoint.
- Fork Deployment from Savepoint: This action will create a copy of the current deployment using the selected savepoint. This permits using the Flink state of one deployment in a second environment, without affecting the originating job.