Repository: nifi-minifi-cpp Updated Branches: refs/heads/MINIFI-77 [created] 7cf8199a7
MINIFI-77 Initial draft of the Quickstart guide in the README. Project: http://git-wip-us.apache.org/repos/asf/nifi-minifi-cpp/repo Commit: http://git-wip-us.apache.org/repos/asf/nifi-minifi-cpp/commit/82a03a77 Tree: http://git-wip-us.apache.org/repos/asf/nifi-minifi-cpp/tree/82a03a77 Diff: http://git-wip-us.apache.org/repos/asf/nifi-minifi-cpp/diff/82a03a77 Branch: refs/heads/MINIFI-77 Commit: 82a03a7777fa3d26a870f0c3f38c6d922db42ff9 Parents: 63d2358 Author: Aldrin Piri <[email protected]> Authored: Fri Aug 5 08:56:12 2016 -0400 Committer: Aldrin Piri <[email protected]> Committed: Fri Aug 5 08:56:12 2016 -0400 ---------------------------------------------------------------------- README.md | 90 ++++++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 62 insertions(+), 28 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/nifi-minifi-cpp/blob/82a03a77/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index 233caf4..8cfbe48 100644 --- a/README.md +++ b/README.md @@ -18,43 +18,60 @@ MiNiFi is a child project effort of Apache NiFi. This repository is for a nativ ## Table of Contents +- [Features](#features) +- [Caveats](#caveats) +- [Requirements](#requirements) +- [Getting Started](#getting-started) +- [Getting Help](#getting-help) +- [Documentation](#documentation) - [License](#license) -## License +## Features -Except as otherwise noted this software is licensed under the -[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html) +Apache NiFi - MiNiFi C++ is a complementary data collection approach that supplements the core tenets of [NiFi](http://nifi.apache.org/) in dataflow management, focusing on the collection of data at the source of its creation. The C++ implementation is an additional implementation to that created in Java with an even smaller resource footprint. -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 +Specific goals for MiNiFi are comprised of: +- small and lightweight footprint +- central management of agents +- generation of data provenance +- integration with NiFi for follow-on dataflow management and full chain of custody of information - http://www.apache.org/licenses/LICENSE-2.0 +Perspectives of the role of MiNiFi should be from the perspective of the agent acting immediately at, or directly adjacent to, source sensors, systems, or servers. -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. -## Dependencies - * gcc - 4.8.4 - * g++ - 4.8.4 - * [libxml2](http://xmlsoft.org/) - tested with 2.9.1 - MAC: brew install libxml2 - * [libuuid] https://sourceforge.net/projects/libuuid/ - MAC: After download the above source, configure/make/make install +## Caveats +* 0.0.1 represents the first release, APIs and interfaces are subject to change +* Build and usage currently only supports Linux and OS X environments. Providing the needed tooling to support Windows will be established as part of [MINIFI-34](https://issues.apache.org/jira/browse/MINIFI-34). +* Currently, provenance events are not yet generated + +## System Requirements +### To build +#### Utilities +* Make +* GCC + * 4.8.4 or greater +* G++ + * 4.8.4 or greater -## Build instructions +#### Libraries / Development Headers +* libboost and boost-devel + * 1.23.0 or greater +* libxml2 and libxml2-devel + +### To run +#### Libraries +* libxml2 + +## Building Build application, it will build minifi exe under build and copy over to target directory - + $ make -Clean - +Clean + $ make clean -## Running +## Running Running application @@ -66,10 +83,10 @@ Also it can pull flowfile from NiFi server and log the flowfile. The NiFi server config is target/conf/flow_Site2SiteServer.xml For trial command control protocol between Native MiNiFi and NiFi Server, please see the example NiFi Server implementation in test/Server.cpp -The command control protocol is not finalized yet. +The command control protocol is not finalized yet. Caveat: -1) +1) Add new propery HostName and Port into RemoteProcessGroup InputOutput port for remote Site2Site hostname and port <remoteProcessGroup> <id>8f3b248f-d493-4269-b317-36f85719f480</id> @@ -96,8 +113,25 @@ Add new propery HostName and Port into RemoteProcessGroup InputOutput port for r </property> </inputPort> 2) -Add new proerties into minifi.properties for command control -# MiNiFi Server for Command Control +Add new proerties into minifi.properties for command control +### MiNiFi Server for Command Control nifi.server.name=localhost nifi.server.port=9000 nifi.server.report.interval=1000 ms + +## License + +Except as otherwise noted this software is licensed under the +[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html) + +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.
