status-im
/
infra-role-winsw
mirror of https://github.com/status-im/infra-role-winsw.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

readme: fill out management section 

Signed-off-by: Jakub Sokołowski <jakub@status.im>
This commit is contained in:
Jakub Sokołowski 2021-07-16 17:42:37 +02:00
parent 3e9020c7d0
commit 0464ffc817
No known key found for this signature in database
GPG Key ID: 4EF064D0E6D63020
1 changed files with 24 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -4,13 +4,13 @@ This role configures a Windows service using [WinSW](https://github.com/winsw/wi
# Configuration
Theare two configuration formats available: [XML](https://github.com/winsw/winsw/blob/v2.11.0/doc/xmlConfigFile.md) and [YAML](https://github.com/winsw/winsw/blob/v2.11.0/doc/yamlConfigFile.md).
The are two configuration formats available: [XML](https://github.com/winsw/winsw/blob/v2.11.0/doc/xmlConfigFile.md) and [YAML](https://github.com/winsw/winsw/blob/v2.11.0/doc/yamlConfigFile.md).
We chose YAML because it's more readable for humans and easier to edit.
A bare minimum configuration would look like this:
```yaml
winsw_service_id: 'jenkins-agent'
winsw_service_name: 'Jenkins Agent'
winsw_service_name: 'Jenkins JNLP'
winsw_service_description: 'JNLP Agent service'
winsw_service_user: 'jenkins'
winsw_service_exe_url: 'https://example.org/jenkins-agent.jar'
@ -23,7 +23,28 @@ You can also just specify `winsw_service_exe_path` if there's no need to downloa
# Management
TODO
Services are managed with a WinSW binary that is a wrapper around the actual service process.
That same binary can be used to install, start, stop, restart, and uninstall the service:
```
admin@windows-01 MINGW64 .../jenkins-agent
$ ls -l
total 25188
-rw-r--r-- 1 admin 197121 0 Jul 16 14:49 jenkins-agent.err.log
-rwxr-xr-x 1 admin 197121 655872 Jul 16 14:37 jenkins-agent.exe*
-rw-r--r-- 1 admin 197121 13911763 Jul 16 15:40 jenkins-agent.out.log
-rw-r--r-- 1 admin 197121 2158 Jul 16 14:49 jenkins-agent.wrapper.log
-rw-r--r-- 1 admin 197121 1254 Jul 16 14:37 jenkins-agent.yml
admin@windows-01 MINGW64 .../jenkins-agent
$ ./jenkins-agent.exe stop
2021-07-16 15:41:20,750 INFO - Stopping service 'Jenkins JNLP (jenkins-agent)'...
2021-07-16 15:41:20,771 INFO - Service 'Jenkins JNLP (jenkins-agent)' stopped successfully.
admin@windows-01 MINGW64 .../jenkins-agent
$ ./jenkins-agent.exe start
2021-07-16 15:41:24,960 INFO - Starting service 'Jenkins JNLP (jenkins-agent)'...
2021-07-16 15:41:24,972 INFO - Service 'Jenkins JNLP (jenkins-agent)' has already started.
```
# Known Issues