# ExtensiveAutomation Agent
**agent** for the extensive automation server.
## Table of contents
* [Agent Installation](#agent-installation)
* [PyPI package](#pypi-package)
* [Source code](#source-code)
* [Install plugins](#install-plugins)
* [Agent Deployment](#agent-deployment)
* [Generate token](#generate-token)
* [Running agent](#running-agent)
### Agent Installation
### About agents
Agents enable to execute remotely your workflow. It's can be useful on some cases
to run them from different machine that your extensive automation server.
### PyPI package
1. Run the following command
```bash
python3 -m pip install extensiveautomation_agent
```
2. Type the following command on your shell to start the server
```bash
extensiveautomation_agent --help
Usage: extensiveautomation_agent.py [options]
Options:
-h, --help show this help message and exit
--verbose Verbose mode
--remote=REMOTE Server host address (default=127.0.0.1)
--port=PORT Server port (optional default=8083)
--token=TOKEN Token agent
--proxy=PROXY Proxy address:port (optional)
```
3. The next step is to install one or more [plugins](#install-plugins)
### Source code
1. Clone this repository on your linux server
```bash
git clone https://github.com/ExtensiveAutomation/extensiveautomation-agent.git
cd extensiveautomation-agent/
```
2. Show usage documentation.
```bash
cd src/
python3 extensiveautomation_agent.py --help
```
3. The next step is to install one or more [plugins](#install-plugins)
### Install plugins
By default the agent binary comes without plugins so you need
to install them one by one according to your needs.
The installation can be done with the `pip` command.
Take a look to the table below to see the correspondence
between the agents plugins you want to use and the plugin to deploy on server side too.
| Agent Plugins | Description | Server Plugins (must have) |
| ------------- | ------------- | ------------- |
| [curl](https://github.com/ExtensiveAutomation/extensiveautomation-agent-plugin-curl) | send http requests and analyze http responses | plugin-web |
| [ssh](https://github.com/ExtensiveAutomation/extensiveautomation-agent-plugin-ssh) | communicate with remote server through SSH | plugin-cli |
| [selenium3](https://github.com/ExtensiveAutomation/extensiveautomation-agent-plugin-selenium) | interact with a selenium server | plugin-gui |
| [sikulix](https://github.com/ExtensiveAutomation/extensiveautomation-agent-plugin-sikulix) | run sikulix commands | plugin-gui |
### Agent Deployment
### Generate token
A token is mandatory to connect a remote agent to your automation server.
1. Connect on your automation server
2. Executes the following command
```bash
extensiveautomation --generate-token agent01.curl
agent01.curl 0bb2705c-9860-445b-b0fc-44b552476cb3
```
3. Save the token generated and reload the server
```bash
extensiveautomation --reload
```
### Running agent
Running agent is easy but before
- you must install the good plugin according to your needs
- generate a token for your agent
- register then on the server
After that you can execute the following command:
```bash
extensiveautomation_agent --remote=10.0.0.100 --token=13ae34f7-e2f6-40b6-9c87-6c275423127e --curl
2020-07-26 10:28:09,513 starting agent curl ...
2020-07-26 10:28:09,877 agent registration successful
```
Raw data
{
"_id": null,
"home_page": "https://www.extensiveautomation.org/",
"name": "extensiveautomation-agent",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "extensiveautomation agent",
"author": "Denis MACHARD",
"author_email": "d.machard@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/1e/69/eea892aa886370b55a2167bf0fcb74a84e2461c9ae07d8f05a3a1569fa58/extensiveautomation_agent-16.2.0.tar.gz",
"platform": "any",
"description": "# ExtensiveAutomation Agent\n\n\n\n\n**agent** for the extensive automation server. \n\n## Table of contents\n* [Agent Installation](#agent-installation)\n\t* [PyPI package](#pypi-package)\n\t* [Source code](#source-code)\n\t* [Install plugins](#install-plugins)\n* [Agent Deployment](#agent-deployment) \n * [Generate token](#generate-token)\n * [Running agent](#running-agent)\n\n### Agent Installation\n\n### About agents\n\nAgents enable to execute remotely your workflow. It's can be useful on some cases\nto run them from different machine that your extensive automation server.\n\n### PyPI package\n\n1. Run the following command\n\n ```bash\n python3 -m pip install extensiveautomation_agent\n ```\n \n2. Type the following command on your shell to start the server\n\n ```bash\n extensiveautomation_agent --help\n Usage: extensiveautomation_agent.py [options]\n\n Options:\n -h, --help show this help message and exit\n --verbose Verbose mode\n --remote=REMOTE Server host address (default=127.0.0.1)\n --port=PORT Server port (optional default=8083)\n --token=TOKEN Token agent\n --proxy=PROXY Proxy address:port (optional)\n ```\n \n3. The next step is to install one or more [plugins](#install-plugins)\n\n### Source code\n \n1. Clone this repository on your linux server\n\n ```bash\n git clone https://github.com/ExtensiveAutomation/extensiveautomation-agent.git\n cd extensiveautomation-agent/\n ```\n\n2. Show usage documentation.\n\n ```bash\n cd src/\n python3 extensiveautomation_agent.py --help\n ```\n \n3. The next step is to install one or more [plugins](#install-plugins)\n\n\n### Install plugins\n\nBy default the agent binary comes without plugins so you need \nto install them one by one according to your needs. \nThe installation can be done with the `pip` command. \n\nTake a look to the table below to see the correspondence\nbetween the agents plugins you want to use and the plugin to deploy on server side too.\n\n| Agent Plugins | Description | Server Plugins (must have) |\n| ------------- | ------------- | ------------- |\n| [curl](https://github.com/ExtensiveAutomation/extensiveautomation-agent-plugin-curl) | send http requests and analyze http responses | plugin-web |\n| [ssh](https://github.com/ExtensiveAutomation/extensiveautomation-agent-plugin-ssh) | communicate with remote server through SSH | plugin-cli |\n| [selenium3](https://github.com/ExtensiveAutomation/extensiveautomation-agent-plugin-selenium) | interact with a selenium server | plugin-gui |\n| [sikulix](https://github.com/ExtensiveAutomation/extensiveautomation-agent-plugin-sikulix) | run sikulix commands | plugin-gui |\n\n### Agent Deployment\n\n### Generate token\n\nA token is mandatory to connect a remote agent to your automation server.\n\n1. Connect on your automation server \n\n2. Executes the following command\n\n```bash\nextensiveautomation --generate-token agent01.curl\nagent01.curl 0bb2705c-9860-445b-b0fc-44b552476cb3\n```\n\n3. Save the token generated and reload the server\n\n```bash\nextensiveautomation --reload\n```\n\n### Running agent\n\nRunning agent is easy but before \n- you must install the good plugin according to your needs \n- generate a token for your agent\n- register then on the server\n\nAfter that you can execute the following command:\n\n```bash\nextensiveautomation_agent --remote=10.0.0.100 --token=13ae34f7-e2f6-40b6-9c87-6c275423127e --curl\n2020-07-26 10:28:09,513 starting agent curl ...\n2020-07-26 10:28:09,877 agent registration successful\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "Remote agent for the extensiveautomation server",
"version": "16.2.0",
"project_urls": {
"Homepage": "https://www.extensiveautomation.org/"
},
"split_keywords": [
"extensiveautomation",
"agent"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1e69eea892aa886370b55a2167bf0fcb74a84e2461c9ae07d8f05a3a1569fa58",
"md5": "9868a6b63ff3bac36972ff74fe3671a6",
"sha256": "e299202ec6378189be503f66aa0ae39d8ad69b8590ccecd75c7db88c86ad65a8"
},
"downloads": -1,
"filename": "extensiveautomation_agent-16.2.0.tar.gz",
"has_sig": false,
"md5_digest": "9868a6b63ff3bac36972ff74fe3671a6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 38328,
"upload_time": "2023-08-18T08:42:03",
"upload_time_iso_8601": "2023-08-18T08:42:03.126791Z",
"url": "https://files.pythonhosted.org/packages/1e/69/eea892aa886370b55a2167bf0fcb74a84e2461c9ae07d8f05a3a1569fa58/extensiveautomation_agent-16.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-18 08:42:03",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "extensiveautomation-agent"
}
JSON