incubator-ambari-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject svn commit: r1189891 - in /incubator/ambari/trunk: ./ client/src/main/java/org/apache/ambari/common/rest/entities/ controller/src/main/resources/
Date Thu, 27 Oct 2011 17:47:37 GMT
Author: omalley
Date: Thu Oct 27 17:47:36 2011
New Revision: 1189891

AMBARI-111. Minor clean up of site documentation (omalley)


Modified: incubator/ambari/trunk/CHANGES.txt
--- incubator/ambari/trunk/CHANGES.txt (original)
+++ incubator/ambari/trunk/CHANGES.txt Thu Oct 27 17:47:36 2011
@@ -2,6 +2,8 @@ Ambari Change log
 Release 0.1.0 - unreleased
+  AMBARI-111. Minor clean up of site documentation (omalley)
   AMBARI-110. Add persistent data store interface (vgogate)
   AMBARI-107. Added reporting section to aggregate javadocs. (Eric Yang)

Added: incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/package.html
--- incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/package.html
+++ incubator/ambari/trunk/client/src/main/java/org/apache/ambari/common/rest/entities/package.html
Thu Oct 27 17:47:36 2011
@@ -0,0 +1,29 @@
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You under the Apache License, Version 2.0
+   (the "License"); you may not use this file except in compliance with
+   the License.  You may obtain a copy of the License at
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+This package defines the entities (messages) for Ambari's REST
+interface. The primary two are <a href="Stack.html">Stack</a>, which
+defines what needs to be deployed and how it should be configured,
+and <a href="ClusterDefinition.html">ClusterDefinition</a>, which
+binds a set of nodes to a given stack. These entities are defined
+using JAXB and thus can be represented as either XML or JSON with a
+very simple mapping.

Modified: incubator/ambari/trunk/controller/src/main/resources/application-doc.xml
--- incubator/ambari/trunk/controller/src/main/resources/application-doc.xml (original)
+++ incubator/ambari/trunk/controller/src/main/resources/application-doc.xml Thu Oct 27 17:47:36
@@ -20,8 +20,37 @@
 <applicationDocs targetNamespace="">
-    <doc xml:lang="en" title="Ambari REST API">
-        Ambari public REST API.
-    </doc>
+<doc xml:lang="en" title="Ambari REST API">
+   Ambari provides rich REST interfaces that allow the creation, 
+   modification, querying, and deletion of stacks and clusters. The
+   primary resources are:
+   <ul>
+      <li><a href="index.html#Stacks">Stacks</a> - definition of which

+        <a href="index.html#Components">components</a> should be deployed and

+        how they should be <a href="index.html#Configuration">configured</a>.
+        </li>
+      <li><a href="index.html#Clusters">Clusters</a> - combination a stack

+        and nodes to run Hadoop</li>
+      <li>Nodes - the machines managed by Ambari</li>
+   </ul>
+   Each is represented by a top level resource, which is a container,
+   and nested resources for each instance.
+   The resources and the entities that are passed to them are defined
+   using JAXB and are represented in either XML or JSON formats
+   depending on the ContentType and Accept HTTP headers. The definition
+   of the types is given in the <a 
+   href="apidocs/org/apache/ambari/common/rest/entities/package-summary.html">
+   JavaDoc</a>.
+   Typical usage would be to create a new stack derived from a pre-defined
+   one and change the neccessary configuration parameters. Then create a
+   cluster based on the stack by assigning nodes and marking it active.

View raw message