Workasync

If you just want to push jobs somewhere and you don't care about other fancy functions

Installation

Requirements

• Node.js >= 14.0.0
• npm >= 6.0.0

Install

git clone https://github.com/Sn0wAlice/Workasync
cd Workasync
npm install

Configuration

{
    "web": {
        "port": 3000 // web server port
    },
    "kind": "default", // "default" -> master node | "client" -> client node
    "socket": {
        "remote_host": "127.0.0.1", // master node host
        "remote_port": 3000, // master node port
        "remote_protocol": "http" // master node protocol
    },
    "security": {
        "key": "mysecretkey" // secret to allow connection from client to master
    }
}

Use

Run the master node (kind: default) then plug client to it, and then you can push jobs to the master node API.

KAL Request lang

KAL is the selectioner of the workasync. It's use to filter where you job can run. With the easy syntax, you can select the best node to run your job.

Kal filter

Filter	Description	Example	Human	Match exemple
*	Any node	*	Any node, can't be combined	any
name	Node name	name:alice	Where name includes alice	alice bob will match, bob patrick will not
name.is	Node name	name:alice	Where name is alice	alice will match, alice bob will not
tags	Node name	tags:linux	Where tags includes linux	tag linux-ubuntu will match, windows will not
tags.is	Node name	tags.is:linux	Where tags is linux	tag linux will match, linux-ubuntu will not

Kal example

This will select the node where the name includes alice

name:alice

If you want to select the node where the name includes alice and the tag is linux

name:alice tags.is:linux

If you want to select the node where the name is alice and the tag is linux

name.is:alice tags.is:linux

Tip

Kal only support AND operator.

Users

When you start your server for the first time, you will be asked to create a root user and whill show you his token.

Note

If you wanna use the api, you need to use the token in the header Authorization: <token>. This is the unique authentication method allowed.

Next, you will be able to create more users with the API. And you will be able to give users the permission they need.

API

Root api endpoints (click to see more)

1. Create a new user

Endpoint:
GET /api/users/create/{username}

Description:
Will create user named username and will send you the auth token.

Response Example:

{
    "error": false,
    "message": "User alice created with apikey: eca1815f-1eb5-443f-9a34-0856ae9afe9a"
}

2. List all users

Endpoint:
GET /api/users/list

Description:
Will send you the list with all users (except the auth token available in ./config/users.json).

Response Example:

{
    "error": false,
    "message": "User alice created with apikey: eca1815f-1eb5-443f-9a34-0856ae9afe9a"
}

3. Delete a user

Endpoint:
GET /api/users/delete/{username}

Description:
Will delete user named username.

Response Example:

{
    "error": false,
    "message": "User alice deleted"
}

User api endpoints (click to see more)

1. Claim server

Endpoint:
GET /api/clients/claim/{serveruuid}

Description:
Will claim server serveruuid to the user. (use the key showed in client console)

Response Example:

{
    "error": false,
    "message": "Server claimed"
}

[!NOTE] You can only claim one time a server.

2. Share server

Endpoint:
GET /api/clients/share/{serveruuid}/{username}

Description:
Will share the acces to server serveruuid to the user username.

Response Example:

{
    "error": false,
    "message": "Server shared"
}

3. Get my server

Endpoint:
GET /api/clients/mine

Description:
Get all the server that you have claimed AND shared.

Response Example:

{
    "error": false,
    "clients": [
        {
            "client_key": "8ebefb55-e2b2-4043-b253-2f2027803a1f",
            "name": "Christian Daphne",
            "tags": [],
            "shared": [
                "root"
            ],
            "status": "online"
        }
    ]
}

4. Get my server details

Endpoint:
GET /api/clients/show/{serveruuid}

Description:
Get all the details of the server serveruuid.

Response Example:

{
    "error": false,
    "server": {
        "client_key": "8ebefb55-e2b2-4043-b253-2f2027803a1f",
        "name": "Christian Daphne",
        "shared": [
            "root"
        ],
        "tags": [],
        "owner": "alice",
        "status": "offline"
    }
}

5. Manage Server tags

Endpoint:
GET /api/clients/tags/{action}/{tag}/{serveruuid}

Description:
Manage the tags of the server serveruuid. Action can be:

• add to add a tag
• remove to remove a tag

Response Example:

{
    "error": false,
    "message": "Tag removed"
}

{
    "error": false,
    "message": "Tag added"
}

6. Manage Server name

Endpoint:
GET /api/clients/rename/{serveruuid}/{newname}

Description:
Rename the server serveruuid to newname.

** !! DO NOT USE SPACE IN SERVER NAME !!**

Response Example:

{
    "error": false,
    "message": "Tag removed"
}

Jobs api endpoints (click to see more)

1. Start a job

Endpoint: POST /api/jobs

Description: Start one or multiple jobs on random server matching the kal.

Request Example:

{
    "jobs": ["hello", "world"],
    "kal": "tags.is:linux",
    "cmd": "echo hello" // optional cmd passed to the docker
}

this will start the job hello and job world on a server where the tag is linux