Fixed typos and broken links in TFE docs
This commit is contained in:
parent
7571ca6c6f
commit
04aa0d8ff8
|
@ -3,12 +3,12 @@ layout: "api"
|
||||||
page_title: "Configuration Versions API"
|
page_title: "Configuration Versions API"
|
||||||
sidebar_current: "docs-enterprise-api-configversions"
|
sidebar_current: "docs-enterprise-api-configversions"
|
||||||
description: |-
|
description: |-
|
||||||
A configuration version represents versions of Terrraform configuration.
|
A configuration version represents versions of Terraform configuration.
|
||||||
---
|
---
|
||||||
|
|
||||||
# Configuration Versions API
|
# Configuration Versions API
|
||||||
|
|
||||||
A configuration version represents versions of Terrraform configuration.
|
A configuration version represents versions of Terraform configuration.
|
||||||
Each set of changes to Terraform HCL files or the scripts
|
Each set of changes to Terraform HCL files or the scripts
|
||||||
used in the files should have an associated configuration version.
|
used in the files should have an associated configuration version.
|
||||||
|
|
||||||
|
@ -38,7 +38,7 @@ to include the necessary variables for the Terraform configuration.
|
||||||
|
|
||||||
### Actions
|
### Actions
|
||||||
|
|
||||||
The following actions can be perfomed on this resource.
|
The following actions can be performed on this resource.
|
||||||
|
|
||||||
<dl>
|
<dl>
|
||||||
<dt>Create</dt>
|
<dt>Create</dt>
|
||||||
|
|
|
@ -3,12 +3,12 @@ layout: "api"
|
||||||
page_title: "Terraform Configuration API"
|
page_title: "Terraform Configuration API"
|
||||||
sidebar_current: "docs-enterprise-api-configurations"
|
sidebar_current: "docs-enterprise-api-configurations"
|
||||||
description: |-
|
description: |-
|
||||||
A configuration respresents settings associated with a resource that runs Terraform with versions of Terraform configuration..
|
A configuration represents settings associated with a resource that runs Terraform with versions of Terraform configuration..
|
||||||
---
|
---
|
||||||
|
|
||||||
# Terraform Configuration API
|
# Terraform Configuration API
|
||||||
|
|
||||||
A configuration respresents settings associated with a resource that
|
A configuration represents settings associated with a resource that
|
||||||
runs Terraform with versions of Terraform configuration.
|
runs Terraform with versions of Terraform configuration.
|
||||||
|
|
||||||
Configurations have many [configuration versions](/docs/enterprise/api/configuration-versions.html)
|
Configurations have many [configuration versions](/docs/enterprise/api/configuration-versions.html)
|
||||||
|
@ -40,7 +40,7 @@ configuration.
|
||||||
|
|
||||||
### Actions
|
### Actions
|
||||||
|
|
||||||
The following actions can be perfomed on this resource.
|
The following actions can be performed on this resource.
|
||||||
|
|
||||||
<dl>
|
<dl>
|
||||||
<dt>Show</dt>
|
<dt>Show</dt>
|
||||||
|
@ -63,7 +63,7 @@ Creates a configuration with the provided attributes.
|
||||||
|
|
||||||
#### Retrieving a configuration
|
#### Retrieving a configuration
|
||||||
|
|
||||||
Returns the JSON respresentation of the latest configuration.
|
Returns the JSON representation of the latest configuration.
|
||||||
|
|
||||||
$ curl %{ATLAS_URL}/api/v1/terraform/configurations/%{DEFAULT_USERNAME}/test/versions/latest \
|
$ curl %{ATLAS_URL}/api/v1/terraform/configurations/%{DEFAULT_USERNAME}/test/versions/latest \
|
||||||
-H "X-Atlas-Token: $ATLAS_TOKEN"
|
-H "X-Atlas-Token: $ATLAS_TOKEN"
|
||||||
|
|
|
@ -24,7 +24,7 @@ This documentation covers the environment interactions with Terraform.
|
||||||
<tr>
|
<tr>
|
||||||
<td><code>variables</code></td>
|
<td><code>variables</code></td>
|
||||||
<td>A key/value map of Terraform variables to be updated. Existing
|
<td>A key/value map of Terraform variables to be updated. Existing
|
||||||
variables will only be removed when their value is empty. Varaibles
|
variables will only be removed when their value is empty. Variables
|
||||||
of the same key will be overwritten.</td>
|
of the same key will be overwritten.</td>
|
||||||
<td>Yes</td>
|
<td>Yes</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
@ -39,11 +39,11 @@ This documentation covers the environment interactions with Terraform.
|
||||||
|
|
||||||
### Actions
|
### Actions
|
||||||
|
|
||||||
The following actions can be perfomed on this resource.
|
The following actions can be performed on this resource.
|
||||||
|
|
||||||
<dl>
|
<dl>
|
||||||
<dt>Update variables</dt>
|
<dt>Update variables</dt>
|
||||||
<dd>PUT /api/v1/enviromments/:username/:name/variables</dd>
|
<dd>PUT /api/v1/environments/:username/:name/variables</dd>
|
||||||
</dl>
|
</dl>
|
||||||
|
|
||||||
### Examples
|
### Examples
|
||||||
|
|
|
@ -20,7 +20,7 @@ or requests for new API features please email [support@hashicorp.com](mailto:sup
|
||||||
## Authentication
|
## Authentication
|
||||||
|
|
||||||
All requests must be authenticated with an `X-Atlas-Token` HTTP header. This
|
All requests must be authenticated with an `X-Atlas-Token` HTTP header. This
|
||||||
token can be generated or revoked on the [account tokens page](/settings/tokens).
|
token can be generated or revoked on the account tokens page.
|
||||||
Your token will have access to all resources your account has access to.
|
Your token will have access to all resources your account has access to.
|
||||||
|
|
||||||
For organization level resources, we recommend creating a separate user account
|
For organization level resources, we recommend creating a separate user account
|
||||||
|
|
|
@ -31,11 +31,11 @@ can be configured to auto-apply to avoid this.
|
||||||
|
|
||||||
### Actions
|
### Actions
|
||||||
|
|
||||||
The following actions can be perfomed on this resource.
|
The following actions can be performed on this resource.
|
||||||
|
|
||||||
<dl>
|
<dl>
|
||||||
<dt>Queue a run</dt>
|
<dt>Queue a run</dt>
|
||||||
<dd>POST /api/v1/enviromments/:username/:name/plan</dd>
|
<dd>POST /api/v1/environments/:username/:name/plan</dd>
|
||||||
</dl>
|
</dl>
|
||||||
|
|
||||||
### Examples
|
### Examples
|
||||||
|
|
|
@ -27,7 +27,7 @@ State represents the status of your infrastructure at the last time Terraform wa
|
||||||
|
|
||||||
### Actions
|
### Actions
|
||||||
|
|
||||||
The following actions can be perfomed on this resource.
|
The following actions can be performed on this resource.
|
||||||
|
|
||||||
<dl>
|
<dl>
|
||||||
<dt>Get a list of states accessible to a user</dt>
|
<dt>Get a list of states accessible to a user</dt>
|
||||||
|
|
|
@ -11,13 +11,13 @@ description: |-
|
||||||
Users are both users and organizations in Terraform Enterprise. They are the
|
Users are both users and organizations in Terraform Enterprise. They are the
|
||||||
parent resource of all resources.
|
parent resource of all resources.
|
||||||
|
|
||||||
Currently, only the retrieval of users is avaiable on the API. Additionally,
|
Currently, only the retrieval of users is available on the API. Additionally,
|
||||||
only Vagrant box resources will be listed. Boxes will
|
only Vagrant box resources will be listed. Boxes will
|
||||||
be returned based on permissions over the organization, or user.
|
be returned based on permissions over the organization, or user.
|
||||||
|
|
||||||
### Actions
|
### Actions
|
||||||
|
|
||||||
The following actions can be perfomed on this resource.
|
The following actions can be performed on this resource.
|
||||||
|
|
||||||
<dl>
|
<dl>
|
||||||
<dt>Show</dt>
|
<dt>Show</dt>
|
||||||
|
|
|
@ -11,4 +11,4 @@ description: |-
|
||||||
|
|
||||||
Currently, the best way to create AWS AMI artifacts is with Packer.
|
Currently, the best way to create AWS AMI artifacts is with Packer.
|
||||||
|
|
||||||
We detail how to do this in the [Packer section of the documentation](https://atlas.hashicorp.com/help/packer/artifacts/creating-amis).
|
We detail how to do this in the [Packer section of the documentation](/docs/enterprise/packer/artifacts/creating-amis.html).
|
||||||
|
|
|
@ -172,7 +172,7 @@ stores artifacts, be it images or IDs for cloud provider images.
|
||||||
|
|
||||||
### Run
|
### Run
|
||||||
|
|
||||||
A run epresents a two step Terraform plan and a subsequent apply.
|
A run represents a two step Terraform plan and a subsequent apply.
|
||||||
|
|
||||||
### Service
|
### Service
|
||||||
|
|
||||||
|
|
|
@ -89,7 +89,7 @@ For `vagrant.box` type artifacts, you can specify keys in the metadata block:
|
||||||
- `version`: This is the Vagrant box version and is constrained to the
|
- `version`: This is the Vagrant box version and is constrained to the
|
||||||
same formatting as in the web UI: `*.*.*` _(optional, but required for boxes
|
same formatting as in the web UI: `*.*.*` _(optional, but required for boxes
|
||||||
with multiple providers). The version will increment on the minor version if left blank (e.g the initial version will be set to 0.1.0, the subsequent version will be set to 0.2.0)._
|
with multiple providers). The version will increment on the minor version if left blank (e.g the initial version will be set to 0.1.0, the subsequent version will be set to 0.2.0)._
|
||||||
- `description`: This is the desciption that will be shown with the
|
- `description`: This is the description that will be shown with the
|
||||||
version of the box. You can use Markdown for links and style. _(optional)_
|
version of the box. You can use Markdown for links and style. _(optional)_
|
||||||
|
|
||||||
## Example
|
## Example
|
||||||
|
|
|
@ -28,8 +28,8 @@ Terraform Enterprise currently supports running the following Packer builders:
|
||||||
|
|
||||||
### Files
|
### Files
|
||||||
|
|
||||||
All files in the uploading package (via [Packer push or GitHub](/help/packer/builds/starting)),
|
All files in the uploading package (via [Packer push or GitHub](/docs/enterprise/packer/builds/starting.html)),
|
||||||
and the application from the [build pipeline](/help/applications/build-pipeline) are available on the filesystem
|
and the application from the build pipeline are available on the filesystem
|
||||||
of the build environment.
|
of the build environment.
|
||||||
|
|
||||||
You can use the file icon on the running build to show a list of
|
You can use the file icon on the running build to show a list of
|
||||||
|
@ -55,7 +55,7 @@ We encourage use of relative paths over absolute paths to maintain portability
|
||||||
between Terraform Enterprise and local builds.
|
between Terraform Enterprise and local builds.
|
||||||
|
|
||||||
The total size of all files in the package being uploaded via
|
The total size of all files in the package being uploaded via
|
||||||
[Packer push or GitHub](/help/packer/builds/starting) must be 5 GB or less.
|
[Packer push or GitHub](/docs/enterprise/packer/builds/starting.html) must be 5 GB or less.
|
||||||
|
|
||||||
If you need to upload objects that are larger, such as dmgs, see the
|
If you need to upload objects that are larger, such as dmgs, see the
|
||||||
[`packer push` "Limits" documentation](https://packer.io/docs/command-line/push.html)
|
[`packer push` "Limits" documentation](https://packer.io/docs/command-line/push.html)
|
||||||
|
@ -91,7 +91,7 @@ Additionally, the following environment variables are automatically injected. Al
|
||||||
- `ATLAS_BUILD_USERNAME` - This is the username associated with the build
|
- `ATLAS_BUILD_USERNAME` - This is the username associated with the build
|
||||||
(e.g. `"sammy"`)
|
(e.g. `"sammy"`)
|
||||||
- `ATLAS_BUILD_CONFIGURATION_VERSION` - This is the unique, auto-incrementing
|
- `ATLAS_BUILD_CONFIGURATION_VERSION` - This is the unique, auto-incrementing
|
||||||
version for the [Packer build configuration](/help/glossary) (e.g. `"34"`).
|
version for the [Packer build configuration](/docs/enterprise/glossary/index.html) (e.g. `"34"`).
|
||||||
- `ATLAS_BUILD_GITHUB_BRANCH` - This is the name of the branch
|
- `ATLAS_BUILD_GITHUB_BRANCH` - This is the name of the branch
|
||||||
that the associated Packer build configuration version was ingressed from
|
that the associated Packer build configuration version was ingressed from
|
||||||
(e.g. `master`).
|
(e.g. `master`).
|
||||||
|
|
|
@ -24,7 +24,7 @@ more builds by configuring the various components of Packer
|
||||||
- Applications that use the build as part of the pipeline and merged into the version prior to running Packer on it
|
- Applications that use the build as part of the pipeline and merged into the version prior to running Packer on it
|
||||||
|
|
||||||
When a new version of Packer configuration and associated
|
When a new version of Packer configuration and associated
|
||||||
scripts from GitHub or `packer push` is recieved, it automatically starts a new
|
scripts from GitHub or `packer push` is received, it automatically starts a new
|
||||||
Packer build. That Packer build runs in an isolated machine environment with the contents
|
Packer build. That Packer build runs in an isolated machine environment with the contents
|
||||||
of that version available to it.
|
of that version available to it.
|
||||||
|
|
||||||
|
|
|
@ -8,7 +8,7 @@ description: |-
|
||||||
|
|
||||||
# Installing Software
|
# Installing Software
|
||||||
|
|
||||||
Please review the [Packer Build Environment](/docs/enterprise/builds/build-environment.html)
|
Please review the [Packer Build Environment](/docs/enterprise/packer/builds/build-environment.html)
|
||||||
specification for important information on isolation, security, and hardware
|
specification for important information on isolation, security, and hardware
|
||||||
limitations before continuing.
|
limitations before continuing.
|
||||||
|
|
||||||
|
|
|
@ -17,7 +17,7 @@ run Packer for you, creating any artifacts and sending the appropriate
|
||||||
notifications.
|
notifications.
|
||||||
|
|
||||||
If your artifacts are used in any other environments and you have activated
|
If your artifacts are used in any other environments and you have activated
|
||||||
the plan on aritfact upload feature, this may also queue Terraform
|
the plan on artifact upload feature, this may also queue Terraform
|
||||||
plans.
|
plans.
|
||||||
|
|
||||||
This feature is useful for maintenance of images and automatic updates,
|
This feature is useful for maintenance of images and automatic updates,
|
||||||
|
|
|
@ -14,10 +14,10 @@ are all possible. Below is a list of debugging options you can use.
|
||||||
|
|
||||||
### Verbose Packer Logging
|
### Verbose Packer Logging
|
||||||
|
|
||||||
You can [set a variable](/help/packer/builds/build-environment#environment-variables) in the UI that increases the logging verbosity
|
You can [set a variable](/docs/enterprise/packer/builds/build-environment.html#environment-variables) in the UI that increases the logging verbosity
|
||||||
in Packer. Set the `PACKER_LOG` key to a value of `1` to accomplish this.
|
in Packer. Set the `PACKER_LOG` key to a value of `1` to accomplish this.
|
||||||
|
|
||||||
After setting the variable, you'll need to [rebuild](/help/packer/builds/rebuilding).
|
After setting the variable, you'll need to [rebuild](/docs/enterprise/packer/builds/rebuilding.html).
|
||||||
|
|
||||||
Verbose logging will be much louder than normal Packer logs and isn't
|
Verbose logging will be much louder than normal Packer logs and isn't
|
||||||
recommended for day-to-day operations. Once enabled, you'll be able to
|
recommended for day-to-day operations. Once enabled, you'll be able to
|
||||||
|
@ -36,7 +36,7 @@ Things to pay attention to when this happens:
|
||||||
|
|
||||||
- SSH credentials must be properly configured. AWS keypairs should
|
- SSH credentials must be properly configured. AWS keypairs should
|
||||||
match, SSH usernames should be correct, passwords should match, etc.
|
match, SSH usernames should be correct, passwords should match, etc.
|
||||||
- Any VM preseed configuration should have the same SSH configuration
|
- Any VM pre-seed configuration should have the same SSH configuration
|
||||||
as your template defines
|
as your template defines
|
||||||
|
|
||||||
A good way to debug this is to manually attempt to use the same SSH
|
A good way to debug this is to manually attempt to use the same SSH
|
||||||
|
@ -46,10 +46,10 @@ more about [debugging Packer builds](https://packer.io/docs/other/debugging.html
|
||||||
### Hardware Limitations
|
### Hardware Limitations
|
||||||
|
|
||||||
Your build may be failing by requesting larger memory or
|
Your build may be failing by requesting larger memory or
|
||||||
disk usage then is available. Read more about the [build environment](/docs/enterprise/packer/builds/build-environment#hardware-limitations).
|
disk usage then is available. Read more about the [build environment](/docs/enterprise/packer/builds/build-environment.html#hardware-limitations).
|
||||||
|
|
||||||
_Typically_ Packer builds that fail due to requesting hardware limits
|
_Typically_ Packer builds that fail due to requesting hardware limits
|
||||||
that exceed Terraform Enterprise's [hardware limitations](/docs/enterprise/packer/builds/build-environment#hardware-limitations)
|
that exceed Terraform Enterprise's [hardware limitations](/docs/enterprise/packer/builds/build-environment.html#hardware-limitations)
|
||||||
will fail with a _The operation was canceled_ error message as shown below:
|
will fail with a _The operation was canceled_ error message as shown below:
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
|
@ -15,5 +15,5 @@ source configuration.
|
||||||
This is a list of features specific to Packer that Terraform Enterprise provides.
|
This is a list of features specific to Packer that Terraform Enterprise provides.
|
||||||
|
|
||||||
- [Running Packer Builds](/docs/enterprise/packer/builds/index.html)
|
- [Running Packer Builds](/docs/enterprise/packer/builds/index.html)
|
||||||
- [Creating and Uploading AMIs](/docs/enterprise/packer/artifacts/creating-amis/index.html)
|
- [Creating and Uploading AMIs](/docs/enterprise/packer/artifacts/creating-amis.html)
|
||||||
- [Creating Vagrant Boxes](/docs/enterprise/packer/artifacts/creating-vagrant-boxes/index.html)
|
- [Creating Vagrant Boxes](/docs/enterprise/packer/artifacts/creating-vagrant-boxes.html)
|
||||||
|
|
|
@ -8,6 +8,6 @@ description: |-
|
||||||
|
|
||||||
# User Accounts in Terraform Enterprise
|
# User Accounts in Terraform Enterprise
|
||||||
|
|
||||||
Users are the main identity system in Terrafgorm Enterprise. A user can
|
Users are the main identity system in Terraform Enterprise. A user can
|
||||||
be a member of multiple [organizations](/docs/enterprise/organizations), as well as individually collaborate on various resources.
|
be a member of multiple [organizations](/docs/enterprise/organizations), as well as individually collaborate on various resources.
|
||||||
|
|
||||||
|
|
|
@ -561,15 +561,15 @@
|
||||||
<li<%= sidebar_current("docs-enterprise-packer") %>>
|
<li<%= sidebar_current("docs-enterprise-packer") %>>
|
||||||
<a href="/docs/enterprise/packer/index.html">Packer</a>
|
<a href="/docs/enterprise/packer/index.html">Packer</a>
|
||||||
</li>
|
</li>
|
||||||
|
<li<%= sidebar_current("docs-enterprise-api") %>>
|
||||||
|
<a href="/docs/enterprise/api/index.html">API</a>
|
||||||
|
</li>
|
||||||
<li<%= sidebar_current("docs-enterprise-accounts") %>>
|
<li<%= sidebar_current("docs-enterprise-accounts") %>>
|
||||||
<a href="/docs/enterprise/user-accounts/index.html">User Accounts</a>
|
<a href="/docs/enterprise/user-accounts/index.html">User Accounts</a>
|
||||||
</li>
|
</li>
|
||||||
<li<%= sidebar_current("docs-enterprise-organizations") %>>
|
<li<%= sidebar_current("docs-enterprise-organizations") %>>
|
||||||
<a href="/docs/enterprise/organizations/index.html">Organizations</a>
|
<a href="/docs/enterprise/organizations/index.html">Organizations</a>
|
||||||
</li>
|
</li>
|
||||||
<li<%= sidebar_current("docs-enterprise-api") %>>
|
|
||||||
<a href="/docs/enterprise/api/index.html">API</a>
|
|
||||||
</li>
|
|
||||||
<li<%= sidebar_current("docs-enterprise-billing") %>>
|
<li<%= sidebar_current("docs-enterprise-billing") %>>
|
||||||
<a href="/docs/enterprise/billing/index.html">Billing</a>
|
<a href="/docs/enterprise/billing/index.html">Billing</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
@ -10,7 +10,7 @@
|
||||||
<a href="/docs/enterprise/faq/index.html">FAQ</a>
|
<a href="/docs/enterprise/faq/index.html">FAQ</a>
|
||||||
<ul class="nav nav-visible">
|
<ul class="nav nav-visible">
|
||||||
<li<%= sidebar_current("docs-enterprise-faq-monolithic") %>>
|
<li<%= sidebar_current("docs-enterprise-faq-monolithic") %>>
|
||||||
<a href="/docs/enterprise/faq/monolithic-artifacts.html">Monolithing Artifacts</a>
|
<a href="/docs/enterprise/faq/monolithic-artifacts.html">Monolithic Artifacts</a>
|
||||||
</li>
|
</li>
|
||||||
<li<%= sidebar_current("docs-enterprise-faq-deployments") %>>
|
<li<%= sidebar_current("docs-enterprise-faq-deployments") %>>
|
||||||
<a href="/docs/enterprise/faq/rolling-deployments.html">Rolling Deployments</a>
|
<a href="/docs/enterprise/faq/rolling-deployments.html">Rolling Deployments</a>
|
||||||
|
|
Loading…
Reference in New Issue