Documentation typo correction;

Licence NOTICE included
renatoalmeidaoliveira · Jun 15, 2020 · e6412c9 · e6412c9
1 parent f8e7636
commit e6412c9
Show file tree

Hide file tree

Showing 8 changed files with 115 additions and 6 deletions.
diff --git a/NOTICE b/NOTICE
@@ -0,0 +1,15 @@
+Netero an Ansible collection for network automation.
+Copyright (C) 2020  Renato Almeida de Oliveira <renato.almeida.oliveira@gmail.com>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published
+by the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.
diff --git a/README.md b/README.md
@@ -1,16 +1,22 @@
 [![published](https://static.production.devnetcloud.com/codeexchange/assets/images/devnet-published.svg)](https://developer.cisco.com/codeexchange/github/repo/renatoalmeidaoliveira/netero)
 # Ansible Collection - renatoalmeidaoliveira.netero
 
-Netero is a simple utiliy to help network manangement, that aims to encpsulate vendors’ specifics sintax in YAML models based on YANG data model, in this realease it is possible to perfom the following:
+Netero is a simple utiliy to help network manangement, that aims to encpsulate vendors’ specifics Syntax in YAML models based on YANG data model, in this realease it is possible to perfom the following:
 
 * Manage your configuration Backups
 * Integrate your backups with Gogs API, with git push and commit
 * Consume PeeringDB API for prospection of when some Autonomous System (AS) lies on the same IXP as your AS
 * Consume PeeringDB API for gather AS informations as max IPv4/IPv6 prefixes, interfaces address, IRR-ASSET
 * Encapsulate BGPq3/BGPq4 for generation of prefix-list of a given IRR-ASSET
 
+
+# Documentation Link:
+
+http://netero.renatooliveira.eng.br/
+
 # Requirements
 
+* [ansible 2.9.5](https://docs.ansible.com/ansible/2.9/index.html) 
 * [git](https://git-scm.com/)
 * [bgpq3](https://github.com/snar/bgpq3) or [bgpq4](https://github.com/bgp/bgpq4)
 * [requests](https://pypi.org/project/requests/)
@@ -25,7 +31,7 @@ Netero is a simple utiliy to help network manangement, that aims to encpsulate v
 
 # Use Cases 
 
-Netero is built for a multivendor environment, where all the  vendors specifics sintax are encapsulated in roles that deliver an uniform interface for the tasks.
+Netero is built for a multivendor environment, where all the  vendors specifics Syntax are encapsulated in roles that deliver an uniform interface for the tasks.
 For acomodate the specifc syntax of the vendors Netero relies on the Roles abstraction and on data models based on OpenConfig or YANG, as described in Figure 1.
 ![Figure 1. Multi Vendor conception](https://github.com/renatoalmeidaoliveira/netero/blob/assets/design.png) <p align="center">
   *Figure 1. Multi Vendor conception*
@@ -131,7 +137,3 @@ With the information’s above it is possible by following the process of Figure
 # Next Steps
 
 The configuration module, that will read model files and configure the network devices
-
-# Documentation Link:
-
-http://netero.renatooliveira.eng.br/
diff --git a/plugins/modules/git_commit.py b/plugins/modules/git_commit.py
@@ -1,4 +1,20 @@
 #!/usr/bin/python
+#  Netero an Ansible collection for network automation.
+#  Copyright (C) 2020  Renato Almeida de Oliveira <renato.almeida.oliveira@gmail.com>
+#
+#  This program is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU Affero General Public License as published
+#  by the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU Affero General Public License for more details.
+#
+#  You should have received a copy of the GNU Affero General Public License
+#  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
 
 from ansible.errors import AnsibleError
 from ansible.module_utils.basic import to_native, AnsibleModule

diff --git a/plugins/modules/git_push.py b/plugins/modules/git_push.py
@@ -1,3 +1,19 @@
+#!/usr/bin/python
+#  Netero an Ansible collection for network automation.
+#  Copyright (C) 2020  Renato Almeida de Oliveira <renato.almeida.oliveira@gmail.com>
+#
+#  This program is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU Affero General Public License as published
+#  by the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU Affero General Public License for more details.
+#
+#  You should have received a copy of the GNU Affero General Public License
+#  along with this program.  If not, see <https://www.gnu.org/licenses/>.
 import re
 
 from ansible.module_utils.basic import AnsibleModule, to_native

diff --git a/plugins/modules/gogs_createrepo.py b/plugins/modules/gogs_createrepo.py
@@ -1,4 +1,19 @@
 #!/usr/bin/python
+#  Netero an Ansible collection for network automation.
+#  Copyright (C) 2020  Renato Almeida de Oliveira <renato.almeida.oliveira@gmail.com>
+#
+#  This program is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU Affero General Public License as published
+#  by the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU Affero General Public License for more details.
+#
+#  You should have received a copy of the GNU Affero General Public License
+#  along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 import requests
 import re

diff --git a/plugins/modules/irr_prefix.py b/plugins/modules/irr_prefix.py
@@ -1,4 +1,19 @@
 #!/usr/bin/python
+#  Netero an Ansible collection for network automation.
+#  Copyright (C) 2020  Renato Almeida de Oliveira <renato.almeida.oliveira@gmail.com>
+#
+#  This program is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU Affero General Public License as published
+#  by the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU Affero General Public License for more details.
+#
+#  You should have received a copy of the GNU Affero General Public License
+#  along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 from ansible.errors import AnsibleError
 from ansible.module_utils.basic import to_native, AnsibleModule

diff --git a/plugins/modules/peeringdb_getasn.py b/plugins/modules/peeringdb_getasn.py
@@ -1,4 +1,19 @@
 #!/usr/bin/python
+#  Netero an Ansible collection for network automation.
+#  Copyright (C) 2020  Renato Almeida de Oliveira <renato.almeida.oliveira@gmail.com>
+#
+#  This program is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU Affero General Public License as published
+#  by the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU Affero General Public License for more details.
+#
+#  You should have received a copy of the GNU Affero General Public License
+#  along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 import requests
 import json

diff --git a/plugins/modules/peeringdb_prospect.py b/plugins/modules/peeringdb_prospect.py
@@ -1,4 +1,19 @@
 #!/usr/bin/python
+#  Netero an Ansible collection for network automation.
+#  Copyright (C) 2020  Renato Almeida de Oliveira <renato.almeida.oliveira@gmail.com>
+#
+#  This program is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU Affero General Public License as published
+#  by the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU Affero General Public License for more details.
+#
+#  You should have received a copy of the GNU Affero General Public License
+#  along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 import requests
 import json