cookbook 'vsts_agent', '= 1.1.1'
vsts_agent (16) Versions 1.1.1 Follow4
Installs/Configures visualstudio team services build agents
cookbook 'vsts_agent', '= 1.1.1', :supermarket
knife supermarket install vsts_agent
knife supermarket download vsts_agent
Visual Studio Team Services Build and Release Agent Cookbook
Installs and configures Visual Studio Team Services Build and Release Agent
Please check Wiki for more examples
Requirements
- Chef 12 or higher
Platforms
The following platforms are tested and supported:
- Debian 8 x64 (Jessie)
- Ubuntu 16.04
- Windows 10
- Mac OS X 10.11.4
Attributes
-
node['vsts_agent']['binary']['version']
- set version of package to install -
node['vsts_agent']['prerequisites']['osx']['install']
- control osx dependencies installation. Default true -
node['vsts_agent']['prerequisites']['debian']['install']
- control debian dependencies installation. Default true
Resource/Provider
vsts_agent
This resource installs and configures the vsts build and release agent
Actions
-
:install
: Install and configure the agent -
:remove
: Remove the agent and unregister it from VSTS -
:restart
: Restart the agent service
Parameters
-
agent_name
: Name attribute. The name of the vsts agent -
version
: an agent version to install. Default version from an attribute -
install_dir
: A target directory to install the vsts agent -
path
: Overwrite system PATH environment variable values. Linux and Mac OS X only -
env
: Additional environment variables. Linux and Mac OS X only -
user
: Set a local user to run the vsts agent -
group
: Set a local group to run the vsts agent -
runasservice
: run agent as a service. Default 'true' -
windowslogonaccount
: Set a user name to run a windows service. Possible values are "NT AUTHORITY\NetworkService", "NT AUTHORITY\LocalService" or any system valid username -
windowslogonpassword
: Set password for windowslogonaccount unless it is equal to NetworkService or LocalService -
vsts_url
: url to VSTS instance -
vsts_pool
: A pool to connect an agent -
vsts_auth
: Authentication type. Valid options are PAT (Personal Access Token), Negotiate (Kerberos or NTLM), Integrated (Windows default credentials) and ALT (Alternate Credentials). Default PAT auth -
vsts_token
: A personal access token for VSTS. Used with PAT auth type. See -
vsts_username
: A user to connect to VSTS. Used with Negotiate and ALT auth -
vsts_password
: A user to connect to VSTS. Used with Negotiate and ALT auth -
work_folder
: Set different workspace location. Default is "install_dir/_work"
Examples
Install, configure, restart and remove an agent.
Check [windows](test/cookbooks/windows-basic/recipes/default.rb), [debian](test/cookbooks/debian-basic/recipes/default.rb) or [osx](test/cookbooks/osx-basic/recipes/default.rb) tests for more examples.
include_recipe 'vsts_agent::default' if platform_family?('windows') dir = 'c:\\agents' else dir = '/tmp/agents' end vsts_agent 'agent_01' do install_dir dir user 'vagrant' group 'vagrant' path '/usr/local/bin/:/usr/bin:/opt/bin/' # only works on nix systems env('M2_HOME' => '/opt/maven', 'JAVA_HOME' => '/opt/java') # only works on nix systems vsts_url 'https://contoso.visualstudio.com' vsts_pool 'default' vsts_token 'my_secret_token_from_vsts' windowslogonaccount 'builder' # will be used only on windows windowslogonpassword 'Pas$w0r_d' # will be used only on windows action :install end vsts_agent 'agent_01' do action :restart end vsts_agent 'agent_01' do vsts_token 'my_secret_token_from_vsts' action :remove end
How to contribute
Check [Contribution Guide](CONTRIBUTING.md) and [Testing Guide](TESTING.md)
Dependent cookbooks
windows >= 0.0.0 |
ark >= 0.0.0 |
seven_zip ~> 2.0.0 |
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
Collaborator Number Metric
1.1.1 failed this metric
Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.
Foodcritic Metric
1.1.1 failed this metric
FC021: Resource condition in provider may not behave as expected: /tmp/052716e784e0e48232eddad5/vsts_agent/providers/default.rb:24
1.1.1 failed this metric
1.1.1 failed this metric
FC021: Resource condition in provider may not behave as expected: /tmp/052716e784e0e48232eddad5/vsts_agent/providers/default.rb:24