terraform-enterprise-cli 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7be0ff4722fee573ba06f5669c5ff3f06f83d865
-  data.tar.gz: 54d126898d3df4a92ef5bfe6779cb8fe9d1de24f
+  metadata.gz: 4586f6d07044eea0e7a048333a0a42cdf7503ea6
+  data.tar.gz: e0d29b7c1ca286efb612ab63685be5a65c5e97eb
 SHA512:
-  metadata.gz: a36b1e28eb77486f599d46ee4c7be11a362e71f9cfa2ba8c43f2d54aadd7527703adc2cacf8a6be7df894c8f2e1f6b5a1708ce992d88a27da70c105aa3ecf7b2
-  data.tar.gz: 4f22023eb7fc584bbd3382916521378c037d89d462d10c302afa6066eca7a238e89e88fd949cfd41fa8a6b63f506a26fbb1876196b0b09f7355eeb6f38ae0419
+  metadata.gz: a29b53531da11eae5ad04ccbc39c1c57628b66368f8cb2bab04c1c6052d248bd111c6bb2f7e5741e6b2b7325ee86d994a82968e64448b3dad84b8c6fbc9e466b
+  data.tar.gz: 341d1972a76f5aa531a9857d585519777b6c52a2e061e5159c8fac2f449e9ebe9b8373d905e9c70854025a6e091d3dfdd81a6e7100a99dced1a5e263c27ff086

data/README.md

@@ -1,4 +1,5 @@
 # Terraform Enterprise Command Line Tool
+
 A simple command line tool for the [Terraform Enterprise API](https://www.terraform.io/docs/enterprise/api/index.html).
 
 [![Gem Version](https://badge.fury.io/rb/terraform-enterprise-cli.svg)](https://badge.fury.io/rb/terraform-enterprise-cli)
@@ -31,7 +32,7 @@ All of the resources, actions and paraeters are documented in the tool and avail
 
 ### Basic Usage
 
-```shell
+```bash
 ➭ tfe help
 Commands:
   tfe configuration-versions <subcommand>          # Manage configuration versions
@@ -61,6 +62,15 @@ Options:
 
 There are two methods for authenticating the CLI with the Terraform Enterprise API. The first is to use the `TFE_TOKEN` environment variable. The second is to pass in the token on the command line using the `--token` option. The command line option takes precendence over the environment variable.
 
+## Using with Private Terraform Enterprise
+
+The API for the hosted (SaaS) service at app.terraform.io is no different then private TFE. However, the host name must be updated to your private TFE instance. This can be done in one of two ways:
+
+- Set the `TFE_HOST` environment variable to the hostname
+- Set the hostname by passing in the `--host` option on the command line
+
+**NOTE**: The hostname must also include the scheme (e.g. `https://`)
+
 ## Scripting
 
 The CLI is designed to be easy to call from other scripts. A few command line options exist to control the output format to minimize the string parsing needed to extract the desired data from the output:
@@ -107,22 +117,35 @@ The CLI supports managing the various Terraform Enterprise resources exposed via
 
 ### Upload a configuration-version
 
+The configuration version is a resource in Terraform Enterprise which references the terraform configuration used in the run. The `configuration-version` resource must first be created, then a configuration must be uploaded. If you do not need such low-leve control, consider using the `tfe push` command instead.
+
 ```
-tfe configuration-versions upload
+tfe configuration-versions upload <upload-url>
 ```
 
+**Note**: Uploading a new configuration version will also start a new run. This is behavior is implemented by  Terraform Enterprise, not the CLI or Client library.
+
+The `upload-url` is provided in the `upload-url` attribute of the `configuration-version`. It is a very long and unique URL generated to use for uploading the configuration.
+
 ### Upload a Sentinel policy
 
+In Terraform Enterprise the policy resource does not include the content of the policy file. The policy file is managed as another resource. As such, when creating a new policy, you must first create the policy then upload the content of the policy file. You can also upload a new policy file to an existing policy to update it.
+
 ```
-tfe policies upload
+tfe policies upload <path> <policy_id>
 ```
 
+The `path` should refence the `*.sentinel` file which contains the content of the policy.
+
 ### Override a policy check
 
+If a policy fails and it's mode is set as `advisory` or `soft-mandatory` it can be overridden.
+
 ```
-tfe policy-checks override
+tfe policy-checks override <policy-check-id>
 ```
 
+To override the policy you will need the policy check ID. This ID is auto-generated by TFE when the policy check is executed after a successful plan. The Policy Checks can be listed using `tfe policy-checks list --run-id=<run-id>`. The Run ID can be obtained using `tfe runs list --workspace-id=<workspace-id>`.
 
 ### Apply or discard a run
 
@@ -168,6 +191,19 @@ A few command require the run ID. This can be obtained dusing the `tfe runs list
 tfe runs list --workspace-id=<workspace_id> --except status-timestamps permissions actions
 ```
 
+### Push a configuration
+
+The `push` command is a convient command which mimics the functionality of the `terraform push` command which has been deprecated. This command performs a sequence of operations:
+
+1. Generates the tar.gz of the current directory (or the directory set using `--path` option)
+2. Given the organization and workspace name it looks up the workspace ID.
+3. Creates a new configuration-version resource in that workspace
+4. Uploads the configuration to the new configuration-version
+
+```
+tfe push <org>/<workspace>
+```
+
 ## Contribution
 
 Contribution to the CLI is welcome. Opening issues and pull requests is welcome and will be reviewed.
@@ -179,6 +215,16 @@ To run the command line binary locally, use `bundle exec` to execute it with the
 ```
 bundle exec ./bin/tfe
 ```
+
+### Debugging
+
+Operations internal to the CLI and API are instrumented to output additional debug logs if debugging is enabled. The logs will show the HTTP requests and responses.
+
+Debugging can be enabled by:
+
+- Setting the `TFE_DEBUG` environment variable to `true` by `export TFE_DEBUG=true`
+- Passing in the `--debug` option on the command line.
+
 ### Command line design
 
 Basic design principles of the command line interface:
@@ -187,3 +233,7 @@ Basic design principles of the command line interface:
 - Required attributes should be set as parameters (e.g. `tfe workspaces create <name> <email>`
 - Optional attributes should be set as options
 - Relationships (member-of, belongs-to) on resources should be set as options (e.g. `tfe variables list --organization <org> --workspace <workspace>`
+
+### Opening Issues
+
+When opening an issue, please include the version of the CLI you are using. The version can be obtained with the `tfe version` command.

data/lib/terraform_enterprise/command_line/commands/main.rb

@@ -1,4 +1,5 @@
 require 'terraform_enterprise/command_line/command'
+require 'terraform_enterprise/command_line/version'
 
 require_relative 'configuration_versions'
 require_relative 'oauth_tokens'
@@ -77,7 +78,7 @@ module TerraformEnterprise
 
         desc 'version', STRINGS[:version][:commands][:version]
         def version
-          puts "Terraform Enterprise CLI #{VERSION}"
+          puts "Terraform Enterprise CLI #{TerraformEnterprise::CommandLine::VERSION}"
         end
       end
     end

data/lib/terraform_enterprise/command_line/version.rb

@@ -1,5 +1,5 @@
 module TerraformEnterprise
   module CommandLine
-    VERSION = '0.0.9'.freeze
+    VERSION = '0.0.10'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: terraform-enterprise-cli
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Maciej Skierkowski