removed Atlas from TF OSS Docs

This commit is contained in:
Chris Riley 2017-03-23 12:28:10 -07:00 committed by Seth Vargo
parent 04aa0d8ff8
commit dd76ccb579
No known key found for this signature in database
GPG Key ID: C921994F9C27E0FF
22 changed files with 156 additions and 118 deletions

View File

@ -1,21 +1,19 @@
---
layout: "backend-types"
page_title: "Backend Type: atlas"
sidebar_current: "docs-backends-types-standard-atlas"
page_title: "Backend Type: terraform enterprise"
sidebar_current: "docs-backends-types-standard-tfe"
description: |-
Terraform can store the state in Atlas.
Terraform can store the state in Terraform Enterprise
---
# atlas
# terraform enterprise
**Kind: Standard (with no locking)**
Stores the state in [Atlas](https://atlas.hashicorp.com/).
Stores the state in [Terraform Enterprise](https://www.terraform.io/docs/providers/index.html).
You can create a new environment in the
[Environments section](https://atlas.hashicorp.com/environments)
and generate new token in the
[Tokens page](https://atlas.hashicorp.com/settings/tokens) under Settings.
Environments section and generate new token in the Tokens page under Settings.
## Example Configuration
@ -48,5 +46,5 @@ data "terraform_remote_state" "foo" {
The following configuration options / environment variables are supported:
* `name` - (Required) Full name of the environment (`<username>/<name>`)
* `access_token` / `ATLAS_TOKEN` - (Required) Atlas API token
* `address` - (Optional) Address to alternative Atlas location (Atlas Enterprise endpoint)
* `access_token` / `ATLAS_TOKEN` - (Required) Terraform Enterprise API token
* `address` - (Optional) Address to alternative Terraform Enterprise location (Terraform Enterprise endpoint)

View File

@ -41,7 +41,7 @@ Common commands:
init Initialize a new or existing Terraform configuration
output Read an output from a state file
plan Generate and show an execution plan
push Upload this Terraform module to Atlas to run
push Upload this Terraform module to Terraform Enterprise to run
refresh Update local state file against real resources
show Inspect Terraform state or plan
taint Manually mark a resource for recreation

View File

@ -3,25 +3,25 @@ layout: "docs"
page_title: "Command: push"
sidebar_current: "docs-commands-push"
description: |-
The `terraform push` command is used to upload the Terraform configuration to HashiCorp's Atlas service for automatically managing your infrastructure in the cloud.
The `terraform push` command is used to upload the Terraform configuration to HashiCorp's Terraform Enterprise service for automatically managing your infrastructure in the cloud.
---
# Command: push
The `terraform push` command uploads your Terraform configuration to
be managed by HashiCorp's [Atlas](https://atlas.hashicorp.com).
By uploading your configuration to Atlas, Atlas can automatically run
be managed by HashiCorp's [Terraform Enterprise](https://www.hashicorp.com/products/terraform/).
By uploading your configuration to Terraform Enterprise, you can automatically run
Terraform for you, will save all state transitions, will save plans,
and will keep a history of all Terraform runs.
This makes it significantly easier to use Terraform as a team: team
members modify the Terraform configurations locally and continue to
use normal version control. When the Terraform configurations are ready
to be run, they are pushed to Atlas, and any member of your team can
to be run, they are pushed to Terraform Enterprise, and any member of your team can
run Terraform with the push of a button.
Atlas can also be used to set ACLs on who can run Terraform, and a
future update of Atlas will allow parallel Terraform runs and automatically
Terraform Enterprise can also be used to set ACLs on who can run Terraform, and a
future update of Terraform Enterprise will allow parallel Terraform runs and automatically
perform infrastructure locking so only one run is modifying the same
infrastructure at a time.
@ -34,31 +34,31 @@ The `path` argument is the same as for the
The command-line flags are all optional. The list of available flags are:
* `-atlas-address=<url>` - An alternate address to an Atlas instance.
* `-atlas-address=<url>` - An alternate address to an instance.
Defaults to `https://atlas.hashicorp.com`.
* `-upload-modules=true` - If true (default), then the
[modules](/docs/modules/index.html)
being used are all locked at their current checkout and uploaded
completely to Atlas. This prevents Atlas from running `terraform get`
completely. This prevents Terraform Enterprise from running `terraform get`
for you.
* `-name=<name>` - Name of the infrastructure configuration in Atlas.
* `-name=<name>` - Name of the infrastructure configuration in Terraform Enterprise.
The format of this is: "username/name" so that you can upload
configurations not just to your account but to other accounts and
organizations. This setting can also be set in the configuration
in the
[Atlas section](/docs/configuration/atlas.html).
[Terraform Enterprise section](/docs/configuration/tfe.html).
* `-no-color` - Disables output with coloring
* `-overwrite=foo` - Marks a specific variable to be updated on Atlas.
Normally, if a variable is already set in Atlas, Terraform will not
* `-overwrite=foo` - Marks a specific variable to be updated.
Normally, if a variable is already set Terraform will not
send the local value (even if it is different). This forces it to
send the local value to Atlas. This flag can be repeated multiple times.
send the local value to Terraform Enterprise. This flag can be repeated multiple times.
* `-token=<token>` - Atlas API token to use to authorize the upload.
* `-token=<token>` - Terraform Enterprise API token to use to authorize the upload.
If blank or unspecified, the `ATLAS_TOKEN` environment variable
will be used.
@ -88,21 +88,21 @@ The reason Terraform uploads all of these files is because Terraform
cannot know what is and isn't being used for provisioning, so it uploads
all the files to be safe. To exclude certain files, specify the `-exclude`
flag when pushing, or specify the `exclude` parameter in the
[Atlas configuration section](/docs/configuration/atlas.html).
[Terraform Enterprise configuration section](/docs/configuration/tfe.html).
## Terraform Variables
When you `push`, Terraform will automatically set the local values of
your Terraform variables on Atlas. The values are only set if they
don't already exist on Atlas. If you want to force push a certain
your Terraform variables on Terraform Enterprise. The values are only set if they
don't already exist. If you want to force push a certain
variable value to update it, use the `-overwrite` flag.
All the variable values stored on Atlas are encrypted and secured
All the variable values stored are encrypted and secured
using [Vault](https://www.vaultproject.io). We blogged about the
[architecture of our secure storage system](https://www.hashicorp.com/blog/how-atlas-uses-vault-for-managing-secrets.html) if you want more detail.
The variable values can be updated using the `-overwrite` flag or via
the [Atlas website](https://atlas.hashicorp.com). An example of updating
the [Terraform Enterprise website](https://www.hashicorp.com/products/terraform/). An example of updating
just a single variable `foo` is shown below:
```shell
@ -111,7 +111,7 @@ $ terraform push -var 'foo=bar' -overwrite foo
Both the `-var` and `-overwrite` flag are required. The `-var` flag
sets the value locally (the exact same process as commands such as apply
or plan), and the `-overwrite` flag tells the push command to update Atlas.
or plan), and the `-overwrite` flag tells the push command to update Terraform Enterprise.
## Remote State Requirement
@ -122,11 +122,11 @@ configuration to be managed remotely. For it to keep the state in sync
and for you to be able to easily access that state, remote state must
be enabled instead of juggling local files.
While `terraform push` sends your configuration to be managed by Atlas,
the remote state backend _does not_ have to be Atlas. It can be anything
as long as it is accessible by the public internet, since Atlas will need
While `terraform push` sends your configuration to be managed by Terraform Enterprise,
the remote state backend _does not_ have to be Terraform Enterprise. It can be anything
as long as it is accessible by the public internet, since Terraform Enterprise will need
to be able to communicate to it.
**Warning:** The credentials for accessing the remote state will be
sent up to Atlas as well. Therefore, we recommend you use access keys
sent up to Terraform Enterprise as well. Therefore, we recommend you use access keys
that are restricted if possible.

View File

@ -21,7 +21,7 @@ present read-only views into pre-existing data, or they compute
new values on the fly within Terraform itself.
For example, a data source may retrieve artifact information from
Atlas, configuration information from Consul, or look up a pre-existing
Terraform Enterprise, configuration information from Consul, or look up a pre-existing
AWS resource by filtering on its attributes and tags.
Every data source in Terraform is mapped to a provider based

View File

@ -1,21 +1,21 @@
---
layout: "docs"
page_title: "Configuring Atlas"
sidebar_current: "docs-config-atlas"
page_title: "Configuring Terraform Enterprise"
sidebar_current: "docs-config-tfe"
description: |-
Atlas is the ideal way to use Terraform in a team environment. Atlas will run Terraform for you, safely handle parallelization across different team members, save run history along with plans, and more.
Terraform Enterprise is the ideal way to use Terraform in a team environment. Terraform Enterprise will run Terraform for you, safely handle parallelization across different team members, save run history along with plans, and more.
---
# Atlas Configuration
# Terraform Enterprise Configuration
Terraform can be configured to be able to upload to HashiCorp's
[Atlas](https://atlas.hashicorp.com). This configuration doesn't change
[Terraform Enterprise](https://www.hashicorp.com/products/terraform/). This configuration doesn't change
the behavior of Terraform itself, it only configures your Terraform
configuration to support being uploaded to Atlas via the
configuration to support being uploaded to Terraform Enterprise via the
[push command](/docs/commands/push.html).
For more information on the benefits of uploading your Terraform
configuration to Atlas, please see the
configuration to Terraform Enterprise, please see the
[push command documentation](/docs/commands/push.html).
This page assumes you're familiar with the
@ -24,7 +24,7 @@ already.
## Example
Atlas configuration looks like the following:
Terraform Enterprise configuration looks like the following:
```hcl
atlas {
@ -35,7 +35,7 @@ atlas {
## Description
The `atlas` block configures the settings when Terraform is
[pushed](/docs/commands/push.html) to Atlas. Only one `atlas` block
[pushed](/docs/commands/push.html) to Terraform Enterprise. Only one `atlas` block
is allowed.
Within the block (the `{ }`) is configuration for Atlas uploading.

View File

@ -1,7 +1,7 @@
---
layout: "artifacts"
page_title: "Artifact Provider"
sidebar_current: "docs-enterprise-artifact-provider"
sidebar_current: "docs-enterprise-artifacts-provider"
description: |-
Terraform has a provider for managing artifacts called `atlas_artifact`.
---

View File

@ -1,7 +1,7 @@
---
layout: "artifacts"
page_title: "Creating AMI Artifacts"
sidebar_current: "docs-enterprise-artifact-amis"
sidebar_current: "docs-enterprise-artifacts-amis"
description: |-
Creating AMI Artifacts with Packer.
---

View File

@ -1,7 +1,7 @@
---
layout: "artifacts"
page_title: "Terraform Artifacts"
sidebar_current: "docs-enterprise-artifact"
sidebar_current: "docs-enterprise-artifacts"
description: |-
Terraform Enterprise can be used to store artifacts for use by Terraform. Typically, artifacts are stored with Packer.
---

View File

@ -1,7 +1,7 @@
---
layout: "artifacts"
page_title: "Managing Artifact Versions"
sidebar_current: "docs-enterprise-artifact-versions"
sidebar_current: "docs-enterprise-artifacts-versions"
description: |-
Artifacts are versioned and assigned a version number, here is how to manage the versions.
---

View File

@ -8,4 +8,4 @@ description: |-
# Linked Applications
Linked applications have been deprecated in favor of the application build pipeline.
<div class="alert-info">Linked applications have been deprecated in favor of the application build pipeline.</div>

View File

@ -1,7 +1,7 @@
---
layout: "packer"
page_title: "Packer Features in Terraform Enterprise"
sidebar_current: "docs-enterprise-packer"
sidebar_current: "docs-enterprise-packer-index"
description: |-
Packer is a tool for creating images for platforms such as Amazon AWS, OpenStack, VMware, VirtualBox, Docker, and more — all from a single source configuration.
---

View File

@ -73,7 +73,7 @@ You can use the same parameters to GitHub repositories as you can generic Git re
### Private GitHub Repos
If you need Terraform to be able to fetch modules from private GitHub repos on a remote machine (like Atlas or a CI server), you'll need to provide Terraform with credentials that can be used to authenticate as a user with read access to the private repo.
If you need Terraform to be able to fetch modules from private GitHub repos on a remote machine (like Terraform Enterprise or a CI server), you'll need to provide Terraform with credentials that can be used to authenticate as a user with read access to the private repo.
First, create a [machine user](https://developer.github.com/guides/managing-deploy-keys/#machine-users) on GitHub with read access to the private repo in question, then embed this user's credentials into the `source` parameter:

View File

@ -9,13 +9,14 @@ description: |-
# Providers
Terraform is used to create, manage, and manipulate infrastructure resources.
Examples of resources include physical machines, VMs, network switches, containers,
etc. Almost any infrastructure noun can be represented as a resource in Terraform.
Examples of resources include physical machines, VMs, network switches,
containers, etc. Almost any infrastructure noun can be represented as a resource
in Terraform.
Terraform is agnostic to the underlying platforms by supporting providers. A
provider is responsible for understanding API interactions and exposing
resources. Providers generally are an IaaS (e.g. AWS, GCP, Microsoft Azure,
OpenStack), PaaS (e.g. Heroku), or SaaS services (e.g. Atlas, DNSimple,
Cloudflare).
OpenStack), PaaS (e.g. Heroku), or SaaS services (e.g. Terraform Enterprise,
DNSimple, CloudFlare).
Use the navigation to the left to read about the available providers.

View File

@ -1,9 +1,9 @@
---
layout: "atlas"
page_title: "Atlas: atlas_artifact"
sidebar_current: "docs-atlas-data-artifact"
layout: "tfe"
page_title: "Terraform Enterprise: atlas_artifact"
sidebar_current: "docs-tfe-data-artifact"
description: |-
Provides a data source to deployment artifacts managed by Atlas. This can
Provides a data source to deployment artifacts managed by Terraform Enterprise. This can
be used to dynamically configure instantiation and provisioning
of resources.
---
@ -11,7 +11,7 @@ description: |-
# atlas_artifact
Provides a [Data Source](/docs/configuration/data-sources.html) to access to deployment
artifacts managed by Atlas. This can be used to dynamically configure instantiation
artifacts managed by Terraform Enterprise. This can be used to dynamically configure instantiation
and provisioning of resources.
## Example Usage
@ -45,7 +45,7 @@ resource "aws_instance" "app" {
The following arguments are supported:
* `name` - (Required) Name of the artifact in Atlas. This is given
* `name` - (Required) Name of the artifact in Terraform Enterprise. This is given
in slug format like "organization/artifact".
* `type` - (Required) The type of artifact to query for.
@ -56,7 +56,7 @@ The following arguments are supported:
matching artifact in any build, or a specific number to pin to that
build. If `build` and `version` are unspecified, `version` will default
to "latest". Cannot be specified with `version`. Note: `build` is only
present if Atlas builds the image.
present if Terraform Enterpris builds the image.
* `version` - (Optional) The version of the artifact to filter on. This can
be "latest", to match against the latest version, "any" to find a matching artifact
@ -85,4 +85,4 @@ The following attributes are exported:
to replace any characters that are invalid in a resource name with a hyphen.
For example, the "region.us-east-1" key will become "region-us-east-1".
* `version_real` - The matching version of the artifact
* `slug` - The artifact slug in Atlas
* `slug` - The artifact slug in Terraform Enterprise

View File

@ -0,0 +1,43 @@
---
layout: "tfe"
page_title: "Provider: Terraform Enterprise"
sidebar_current: "docs-tfe-index"
description: |-
The Terraform Enterprise provider is used to interact with configuration,
artifacts, and metadata managed by the Terraform Enterprise service.
---
# Terraform Enterprise Provider
The Terraform Enterprise provider is used to interact with resources, configuration,
artifacts, and metadata managed by [Terraform Enterprise](https://www.terraform.io/docs/providers/index.html).
The provider needs to be configured with the proper credentials before
it can be used.
Use the navigation to the left to read about the available resources.
## Example Usage
```
# Configure the Atlas provider
provider "atlas" {
token = "${var.atlas_token}"
}
# Fetch an artifact configuration
data "atlas_artifact" "web" {
# ...
}
```
## Argument Reference
The following arguments are supported:
* `address` - (Optional) Terrafrom Enterprise server endpoint. Defaults to public Terraform Enterprise.
This is only required when using an on-premise deployment of Terraform Enterprise. This can
also be specified with the `ATLAS_ADDRESS` shell environment variable.
* `token` - (Required) API token. This can also be specified with the
`ATLAS_TOKEN` shell environment variable.

View File

@ -1,9 +1,9 @@
---
layout: "atlas"
page_title: "Atlas: atlas_artifact"
sidebar_current: "docs-atlas-resource-artifact"
layout: "tfe"
page_title: "Terraform Enterprise: atlas_artifact"
sidebar_current: "docs-tfe-resource-artifact"
description: |-
Provides access to deployment artifacts managed by Atlas. This can
Provides access to deployment artifacts managed by Terraform Enterprise. This can
be used to dynamically configure instantiation and provisioning
of resources.
---
@ -14,8 +14,9 @@ Provides access to deployment artifacts managed by Atlas. This can
be used to dynamically configure instantiation and provisioning
of resources.
!> **This resource is deprecated!** Use the
[Atlas Artifact Data Source](/docs/providers/atlas/d/artifact.html)
~> **This resource is deprecated!** Please use the
[Artifact Data Source](/docs/providers/tfe/d/artifact.html)
## Example Usage
@ -48,7 +49,7 @@ resource "aws_instance" "app" {
The following arguments are supported:
* `name` - (Required) Name of the artifact in Atlas. This is given
* `name` - (Required) Name of the artifact in Terraform Enterprise. This is given
in slug format like "organization/artifact".
* `type` - (Required) The type of artifact to query for.
@ -59,7 +60,7 @@ The following arguments are supported:
matching artifact in any build, or a specific number to pin to that
build. If `build` and `version` are unspecified, `version` will default
to "latest". Cannot be specified with `version`. Note: `build` is only
present if Atlas builds the image.
present if Terraform Enterprise builds the image.
* `version` - (Optional) The version of the artifact to filter on. This can
be "latest", to match against the latest version, "any" to find a matching artifact
@ -88,4 +89,4 @@ The following attributes are exported:
to replace any characters that are invalid in a resource name with a hyphen.
For example, the "region.us-east-1" key will become "region-us-east-1".
* `version_real` - The matching version of the artifact
* `slug` - The artifact slug in Atlas
* `slug` - The artifact slug in Terraform Enterprise

View File

@ -14,7 +14,7 @@ complicated since it is a frequent source of merge conflicts. Remote state
helps alleviate these issues.
With remote state, Terraform stores the state in a remote store. Terraform
supports storing state in [Atlas](https://atlas.hashicorp.com),
supports storing state in [Terraform Enterprise](https://www.hashicorp.com/products/terraform/),
[Consul](https://www.consul.io), S3, and more.
Remote state is a feature of [backends](/docs/backends). Configuring and
@ -48,7 +48,7 @@ Terraform will automatically lock state depending on the
[backend](/docs/backends) used. Please see the full page dedicated
to [state locking](/docs/state/locking.html).
[Atlas by HashiCorp](https://atlas.hashicorp.com) is a commercial offering
[Terraform Enterprise by HashiCorp](https://www.hashicorp.com/products/terraform/) is a commercial offering
that in addition to locking supports remote operations that allow you to
safely queue Terraform operations in a central location. This enables
teams to safely modify infrastructure concurrently.

View File

@ -6,16 +6,16 @@
<a href="/docs/enterprise/index.html">&laquo; Terraform Enterprise</a>
</li>
<li<%= sidebar_current(/^docs-enterprise-artifact-/) %>>
<li<%= sidebar_current(/^docs-enterprise-artifacts-/) %>>
<a href="/docs/enterprise/artifacts/index.html">Artifact</a>
<ul class="nav nav-visible">
<li<%= sidebar_current("docs-enterprise-artifact-provider") %>>
<li<%= sidebar_current("docs-enterprise-artifacts-provider") %>>
<a href="/docs/enterprise/artifacts/artifact-provider.html">Artifact Provider</a>
</li>
<li<%= sidebar_current("docs-enterprise-artifact-versions") %>>
<li<%= sidebar_current("docs-enterprise-artifacts-versions") %>>
<a href="/docs/enterprise/artifacts/managing-versions.html">Managing Versions</a>
</li>
<li<%= sidebar_current("docs-enterprise-artifact-amis") %>>
<li<%= sidebar_current("docs-enterprise-artifacts-amis") %>>
<a href="/docs/enterprise/artifacts/creating-amis.html">Creating AMI Artifacts</a>
</li>
</ul>

View File

@ -1,35 +0,0 @@
<% wrap_layout :inner do %>
<% content_for :sidebar do %>
<ul class="nav docs-sidenav">
<li>
<a class="back" href="/docs/providers/index.html">All Providers</a>
</li>
<li<%= sidebar_current("docs-atlas-index") %>>
<a class="back" href="/docs/providers/atlas/index.html">Atlas Provider</a>
</li>
<h4>Data Sources</h4>
<li<%= sidebar_current("docs-atlas-data") %>>
<ul class="nav nav-visible">
<li<%= sidebar_current("docs-atlas-data-artifact") %>>
<a href="/docs/providers/atlas/d/artifact.html">atlas_artifact</a>
</li>
</ul>
</li>
<h4>Resources</h4>
<li<%= sidebar_current("docs-atlas-resource") %>>
<ul class="nav nav-visible">
<li<%= sidebar_current("docs-atlas-resource-artifact") %>>
<a href="/docs/providers/atlas/r/artifact.html">atlas_artifact</a>
</li>
</ul>
</li>
</ul>
<% end %>
<%= yield %>
<% end %>

View File

@ -53,6 +53,9 @@
<li<%= sidebar_current("docs-backends-types-standard-swift") %>>
<a href="/docs/backends/types/swift.html">swift</a>
</li>
<li<%= sidebar_current("docs-backends-types-standard-tfe") %>>
<a href="/docs/backends/types/tfe.html">terraform enterprise</a>
</li>
</ul>
</li>
</ul>

View File

@ -48,8 +48,8 @@
<a href="/docs/configuration/terraform.html">Terraform</a>
</li>
<li<%= sidebar_current("docs-config-atlas") %>>
<a href="/docs/configuration/atlas.html">Atlas</a>
<li<%= sidebar_current("docs-config-tfe") %>>
<a href="/docs/configuration/tfe.html">Terraform Enterprise</a>
</li>
<li<%= sidebar_current("docs-config-environment-variables") %>>
@ -196,8 +196,8 @@
<a href="/docs/providers/arukas/index.html">Arukas</a>
</li>
<li<%= sidebar_current("docs-providers-atlas") %>>
<a href="/docs/providers/atlas/index.html">Atlas</a>
<li<%= sidebar_current("docs-providers-tfe") %>>
<a href="/docs/providers/tfe/index.html">Terraform Enterprise</a>
</li>
<li<%= sidebar_current("docs-providers-aws") %>>

View File

@ -0,0 +1,27 @@
<% wrap_layout :inner do %>
<% content_for :sidebar do %>
<ul class="nav docs-sidenav">
<li>
<a class="back" href="/docs/providers/index.html">All Providers</a>
</li>
<li<%= sidebar_current("docs-tfe-index") %>>
<a class="back" href="/docs/providers/tfe/index.html">Terraform Enterprise Provider</a>
</li>
<h4>Data Sources</h4>
<li<%= sidebar_current("docs-tfe-data-artifact") %>>
<a href="/docs/providers/tfe/d/artifact.html">atlas_artifact</a>
</li>
<h4>Resources</h4>
<li<%= sidebar_current("docs-tfe-resource-artifact") %>>
<a href="/docs/providers/tfe/r/artifact.html">atlas_artifact</a>
</li>
</ul>
<% end %>
<%= yield %>
<% end %>