[
https://issues.apache.org/jira/browse/NIFIREG-67?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16291898#comment-16291898
]
ASF GitHub Bot commented on NIFIREG-67:
---------------------------------------
Github user alopresto commented on a diff in the pull request:
https://github.com/apache/nifi-registry/pull/57#discussion_r157106933
--- Diff: nifi-registry-docs/src/main/asciidoc/administration-guide.adoc ---
@@ -14,7 +14,1303 @@
// See the License for the specific language governing permissions and
// limitations under the License.
//
-NiFi Registry System Administrator's Guide
-=================================
+Apache NiFi Registry System Administrator's Guide
+==========================================
Apache NiFi Team <d...@nifi.apache.org>
:homepage: http://nifi.apache.org
+
+System Requirements
+-------------------
+NiFi Registry has the following minimum system requirements:
+
+* Requires Java 8 or newer
+* Supported Operating Systems:
+** Linux
+** Unix
+** Mac OS X
+* Supported Web Browsers:
+** Google Chrome: Current & (Current - 1)
+** Mozilla FireFox: Current & (Current - 1)
+** Safari: Current & (Current - 1)
+
+**Note** Under sustained and extremely high throughput the CodeCache
settings may need to be tuned to avoid sudden performance loss. See the
<<bootstrap_properties>> section for more information.
+
+How to install and start NiFi Registry
+--------------------------------------
+
+* Linux/Unix/OS X
+** Decompress and untar into desired installation directory
+** Make any desired edits in files found under <installdir>/conf
+** From the <installdir>/bin directory, execute the following commands by
typing ./nifi-registry.sh <command>:
+*** start: starts NiFi Registry in the background
+*** stop: stops NiFi Registry that is running in the background
+*** status: provides the current status of NiFi Registry
+*** run: runs NiFi Registry in the foreground and waits for a Ctrl-C to
initiate shutdown of NiFi Registry
+*** install: installs NiFi Registry as a service that can then be
controlled via
+**** service nifi-registry start
+**** service nifi-regsitry stop
+**** service nifi-registry status
+
+
+When NiFi Registry first starts up, the following files and directories
are created:
+
+* flow_storage directory
+* work directory
+* logs directory
+* run directory
+
+See the <<system_properties>> section of this guide for more information
about NiFi Registry configuration files.
+
+
+Configuration Best Practices
+----------------------------
+
+NOTE: If you are running on Linux, consider these best practices. Typical
Linux defaults are not necessarily well tuned for the needs of an IO intensive
application like NiFi Registry. For all of these areas, your distribution's
requirements may vary. Use these sections as advice, but consult your
distribution-specific documentation for how best to achieve these
recommendations.
--- End diff --
I'm assuming this was copied from the Apache NiFi Admin Guide -- is
Registry really I/O intensive?
> Create User Guide and update Adminstrator's Guide
> -------------------------------------------------
>
> Key: NIFIREG-67
> URL: https://issues.apache.org/jira/browse/NIFIREG-67
> Project: NiFi Registry
> Issue Type: Improvement
> Affects Versions: 0.0.1
> Reporter: Andrew Lim
> Assignee: Andrew Lim
> Fix For: 0.0.1
>
>
> User Guide should cover topics such as Managing Flow, Managing Buckets,
> Managing Users/Groups, Managing Policies,...
> Sys Admin Guide should cover System Requirements, Installation, Security
> Configuration,...
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
