From 8194846d8631c09487879828b7f872880199e561 Mon Sep 17 00:00:00 2001 From: Seth Vargo Date: Tue, 3 Feb 2015 17:37:55 -0500 Subject: [PATCH] Update push command docs to remove `-token` --- .../docs/command-line/push.html.markdown | 39 +++++++++++-------- 1 file changed, 23 insertions(+), 16 deletions(-) diff --git a/website/source/docs/command-line/push.html.markdown b/website/source/docs/command-line/push.html.markdown index 10165cc22..177892150 100644 --- a/website/source/docs/command-line/push.html.markdown +++ b/website/source/docs/command-line/push.html.markdown @@ -7,27 +7,34 @@ description: |- # Command-Line: Push -The `packer push` Packer command takes a template and pushes it to a build -service. The build service will automatically build your Packer template and -expose the artifacts. +The `packer push` Packer command takes a template and pushes it to a Packer +build service such as [HashiCorp's Atlas](https://atlas.hashicorp.com). The +build service will automatically build your Packer template and expose the +artifacts. -This command currently only sends templates to -[Atlas](https://atlas.hashicorp.com) by HashiCorp, but the command will -be pluggable in the future with alternate implementations. - -External build services such as Atlas make it easy to iterate on Packer -templates, especially when the builder you're running may not be easily +External build services such as HashiCorp's Atlas make it easy to iterate on +Packer templates, especially when the builder you are running may not be easily accessable (such as developing `qemu` builders on Mac or Windows). -For the `push` command to work, the -[push configuration](/docs/templates/push.html) +For the `push` command to work, the [push configuration](/docs/templates/push.html) must be completed within the template. ## Options -* `-create=true` - If the build configuration matching the name of the push - doesn't exist, it will be created if this is true. This defaults to true. +* `-token` - An access token for authenticating the push to the Packer build + service such as Atlas. This can also be specified within the push + configuration in the template. -* `-token=FOO` - An access token for authenticating the push. This can also - be specified within the push configuration in the template. By setting this - in the template, you can take advantage of user variables. +## Examples + +Push a Packer template: + +```shell +$ packer push template.json +``` + +Push a Packer template with a custom token: + +```shell +$ packer push -token ABCD1234 template.json +```