Skip to end of metadata
Go to start of metadata


Introduction

Introduced in Ambari-2.1.0, the Enhanced Configs feature makes it possible for service providers to customize their service's configs to a great deal and determine which configs are prominently shown to user without making any UI code changes. Customization includes providing a service friendly layout, better controls (sliders, combos, lists, toggles, spinners, etc.), better validation (minimum, maximum, enums), automatic unit conversion (MB, GB, seconds, milliseconds, etc.), configuration dependencies and improved dynamic recommendations of default values.

 A service provider can accomplish all the above just by changing their service definition in the stacks/ folder.


 Example: HBase Enhanced Configs

Hive Enhanced Configs

Features

  • Define theme with custom layout of configs

    • Tabs

    • Sections

    • Sub-sections

  • Place selected configs in the layout defined above

  • Associate UI widget to use for a config

    • Radio Buttons

    • Slider

    • Combo

    • Time Interval Spinner

    • Toggle

    • Directory

    • Directories

    • List

    • Password

    • Text Field

    • Checkbox

    • Text Area

  • Automatic unit conversion for configs which have to be shown in units different from the units being saved as.

    • Memory - B, KB, MB, GB, TB, PB

    • Time - milliseconds, seconds, minutes, hours, days, months, years

    • Percentage - float, percentage

  • Ability to define dependencies between configurations across services (depends-on, depended-by).

  • Ability to dynamically update values of other depended-by configs when a config is changed.

 

Enable Enhanced Configs - Steps

Step 1 - Create Theme (UI Metadata)

The first step is to create a theme for your service in the stack definition folder. A theme provides necessary information of the UI to construct the enhanced configs. UI information like layout (tabs, sections, sub-sections), placement of configs in the sub-sections, and which widgets and units to use for each config


  1. Modify metainfo.xml to define a theme by including a themes block.

    <themes-dir>themes-dir</themes-dir>
    <themes>
    <theme>
    <fileName>theme.json</fileName>
    <default>true</default>
    </theme>
    </themes>
  2. The optional <themes-dir> element can be used if the default theme folder of 'themes' is not desired, or taken by another service in the same metainfo.xml.

  3. Multiple themes can be defined, however only the first default theme will be used for the service.

  4. Each theme points to a theme JSON file (via fileName element) in the themes-dir folder.

  5. The theme.json file contains one configuration block containing three main keys

    1. layouts - specify tabs, sections and sub-section layout

    2. placement - specify configurations to place in sub-sections

    3. widgets - specify which UI widgets to use for each config

      {
      "configuration": {
      "layouts": [
      ...
      ],
      "placement": {
      ...
      },
      "widgets": [
      ...
      ]
      }
      }

       

  6. Layouts - Multiple layouts can be defined in a theme. Currently only the first layout will be used while rendering. A layout has following content:

    1. Tabs: Multiple tabs can be defined in a layout. Each tab can have its contents laid out using a simple grid-layout using the tab-columns and tab-rows keys.

      In below example the Settings tab has a grid of 3 rows and 2 columns in which sections can be placed.

      "layouts": [
      {
      "name": "default",
      "tabs": [
      {
      "name": "settings",
      "display-name": "Settings",
      "layout": {
      "tab-columns": "2",
      "tab-rows": "3",
      "sections": [ … ]
      }
      }
          ]
      }
      ]
    2. Sections: Each section is defined inside a tab and specifies its location and size inside the tab's grid-layout by using the row-index, column-index, row-span and column-span keys. Being a container itself, it can further define a grid-layout for the sub-sections it contains using the section-rows and section-columns keys.

      In below example the MapReduce section occupies the first cell of the Settings tab grid, and itself has a grid-layout of 1 row and 3 columns.

      "sections": [
      {
      "name": "section-mr-scheduler",
      "display-name": "MapReduce",
      "row-index": "0",
      "column-index": "0",
      "row-span": "1",
      "column-span": "1",
      "section-columns": "3",
      "section-rows": "1",
      "subsections": [ ... ]
      },
      ...
      ]

       

    3. Sub-sections: Each sub-section is defined inside a section and specifies its location and size inside the section's grid-layout using the row-index, column-index, row-span and column-span keys. Each section also has an optional border boolean key which tells if a border should encapsulate its content.

      "subsections": [
      {
      "name": "subsection-mr-scheduler-row1-col1",
      "display-name": "MapReduce Framework",
      "row-index": "0",
      "column-index": "0",
      "row-span": "1",
      "column-span": "1"
      },
      ...
      ]
  7. Placement: Specifies the order of configurations that are to be placed into each sub-section. Each placement identifies a config, and which sub-section it should appear in. The placement specifies which layout it applies to using the configuration-layout key.

    "placement": {
    "configuration-layout": "default",
    "configs": [
    {
    "config": "mapred-site/mapreduce.map.memory.mb",
    "subsection-name": "subsection-mr-scheduler-row1-col1"
    },
    {
    "config": "mapred-site/mapreduce.reduce.memory.mb",
    "subsection-name": "subsection-mr-scheduler-row1-col2"
    },
    ...
    ]
    }
  8. Wigets: The widgets array specifies which UI widget should be used to show a specific config. It also contains extra UI specific metadata required to show the widget.

    In the example below, both configs are using the slider widget. However the unit varies, resulting in one config being shown in bytes and another being shown as percentage. This unit is purely for showing a config - which is different from the units in which it is actually persisted in Ambari. For example, the percent unit below maybe persisted as a float, while the MB config below can be persisted in B (bytes).

     

    "widgets": [
    {
    "config": "yarn-site/yarn.nodemanager.resource.memory-mb",
    "widget": {
    "type": "slider",
    "units": [
    {
    "unit-name": "MB"
    }
    ]
    }
    },
    {
    "config": "yarn-site/yarn.nodemanager.resource.percentage-physical-cpu-limit",
    "widget": {
    "type": "slider",
    "units": [
    {
    "unit-name": "percent"
    }
    ]
    }
    },
    {
    "config": "yarn-site/yarn.node-labels.enabled",
    "widget": {
    "type": "toggle"
    }
    },
    ...
    ]

     

For a complete reference to what UI widgets are available and what metadata can be specified per widget, please refer to Appendix A.

 

Step 2 - Annotate stack configs (Non-UI Metadata) 

Each configuration that is used by the service's theme has to provide extra metadata about the configuration. The list of available metadata are:

  • display-name

  • value-attributes

    • type

      • string

      • value-list

      • float

      • int

      • boolean

    • minimum

    • maximum

    • unit

    • increment-step

    • entries

      • entry

        • value

        • description

  • depends-on

    • property

      • type

      • name

The value-attributes provide meta information about the value that can used as hints by the appropriate widget. For example the slider widget can make use of the minimum and maximum values in its working.

Examples:

<property>
<name>namenode_heapsize</name>
<value>1024</value>
<description>NameNode Java heap size</description>
<display-name>NameNode Java heap size</display-name>
<value-attributes>
<type>int</type>
<minimum>0</minimum>
<maximum>268435456</maximum>
<unit>MB</unit>
<increment-step>256</increment-step>
</value-attributes>
<depends-on>
<property>
<type>hdfs-site</type>
<name>dfs.datanode.data.dir</name>
</property>
</depends-on>
</property>
<property>
<name>hive.default.fileformat</name>
<value>TextFile</value>
<description>Default file format for CREATE TABLE statement.</description>
<display-name>Default File Format</display-name>
<value-attributes>
<type>value-list</type>
<entries>
<entry>
<value>ORC</value>
<description>The Optimized Row Columnar (ORC) file format provides a highly efficient way to store Hive data. It was designed to overcome limitations of the other Hive file formats. Using ORC files improves performance when Hive is reading, writing, and processi
</entry>
<entry>
<value>TextFile</value>
<description>Text file format saves Hive data as normal text.</description>
</entry>
</entries>
</value-attributes>
</property>

The depends-on is useful in building a dependency graph between different configs in Ambari. Ambari uses these bi-directional relationships (depends-on and depended-by) to automatically update dependent configs using the stack-advisor functionality in Ambari.


Dependencies between configurations is a directed-acyclic-graph (DAG). When a configuration is updated, the UI has to determine its effect on other configs in the graph. To determine this, the /recommendations endpoint should be provided an array of what configurations have been just changed in the changed_configurations field. Based on the provided changed-configs, only its dependencies are updated in the response.

Example:

Figure below shows some config dependencies - A effects B and C, each of which effects DE and FG respectively.

Now assume user changes B to B' - a call to /recommendations will only change D and E to D' and E' respectively (AB'CD'E'FG). No other config will be changed. Now assume that C is changed to C' - /recommendations will only change F and G to F' and G' while still keeping the values of B' D' E' intact (AB'C'D'E'F'G'). Now if you change A to A', it will affect all its children (A'B''C''D''E''F''G''). The user will have chance to pick and choose which he wants to apply.

 The call to /recommendations happens whenever a configuration with dependencies is changed. The POST call has the action configuration-dependencies - which will only change the configurations and its dependencies identified by the changed_configurations field.

 

Step 3 - Restart Ambari server

Restarting ambari-server is required for any changes in the themes or the stack-definition to be loaded.

Reference

Appendix

Appendix A - Widget Non-UI Metadata

WidgetMetadata Used
Slider
<value-attributes>
<type>int</type>
<minimum>1073741824</minimum>
<maximum>17179869184</maximum>
<unit>B</unit>
<increment-step>1073741824</increment-step>
</value-attributes>
Combo
<value-attributes>
<type>value-list</type>
<entries>
<entry>
<value>2</value>
</entry>
<entry>
<value>4</value>
</entry>
<entry>
<value>8</value>
</entry>
</entries>
<selection-cardinality>1</selection-cardinality>
</value-attributes>
List
<value-attributes>
<type>value-list</type>
<entries>
<entry>
<value>2</value>
</entry>
<entry>
<value>4</value>
</entry>
<entry>
<value>8</value>
</entry>
</entries>
<selection-cardinality>2+</selection-cardinality>
</value-attributes>
Time Interval Spinner
<value-attributes>
<type>int</type>
<minimum>0</minimum>
<maximum>2592000000</maximum>
<unit>milliseconds</unit>
</value-attributes>
Toggle, Checkbox
<value-attributes>
<type>value-list</type>
<entries>
<entry>
<value>true</value>
<label>Native</label>
</entry>
<entry>
<value>false</value>
<label>Off</label>
</entry>
</entries>
<selection-cardinality>1</selection-cardinality>
</value-attributes>
Directory, Directories, Password, Text Field, Text AreaNo value-attributes required
Radio-Buttons
<value-attributes>
<type>value-list</type>
<entries>
<entry>
<value>1</value>
<label>Radio Option 1</label>
</entry>
<entry>
<value>2</value>
<label>Radio Option 2</label>
</entry>
<entry>
<value>3</value>
<label>Radio Option 3</label>
</entry>
</entries>
<selection-cardinality>1</selection-cardinality>
</value-attributes>


  • No labels