Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rosenbjerg/agentdeploy
An agent for managing execution of taco bell style deployment and server management scripts
https://github.com/rosenbjerg/agentdeploy
automation bash cli-tool deployment remote rest-api scripts ssh
Last synced: 8 days ago
JSON representation
An agent for managing execution of taco bell style deployment and server management scripts
- Host: GitHub
- URL: https://github.com/rosenbjerg/agentdeploy
- Owner: rosenbjerg
- License: mit
- Created: 2021-02-26T23:23:48.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-02-22T04:17:22.000Z (almost 2 years ago)
- Last Synced: 2025-01-19T01:33:37.069Z (12 days ago)
- Topics: automation, bash, cli-tool, deployment, remote, rest-api, scripts, ssh
- Language: C#
- Homepage:
- Size: 684 KB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# agentd
An agent for managing execution of [taco bell programming](http://widgetsandshit.com/teddziuba/2010/10/taco-bell-programming.html)-style deployment and server management scripts on remote hosts
[](https://github.com/rosenbjerg/agentdeploy/actions/workflows/ci.yml)
[](https://github.com/rosenbjerg/agentdeploy/blob/main/LICENSE)
[](https://app.codecov.io/gh/rosenbjerg/agentdeploy)
[](https://hub.docker.com/r/mrosenbjerg/agentd-server)
[](https://hub.docker.com/r/mrosenbjerg/agentd-server)
[](https://hub.docker.com/r/mrosenbjerg/agentd-server)
[](https://hub.docker.com/r/mrosenbjerg/agentd-client)
[](https://hub.docker.com/r/mrosenbjerg/agentd-client)
[](https://hub.docker.com/r/mrosenbjerg/agentd-client)
[](https://sonarcloud.io/dashboard?id=rosenbjerg_AgentDeploy)
[](https://sonarcloud.io/dashboard?id=rosenbjerg_AgentDeploy)
[](https://sonarcloud.io/dashboard?id=rosenbjerg_AgentDeploy)
[](https://sonarcloud.io/dashboard?id=rosenbjerg_AgentDeploy)
[](https://www.codefactor.io/repository/github/rosenbjerg/agentdeploy/overview/main)
## Server
Running the `agentd` server, either in a container or directly using an executable, exposes a REST endpoint that can be used to invoke **scripts**. These **scripts** are either executed locally relative to the executable, or remotely through SSH.
**Scripts** are defined using yaml files that specify which *variables* the **script** require for invocation. Both *variables*, *secret variables* and *files* are declared and optionally constrained to certain values using regular expressions. *Files* can be constrained on size (maximum and minimum) and file extension.
Permission to invoke a **script** is granted through a **token**, which is also specified by a yaml file. A **token** can also limit which of the availabe **script**-files should be invocable with a given **token**.
**Tokens** can also further constrain the input *variables* to a given **script** or even lock a *variable* to a specific value.
### Script examples
#### Minimal example (`minimal-example.yaml`)
```yaml
variables:
name:
command: echo "Hello $(name)!"
```
Advanced example (advanced-example.yaml)
```yaml
variables:
username:
default_value: johndoe
password:
secret: true
regex: ^s{16,32}$
files:
test_file:
max_size: 1_000
preprocessing: clamscan -i $(FilePath)
assets:
- *.jpeg
- resize.sh
show_command: true
concurrency: none
command: |
echo "logging in $(username):$(password)"
cat $(test_file)
bash ./resize.sh ./*.jpeg /home/someuser/images
```
### Token examples
#### Minimal example (`my-token-123.yaml`)
```yaml
available_scripts:
minimal-example:
advanced-example:
```
Advanced example (adv-token-321.yaml)
```yaml
name: advanced example
description: just an advanced example with more stuff in it
ssh:
username: myuser
private_key_file: /home/myuser/.ssh/id_rsa
trusted_ips:
- 127.0.0.1
- ::1
- ::ffff:172.18.0.1
available_scripts:
minimal-example:
variable_constraints:
name: ^john(doe)?$
advanced-example:
ssh:
username: myotheruser
private_key_file: /home/myotheruser/.ssh/id_rsa
locked_variables:
username: john
variable_constraints:
password: ^[a-zA-Z0-9_-]{18,32}$
```
## Client
The `agentd-client` CLI tool simplifies usage in terminals, scripts and CD pipelines by providing a simple way to invoke the `agentd` server.
The CLI tool supports WebSockets to enable the output from the invoked script to be printed immediately after it is emitted.
#### Installation
Download a binary from [GitHub Releases](https://github.com/rosenbjerg/agentdeploy/releases) or use with docker using an alias `alias agentd-client='docker run --rm -it -v $(pwd):/files mrosenbjerg/agentd-client'`
#### Minimal usage example
```
agentd-client invoke minimal-example http://localhost:5000 -i -v name=John
// or
agentd-client invoke minimal-example http://localhost:5000 -t my-token-123 -v name=John
```
#### Advanced usage example
```
agentd-client invoke advanced-example http://localhost:5000 -iw -v username=johndoe password=longbutveryweakpassword -f test_file=./the-test-file.txt
// or
agentd-client invoke advanced-example http://localhost:5000 -w -t adv-token-321 -v username=johndoe password=longbutveryweakpassword -f test_file=./the-test-file.txt
```
#### Help
Use `--help` to print the CLI help.
For version 3.x:
```
Usage: agentd-client [options] [command]
Options:
-V, --version output the version number
-t, --token Authentication token
-i, --interactive Enable providing token through stdin
-w, --ws Enable websocket connection for receiving output
-v, --variables Add variable
-s, --secret-variables Add secret variable
-e, --environment-variables Add environment variable
-f, --files Add file
--hide-timestamps Omit printing timestamps
--hide-headers Omit printing info headers
--hide-script Omit printing script (if available)
--hide-script-line-numbers Omit printing line-numbers for script
-h, --help display help for command
Commands:
invoke Invoke named script on remote server
help [command] display help for command
```