vaguerent/website/source/docs/push/atlas.html.md
Seth Vargo 5093f3120e Merge docs and www into a single static site
This is a big commit, and I apologize in advance for the future
git-blames all pointing to me. This commit does a few things:

1.  Merges the website/docs and website/www repo into a single website repo
    to be in line with other HashiCorp projects
2.  Updates to use middleman-hashicorp
3.  Converts less to scss to be in line with other projects
4.  Updates page styles to be in line with other projects
5.  Optimizes images
6.  Prepare for S3 + Fastly deployment with scripts, etc.
7.  Removes blog posts (they have been transferred to hashicorp.com with
    redirects in place
8.  Updated sitemap generation script for better SEO
9.  Fixed many broken links
10. Add description to all fields
2016-01-19 14:35:05 -05:00

2.4 KiB

layout page_title sidebar_current description
docs Vagrant Push - Atlas Strategy push-atlas Atlas is HashiCorp's commercial offering to bring your Vagrant development environments to production. The Vagrant Push Atlas strategy pushes your application's code to HashiCorp's Atlas service.

Vagrant Push

Atlas Strategy

Atlas is HashiCorp's commercial offering to bring your Vagrant development environments to production. You can read more about HashiCorp's Atlas and all its features on the Atlas homepage. The Vagrant Push Atlas strategy pushes your application's code to HashiCorp's Atlas service.

The Vagrant Push Atlas strategy supports the following configuration options:

  • app - The name of the application in HashiCorp's Atlas. If the application does not exist, it will be created with user confirmation.

  • exclude - Add a file or file pattern to exclude from the upload, relative to the dir. This value may be specified multiple times and is additive. exclude take precedence over include values.

  • include - Add a file or file pattern to include in the upload, relative to the dir. This value may be specified multiple times and is additive.

  • dir - The base directory containing the files to upload. By default this is the same directory as the Vagrantfile, but you can specify this if you have a src folder or bin folder or some other folder you want to upload.

  • vcs - If set to true, Vagrant will automatically use VCS data to determine the files to upload. Uncommitted changes will not be deployed.

Additionally, the following options are exposed for power users of the Vagrant Atlas push strategy. Most users will not require these options:

  • address - The address of the Atlas server to upload to. By default this will be the public Atlas server.

  • token - The Atlas token to use. If the user has run vagrant login, this will the token generated by that command. If the environment variable ATLAS_TOKEN is set, the uploader will use this value. By default, this is nil.

Usage

The Vagrant Push Atlas strategy is defined in the Vagrantfile using the atlas key:

config.push.define "atlas" do |push|
  push.app = "username/application"
end

And then push the application to Atlas:

$ vagrant push