base commit

LICENSE-2.0.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed 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
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   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.

README.md

@@ -0,0 +1,140 @@
+zkui - Zookeeper UI Dashboard
+====================
+A UI dashboard that allows CRUD operations on Zookeeper.
+
+Requirements
+====================
+Requires Java 7 to run.
+
+Setup
+====================
+1. mvn clean install
+2. Copy the config.cfg to the folder with the jar file. Modify it to point to the zookeeper instance. Multiple zk instances are coma separated.  eg: server1:2181,server2:2181. First server should always be the leader.
+3. Run the jar. ( nohup java -jar zkui-2.0-SNAPSHOT-jar-with-dependencies.jar & )
+4. <a href="http://localhost:9090">http://localhost:9090</a> 
+
+Login Info
+====================
+username: admin, pwd: manager (Admin privileges, CRUD operations supported)
+username: appconfig, pwd: appconfig (Readonly privileges, Read operations supported)
+
+You can change this in the config.cfg
+
+Technology Stack
+====================
+1. Embedded Jetty Server.
+2. Freemarker template.
+3. H2 DB.
+4. Active JDBC.
+5. JSON.
+6. SLF4J.
+7. Zookeeper.
+8. Apache Commons File upload.
+9. Bootstrap.
+10. Jquery.
+11. Flyway DB migration.
+
+Features
+====================
+1. CRUD operation on zookeeper properties.
+2. Export properties.
+3. Import properties via call back url.
+4. Import properties via file upload.
+5. History of changes + Path specific history of changes.
+6. Search feature.
+7. Rest API for accessing Zookeeper properties.
+8. Basic Role based authentication.
+9. LDAP authentication supported.
+10. Root node /zookeeper hidden for safety.
+
+Import File Format
+====================
+#add property
+/appconfig/path=property=value
+#remove a propery
+-/path/property
+
+You can either upload a file or specify a http url of the version control system that way all your zookeeper changes will be in version control. 
+
+Export File Format
+====================
+/appconfig/path=property=value
+
+You can export a file and then use the same format to import.
+
+SOPA/PIPA BLACKLISTED VALUE
+====================
+All password will be displayed as SOPA/PIPA BLACKLISTED VALUE for a normal user. Admins will be able to view and edit the actual value upon login.
+Password will be not shown on search / export / view for normal user.
+For a property to be eligible for black listing it should have (PWD / pwd / PASSWORD / password) in the property name.
+
+LDAP
+====================
+If you want to use LDAP authentication provide the ldap url. This will take precedence over roleSet property file authentication.
+ldapUrl=ldap://<ldap_host>:<ldap_port>/dc=mycom,dc=com
+If you dont provide this then default roleSet file authentication will be used.
+
+REST call
+====================
+A lot of times you require your shell scripts to be able to read properties from zookeeper. This can now be achieved with a http call. Password are not exposed via rest api for security reasons. The rest call is a read only operation requiring no authentication.
+
+Eg:
+http://localhost:9090/acd/appconfig?propNames=foo&host=myhost.com
+This will first lookup the host name under /appconfig/hosts and then find out which path the host point to. Then it will look for the property under that path.
+
+There are 2 additional properties that can be added to give better control.
+cluster=cluster1
+http://localhost:9090/acd/appconfig?propNames=foo&cluster=cluster1&host=myhost.com
+In this case the lookup will happen on lookup path + cluster1.
+
+app=myapp
+http://localhost:9090/acd/appconfig?propNames=foo&app=myapp&host=myhost.com
+In this case the lookup will happen on lookup path + myapp.
+
+A shell script will call this via
+MY_PROPERTY="$(curl -f -s -S -k "http://localhost:9090/acd/appconfig?propNames=foo&host=`hostname -f`" | cut -d '=' -f 2)"
+echo $MY_PROPERTY
+
+Limitations
+====================
+1. ACLs are not yet fully supported
+
+Screenshots
+====================
+Basic Role Based Authentication
+<br/>
+<img src="https://raw.github.com/DeemOpen/zkui/master/images/zkui-0.png"/>
+<br/>
+
+Dashboard Console
+<br/>
+<img src="https://raw.github.com/DeemOpen/zkui/master/images/zkui-1.png"/>
+<br/>
+
+CRUD Operations
+<br/>
+<img src="https://raw.github.com/DeemOpen/zkui/master/images/zkui-2.png"/>
+<br/>
+
+Import Feature
+<br/>
+<img src="https://raw.github.com/DeemOpen/zkui/master/images/zkui-3.png"/>
+<br/>
+
+Track History of changes
+<br/>
+<img src="https://raw.github.com/DeemOpen/zkui/master/images/zkui-4.png"/>
+<br/>
+
+Status of Zookeeper Servers
+<br/>
+<img src="https://raw.github.com/DeemOpen/zkui/master/images/zkui-5.png"/>
+<br/>
+
+License & Contribution
+====================
+
+ZKUI is released under the Apache 2.0 license. Comments, bugs, pull requests, and other contributions are all welcomed!
+
+Thanks to : Jozef Krajčovič the creator of the zkui logo.
+http://creativecommons.org/licenses/by/3.0/

config.cfg

@@ -0,0 +1,28 @@
+#Use 8443 for https
+https=false
+serverPort=9090
+#Comma seperated list of all the zookeeper servers
+zkServer=localhost:2181,localhost:2181
+#Http path of the repository.
+scmRepo=http://myserver.com/@rev1=
+#Path appended to the repo url.
+scmRepoPath=//appconfig.txt
+#if set to true then userSet is used for authentication, else ldap authentication is used.
+ldapAuth=false
+ldapDomain=mycompany,mydomain
+userSet = {"users": [{ "username":"admin" , "password":"manager","role": "ADMIN" },{ "username":"appconfig" , "password":"appconfig","role": "USER" }]}
+#ldap authentication url.
+ldapUrl=ldap://<ldap_host>:<ldap_port>/dc=mycom,dc=com
+#Specific roles for ldap authenticated users.
+ldapRoleSet={"users": [{ "username":"domain\\user1" , "role": "ADMIN" }]}
+env=dev
+jdbcClass=org.h2.Driver
+jdbcUrl=jdbc:h2:zkui
+jdbcUser=root
+jdbcPwd=manager
+#jdbcClass=com.mysql.jdbc.Driver
+#jdbcUrl=jdbc:mysql://localhost:3306/zkui
+#jdbcUser=root
+#jdbcPwd=manager
+loginMessage=Please login using admin/manager or appconfig/appconfig.
+sessionTimeout=300