From 3b1dad91232ef24e3cb01d7752b11feb1d80262c Mon Sep 17 00:00:00 2001 From: Eric Yang Date: Tue, 24 Apr 2018 19:11:21 -0400 Subject: [PATCH] YARN-8196. Updated documentation for enabling YARN Service REST API. Contributed by Billie Rinaldi --- .../site/markdown/yarn-service/QuickStart.md | 30 +++++++++---------- 1 file changed, 14 insertions(+), 16 deletions(-) diff --git a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/markdown/yarn-service/QuickStart.md b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/markdown/yarn-service/QuickStart.md index f5631937bc3..e91380c02bd 100644 --- a/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/markdown/yarn-service/QuickStart.md +++ b/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-site/src/site/markdown/yarn-service/QuickStart.md @@ -18,10 +18,21 @@ This document describes how to deploy services on YARN using the YARN Service fr -## Start HDFS and YARN components +## Configure and start HDFS and YARN components - Start all the hadoop components HDFS, YARN as usual. +Start all the hadoop components for HDFS and YARN as usual. +To enable the YARN Service framework, add this property to `yarn-site.xml` and restart the ResourceManager or set the property before the ResourceManager is started. +This property is required for using the YARN Service framework through the CLI or the REST API. +``` + + + Enable services rest api on ResourceManager. + + yarn.webapp.api-service.enable + true + +``` ## Example service Below is a simple service definition that launches sleep containers on YARN by writing a simple spec file and without writing any code. @@ -104,20 +115,7 @@ yarn app -destroy ${SERVICE_NAME} ## Manage services on YARN via REST API -YARN API Server REST API can be activated as part of the ResourceManager. - -### Start Embedded API-Server as part of ResourceManager -For running inside ResourceManager, add this property to `yarn-site.xml` and restart ResourceManager. - -``` - - - Enable services rest api on ResourceManager. - - yarn.webapp.api-service.enable - true - -``` +The YARN API Server REST API is activated as part of the ResourceManager when `yarn.webapp.api-service.enable` is set to true. Services can be deployed on YARN through the ResourceManager web endpoint.