cookbook 'vsts_agent_macos', '~> 2.1.2'
vsts_agent_macos (12) Versions 2.1.2 Follow2
A dedicated cookbook for configuring an Azure DevOps build or release agent on macOS.
cookbook 'vsts_agent_macos', '~> 2.1.2', :supermarket
knife supermarket install vsts_agent_macos
knife supermarket download vsts_agent_macos
Azure DevOps Build and Release Agent Cookbook for macOS
Visual Studio Team Services is now Azure DevOps Services
We're working on the best way to rename the cookbook and recipes while maintaining backwards compatibility.
Recipes
Bootstrap
Usage: vsts_agent_macos::bootstrap
Add the node to the agent pool or deployment group.
Teardown
Usage: vsts_agent_macos::teardown
Remove an existing agent from the build pool or deployment group.
Attributes
Agent Name
The name of the agent.
Default value: node['hostname']
default['vsts_agent']['agent_name']
Agent Version
The version of the agent to install.
Default value: '2.144.0'
default['vsts_agent']['version']
Agent Pool
The name of the agent pool you wish to add the agent to.
Default value: American Hanko's Agents
default['vsts_agent']['agent_pool']
Organization Name
The name of your Azure DevOps organization. (i.e. 'americanhanko' in https://dev.azure.com/americanhanko
)
Default value: americanhanko
default['vsts_agent']['account']
Admin User
The username of an adminstrator on the macOS system.
Default value: 'vagrant'
default['vsts_agent']['admin_user']
Agent Home Directory
The location that contains all builds, source, release, etc.
Default value: '/Users/#{node['vsts_agent']['admin_user']}/vsts-agent'
default['vsts_agent']['agent_home']
Additional Environment Variables
An optional hash may be set to pass environment variables to the agent. The agent
will then be configured with these environment variables which it will then
report back to the servers.
Default value: {}
default['vsts_agent']['additional_environment']
Deployment Group
This cookbook supports adding agents to Azure DevOps deployment groups. To use this feature, simply
set the default['vsts_agent']['deployment_group']
attribute. In addition, make sure you have
the appropriate values set for the following attributes shown below. By default, we assume that
if the default['vsts_agent']['deployment_group']
attribute is nil
, we are bootstrapping
a build agent and not a deployment agent. This means if you set this attribute, it will
override the default functionality. You may optionally specifiy deployment group tags using
default['vsts_agent']['deployment_group_tags']
.
default['vsts_agent']['deployment_group'] = nil default['vsts_agent']['project'] = nil default['vsts_agent']['work'] = nil default['vsts_agent']['deployment_group_tags'] = nil
Authentication
This cookbook uses a personal access token
to authenticate to your organization on the Azure DevOps servers. The cookbook allows access to the token via either an attribute, within a data bag or using a chef vault item.
Plaintext Attribute
Example:
default['vsts_agent']['pat'] = '0fbdebc988934add98179ddaae019a01711'
Data Bag or Chef Vault Item
Name your vault or bag and corresponding item whatever you like and
make sure to set the corresponding attributes to reference it
accordingly:
Example:
default['vsts_agent']['data_bag'] = 'tea_bag' default['vsts_agent']['data_bag_item'] = 'green_tea'
However, it must contain a personal_access_token
key with
the token itself as the value. The token must have rights to read and modify
build agents. The permissions are selected at the time of the PAT creation, which
you can read more about here.
Example:
{ "id": "vsts_build_agent", "personal_access_token": "iu8tfaxxrhce7yeu434yo9zfjtxif3jygzk24wegi855er2moobs" }
Dependent cookbooks
chef-vault ~> 3.1.1 |
homebrew ~> 5.0.0 |
tar ~> 2.1.0 |
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
Collaborator Number Metric
2.1.2 passed this metric
Contributing File Metric
2.1.2 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
2.1.2 passed this metric
No Binaries Metric
2.1.2 passed this metric
Testing File Metric
2.1.2 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
2.1.2 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
2.1.2 passed this metric
2.1.2 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
2.1.2 passed this metric
No Binaries Metric
2.1.2 passed this metric
Testing File Metric
2.1.2 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
2.1.2 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
2.1.2 passed this metric
2.1.2 passed this metric
Testing File Metric
2.1.2 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
2.1.2 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
2.1.2 failed this metric
2.1.2 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number