diff --git a/Docs/Implementation.md b/Docs/Implementation.md index 3a27aaf..619385c 100644 --- a/Docs/Implementation.md +++ b/Docs/Implementation.md @@ -15,4 +15,5 @@ the project is git.sr.ht/~akilan1999/p2p-rendering-computation. ## [Config Module](ConfigImplementation.md) ## [Server Module](ServerImplementation.md) ## [Client Module](ClientImplementation.md) -## [P2P Module](P2PImplementation.md) \ No newline at end of file +## [P2P Module](P2PImplementation.md) +## [Plugin Module](PluginImplementation.md) \ No newline at end of file diff --git a/Docs/Installation.md b/Docs/Installation.md index 3e1e48d..a4a6e2d 100644 --- a/Docs/Installation.md +++ b/Docs/Installation.md @@ -133,8 +133,15 @@ p2prc --ls p2prc --ni ``` +
+ +-------------- + +
+ # Using Plugins -This feature is still Under Development +This feature is still Under Development: +[Read more on the implementation](PluginImplementation.md) #### Dependencies - Ansible: @@ -146,12 +153,6 @@ This feature is still Under Development - ```sudo nano /etc/ansible/ansible.cfg```: Open the following file. If this file is not found then where ever the file ```ansible.cfg``` is located. - Add or uncomment ```host_key_checking = False``` - -
- --------------- - -
#### Run Test Cases - Generate Test Case Ansible file diff --git a/Docs/PluginImplementation.md b/Docs/PluginImplementation.md index 709efdb..1dcf2a9 100644 --- a/Docs/PluginImplementation.md +++ b/Docs/PluginImplementation.md @@ -1,4 +1,12 @@ # Plugin Module Implementation +## Topics +1. [Introduciton](#introduction) +2. [Site.yml](#site-File-Template) +3. [Host](#hosts-file) +4. [Description](#description-file) + +## Introduction + The plugin module is designed to ensure clients can execute instructions in a declarative manner across different containers created. This means the user (i.e client) needs to write the instruction only once, and these instructions can be executed across different nodes in a repetitive manner. @@ -23,7 +31,7 @@ plugin n: n number of plugins possible ``` -### Site File Template (i.e site.yml) +## Site File Template The site file is also known as the Ansible playbook and is incharge of executing instructions in a declarative manner. The below example specifies how to make one. ``` @@ -37,7 +45,7 @@ instructions in a declarative manner. The below example specifies how to make on ``` Read more about ansible tasks: https://docs.ansible.com/ansible/latest/user_guide/playbooks_intro.html#about-playbooks -### Hosts file (i.e hosts) +## Hosts file hosts file is also known as the inventory file. This file consists of all the information required to connect to other nodes to execute Ansible instructions. In this project this file needs to be set in a certain configuration because the go code or binary will populate this file automatically with the appropriate information required to connect to local or @@ -60,7 +68,7 @@ main: ansible_sudo_pass: password ``` -### Description file (i.e description.txt) +## Description file This is a simple text file used to describe what the module does. When the client is looking at various commands via the ClI. The description is displayed along-side the plugin name. diff --git a/Docs/README.md b/Docs/README.md index e9bfe07..26b4b20 100644 --- a/Docs/README.md +++ b/Docs/README.md @@ -12,5 +12,6 @@ 3. [Server Module](ServerImplementation.md) 4. [Config Module](ConfigImplementation.md) 5. [Cli Module](CliImplementation.md) + 6. [Plugin Module](PluginImplementation.md) 5. [Problems](Problems.md)