me/p2p-rendering-computation
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

modified docs for plugin module

Browse Source
This commit is contained in:
Akilan Selvacoumar
2021-07-16 21:44:07 +04:00
parent 0131ce5765
commit 75a4bed9d1
4 changed files with 22 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
Docs/Implementation.md
View File

@@ -16,3 +16,4 @@ the project is git.sr.ht/~akilan1999/p2p-rendering-computation.
## [Server Module](ServerImplementation.md) ## [Server Module](ServerImplementation.md)
## [Client Module](ClientImplementation.md) ## [Client Module](ClientImplementation.md)
## [P2P Module](P2PImplementation.md) ## [P2P Module](P2PImplementation.md)
## [Plugin Module](PluginImplementation.md)

15
Docs/Installation.md
View File

@@ -133,8 +133,15 @@ p2prc --ls
p2prc --ni p2prc --ni
``` ```
<br>
--------------
<br>
# Using Plugins # Using Plugins
This feature is still Under Development This feature is still Under Development:
[Read more on the implementation](PluginImplementation.md)
#### Dependencies #### Dependencies
- Ansible: - Ansible:
@@ -147,12 +154,6 @@ This feature is still Under Development
ever the file ```ansible.cfg``` is located. ever the file ```ansible.cfg``` is located.
- Add or uncomment ```host_key_checking = False``` - Add or uncomment ```host_key_checking = False```
<br>
--------------
<br>
#### Run Test Cases #### Run Test Cases
- Generate Test Case Ansible file - Generate Test Case Ansible file
- ```make testcases``` - ```make testcases```

14
Docs/PluginImplementation.md
View File

@@ -1,4 +1,12 @@
# Plugin Module Implementation # 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 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 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. can be executed across different nodes in a repetitive manner.
@@ -23,7 +31,7 @@ plugin
n: n number of plugins possible 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 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. 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 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 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 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 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 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. This is a simple text file used to describe what the module does.
When the client is looking at various commands via the ClI. When the client is looking at various commands via the ClI.
The description is displayed along-side the plugin name. The description is displayed along-side the plugin name.

1
Docs/README.md
View File

@@ -12,5 +12,6 @@
3. [Server Module](ServerImplementation.md) 3. [Server Module](ServerImplementation.md)
4. [Config Module](ConfigImplementation.md) 4. [Config Module](ConfigImplementation.md)
5. [Cli Module](CliImplementation.md) 5. [Cli Module](CliImplementation.md)
6. [Plugin Module](PluginImplementation.md)
5. [Problems](Problems.md) 5. [Problems](Problems.md)