METRON-1381 Add Apache license to MD files and remove the Rat exclusion (justinleet) closes apache/metron#883
Project: http://git-wip-us.apache.org/repos/asf/metron/repo Commit: http://git-wip-us.apache.org/repos/asf/metron/commit/2d9d7a5f Tree: http://git-wip-us.apache.org/repos/asf/metron/tree/2d9d7a5f Diff: http://git-wip-us.apache.org/repos/asf/metron/diff/2d9d7a5f Branch: refs/heads/feature/METRON-1211-extensions-parsers-gradual Commit: 2d9d7a5f6302267edafba772268145e76751795c Parents: 3b10f84 Author: justinleet <justinjl...@gmail.com> Authored: Tue Jan 2 11:38:54 2018 -0500 Committer: leet <l...@apache.org> Committed: Tue Jan 2 11:38:54 2018 -0500 ---------------------------------------------------------------------- README.md | 17 +++++++++++++++++ Upgrading.md | 17 +++++++++++++++++ build_utils/README.md | 17 +++++++++++++++++ metron-analytics/README.md | 17 +++++++++++++++++ metron-analytics/metron-maas-service/README.md | 17 +++++++++++++++++ .../metron-profiler-client/README.md | 17 +++++++++++++++++ metron-analytics/metron-profiler/README.md | 17 +++++++++++++++++ metron-analytics/metron-statistics/HLLP.md | 17 +++++++++++++++++ metron-analytics/metron-statistics/README.md | 17 +++++++++++++++++ metron-contrib/metron-docker/README.md | 17 +++++++++++++++++ metron-deployment/Kerberos-ambari-setup.md | 17 +++++++++++++++++ metron-deployment/Kerberos-manual-setup.md | 17 +++++++++++++++++ metron-deployment/README.md | 17 +++++++++++++++++ metron-deployment/amazon-ec2/README.md | 17 +++++++++++++++++ metron-deployment/other-examples/README.md | 17 +++++++++++++++++ .../manual-install/Manual_Install_CentOS6.md | 17 +++++++++++++++++ metron-deployment/packaging/ambari/README.md | 17 +++++++++++++++++ .../packaging/docker/ansible-docker/README.md | 17 +++++++++++++++++ .../packaging/docker/deb-docker/README.md | 18 +++++++++++++++++- .../packaging/docker/rpm-docker/README.md | 17 +++++++++++++++++ .../packaging/packer-build/README.md | 17 +++++++++++++++++ metron-deployment/roles/README.md | 17 +++++++++++++++++ metron-deployment/roles/monit/README.md | 17 +++++++++++++++++ metron-deployment/roles/opentaxii/README.md | 17 +++++++++++++++++ metron-deployment/roles/pcap_replay/README.md | 17 +++++++++++++++++ metron-deployment/roles/sensor-stubs/README.md | 18 +++++++++++++++++- .../roles/sensor-test-mode/README.md | 17 +++++++++++++++++ metron-deployment/vagrant/README.md | 17 +++++++++++++++++ .../vagrant/fastcapa-test-platform/README.md | 17 +++++++++++++++++ .../vagrant/full-dev-platform/README.md | 17 +++++++++++++++++ metron-interface/metron-alerts/README.md | 17 +++++++++++++++++ metron-interface/metron-config/README.md | 17 +++++++++++++++++ metron-interface/metron-rest/README.md | 17 +++++++++++++++++ metron-platform/Performance-tuning-guide.md | 17 +++++++++++++++++ metron-platform/metron-api/README.md | 17 +++++++++++++++++ metron-platform/metron-common/README.md | 19 +++++++++++++++++-- metron-platform/metron-data-management/README.md | 17 +++++++++++++++++ metron-platform/metron-elasticsearch/README.md | 17 +++++++++++++++++ metron-platform/metron-enrichment/README.md | 17 +++++++++++++++++ metron-platform/metron-indexing/README.md | 17 +++++++++++++++++ metron-platform/metron-management/README.md | 17 +++++++++++++++++ metron-platform/metron-parsers/README.md | 17 +++++++++++++++++ metron-platform/metron-parsers/parser-testing.md | 17 +++++++++++++++++ metron-platform/metron-pcap-backend/README.md | 17 +++++++++++++++++ metron-sensors/README.md | 17 +++++++++++++++++ metron-sensors/fastcapa/README.md | 17 +++++++++++++++++ metron-sensors/pycapa/README.md | 17 +++++++++++++++++ .../stellar-3rd-party-example/README.md | 17 +++++++++++++++++ metron-stellar/stellar-common/3rdPartyStellar.md | 17 +++++++++++++++++ metron-stellar/stellar-common/README.md | 18 +++++++++++++++++- pom.xml | 1 - site-book/README.md | 17 +++++++++++++++++ use-cases/README.md | 17 +++++++++++++++++ use-cases/forensic_clustering/README.md | 17 +++++++++++++++++ use-cases/geographic_login_outliers/README.md | 17 +++++++++++++++++ 55 files changed, 918 insertions(+), 6 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index 91bef3d..86d61e7 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> [](https://travis-ci.org/apache/metron) # Apache Metron http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/Upgrading.md ---------------------------------------------------------------------- diff --git a/Upgrading.md b/Upgrading.md index c3892ce..66bba0c 100644 --- a/Upgrading.md +++ b/Upgrading.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # Upgrading This document constitutes a per-version listing of changes of configuration which are non-backwards compatible. http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/build_utils/README.md ---------------------------------------------------------------------- diff --git a/build_utils/README.md b/build_utils/README.md index dba2114..04087ee 100644 --- a/build_utils/README.md +++ b/build_utils/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # Build Utilities The aim of the build utilities project is to provide some scripting http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-analytics/README.md ---------------------------------------------------------------------- diff --git a/metron-analytics/README.md b/metron-analytics/README.md index d639ca3..56a4b75 100644 --- a/metron-analytics/README.md +++ b/metron-analytics/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # Metron Analytics Metron analytics consists of: http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-analytics/metron-maas-service/README.md ---------------------------------------------------------------------- diff --git a/metron-analytics/metron-maas-service/README.md b/metron-analytics/metron-maas-service/README.md index d234130..bd1d76c 100644 --- a/metron-analytics/metron-maas-service/README.md +++ b/metron-analytics/metron-maas-service/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # Model Management Infrastructure ## Introduction http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-analytics/metron-profiler-client/README.md ---------------------------------------------------------------------- diff --git a/metron-analytics/metron-profiler-client/README.md b/metron-analytics/metron-profiler-client/README.md index 4156058..9fe1f6e 100644 --- a/metron-analytics/metron-profiler-client/README.md +++ b/metron-analytics/metron-profiler-client/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # Metron Profiler Client This project provides a client API for accessing the profiles generated by the [Metron Profiler](../metron-profiler). This includes both a Java API and Stellar API for accessing the profile data. The primary use case is to extract profile data for use during model scoring. http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-analytics/metron-profiler/README.md ---------------------------------------------------------------------- diff --git a/metron-analytics/metron-profiler/README.md b/metron-analytics/metron-profiler/README.md index a24e3cf..dc5ec07 100644 --- a/metron-analytics/metron-profiler/README.md +++ b/metron-analytics/metron-profiler/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # Metron Profiler The Profiler is a feature extraction mechanism that can generate a profile describing the behavior of an entity. An entity might be a server, user, subnet or application. Once a profile has been generated defining what normal behavior looks-like, models can be built that identify anomalous behavior. http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-analytics/metron-statistics/HLLP.md ---------------------------------------------------------------------- diff --git a/metron-analytics/metron-statistics/HLLP.md b/metron-analytics/metron-statistics/HLLP.md index c645253..ed105b0 100644 --- a/metron-analytics/metron-statistics/HLLP.md +++ b/metron-analytics/metron-statistics/HLLP.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # HyperLogLogPlus ## Preliminaries - Distinct Value (cardinality) Estimation http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-analytics/metron-statistics/README.md ---------------------------------------------------------------------- diff --git a/metron-analytics/metron-statistics/README.md b/metron-analytics/metron-statistics/README.md index 508b612..1b83245 100644 --- a/metron-analytics/metron-statistics/README.md +++ b/metron-analytics/metron-statistics/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # Statistics and Mathematical Functions A variety of non-trivial and advanced analytics make use of statistics http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-contrib/metron-docker/README.md ---------------------------------------------------------------------- diff --git a/metron-contrib/metron-docker/README.md b/metron-contrib/metron-docker/README.md index 54cb63b..c290732 100644 --- a/metron-contrib/metron-docker/README.md +++ b/metron-contrib/metron-docker/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # Metron Docker Metron Docker is a [Docker Compose](https://docs.docker.com/compose/overview/) application that is intended only for development and integration testing of Metron. These images can quickly spin-up the underlying components on which Apache Metron runs. http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-deployment/Kerberos-ambari-setup.md ---------------------------------------------------------------------- diff --git a/metron-deployment/Kerberos-ambari-setup.md b/metron-deployment/Kerberos-ambari-setup.md index 39e8dee..2c6e055 100644 --- a/metron-deployment/Kerberos-ambari-setup.md +++ b/metron-deployment/Kerberos-ambari-setup.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # Setting Up Kerberos in Vagrant Full Dev **Note:** These are instructions for Kerberizing Metron Storm topologies from Kafka to Kafka. This does not cover the sensor connections or MAAS. General Kerberization notes can be found in the metron-deployment [README.md](../README.md) http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-deployment/Kerberos-manual-setup.md ---------------------------------------------------------------------- diff --git a/metron-deployment/Kerberos-manual-setup.md b/metron-deployment/Kerberos-manual-setup.md index 5d44b2a..9ebe408 100644 --- a/metron-deployment/Kerberos-manual-setup.md +++ b/metron-deployment/Kerberos-manual-setup.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> Kerberos Setup ============== http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-deployment/README.md ---------------------------------------------------------------------- diff --git a/metron-deployment/README.md b/metron-deployment/README.md index 73e7e87..0b9a6fe 100644 --- a/metron-deployment/README.md +++ b/metron-deployment/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # Overview This set of playbooks can be used to deploy an Ambari-managed Hadoop cluster containing Metron services using Ansible. These playbooks target RHEL/CentOS 6.x operating systems. http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-deployment/amazon-ec2/README.md ---------------------------------------------------------------------- diff --git a/metron-deployment/amazon-ec2/README.md b/metron-deployment/amazon-ec2/README.md index 82b7aeb..f34632d 100644 --- a/metron-deployment/amazon-ec2/README.md +++ b/metron-deployment/amazon-ec2/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> Apache Metron on Amazon EC2 =========================== http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-deployment/other-examples/README.md ---------------------------------------------------------------------- diff --git a/metron-deployment/other-examples/README.md b/metron-deployment/other-examples/README.md index 5e2ef12..88308ee 100644 --- a/metron-deployment/other-examples/README.md +++ b/metron-deployment/other-examples/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # Other Example Deployments This folder contains other example deployments which are not covered under the automatic installs. These examples have been vetted and tested by the Metron community at the time of entry. However, development moves fast and things may change. If there are problems with these steps, please check the mailing lists first or log a Jira ticket. http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-deployment/other-examples/manual-install/Manual_Install_CentOS6.md ---------------------------------------------------------------------- diff --git a/metron-deployment/other-examples/manual-install/Manual_Install_CentOS6.md b/metron-deployment/other-examples/manual-install/Manual_Install_CentOS6.md index e078a72..0c9df5e 100644 --- a/metron-deployment/other-examples/manual-install/Manual_Install_CentOS6.md +++ b/metron-deployment/other-examples/manual-install/Manual_Install_CentOS6.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> [//]: # (Metron 0.4.0 bare metal installation guide for CentOS 6) [//]: # (Written by Laurens Vets, laur...@daemon.be) [//]: # (Version 0.3.3, July 2017) http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-deployment/packaging/ambari/README.md ---------------------------------------------------------------------- diff --git a/metron-deployment/packaging/ambari/README.md b/metron-deployment/packaging/ambari/README.md index af511b4..bdb8b49 100644 --- a/metron-deployment/packaging/ambari/README.md +++ b/metron-deployment/packaging/ambari/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # Ambari Management Pack Development ## Table of Contents http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-deployment/packaging/docker/ansible-docker/README.md ---------------------------------------------------------------------- diff --git a/metron-deployment/packaging/docker/ansible-docker/README.md b/metron-deployment/packaging/docker/ansible-docker/README.md index 1d0d22b..910446b 100644 --- a/metron-deployment/packaging/docker/ansible-docker/README.md +++ b/metron-deployment/packaging/docker/ansible-docker/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # Overview The Metron ansible-docker container is provided in an effort reduce the installation burden of building Metron. It may also be used to deploy Metron in a live environment. http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-deployment/packaging/docker/deb-docker/README.md ---------------------------------------------------------------------- diff --git a/metron-deployment/packaging/docker/deb-docker/README.md b/metron-deployment/packaging/docker/deb-docker/README.md index 8ee8671..800984b 100644 --- a/metron-deployment/packaging/docker/deb-docker/README.md +++ b/metron-deployment/packaging/docker/deb-docker/README.md @@ -1,4 +1,20 @@ - +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> This project builds DEB packages for installing Apache Metron on Ubuntu. **WARNING**: The DEB packages are a recent addition to Metron. These packages have not undergone the same level of testing as the RPM packages. Improvements and more rigerous testing of these packages is underway and will improve in future releases. Until then, use these at your own risk. http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-deployment/packaging/docker/rpm-docker/README.md ---------------------------------------------------------------------- diff --git a/metron-deployment/packaging/docker/rpm-docker/README.md b/metron-deployment/packaging/docker/rpm-docker/README.md index d62b204..e9fe2e6 100644 --- a/metron-deployment/packaging/docker/rpm-docker/README.md +++ b/metron-deployment/packaging/docker/rpm-docker/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # Overview The Metron ansible-docker container is provided in an effort reduce the installation burden of deploying Metron in a live envirionment. It is provisioned with software required to sucessfully run the deployment scripts. http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-deployment/packaging/packer-build/README.md ---------------------------------------------------------------------- diff --git a/metron-deployment/packaging/packer-build/README.md b/metron-deployment/packaging/packer-build/README.md index 78217a0..8cb5ff5 100644 --- a/metron-deployment/packaging/packer-build/README.md +++ b/metron-deployment/packaging/packer-build/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> Build Metron Images ========================= http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-deployment/roles/README.md ---------------------------------------------------------------------- diff --git a/metron-deployment/roles/README.md b/metron-deployment/roles/README.md index ce6c3ba..1cb5878 100644 --- a/metron-deployment/roles/README.md +++ b/metron-deployment/roles/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # Ansible Roles - Monit http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-deployment/roles/monit/README.md ---------------------------------------------------------------------- diff --git a/metron-deployment/roles/monit/README.md b/metron-deployment/roles/monit/README.md index bf52c5d..6f50852 100644 --- a/metron-deployment/roles/monit/README.md +++ b/metron-deployment/roles/monit/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # Monit Integration This role will leverage Monit as a process watchdog to manage sensors, topologies, and core services. http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-deployment/roles/opentaxii/README.md ---------------------------------------------------------------------- diff --git a/metron-deployment/roles/opentaxii/README.md b/metron-deployment/roles/opentaxii/README.md index 52baa2c..7c111de 100644 --- a/metron-deployment/roles/opentaxii/README.md +++ b/metron-deployment/roles/opentaxii/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # OpenTAXII Installs [OpenTAXII](https://github.com/EclecticIQ/OpenTAXII) as a deamon that can be launched via a SysV service script. The complementary client implementation, [Cabby](https://github.com/EclecticIQ/cabby) is also installed. http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-deployment/roles/pcap_replay/README.md ---------------------------------------------------------------------- diff --git a/metron-deployment/roles/pcap_replay/README.md b/metron-deployment/roles/pcap_replay/README.md index 8bc92c9..01475f9 100644 --- a/metron-deployment/roles/pcap_replay/README.md +++ b/metron-deployment/roles/pcap_replay/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> Pcap Replay =========== http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-deployment/roles/sensor-stubs/README.md ---------------------------------------------------------------------- diff --git a/metron-deployment/roles/sensor-stubs/README.md b/metron-deployment/roles/sensor-stubs/README.md index 5acd36e..3e99cfc 100644 --- a/metron-deployment/roles/sensor-stubs/README.md +++ b/metron-deployment/roles/sensor-stubs/README.md @@ -1,4 +1,20 @@ - +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # Sensor Stubs A service has been created to simulate the behavior of a sensor by sending canned telemetry data to a Kafka topic. These "Sensor Stubs" consume fewer resources than the actual sensor that they replace. http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-deployment/roles/sensor-test-mode/README.md ---------------------------------------------------------------------- diff --git a/metron-deployment/roles/sensor-test-mode/README.md b/metron-deployment/roles/sensor-test-mode/README.md index 76a3220..37afad8 100644 --- a/metron-deployment/roles/sensor-test-mode/README.md +++ b/metron-deployment/roles/sensor-test-mode/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> Sensor Test Mode ================ http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-deployment/vagrant/README.md ---------------------------------------------------------------------- diff --git a/metron-deployment/vagrant/README.md b/metron-deployment/vagrant/README.md index 9e48302..6a86b6a 100644 --- a/metron-deployment/vagrant/README.md +++ b/metron-deployment/vagrant/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # Vagrant Deployment - Fast CAPA Test Platform http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-deployment/vagrant/fastcapa-test-platform/README.md ---------------------------------------------------------------------- diff --git a/metron-deployment/vagrant/fastcapa-test-platform/README.md b/metron-deployment/vagrant/fastcapa-test-platform/README.md index 95c3cdf..213d115 100644 --- a/metron-deployment/vagrant/fastcapa-test-platform/README.md +++ b/metron-deployment/vagrant/fastcapa-test-platform/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> Fastcapa Test Environment ========================= http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-deployment/vagrant/full-dev-platform/README.md ---------------------------------------------------------------------- diff --git a/metron-deployment/vagrant/full-dev-platform/README.md b/metron-deployment/vagrant/full-dev-platform/README.md index b6624ac..3da383c 100644 --- a/metron-deployment/vagrant/full-dev-platform/README.md +++ b/metron-deployment/vagrant/full-dev-platform/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> Full Development Platform ========================= http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-interface/metron-alerts/README.md ---------------------------------------------------------------------- diff --git a/metron-interface/metron-alerts/README.md b/metron-interface/metron-alerts/README.md index 8480a69..0cc2fba 100644 --- a/metron-interface/metron-alerts/README.md +++ b/metron-interface/metron-alerts/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> - [Caveats](#caveats) - [Prerequisites](#prerequisites) - [Development Setup](#development-setup) http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-interface/metron-config/README.md ---------------------------------------------------------------------- diff --git a/metron-interface/metron-config/README.md b/metron-interface/metron-config/README.md index 1b20731..7ae774b 100644 --- a/metron-interface/metron-config/README.md +++ b/metron-interface/metron-config/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # Metron Management UI This module provides a user interface for management functions in Metron. http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-interface/metron-rest/README.md ---------------------------------------------------------------------- diff --git a/metron-interface/metron-rest/README.md b/metron-interface/metron-rest/README.md index 0cf58c0..c9684a5 100644 --- a/metron-interface/metron-rest/README.md +++ b/metron-interface/metron-rest/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # Metron REST This module provides a RESTful API for interacting with Metron. http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-platform/Performance-tuning-guide.md ---------------------------------------------------------------------- diff --git a/metron-platform/Performance-tuning-guide.md b/metron-platform/Performance-tuning-guide.md index a1fe738..8a2a1ba 100644 --- a/metron-platform/Performance-tuning-guide.md +++ b/metron-platform/Performance-tuning-guide.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # Metron Performance Tuning Guide ## Overview http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-platform/metron-api/README.md ---------------------------------------------------------------------- diff --git a/metron-platform/metron-api/README.md b/metron-platform/metron-api/README.md index 7b4aa4e..4a0dde8 100644 --- a/metron-platform/metron-api/README.md +++ b/metron-platform/metron-api/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # Metron PCAP Service The purpose of the Metron PCAP service is to provide a middle tier to http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-platform/metron-common/README.md ---------------------------------------------------------------------- diff --git a/metron-platform/metron-common/README.md b/metron-platform/metron-common/README.md index 5f9fec6..ab90a66 100644 --- a/metron-platform/metron-common/README.md +++ b/metron-platform/metron-common/README.md @@ -1,5 +1,20 @@ - - +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # Contents * [Stellar Language](#stellar-language) http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-platform/metron-data-management/README.md ---------------------------------------------------------------------- diff --git a/metron-platform/metron-data-management/README.md b/metron-platform/metron-data-management/README.md index c351f48..b6acd83 100644 --- a/metron-platform/metron-data-management/README.md +++ b/metron-platform/metron-data-management/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # Resource Data Management This project is a collection of classes to assist with loading of http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-platform/metron-elasticsearch/README.md ---------------------------------------------------------------------- diff --git a/metron-platform/metron-elasticsearch/README.md b/metron-platform/metron-elasticsearch/README.md index 9113672..7278a25 100644 --- a/metron-platform/metron-elasticsearch/README.md +++ b/metron-platform/metron-elasticsearch/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # Elasticsearch in Metron ## Introduction http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-platform/metron-enrichment/README.md ---------------------------------------------------------------------- diff --git a/metron-platform/metron-enrichment/README.md b/metron-platform/metron-enrichment/README.md index 70bf832..d742046 100644 --- a/metron-platform/metron-enrichment/README.md +++ b/metron-platform/metron-enrichment/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # Enrichment ## Introduction http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-platform/metron-indexing/README.md ---------------------------------------------------------------------- diff --git a/metron-platform/metron-indexing/README.md b/metron-platform/metron-indexing/README.md index d8c5beb..e7f1e4f 100644 --- a/metron-platform/metron-indexing/README.md +++ b/metron-platform/metron-indexing/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # Indexing ## Introduction http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-platform/metron-management/README.md ---------------------------------------------------------------------- diff --git a/metron-platform/metron-management/README.md b/metron-platform/metron-management/README.md index 07a5b1a..c4b9555 100644 --- a/metron-platform/metron-management/README.md +++ b/metron-platform/metron-management/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # Stellar REPL Management Utilities In order to augment the functionality of the Stellar REPL, a few http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-platform/metron-parsers/README.md ---------------------------------------------------------------------- diff --git a/metron-platform/metron-parsers/README.md b/metron-platform/metron-parsers/README.md index 88dde44..ade0f51 100644 --- a/metron-platform/metron-parsers/README.md +++ b/metron-platform/metron-parsers/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # Parsers ## Introduction http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-platform/metron-parsers/parser-testing.md ---------------------------------------------------------------------- diff --git a/metron-platform/metron-parsers/parser-testing.md b/metron-platform/metron-parsers/parser-testing.md index e30a7b7..3d670b5 100644 --- a/metron-platform/metron-parsers/parser-testing.md +++ b/metron-platform/metron-parsers/parser-testing.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # Parser Contribution and Testing So you want to contribute a parser to Apache Metron. First off, on behalf http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-platform/metron-pcap-backend/README.md ---------------------------------------------------------------------- diff --git a/metron-platform/metron-pcap-backend/README.md b/metron-platform/metron-pcap-backend/README.md index 69ffe52..e7960e3 100644 --- a/metron-platform/metron-pcap-backend/README.md +++ b/metron-platform/metron-pcap-backend/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # Metron PCAP Backend The purpose of the Metron PCAP backend is to create a storm topology http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-sensors/README.md ---------------------------------------------------------------------- diff --git a/metron-sensors/README.md b/metron-sensors/README.md index ad30c82..d926d97 100644 --- a/metron-sensors/README.md +++ b/metron-sensors/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> Metron Sensors -------------- http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-sensors/fastcapa/README.md ---------------------------------------------------------------------- diff --git a/metron-sensors/fastcapa/README.md b/metron-sensors/fastcapa/README.md index 37c4189..277f518 100644 --- a/metron-sensors/fastcapa/README.md +++ b/metron-sensors/fastcapa/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> Fastcapa ======== http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-sensors/pycapa/README.md ---------------------------------------------------------------------- diff --git a/metron-sensors/pycapa/README.md b/metron-sensors/pycapa/README.md index ed929f9..ab4389f 100644 --- a/metron-sensors/pycapa/README.md +++ b/metron-sensors/pycapa/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> Pycapa ------ http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-stellar/stellar-3rd-party-example/README.md ---------------------------------------------------------------------- diff --git a/metron-stellar/stellar-3rd-party-example/README.md b/metron-stellar/stellar-3rd-party-example/README.md index 14c489e..e2f2c1b 100644 --- a/metron-stellar/stellar-3rd-party-example/README.md +++ b/metron-stellar/stellar-3rd-party-example/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # Introduction This is just a sample 3rd party stellar function (which is used in our http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-stellar/stellar-common/3rdPartyStellar.md ---------------------------------------------------------------------- diff --git a/metron-stellar/stellar-common/3rdPartyStellar.md b/metron-stellar/stellar-common/3rdPartyStellar.md index 3a6f958..ff54234 100644 --- a/metron-stellar/stellar-common/3rdPartyStellar.md +++ b/metron-stellar/stellar-common/3rdPartyStellar.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # Custom Stellar Functions Metron is fundamentally a programmable, extensible system http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/metron-stellar/stellar-common/README.md ---------------------------------------------------------------------- diff --git a/metron-stellar/stellar-common/README.md b/metron-stellar/stellar-common/README.md index 09bd4d6..6c420b6 100644 --- a/metron-stellar/stellar-common/README.md +++ b/metron-stellar/stellar-common/README.md @@ -1,4 +1,20 @@ - +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # Stellar Language For a variety of components (threat intelligence triage and field transformations) we have the need to do simple computation and transformation using the data from messages as variables. For those purposes, there exists a simple, scaled down DSL created to do simple computation and transformation. http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/pom.xml ---------------------------------------------------------------------- diff --git a/pom.xml b/pom.xml index 04abab6..15a612b 100644 --- a/pom.xml +++ b/pom.xml @@ -304,7 +304,6 @@ <exclude>dependencies_with_url.csv</exclude> <!-- In travis we need to pull down maven 3.3.9, so we should exclude it here as it is not our code. --> <exclude>apache-maven-3.3.9/**</exclude> - <exclude>**/*.md</exclude> <exclude>**/VERSION</exclude> <exclude>**/*.json</exclude> <exclude>**/*.json.j2</exclude> http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/site-book/README.md ---------------------------------------------------------------------- diff --git a/site-book/README.md b/site-book/README.md index 52aae51..25e1a39 100644 --- a/site-book/README.md +++ b/site-book/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # Metron Site-Book documentation Metron's Site Book is an attempt at producing documentation that is: http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/use-cases/README.md ---------------------------------------------------------------------- diff --git a/use-cases/README.md b/use-cases/README.md index 02be32d..7105785 100644 --- a/use-cases/README.md +++ b/use-cases/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # Worked Examples The following are worked examples of use-cases that showcase some (or http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/use-cases/forensic_clustering/README.md ---------------------------------------------------------------------- diff --git a/use-cases/forensic_clustering/README.md b/use-cases/forensic_clustering/README.md index 7aa3468..f9c1333 100644 --- a/use-cases/forensic_clustering/README.md +++ b/use-cases/forensic_clustering/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # Problem Statement Having a forensic hash, such as [TLSH](https://github.com/trendmicro/tlsh), is a useful tool in cybersecurity. http://git-wip-us.apache.org/repos/asf/metron/blob/2d9d7a5f/use-cases/geographic_login_outliers/README.md ---------------------------------------------------------------------- diff --git a/use-cases/geographic_login_outliers/README.md b/use-cases/geographic_login_outliers/README.md index bfa5234..1e092a1 100644 --- a/use-cases/geographic_login_outliers/README.md +++ b/use-cases/geographic_login_outliers/README.md @@ -1,3 +1,20 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you 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. +--> # Problem Statement One way to find anomalous behavior in a network is by inspecting user
