distelli.yml file provides authentication credentials for automated use of the Pipelines agent and the Pipelines CLI.
Using distelli.yml with Pipelines agent
The distelli.yml file allows automated installation of the Pipelines agent. To use this feature:
- Create the file in the appropriate location.
- Add the correct credentials.
- Install the Pipelines agent.
When the agent installs, it will use the specified credentials to add the server to the specified Puppet Pipelines account. You can also specify options to automate adding the server to specific environments.
To use the distelli.yml for automating authentication and installation features of the Pipelines agent, the distelli.yml may be placed in the /etc directory.
In a Windows environment, the distelli.yml may be placed in the %SystemDrive%.
To use the distelli.yml for authenticating the Pipelines agent, use this syntax:
distelli agent install -conf /etc/distelli.yml
Using distelli.yml with the Pipelines CLI
To use the distelli.yml for automating authentication with the Pipelines CLI, the distelli.yml file may be placed in the user’s home directory.
To view an example of this, see Auto-deploy from your CI platform.
To use the distelli.yml for authenticating the Pipelines CLI, use this syntax:
distelli login -conf ~/distelli.yml
Formatting the distelli.yml file
Here is an example file. Access token and secret key are required. All other fields are optional.
DistelliAccessToken: '12345678901234567890123456' DistelliSecretKey: '1234567890123456789012345678901234567' Environments: - ENVIRONMENT1 - ENVIRONMENT2 BuildCapabilities: - Docker - SFOIntranet IsBuildServer: true
Required. When using the distelli.yml file, the following fields are required:
DistelliAccessToken: This is the access token associated with a specific Puppet Pipelines account. Provide this, and the secret key, to have the Pipelines agent automatically connect the server to a Puppet Pipelines account on agent installation.
DistelliSecretKey: This is the secret key associated with a specific Pipelines account. Provide this to have the Pipelines agent automatically connect the server to a Puppet Pipelines account on agent installation.
These fields are tied to a Puppet Pipelines account. Ensure you are using the correct account when retrieving these values.
- Click the gear icon from the top right.
- Click the Agent icon on the left.
- Under Secret Key click the Show button.
Here you will find the Access Token and Secret Key. Add them to the distelli.yml. For example:
DistelliAccessToken: '12345678901234567890123456' DistelliSecretKey: '1234567890123456789012345678901234567'
With this file in place, when you do a Pipelines agent install, you will not be prompted for manual entry of your email credentials. Instead the agent will use the credentials in the distelli.yml file to connect the server to a Puppet Pipelines account.
Optional. This section of the file allows the user to specify application environment(s) that the server should be automatically be added to when installing the Pipelines agent.
You can specify one or more application environments for this server to join automatically when installing the Pipelines agent and using a distelli.yml. This assumes the environment(s) specified belong to the Puppet Pipelines account associated with the agent access token and secret key.
This feature is enabled in the Environments: section of the
Environments: - ENVIRONMENT1 - ENVIRONMENT2
Important: If the environment setting “Auto Deploy the Active Release when a new Server joins this environment” is enabled (checked) and there is an active release, an auto deploy will occur when servers join an environment using distelli.yml. For more information, see Environment Settings.
Specifying the capabilities of build servers
Optional. In this section of the build server, you can specify any capabilities that should be associated with a server on which you’re installing the Pipelines agent.
BuildCapabilities: - Docker - SFOIntranet
BuildCapabilities are case-sensitive strings. These capabilities are used in conjunction with your application’s build server capability requirements to schedule builds on a particular subset of servers that have required dependencies.
Specifying whether servers are build servers
Optional. In this section of the distelli.yml file, you can specify whether the server on which you’re installing the Pipelines agent should be marked as a build server. Mark new servers as build servers by setting IsBuildServer: to true.
If you set IsBuildServer to false, the next time the distelli.yml file is read, servers previously marked as build servers will have this designation removed.