Add a Nomad environment
Nomad support in Portainer is provided through the use of the Portainer Edge Agent.
To add a Nomad environment, click on Environments then click the Add environment button.
![](https://docs.portainer.io/~gitbook/image?url=https%3A%2F%2F1004065720-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FQ9EPCYBx6l34QfUrfWiJ%252Fuploads%252FRkDXKQGsQifovBUBvjIy%252F2.14-environments-add.gif%3Falt%3Dmedia%26token%3D3ef556d4-e24c-4bed-8d13-fb2bac14e95f&width=768&dpr=4&quality=100&sign=c8e2bd2d&sv=1)
Select Nomad as your environment type and click Start Wizard. Enter the environment details using the table below as a guide.
Field | Overview |
---|---|
Name | Enter a name for your environment. |
Portainer server URL | Enter the URL and port of your Portainer Server instance as it will be seen from your Nomad environment. If using a FQDN, ensure that DNS is properly configured to provide this. |
![](https://docs.portainer.io/~gitbook/image?url=https%3A%2F%2F1004065720-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FQ9EPCYBx6l34QfUrfWiJ%252Fuploads%252FYXHXN9MoJuI4ya0sDTiK%252F2.14-environments-add-nomad-details.png%3Falt%3Dmedia%26token%3D77690030-dc79-4eb5-9f26-2dc716ba8192&width=768&dpr=4&quality=100&sign=c38e98b0&sv=1)
As an optional step you can expand the More settings section and adjust the Poll frequency for the environment - this defines how often this Edge Agent will check the Portainer Server for new jobs. The default is every 5 seconds. You can also categorize the environment by adding it to a group or tagging it for better searchability.
![](https://docs.portainer.io/~gitbook/image?url=https%3A%2F%2F1004065720-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FQ9EPCYBx6l34QfUrfWiJ%252Fuploads%252FtlMk7MGPNj1AAivbXQB3%252F2.14-environments-add-edge-metadata.png%3Falt%3Dmedia%26token%3Da8f0e186-d0a8-441d-96f7-9bb1b297cb8d&width=768&dpr=4&quality=100&sign=8b37126d&sv=1)
When you're ready, click Create. Then complete the new fields that have appeared using the table below as a guide.
Field/Option | Overview |
---|---|
Nomad Authentication Enabled | Toggle this on if your Nomad installation has ACL enabled (recommended). |
Nomad Token | If the above toggle is on, this field is displayed. Enter the Secret ID from your Nomad installation. |
TLS | Toggle this on if your Nomad installation uses TLS. |
Environment variables | Enter a comma separated list of environment variables that will be sourced from the host where the agent is deployed and provided to the agent. |
Allow self-signed certs | Toggle this on to allow self-signed certificates when the agent is connecting to Portainer via HTTPS. |
![](https://docs.portainer.io/~gitbook/image?url=https%3A%2F%2F1004065720-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FQ9EPCYBx6l34QfUrfWiJ%252Fuploads%252FDaW8XQjomziMOqSqHzh8%252F2.14-environments-add-nomad-details-2.png%3Falt%3Dmedia%26token%3Dccbbd12e-9c74-4320-8c3d-2b77081ba23f&width=768&dpr=4&quality=100&sign=5300b144&sv=1)
Copy the generated command based on your settings and run it on your Nomad environment to deploy the Edge Agent.
If you have set a custom AGENT_SECRET
on your Portainer Server instance you must remember to explicitly provide this when deploying your Edge Agent.
If you have another Nomad environment to deploy you can click Add another environment to do so. If you have any other non-Nomad environments to configure click Next to proceed, otherwise click Close to return to the list of environments.
Last updated