This repository has been archived by the owner. It is now read-only.
Permalink
Show file tree
Hide file tree
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
FALCON-1934 Document Safemode in Falcon Server
Author: bvellanki <bvellanki@hortonworks.com> Reviewers: "Ying Zheng <yzheng@hortonworks.com>, Venkatesan Ramachandran <vramachandran@hortonworks.com>" Closes #140 from bvellanki/FALCON-1934
- Loading branch information
Showing
6 changed files
with
85 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
---+++SetSafeMode | ||
|
||
[[CommonCLI][Common CLI Options]] | ||
|
||
When -setsafemode is true, Falcon starts in safemode. | ||
When -setsafemode is false, falcon starts in normal mode. | ||
|
||
Usage: | ||
$FALCON_HOME/bin/falcon admin -setsafemode true/false | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
---++ GET /api/admin/setSafeMode/:mode | ||
* <a href="#Description">Description</a> | ||
* <a href="#Parameters">Parameters</a> | ||
* <a href="#Results">Results</a> | ||
* <a href="#Examples">Examples</a> | ||
|
||
---++ Description | ||
Set falcon server into/out of safemode. | ||
|
||
---++ Parameters | ||
* :mode true/false. | ||
* doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system. | ||
|
||
---++ Results | ||
The value of FalconSever safemode. | ||
|
||
---++ Examples | ||
---+++ Rest Call | ||
<verbatim> | ||
GET http://localhost:15000/api/admin/setSafeMode/true | ||
</verbatim> | ||
---+++ Result | ||
<verbatim> | ||
true | ||
</verbatim> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters