CDAP UI
- Robin Rielley
The CDAP UI is a web UI for deploying and managing applications and datasets. In addition, it also contains UIs for the Pipeline Studio, Replication, and Wrangler applications.
Supported Browsers and Components
Browser | Platform | Supported Versions |
|---|---|---|
Chrome | Apple OS X, Microsoft Windows | 55.0 and higher |
Firefox | Apple OS X, Microsoft Windows | 50.0 and higher |
Safari | Apple OS X, Microsoft Windows | 10 and higher |
Component | Platform | Supported Versions |
|---|---|---|
Node.js | Various | 8.7 and higher |
Note: Supported component versions shown in these tables are those that we have tested and are confident of their suitability and compatibility. Earlier versions (and different suppliers) of components may work, but have not necessarily been either tested or confirmed compatible.
UI Customization
Certain features in the UI can be customized. The <CDAP_HOME>/ui/server_dist/server/config/themes/default.json file contains these features, along with their default values. As of version 6.3.0, here is the list of features that can be customized, and their expected values:
Property Name | Description | Example |
|---|---|---|
| The primary brand color to be used across UI. This is most often used as the color of the 'active' text selection e.g. the active connection in Preparation app. This will also determine the color of some icons, e.g. the loading icon used across UI. Can be in hex/rgb/rgba format. | "brand-primary-color": "#3b78e7" |
| The background color of the top navigation bar. Can be in hex/rgb/rgba format. | "navbar-color": "rgba(51, 51, 51, 1)" |
| Comma-separated list of font families to be used in UI, in decreasing order of priority. | "font-family": "-apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, 'Helvetica Neue', Arial, sans-serif" |
| The product name to be used in UI. This will displayed on page titles, 'Welcome' modal, and the 'About' modal. | "product-name": "CDAP" |
| The product description to be used in 'Welcome' modal. | "product-description": "CDAP is an open source framework that simplifies data application development, data
integration, and data management." |
| The logo to be displayed on the navigation bar. This can be specified using the | "product-logo-navbar": {
"type": "link",
"arguments": {
"url": "/cdap_assets/img/company_logo.png"
}
} |
| The logo to be displayed in the 'About' modal. This can be specified using the | "product-logo-about": {
"type": "link",
"arguments": {
"url": "/cdap_assets/img/CDAP_darkgray.png"
}
} |
| Path to the image to be used as favicon. Should be absolute path from | "favicon-path": "/cdap_assets/img/favicon.png" |
| Text content to displayed on the footer component. | "footer-text": "Licensed under the Apache License, Version 2.0" |
| Link to route to when user clicks on footer text. | "footer-link": "https://www.apache.org/licenses/LICENSE-2.0" |
| Whether to show 'Dashboard' feature on the navigation bar. | "dashboard": true |
| Whether to show 'Reports' feature on the navigation bar. | "reports": true |
| Whether to show 'Wrangler' feature on the navigation bar. | "data-prep": true |
| Whether to show 'Pipelines' feature on the navigation bar. | "pipelines": true |
| Whether to show 'Analytics' feature on the navigation bar. | "analytics": true |
| Whether to show 'Rules Engine' feature on the navigation bar. | "rules-engine": true |
| Whether to show 'Metadata' feature on the navigation bar. | "metadata": true |
| Whether to show 'Hub' feature on the navigation bar. | "hub": true |
| Whether to show 'Ingest Data' feature in the Wrangler app. | "ingest-data": true |
| Whether the user can add a new namespace in the UI. | "add-namespace": true |
| Whether the user can add a new schedule in the UI. | "schedules": true |
| Whether the user can add a new trigger in the UI. | "triggers": true |
| Whether the user can view lineage in the UI. | "triggers": true |
| Whether the user can create a real-time pipeline. | "real-time-pipeline": true |
| Whether to hide the native system compute profile in the UI. | "native-profile": true |
| Whether a user can upload an application in the UI. | "application-upload": true |
| Whether to show the number of instances allocated for each system service in the System Admin page. If you are running CDAP on k8s, set this to false since this is not supported in k8s. | "system-services-instance": true |
| Whether a user can view system metrics. | "system-metrics": true |
| Whether additional properties of a namespace are visible on the Namespace Details page. For example, if you running CDAP on k8s, you can set this to false to hide the namespace properties such as HDFS root directory and HBase namespace name, which are not supported. | "namespace-mapping": true |
| Whether the security properties for a namespace are visible on the Namespace Details page. | "namespace-security": true |
| Whether the user can create a compute profile. | "create-profile": true |
| Whether the user can reload system artifacts. | "reload-system-artifacts": true |
| Whether the user can perform Replication in the UI. | "cdc": true |
It is not recommended to overwrite values in default.json for customizations, since these values will be reverted when CDAP is upgraded. Instead of this, users should create their own theme file using this spec, and link to this file. To do so, add this property to cdap-site.xml:
<property>
<name>ui.theme.file</name>
<value>[path-to-theme-file]</value>
<description>
File containing the theme to be used in UI
</description>
</property>After updating this property (or changing values in default.json), the changes will be reflected in CDAP UI after CDAP is restarted.
Related content
Created in 2020 by Google Inc.