aicrosoft/jobagent repository overview

⁠JobAgent

   __        _       _                    _   
   \ \  ___ | |__   /_\   __ _  ___ _ __ | |_ 
    \ \/ _ \| '_ \ //_\\ / _` |/ _ \ '_ \| __|
 /\_/ / (_) | |_) /  _  \ (_| |  __/ | | | |_ 
 \___/ \___/|_.__/\_/ \_/\__, |\___|_| |_|\__|
                         |___/                

📖👉 查看中文帮助文档⁠

JobAgent⁠ is a task scheduling client that is easy to use and expand, and accepts various job trigger types. It is implemented using the JobsFactory⁠ task scheduling framework. It is written in dotnet8⁠. It is an upgrade and refactoring of my earlier open-source project BeesTask⁠ .

⁠Advantages

• Multiple trigger modes are supported:
• • Setup trigger – runs when the system or component is upgraded.
• • Interval trigger – runs on a fixed time interval.
• • Cron trigger – runs based on a cron Expression.
• • Event trigger – runs when specific events occur.
• Simply inherit a few classes, set the properties, and override the necessary methods to implement your custom business logic.
• The system is implemented as a plugin based on a .NET library, featuring a clean and well-structured design that’s easy to manage and use.

⁠Applicable Scenarios

• Periodically triggering a task to perform certain operations, such as processing large amounts of data;
• Triggering at specific times to perform operations that need to be executed at certain times, such as on the first day of each month;
• Triggering based on events to perform subsequent operations, such as automatic directory updates and transfers;

⁠Common Usage Examples

• DDNS updates can be executed periodically or triggered by IP update events from routers;
• Monitoring a directory and synchronizing its contents to other locations when changes occur;
• Monitoring events in the database and executing specific business logic based on the content of the events;

⁠Supported Task Types

Before using this framework, please determine whether it is suitable for your needs based on the supported job types.

NOTE: Job type extensions are not supported at the moment.

⁠Run As a Docker

Available Docker registries:

• https://hub.docker.com/r/aicrosoft/jobagent⁠
• https://github.com/neatFactory/JobAgent/pkgs/container/jobagent⁠

⁠Available Docker Versions

⁠Debug Creation

# You can enter the container to perform operations
sudo docker run -d \
  --name jobagent-de \
  aicrosoft/jobagent:debug
## The DEBUG version image already includes the JobSamples plugin.

⁠Production Environment

## Create a container.
sudo docker run -d \
  --name jobagent \
  -v /apps/ja/logs:/app/logs:rw \
  -v /apps/ja/plugins:/app/Plugins:rw \
  -v /apps/ja/states:/app/states:rw \
  aicrosoft/jobagent:latest

⁠Production Environment with Minimum Privileges

## Pre-create empty directories on the host machine and assign permissions
sudo mkdir -p /apps/ja/logs /apps/ja/plugins /apps/ja/states
sudo chmod -R 777 /apps/ja
sudo chown -R 65532:65532 /apps/ja

## Create a container.
sudo docker run -d \
  --name jobagent \
  -v /apps/ja/logs:/app/logs:rw \
  -v /apps/ja/plugins:/app/Plugins:rw \
  -v /apps/ja/states:/app/states:rw \
  aicrosoft/jobagent:latest

⁠Parameter Description

• If you don't need to view logs, you don't need to map /app/logs. Logs will only be retained for 30 days.
• If you don't need to view or modify the state of Jobs, you don't need to map /app/states.
• If you map /app/Plugins, you must place the plugin content in the corresponding path on the host machine.
• You can map /app/appsettings.json to the corresponding configuration on the host machine.
• You can map /app/Plugins/PluginName/PluginName.json to the corresponding configuration on the host machine.

⁠Contributing

Contributions are welcome! Feel free to submit a Pull Request.

⁠Special Thanks