Skip to content

Latest commit

 

History

History
138 lines (91 loc) · 4.01 KB

nixsvc.md

File metadata and controls

138 lines (91 loc) · 4.01 KB
Raw

Running As A Service On Unix and OSX

Key Points:

  • This is a convenience which only creates OS specific service files.
  • SystemD is used on Linux. Ubuntu 16 LTS, Redhat 7.1 has SystemD
  • SystemD requires sudo so all scripts below must be called with sudo. OSX does not.

Managing the Service

./svc.sh was generated to manage your service

Install

Install will create a LaunchAgent plist on OSX or a systemd unit file on Linux

$ ./svc.sh install
...
Creating runsvc.sh
Creating .Service
svc install complete

Service files point to ./runsvc.sh which will setup the environment and start the agents host. See Environment section below.

Start

$ sudo ./svc.sh start

starting vsts.agent.bryanmac.testsvc
status vsts.agent.bryanmac.testsvc:

/Users/bryanmac/Library/LaunchAgents/vsts.agent.bryanmac.testsvc.plist

Started:
25324 0 vsts.agent.bryanmac.testsvc

Status

$ sudo ./svc.sh status

status vsts.agent.bryanmac.testsvc:

/Users/bryanmac/Library/LaunchAgents/vsts.agent.bryanmac.testsvc.plist

Started:
25324 0 vsts.agent.bryanmac.testsvc

Left number is the pid if the service is running

Stop

$ sudo ./svc.sh stop

stopping vsts.agent.bryanmac.testsvc
status vsts.agent.bryanmac.testsvc:

/Users/bryanmac/Library/LaunchAgents/vsts.agent.bryanmac.testsvc.plist

Stopped

Uninstall

NOTE: Stop is a separate command with launchd (script is a thin wrapper). You likely want to stop before uninstalling.

$ sudo ./svc.sh uninstall

OSX Auto Logon and Lock

On OSX the convenience default is to create the service as a LaunchAgent. A LaunchAgent runs when the user logs which gives it access to the UI for UI tests. If you want it start when the box reboots, you can configure it to auto logon that account and lock on startup.

Auto Logon and Lock

Setting the Environment

When you install and/or configure tools, your path is often setup or other environment variables are set. Examples are PATH, JAVA_HOME, ANT_HOME, MYSQL_PATH etc...

If your environment changes at any time, you can run env.sh and it will update your path. You can also manually edit .env file. Changes are retained.

Stop and start the service for changes to take effect.

$ ./env.sh 
$ sudo ./svc.sh stop
...
Stopped

$ sudo ./svc.sh start
...
Started:
15397 0 vsts.agent.bryanmac.testsvc2

Environment

Configuring as a service will snapshot off your PATH and other "interesting variables" like LANG, JAVA_HOME etc.. When the service starts, it will read these and set. This allows for unified environment management between

$ ls -la
-rwxrwx---    1 bryanmac  staff   189 May 29 11:42 .agent
-rwxrwx---    1 bryanmac  staff   106 May 29 11:41 .credentials
-rw-r--r--    1 bryanmac  staff    58 May 29 11:44 .env
-rw-r--r--    1 bryanmac  staff   187 May 29 11:40 .path
...
-rwxr-xr-x    1 bryanmac  staff   546 May 29 11:40 env.sh

Run ./env.sh to update.

You can also inject anything you want to run when the service runs. For example setting up environment, calling other scripts etc...

./runsvc.sh

# insert anything to setup env when running as a service

Service Files

This is a convenience that simply creates a service file for you can sets permissions. You are free to manually configure and control your service using alternate methods.

Details are in .service file in root of the agent

OSX LaunchAgent: ~/Library/LaunchAgents/vsts.agent.{accountName}.{agentName}.plist Linux SystemD: /etc/systemd/system/vsts.agent.{accountName}.{agentName}.service

These files are created from a template located

OSX: ./bin/vsts.agent.plist.template Linux: ./bin/vsts.agent.service.template

For example, on OSX you could use that template to run as a launch daemon if you are not needing UI tests and/or don't want to configure auto logon lock. Details Here