More auth docs
This commit is contained in:
parent
338b9da27e
commit
10edf881fc
|
@ -33,7 +33,9 @@ The `docker` driver supports the following configuration in the job spec:
|
||||||
|
|
||||||
* `image` - The Docker image to run. The image may include a tag or custom URL
|
* `image` - The Docker image to run. The image may include a tag or custom URL
|
||||||
and should include `https://` if required. By default it will be fetched from
|
and should include `https://` if required. By default it will be fetched from
|
||||||
Docker Hub.
|
Docker Hub. If the image to be pulled exists in a registry that requires
|
||||||
|
authentication credentials must be provided to Nomad. Please see the
|
||||||
|
[Authentication section](#authentication).
|
||||||
|
|
||||||
```hcl
|
```hcl
|
||||||
config {
|
config {
|
||||||
|
@ -201,6 +203,7 @@ The `docker` driver supports the following configuration in the job spec:
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
* `volume_driver` - (Optional) The name of the volume driver used to mount
|
* `volume_driver` - (Optional) The name of the volume driver used to mount
|
||||||
volumes. Must be used along with `volumes`.
|
volumes. Must be used along with `volumes`.
|
||||||
Using a `volume_driver` also allows to use `volumes` with a named volume as
|
Using a `volume_driver` also allows to use `volumes` with a named volume as
|
||||||
|
@ -232,7 +235,9 @@ This is not configurable.
|
||||||
### Authentication
|
### Authentication
|
||||||
|
|
||||||
If you want to pull from a private repo (for example on dockerhub or quay.io),
|
If you want to pull from a private repo (for example on dockerhub or quay.io),
|
||||||
you will need to specify credentials in your job via the `auth` option.
|
you will need to specify credentials in your job via the `auth` option or by
|
||||||
|
storing the credentials in a file and setting the
|
||||||
|
[docker.auth.config](#auth_file) value on the client.
|
||||||
|
|
||||||
The `auth` object supports the following keys:
|
The `auth` object supports the following keys:
|
||||||
|
|
||||||
|
@ -389,8 +394,9 @@ options](/docs/agent/configuration/client.html#options):
|
||||||
to customize this if you use a non-standard socket (HTTP or another
|
to customize this if you use a non-standard socket (HTTP or another
|
||||||
location).
|
location).
|
||||||
|
|
||||||
* `docker.auth.config` - Allows an operator to specify a JSON file which is in
|
* `docker.auth.config` <a id="auth_file"></a>- Allows an operator to specify a
|
||||||
the dockercfg format containing authentication information for a private registry.
|
JSON file which is in the dockercfg format containing authentication
|
||||||
|
information for a private registry.
|
||||||
|
|
||||||
* `docker.tls.cert` - Path to the server's certificate file (`.pem`). Specify
|
* `docker.tls.cert` - Path to the server's certificate file (`.pem`). Specify
|
||||||
this along with `docker.tls.key` and `docker.tls.ca` to use a TLS client to
|
this along with `docker.tls.key` and `docker.tls.ca` to use a TLS client to
|
||||||
|
|
Loading…
Reference in New Issue