You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Next »

This capability is currently under development.

Ambari Views offer a systematic way to plug-in UI capabilities to surface custom visualization, management and monitoring features in Ambari Web. A "view" is a way of extending Ambari that allows 3rd parties to plug in new resource types along with the APIs, providers and UI to support them. In other words, a view is an application that is deployed into the Ambari container.

Terminology

The following section describes the basic terminology associated with views.

TermDescription
View NameThe name of the view. The view name identifies the view to Ambari.
View PackageThis is the JAR package that contains the view definition and all view resources (server-side classes, dependencies and client-side files). See View Package for more information on the contents and structure of the package.
View DefinitionThis defines the view name, version, resources and required/optional configuration parameters for a view. The view definition file is included in the view package. See View Definition for more information on the view definition file syntax and features.
View InstanceAn unique instance of a view, that is based on a view definition and specific version that is configured.

View Package

The assets associated with a view are delivered as a JAR package. The view definition file must be at the root of the package. UI assets and server-side classes are served from the root. Dependent Java libraries are placed in the WEB-INF/lib directory.

view.jar
|
|- view.xml
|
|- org.
|
|- WEB-INF
| |
| |_ lib/*.jar
|
|- <server packages + classes>
|
|_ <ui assets>

 

Useful Resources

ResourceLink
Views Framework API Docshttps://github.com/apache/ambari/blob/trunk/ambari-views/docs/index.md
Views Framework Exampleshttps://github.com/apache/ambari/tree/trunk/ambari-views/examples

Get List of Views

  1. Gets the list of all available Views

    GET /api/v1/views

200 - OK

  2. Once you have a list of views, you can drill-into a view and see the available versions.

    GET /api/v1/views/FILES

200 - OK

  3. You can go a level deeper and see more information about that specific version for the view, such as the parameters and the archive name, and a list of all instances of the view.

    GET /api/v1/views/FILES/versions/0.1.0

200 - OK

Creating a View Instance

The following example shows creating an instance of the FILES view, version 1.0.0 view called "MyFiles".

  1. Create the view instance.

    POST /api/v1/views/FILES/versions/1.0.0/instances/MyFiles

201 - CREATED

  2. Set view properties.

    PUT /api/v1/views/FILES/versions/1.0.0/instances/MyFiles

[ {
"ViewInstanceInfo" : {
    "properties" : {
      "dataworker.defaultFs" : "webhdfs://your.namenode.host:50070"
    }
  }
} ]

200 - OK

  3. Restart Ambari Server to pick-up the view instance and UI resources.

    ambari-server restart

  4. Confirm the newly created view instance is available.

    GET /api/v1/views/FILES/

{
  "href" : "http://127.0.0.1:8080/api/v1/views/FILES/versions/1.0.0",
  "ViewInfo" : {
    "archive" : "/var/lib/ambari-server/resources/views/files-0.0.1-SNAPSHOT-jar-with-dependencies.jar",
    "label" : "Files",
    "parameters" : [
      {
        "name" : "dataworker.defaultFs",
        "description" : "FileSystem URI",
        "required" : true
      }
    ],
    "version" : "1.0.0",
    "view_name" : "FILES"
  },
  "instances" : [
    {
      "href" : "http://127.0.0.1:8080/api/v1/views/FILES/versions/1.0.0/instances/MyFiles",
      "ViewInstanceInfo" : {
        "instance_name" : "MyFiles",
        "view_name" : "FILES"
      }
    }
  ]
}

  5. Browse to the view instance.

    http://127.0.0.1:8080/views/FILES/1.0.0/MyFiles

 

  • No labels