Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Property Name

Description

Example

brand-primary-color

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.

Code Block
"brand-primary-color": "#3b78e7"

navbar-color

The background color of the top navigation bar. Can be in hex/rgb/rgba format.

Code Block
"navbar-color": "rgba(51, 51, 51, 1)"

font-family

Comma-separated list of font families to be used in UI, in decreasing order of priority.

Code Block
"font-family": "-apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, 'Helvetica Neue', Arial, sans-serif"

product-name

The product name to be used in UI. This will displayed on page titles, 'Welcome' modal, and the 'About' modal.

Code Block
"product-name": "CDAP"

product-description

The product description to be used in 'Welcome' modal.

Code Block
"product-description": "CDAP is an open source framework that simplifies data application development, data
integration, and data management."

product-logo-navbar

The logo to be displayed on the navigation bar. This can be specified using the type and arguments fields. If value of type field is link, then the user is expected to specify the path to the logo image in a url attribute inside the arguments map, and this should be absolute path from <CDAP_HOME>/ui/cdap_dist. If value of type field is inline, the user is expected to provide a base64 encoded image in a data attribute inside the arguments map. The image can be in any standard image format e.g. PNG, JPEG, SVG etc.

Code Block
"product-logo-navbar": {
  "type": "link",
  "arguments": {
    "url": "/cdap_assets/img/company_logo.png"
  }
}

product-logo-about

The logo to be displayed in the 'About' modal. This can be specified using the type and arguments fields. If value of type field is link, then the user is expected to specify the path to the logo image in a url attribute inside the arguments map, and this should be absolute path from <CDAP_HOME>/ui/cdap_dist. If value of type field is inline, the user is expected to provide a base64 encoded image in a data attribute inside the arguments map. The image can be in any standard image format e.g. PNG, JPEG, SVG etc.

Code Block
"product-logo-about": {
  "type": "link",
  "arguments": {
    "url": "/cdap_assets/img/CDAP_darkgray.png"
  }
}

favicon-path

Path to the image to be used as favicon. Should be absolute path from <CDAP_HOME>/ui/cdap_dist. The image can be in any standard image format e.g. PNG, JPEG, SVG etc.

Code Block
"favicon-path": "/cdap_assets/img/favicon.png"

footer-text

Text content to displayed on the footer component.

Code Block
"footer-text": "Licensed under the Apache License, Version 2.0"

footer-link

Link to route to when user clicks on footer text.

Code Block
"footer-link": "https://www.apache.org/licenses/LICENSE-2.0"

dashboard

Whether to show 'Dashboard' feature on the navigation bar.

Code Block
"dashboard": true

reports

Whether to show 'Reports' feature on the navigation bar.

Code Block
"reports": true

data-prep

Whether to show 'Wrangler' feature on the navigation bar.

Code Block
"data-prep": true

pipelines

Whether to show 'Pipelines' feature on the navigation bar.

Code Block
"pipelines": true

analytics

Whether to show 'Analytics' feature on the navigation bar.

Code Block
"analytics": true

rules-engine

Whether to show 'Rules Engine' feature on the navigation bar.

Code Block
"rules-engine": true

metadata

Whether to show 'Metadata' feature on the navigation bar.

Code Block
"metadata": true

hub

Whether to show 'Hub' feature on the navigation bar.

Code Block
"hub": true

ingest-data

Whether to show 'Ingest Data' feature in the Wrangler app.

Code Block
"ingest-data": true

add-namespace

Whether the user can add a new namespace in the UI.

Code Block
"add-namespace": true

schedules

Whether the user can add a new schedule in the UI.

Code Block
"schedules": true

triggers

Whether the user can add a new trigger in the UI.

Code Block
"triggers": true

lineage

Whether the user can view lineage in the UI.

Code Block
"triggers": true

real-time-pipeline

Whether the user can create a real-time pipeline.

Code Block
"real-time-pipeline": true

native-profile

Whether to hide the native system compute profile in the UI.

Code Block
"native-profile": true

application-upload

Whether a user can upload an application in the UI.

Code Block
"application-upload": true

system-services-instance

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.

Code Block
"system-services-instance": true

system-metrics

Whether a user can view system metrics.

Code Block
"system-metrics": true

namespace-mapping

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.

Code Block
"namespace-mapping": true

namespace-security

Whether the security properties for a namespace are visible on the Namespace Details page.

Code Block
"namespace-security": true

create-profile

Whether the user can create a compute profile.

Code Block
"create-profile": true

reload-system-artifacts

Whether the user can reload system artifacts.

Code Block
"reload-system-artifacts": true

cdc

Whether the user can perform Replication in the UI.

Code Block
"cdc": true

...