Modified: zeppelin/site/docs/0.8.0-SNAPSHOT/setup/security/shiro_authentication.html URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.8.0-SNAPSHOT/setup/security/shiro_authentication.html?rev=1802748&r1=1802747&r2=1802748&view=diff ============================================================================== --- zeppelin/site/docs/0.8.0-SNAPSHOT/setup/security/shiro_authentication.html (original) +++ zeppelin/site/docs/0.8.0-SNAPSHOT/setup/security/shiro_authentication.html Mon Jul 24 05:01:08 2017 @@ -359,60 +359,43 @@ ldapRealm.userDnTemplate = uid={0},ou=Us ldapRealm.contextFactory.authenticationMechanism = simple </code></pre></div> <p>The other more flexible option is to use the LdapRealm. It allows for mapping of ldapgroups to roles and also allows for - role/group based authentication into the zeppelin server. Sample configuration for this realm is given below. - ``` -[main] -ldapRealm=org.apache.zeppelin.realm.LdapRealm</p> + role/group based authentication into the zeppelin server. Sample configuration for this realm is given below.</p> +<div class="highlight"><pre><code class="text language-text" data-lang="text">[main] +ldapRealm=org.apache.zeppelin.realm.LdapRealm -<p>ldapRealm.contextFactory.authenticationMechanism=simple +ldapRealm.contextFactory.authenticationMechanism=simple ldapRealm.contextFactory.url=ldap://localhost:33389 -ldapRealm.userDnTemplate=uid={0},ou=people,dc=hadoop,dc=apache,dc=org</p> - -<h1>Ability to set ldap paging Size if needed default is 100</h1> - -<p>ldapRealm.pagingSize = 200 +ldapRealm.userDnTemplate=uid={0},ou=people,dc=hadoop,dc=apache,dc=org +# Ability to set ldap paging Size if needed default is 100 +ldapRealm.pagingSize = 200 ldapRealm.authorizationEnabled=true ldapRealm.contextFactory.systemAuthenticationMechanism=simple ldapRealm.searchBase=dc=hadoop,dc=apache,dc=org ldapRealm.userSearchBase = dc=hadoop,dc=apache,dc=org ldapRealm.groupSearchBase = ou=groups,dc=hadoop,dc=apache,dc=org -ldapRealm.groupObjectClass=groupofnames</p> - -<h1>Allow userSearchAttribute to be customized</h1> - -<p>ldapRealm.userSearchAttributeName = sAMAccountName -ldapRealm.memberAttribute=member</p> - -<h1>force usernames returned from ldap to lowercase useful for AD</h1> - -<p>ldapRealm.userLowerCase = true</p> - -<h1>ability set searchScopes subtree (default), one, base</h1> - -<p>ldapRealm.userSearchScope = subtree; +ldapRealm.groupObjectClass=groupofnames +# Allow userSearchAttribute to be customized +ldapRealm.userSearchAttributeName = sAMAccountName +ldapRealm.memberAttribute=member +# force usernames returned from ldap to lowercase useful for AD +ldapRealm.userLowerCase = true +# ability set searchScopes subtree (default), one, base +ldapRealm.userSearchScope = subtree; ldapRealm.groupSearchScope = subtree; ldapRealm.memberAttributeValueTemplate=cn={0},ou=people,dc=hadoop,dc=apache,dc=org ldapRealm.contextFactory.systemUsername=uid=guest,ou=people,dc=hadoop,dc=apache,dc=org -ldapRealm.contextFactory.systemPassword=S{ALIAS=ldcSystemPassword}</p> - -<h1>enable support for nested groups using the LDAP<em>MATCHING</em>RULE<em>IN</em>CHAIN operator</h1> - -<p>ldapRealm.groupSearchEnableMatchingRuleInChain = true</p> - -<h1>optional mapping from physical groups to logical application roles</h1> - -<p>ldapRealm.rolesByGroup = LDN<em>USERS: user</em>role, NYK<em>USERS: user</em>role, HKG<em>USERS: user</em>role, GLOBAL<em>ADMIN: admin</em>role</p> - -<h1>optional list of roles that are allowed to authenticate. Incase not present all groups are allowed to authenticate (login).</h1> - -<h1>This changes nothing for url specific permissions that will continue to work as specified in [urls].</h1> - -<p>ldapRealm.allowedRolesForAuthentication = admin<em>role,user</em>role -ldapRealm.permissionsByRole= user<em>role = <em>:ToDoItemsJdo:</em>:<em>, *:ToDoItem:</em>:*; admin</em>role = * +ldapRealm.contextFactory.systemPassword=S{ALIAS=ldcSystemPassword} +# enable support for nested groups using the LDAP_MATCHING_RULE_IN_CHAIN operator +ldapRealm.groupSearchEnableMatchingRuleInChain = true +# optional mapping from physical groups to logical application roles +ldapRealm.rolesByGroup = LDN_USERS: user_role, NYK_USERS: user_role, HKG_USERS: user_role, GLOBAL_ADMIN: admin_role +# optional list of roles that are allowed to authenticate. Incase not present all groups are allowed to authenticate (login). +# This changes nothing for url specific permissions that will continue to work as specified in [urls]. +ldapRealm.allowedRolesForAuthentication = admin_role,user_role +ldapRealm.permissionsByRole= user_role = *:ToDoItemsJdo:*:*, *:ToDoItem:*:*; admin_role = * securityManager.sessionManager = $sessionManager securityManager.realms = $ldapRealm - ```</p> - +</code></pre></div> <h3>PAM</h3> <p><a href="https://en.wikipedia.org/wiki/Pluggable_authentication_module">PAM</a> authentication support allows the reuse of existing authentication
Modified: zeppelin/site/docs/0.8.0-SNAPSHOT/usage/rest_api/helium.html URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.8.0-SNAPSHOT/usage/rest_api/helium.html?rev=1802748&r1=1802747&r2=1802748&view=diff ============================================================================== --- zeppelin/site/docs/0.8.0-SNAPSHOT/usage/rest_api/helium.html (original) +++ zeppelin/site/docs/0.8.0-SNAPSHOT/usage/rest_api/helium.html Mon Jul 24 05:01:08 2017 @@ -264,7 +264,7 @@ Note that Apache Zeppelin REST APIs rece <h2>Helium REST API List</h2> -<h3>List of all available helium packages</h3> +<h3>Get all available helium packages</h3> <p><table class="table-configuration"> <col width="200"> @@ -274,7 +274,7 @@ Note that Apache Zeppelin REST APIs rece </tr> <tr> <td>URL</td> - <td><code>http://[zeppelin-server]:[zeppelin-port]/api/helium/all</code></td> + <td><code>http://[zeppelin-server]:[zeppelin-port]/api/helium/package</code></td> </tr> <tr> <td>Success code</td> @@ -310,42 +310,115 @@ Note that Apache Zeppelin REST APIs rece }, "enabled": false } - ], - "zeppelin-bubblechart": [ - { - "registry": "local", - "pkg": { - "type": "VISUALIZATION", - "name": "zeppelin-bubblechart", - "description": "Animated bubble chart", - "artifact": ".\/..\/helium\/zeppelin-bubble", - "icon": "icon" - }, - "enabled": true - }, + ] + } +} + </pre> + </td> + </tr> + </table> +<br/></p> + +<h3>Get all enabled helium packages</h3> + +<p><table class="table-configuration"> + <col width="200"> + <tr> + <td>Description</td> + <td>This <code>GET</code> method returns all enabled helium packages in configured registries.</td> + </tr> + <tr> + <td>URL</td> + <td><code>http://[zeppelin-server]:[zeppelin-port]/api/helium/enabledPackage</code></td> + </tr> + <tr> + <td>Success code</td> + <td>200</td> + </tr> + <tr> + <td>Fail code</td> + <td> 500 </td> + </tr> + <tr> + <td>Sample JSON response</td> + <td> + <pre> +{ + "status": "OK", + "message": "", + "body": { + "zeppelin.clock": [ { "registry": "local", "pkg": { - "type": "VISUALIZATION", - "name": "zeppelin-bubblechart", - "description": "Animated bubble chart", - "artifact": "zeppelin-bubblechart@0.0.2", + "type": "APPLICATION", + "name": "zeppelin.clock", + "description": "Clock (example)", + "artifact": "zeppelin-examples\/zeppelin-example-clock\/target\/zeppelin-example-clock-0.7.0-SNAPSHOT.jar", + "className": "org.apache.zeppelin.example.app.clock.Clock", + "resources": [ + [ + ":java.util.Date" + ] + ], "icon": "icon" }, "enabled": false } - ], - "zeppelin_horizontalbar": [ + ] + } +} + </pre> + </td> + </tr> + </table> +<br/></p> + +<h3>Get single helium package</h3> + +<p><table class="table-configuration"> + <col width="200"> + <tr> + <td>Description</td> + <td>This <code>GET</code> method returns specified helium package information</td> + </tr> + <tr> + <td>URL</td> + <td><code>http://[zeppelin-server]:[zeppelin-port]/api/helium/package/[Package Name]</code></td> + </tr> + <tr> + <td>Success code</td> + <td>200</td> + </tr> + <tr> + <td>Fail code</td> + <td> 500 </td> + </tr> + <tr> + <td>Sample JSON response</td> + <td> + <pre> +{ + "status": "OK", + "message": "", + "body": { + "zeppelin.clock": [ { "registry": "local", "pkg": { - "type": "VISUALIZATION", - "name": "zeppelin_horizontalbar", - "description": "Horizontal Bar chart (example)", - "artifact": ".\/zeppelin-examples\/zeppelin-example-horizontalbar", + "type": "APPLICATION", + "name": "zeppelin.clock", + "description": "Clock (example)", + "artifact": "zeppelin-examples\/zeppelin-example-clock\/target\/zeppelin-example-clock-0.7.0-SNAPSHOT.jar", + "className": "org.apache.zeppelin.example.app.clock.Clock", + "resources": [ + [ + ":java.util.Date" + ] + ], "icon": "icon" }, - "enabled": true + "enabled": false } ] } @@ -353,17 +426,16 @@ Note that Apache Zeppelin REST APIs rece </pre> </td> </tr> - </table></p> - -<p><br/></p> + </table> +<br/></p> -<h3>Suggest Helium application</h3> +<h3>Suggest Helium package on a paragraph</h3> <p><table class="table-configuration"> <col width="200"> <tr> <td>Description</td> - <td>This <code>GET</code> method returns suggested helium application for the paragraph.</td> + <td>This <code>GET</code> method returns suggested helium package for the paragraph.</td> </tr> <tr> <td>URL</td> @@ -412,17 +484,16 @@ Note that Apache Zeppelin REST APIs rece </pre> </td> </tr> - </table></p> - -<p><br/></p> + </table> +<br/></p> -<h3>Load helium Application on a paragraph</h3> +<h3>Load Helium package on a paragraph</h3> <p><table class="table-configuration"> <col width="200"> <tr> <td>Description</td> - <td>This <code>GET</code> method returns a helium Application id on success.</td> + <td>This <code>POST</code> method loads helium package to target paragraph.</td> </tr> <tr> <td>URL</td> @@ -435,8 +506,8 @@ Note that Apache Zeppelin REST APIs rece <tr> <td>Fail code</td> <td> - 404 on note or paragraph not exists <br/> - 500 for any other errors + 404 on note or paragraph not exists <br /> + 500 </td> </tr> <tr> @@ -451,9 +522,8 @@ Note that Apache Zeppelin REST APIs rece </pre> </td> </tr> - </table></p> - -<p><br/></p> + </table> +<br/></p> <h3>Load bundled visualization script</h3> @@ -461,11 +531,11 @@ Note that Apache Zeppelin REST APIs rece <col width="200"> <tr> <td>Description</td> - <td>This <code>GET</code> method returns bundled helium visualization javascript. When refresh=true (optional) is provided, Zeppelin rebuild bundle. otherwise, provided from cache</td> + <td>This <code>GET</code> method returns bundled helium visualization javascript. When refresh=true (optional) is provided, Zeppelin rebuilds bundle. Otherwise, it's provided from cache</td> </tr> <tr> <td>URL</td> - <td><code>http://[zeppelin-server]:[zeppelin-port]/api/helium/visualizations/load[?refresh=true]</code></td> + <td><code>http://[zeppelin-server]:[zeppelin-port]/api/helium/bundle/load/[Package Name][?refresh=true]</code></td> </tr> <tr> <td>Success code</td> @@ -477,9 +547,8 @@ Note that Apache Zeppelin REST APIs rece 200 reponse body is error message string starts with ERROR:<br/> </td> </tr> - </table></p> - -<p><br/></p> + </table> +<br/></p> <h3>Enable package</h3> @@ -517,9 +586,8 @@ zeppelin-examples/zeppelin-example-clock </pre> </td> </tr> - </table></p> - -<p><br/></p> + </table> +<br/></p> <h3>Disable package</h3> @@ -548,7 +616,7 @@ zeppelin-examples/zeppelin-example-clock </td> </tr> </table> -<br /></p> +<br/></p> <h3>Get visualization display order</h3> @@ -560,7 +628,7 @@ zeppelin-examples/zeppelin-example-clock </tr> <tr> <td>URL</td> - <td><code>http://[zeppelin-server]:[zeppelin-port]/api/helium/visualizationOrder</code></td> + <td><code>http://[zeppelin-server]:[zeppelin-port]/api/helium/order/visualization</code></td> </tr> <tr> <td>Success code</td> @@ -576,9 +644,8 @@ zeppelin-examples/zeppelin-example-clock <code>{"status":"OK","body":["zeppelin_horizontalbar","zeppelin-bubblechart"]}</code> </td> </tr> - </table></p> - -<p><br /></p> + </table> +<br/></p> <h3>Set visualization display order</h3> @@ -590,7 +657,7 @@ zeppelin-examples/zeppelin-example-clock </tr> <tr> <td>URL</td> - <td><code>http://[zeppelin-server]:[zeppelin-port]/api/helium/visualizationOrder</code></td> + <td><code>http://[zeppelin-server]:[zeppelin-port]/api/helium/order/visualization</code></td> </tr> <tr> <td>Success code</td> @@ -612,7 +679,100 @@ zeppelin-examples/zeppelin-example-clock <code>{"status":"OK"}</code> </td> </tr> - </table></p> + </table> +<br/></p> + +<h3>Get configuration for all Helium packages</h3> + +<p><table class="table-configuration"> + <col width="200"> + <tr> + <td>Description</td> + <td>This <code>GET</code> method returns configuration for all Helium packages</td> + </tr> + <tr> + <td>URL</td> + <td><code>http://[zeppelin-server]:[zeppelin-port]/api/helium/config</code></td> + </tr> + <tr> + <td>Success code</td> + <td>200</td> + </tr> + <tr> + <td> Fail code</td> + <td> 500 </td> + </tr> + </table> + <br/></p> + +<p>### Get configuration for specific package</p> + +<p><table class="table-configuration"> + <col width="200"> + <tr> + <td>Description</td> + <td>This <code>GET</code> method returns configuration for the specified package name and artifact</td> + </tr> + <tr> + <td>URL</td> + <td><code>http://[zeppelin-server]:[zeppelin-port]/api/helium/config/[Package Name]/[Artifact]</code></td> + </tr> + <tr> + <td>Success code</td> + <td>200</td> + </tr> + <tr> + <td> Fail code</td> + <td> 500 </td> + </tr> + </table> +<br/></p> + +<h3>Set configuration for specific package</h3> + +<p><table class="table-configuration"> + <col width="200"> + <tr> + <td>Description</td> + <td>This <code>POST</code> method updates configuration for specified package name and artifact</td> + </tr> + <tr> + <td>URL</td> + <td><code>http://[zeppelin-server]:[zeppelin-port]/api/helium/config/[Package Name]/[Artifact]</code></td> + </tr> + <tr> + <td>Success code</td> + <td>200</td> + </tr> + <tr> + <td> Fail code</td> + <td> 500 </td> + </tr> + </table><br> + <br/></p> + +<p>### Get Spell configuration for single package</p> + +<p><table class="table-configuration"> + <col width="200"> + <tr> + <td>Description</td> + <td>This <code>GET</code> method returns specified package Spell configuration</td> + </tr> + <tr> + <td>URL</td> + <td><code>http://[zeppelin-server]:[zeppelin-port]/api/helium/spell/config/[Package Name]</code></td> + </tr> + <tr> + <td>Success code</td> + <td>200</td> + </tr> + <tr> + <td> Fail code</td> + <td> 500 </td> + </tr> + </table> + <br/></p> </div> </div> Modified: zeppelin/site/docs/0.8.0-SNAPSHOT/usage/rest_api/interpreter.html URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.8.0-SNAPSHOT/usage/rest_api/interpreter.html?rev=1802748&r1=1802747&r2=1802748&view=diff ============================================================================== --- zeppelin/site/docs/0.8.0-SNAPSHOT/usage/rest_api/interpreter.html (original) +++ zeppelin/site/docs/0.8.0-SNAPSHOT/usage/rest_api/interpreter.html Mon Jul 24 05:01:08 2017 @@ -846,6 +846,30 @@ Note that Apache Zeppelin REST APIs rece </td><br> </table> </p> +<p><br/></p> + +<h3>Get interpreter settings metadata info</h3> + +<p><table class="table-configuration"> + <col width="200"> + <tr> + <td>Description</td> + <td>This <code>GET</code> method returns interpreter settings metadata info. </td> + </tr> + <tr> + <td>URL</td> + <td><code>http://[zeppelin-server]:[zeppelin-port]/api/interpreter/metadata/[setting ID]</code></td> + </tr> + <tr> + <td>Success code</td> + <td>200</td> + </tr> + <tr> + <td>Fail code</td> + <td> 500 </td> + </tr> + </table></p> + </div> </div>