github.com/codemodify/systemkit-service-spec
Service
WhatAfter reading a ton of material on
initframeworks and service management for different OSes; Going through mental debate of smartness of one versus another and their historical backlog and tech debt, as well as developer and user friendliness of the material provided which in itself can drive away companies and engineering force to provide support for one or another platform - THE TAKE AWAY IS - In the end what matters is to have an OS efficient and developer friendly mechanics to manipulate a service.
This repo proposes to create a portable
SERVICEdefinition that can be used by developers and businesses to implement their products on a range of platforms without worrying about misunderstanding the genius on each of those.
Reference Implementations
Where
- Use Case (A) - code
NewServiceFromSERVICE()
- creates and controls a service based on
SERVICEportable descriptionNewServiceFromName()
- finds and controls an existing service based on its name; previously created by our app or something else
NewServiceFromPlatformTemplate()
- create a service from a platform dependent template
- template is already a service definition as it is defined by the one of
initframeworks
- Use Case (B) - scripting
- manipulate a service based on a SERVICE file
systemkit-service-spec-cli create/delete/start/stop/info -service SERVICE-FILE- manipulate a service based on commands and flags
systemkit-service-spec-cli create/delete/start/stop/info -name test-service -executable vim- compile your own service manipulator binary based on the
systemkit-service-spec-clisource code
- Use Case (C) - convert
- used as an ETL mechanism, used by scripting or cloud based services
- convert
SERVICEfile to a platform dependent format- convert platform dependent format to
SERVICEformat- convert platform dependent format to a different platform dependent format, by going through
SERVICEformat
SERVICE format
{
"name": "test-service",
"description": "Test Service",
"documentation": "http://test-service.com",
"executable": "/bin/sleep",
"args": [
"40"
],
"workingDirectory": "/tmp",
"environment": {
"API_URL": "https://api.test-service.com"
},
"dependsOn": [
"network"
],
"dependsOnOverrides": {
"init_rc.d": {
"remove": [
"*"
],
"add": [
"bumblebee",
"mumbled"
]
},
"init_systemd": {
"add": [
"printer"
]
},
"os_freebsd": {
"add": [
"linux"
]
},
"os_linux": {
"add": [
"bluetooth"
]
}
},
"start": {
"atBoot": true,
"restart": true,
"restartTimeout": 10
},
"logging": {
"stdout": {
"disabled": false,
"useDefault": false,
"value": "/var/log/test-service-stdout.log"
},
"stderr": {
"disabled": false,
"useDefault": false,
"value": "/var/log/test-service-stderr.log"
}
},
"credentials": {
"user": "user",
"group": "group"
}
}
References & CreditsAny missing credits are the author's unconscious error
FAQs
Unknown package
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.