website: update docs for provider key [GH-2099]
This commit is contained in:
parent
f259e7352a
commit
58b430d7ef
@ -9,11 +9,11 @@ description: |-
|
|||||||
|
|
||||||
Type: `atlas`
|
Type: `atlas`
|
||||||
|
|
||||||
The Atlas post-processor for Packer receives an artifact from a Packer build and uploads it to Atlas. [Atlas](https://atlas.hashicorp.com) hosts and serves artifacts, allowing you to version and distribute them in a simple way.
|
The Atlas post-processor for Packer receives an artifact from a Packer build and uploads it to Atlas. [Atlas](https://atlas.hashicorp.com) hosts and serves artifacts, allowing you to version and distribute them in a simple way.
|
||||||
|
|
||||||
## Workflow
|
## Workflow
|
||||||
|
|
||||||
To take full advantage of Packer and Atlas, it's important to understand the
|
To take full advantage of Packer and Atlas, it's important to understand the
|
||||||
workflow for creating artifacts with Packer and storing them in Atlas using this post-processor. The goal of the Atlas post-processor is to streamline the distribution of public or private artifacts by hosting them in a central location in Atlas.
|
workflow for creating artifacts with Packer and storing them in Atlas using this post-processor. The goal of the Atlas post-processor is to streamline the distribution of public or private artifacts by hosting them in a central location in Atlas.
|
||||||
|
|
||||||
Here is an example workflow:
|
Here is an example workflow:
|
||||||
@ -25,17 +25,17 @@ Here is an example workflow:
|
|||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
The configuration allows you to specify and access the artifact in Atlas.
|
The configuration allows you to specify and access the artifact in Atlas.
|
||||||
|
|
||||||
### Required:
|
### Required:
|
||||||
|
|
||||||
* `token` (string) - Your access token for the Atlas API.
|
* `token` (string) - Your access token for the Atlas API.
|
||||||
This can be generated on your [tokens page](https://atlas.hashicorp.com/settings/tokens). Alternatively you can export your Atlas token as an environmental variable and remove it from the configuration.
|
This can be generated on your [tokens page](https://atlas.hashicorp.com/settings/tokens). Alternatively you can export your Atlas token as an environmental variable and remove it from the configuration.
|
||||||
|
|
||||||
* `artifact` (string) - The shorthand tag for your artifact that maps to
|
* `artifact` (string) - The shorthand tag for your artifact that maps to
|
||||||
Atlas, i.e `hashicorp/foobar` for `atlas.hashicorp.com/hashicorp/foobar`. You must
|
Atlas, i.e `hashicorp/foobar` for `atlas.hashicorp.com/hashicorp/foobar`. You must
|
||||||
have access to the organization, hashicorp in this example, in order to add an artifact to
|
have access to the organization, hashicorp in this example, in order to add an artifact to
|
||||||
the organization in Atlas.
|
the organization in Atlas.
|
||||||
|
|
||||||
* `artifact_type` (string) - For uploading AMIs to Atlas, `artifact_type` will always be `aws.ami`.
|
* `artifact_type` (string) - For uploading AMIs to Atlas, `artifact_type` will always be `aws.ami`.
|
||||||
This field must be defined because Atlas can host other artifact types, such as Vagrant boxes.
|
This field must be defined because Atlas can host other artifact types, such as Vagrant boxes.
|
||||||
@ -48,7 +48,9 @@ The configuration allows you to specify and access the artifact in Atlas.
|
|||||||
is useful if you're using Atlas Enterprise in your own network. Defaults
|
is useful if you're using Atlas Enterprise in your own network. Defaults
|
||||||
to `https://atlas.hashicorp.com/api/v1`.
|
to `https://atlas.hashicorp.com/api/v1`.
|
||||||
|
|
||||||
* `metadata` (map) - Send metadata about the artifact.
|
* `metadata` (map) - Send metadata about the artifact. If the artifact
|
||||||
|
type is "vagrant.box", you must specify a "provider" metadata about
|
||||||
|
what provider to use.
|
||||||
|
|
||||||
### Example Configuration
|
### Example Configuration
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user