terraform-enterprise-cli 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 0bf7418e797b81d541470d89264240735c739c42514ef345c4594d5162570883
-  data.tar.gz: 962772ffeaaec2c33920b4f6bf9c9b65528ab37d4b1019afe73092222dc89708
+SHA1:
+  metadata.gz: 7be0ff4722fee573ba06f5669c5ff3f06f83d865
+  data.tar.gz: 54d126898d3df4a92ef5bfe6779cb8fe9d1de24f
 SHA512:
-  metadata.gz: aa77a6d7f90efce7a99d2ac01ab576b36db9298e49ead87be6b8d495ba33f5a4a9931aa01631f610e54be8fc08c6233ecc6e39e3fdb2afe3485046c6a9250b34
-  data.tar.gz: 55528a8b1695cb7b5065ee51f1fa8b999b170f540d8d41b17758f8cebf8d712aaa2da5b7889b0264fa57e0e826be4c35eeefc2bfc0744cef4e89b6bf822febea
+  metadata.gz: a36b1e28eb77486f599d46ee4c7be11a362e71f9cfa2ba8c43f2d54aadd7527703adc2cacf8a6be7df894c8f2e1f6b5a1708ce992d88a27da70c105aa3ecf7b2
+  data.tar.gz: 4f22023eb7fc584bbd3382916521378c037d89d462d10c302afa6066eca7a238e89e88fd949cfd41fa8a6b63f506a26fbb1876196b0b09f7355eeb6f38ae0419

data/README.md

@@ -21,6 +21,10 @@ This gem depends on these other gems for usage at runtime:
 
 Installing the gem `terraform-enterprise-cli` gem installs the `tfe` command line tool. Running `tfe help` provides the help information and list of available subcomands.
 
+## Releases
+
+All releases and changelogs are available as [Releases/Tags](https://github.com/skierkowski/terraform-enterprise-cli/releases).
+
 ## Usage
 
 All of the resources, actions and paraeters are documented in the tool and available through the `help` subcommand.
@@ -30,13 +34,27 @@ All of the resources, actions and paraeters are documented in the tool and avail
 ```shell
 ➭ tfe help
 Commands:
-  tfe configuration_versions <subcommand>  # Manage configuration versions
-  tfe help [COMMAND]                       # Describe available commands or one specific command
-  tfe oauth_tokens <subcommand>            # Manage OAuth tokens
-  tfe organizations <subcommand>           # Manage organizations
-  tfe teams <subcommand>                   # Manage teams
-  tfe variables <subcommand>               # Manage variables
-  tfe workspaces <subcommand>              # Manage workspaces
+  tfe configuration-versions <subcommand>          # Manage configuration versions
+  tfe help [COMMAND]                               # Describe available commands or one specific command
+  tfe oauth-tokens <subcommand>                    # Manage OAuth tokens
+  tfe organizations <subcommand>                   # Manage organizations
+  tfe policies <subcommand>                        # Manage policies
+  tfe policy-checks <subcommand>                   # Manage policy checks
+  tfe push <organization>/<workspace> --path=PATH  # Pushes the configuration to the workspace
+  tfe runs <subcommand>                            # Manage runs
+  tfe teams <subcommand>                           # Manage teams
+  tfe variables <subcommand>                       # Manage variables
+  tfe workspaces <subcommand>                      # Manage workspaces
+
+Options:
+  [--host=HOST]             # Set host address for private Terraform Enterprise
+  [--token=TOKEN]           # Set the auth token, defaults to TFE_TOKEN environment variable
+  [--color], [--no-color]   # If disabled the ANSI color codes will not be used
+  [--except=one two three]  # List of fields that should not be displayed
+  [--only=one two three]    # List of fields that should be displayed
+  [--all], [--no-all]       # Return all fields, not just summary
+  [--value], [--no-value]   # Only return the value; i.e. do not show keys
+  [--debug], [--no-debug]   # Show debug logs
 ```
 
 ## Authentication
@@ -54,6 +72,102 @@ The CLI is designed to be easy to call from other scripts. A few command line op
 - `--value` (Boolean, default: false): The output text by default shows the key and values for each field. If this option is enabled only the value of the fields will be returned. This is particularly useful if you would like to obtain the id of a newly created resource (e.g. `tfe workspcaces create new-ws --organization my-organization --only name --value` would return only the name of the created workspace)
 - `--no-table` (Boolean, default: false): For `list` subcommands format the output as a list of key/value paris instead of formatting the list in a table. 
 
+## Commands
+
+### Help
+
+Get the list of all all commands and subcommands, and global options:
+
+`tfe help`
+
+Get the help information for a particular subcommand. For example, you can see all the operations on workspaces by running `tfe help workspaces` or `tfe workspaces help`.
+
+`tfe help <subcommand>`
+`tfe <subcommand> help`
+
+Get help information, including the options, for a specific command. For example, to get help on listing workspcaes you can use `tfe workspaces help list`
+
+`tfe <subcommand> help <command>`
+
+### Managing TFE Resources
+
+The CLI supports managing the various Terraform Enterprise resources exposed via the TFE API. Below is a table of all the subcommands and the commands for each for performing CRUD operations. The `X` indicates the operation is supported by the CLI. 
+
+| resource / sub-command | list | get  | update | create | delete |
+| ---------------------- | :--: | :--: | :----: | :----: | :----: |
+| configuration-version  |  X   |  X   |        |   X    |   X    |
+| oauth-tokens           |  X   |      |        |        |        |
+| organizations          |  X   |  X   |        |   X    |   X    |
+| policies               |  X   |  X   |   X    |   X    |   X    |
+| policy-checks          |  X   |      |        |        |        |
+| runs                   |  X   |  X   |        |   X    |        |
+| teams                  |  X   |  X   |        |   X    |   X    |
+| variables              |  X   |  X   |   X    |   X    |   X    |
+| workspaces             |  X   |  X   |   X    |   X    |   X    |
+
+### Upload a configuration-version
+
+```
+tfe configuration-versions upload
+```
+
+### Upload a Sentinel policy
+
+```
+tfe policies upload
+```
+
+### Override a policy check
+
+```
+tfe policy-checks override
+```
+
+
+### Apply or discard a run
+
+If a workspace is configured with auto-apply disabled and a plan completes successfully, then the run can be applied or discarded. 
+
+```
+tfe runs apply <id>
+tfe runs discard <id>
+```
+
+### Read and follow run logs (plan & apply)
+
+When a run is strated in Terraform Enterprise it will queue the work and then execute the plan. Once the plan finishes successfully, it will automatically start an apply or it can be started manually if auto-apply is disabled. When the plan and apply execute, the output is saved in TFE. This is the same output if you ran `terraform plan` or `terraform apply` locally. These locs are accessible via the API and CLI.
+
+```
+tfe runs logs <run-id> --event=<event>
+```
+
+The `--follow` option can also be specified. If used, this will render the current logs in real time (refreshed every 2 seconds). If the the particular event has not started, then the command will sit idly waiting for the particular event to start. 
+
+### Lock and unlock a workspace
+
+A workspace can be locked and unlocked. Locking prevents runs from being execute, but permits in progress runs to complete. The workspace ID (not the name) is required to perform the `lock` and `unlock` action.
+
+```
+tfe workspace lock <id>
+tfe workspace unlock <id>
+```
+
+### Get the Workspace ID
+
+A few commands require the workspace ID, not the workspace and organization name. The easiest way to obtain the workspace ID given a organization name and workspace name is to use the `workspaces get` subcommand. The `--value` option will strip away the keys, and the `--only id` option will return only the ID field. As such, response will return the workspace ID. 
+
+```
+tfe workspaces get <workspace_name> --organization=<organization_name> --value --only id
+```
+
+### Get the run ID
+
+A few command require the run ID. This can be obtained dusing the `tfe runs list` command. The command below shows a nicely formatted list with a few fields removed for brevity.
+
+```
+tfe runs list --workspace-id=<workspace_id> --except status-timestamps permissions actions
+```
+
 ## Contribution
 
 Contribution to the CLI is welcome. Opening issues and pull requests is welcome and will be reviewed.

data/lib/terraform_enterprise/command_line/command.rb

@@ -46,8 +46,9 @@ module TerraformEnterprise
         def client
           settings         = {}
           settings[:token] = options[:token] || ENV['TFE_TOKEN']
+          settings[:host]  = ENV['TFE_HOST'] if ENV['TFE_HOST']
           settings[:host]  = options[:host] if options[:host]
-          settings[:debug] = options[:debug] if options[:debug]
+          settings[:debug] = options[:debug] || ENV['TFE_DEBUG']
           TerraformEnterprise::API::Client.new(settings)
         end
 

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

@@ -26,9 +26,10 @@ module TerraformEnterprise
           render client.configuration_versions.get(id: id)
         end
 
-        desc 'upload <path> <upload-url>', CMD_STR[:upload]
-        def upload(path, url)
-          content = tarball(path)
+        desc 'upload <upload-url>', CMD_STR[:upload]
+        option :path, default: '.', type: :string, desc: ATTR_STR[:path]
+        def upload(url)
+          content = tarball(options[:path])
           params  = { content: content, url: url }
 
           render client.configuration_versions.upload(params)

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

@@ -74,6 +74,11 @@ module TerraformEnterprise
           upload_params = { content: content, url: upload_url }
           render client.configuration_versions.upload(upload_params)
         end
+
+        desc 'version', STRINGS[:version][:commands][:version]
+        def version
+          puts "Terraform Enterprise CLI #{VERSION}"
+        end
       end
     end
   end

data/lib/terraform_enterprise/command_line/strings.rb

@@ -22,6 +22,11 @@ module TerraformEnterprise
           push: 'Pushes the configuration to the workspace'
         }
       },
+      version: {
+        commands: {
+          version: 'Show current version'
+        }
+      },
       workspaces: {
         attributes: {
           terraform_version: 'Version of Terraform to use for this workspace.',
@@ -47,7 +52,7 @@ module TerraformEnterprise
       configuration_versions: {
         attributes: {
           workspace_id: 'Workspace ID of the workspace to which the configuration version belongs to.',
-          path: 'Path to the tar.gz file'
+          path: 'Path of directory or tar.gz file to push to the workspace'
         },
         commands: {
           create: 'Create a new configuration version',

data/lib/terraform_enterprise/command_line/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: terraform-enterprise-cli
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Maciej Skierkowski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-07 00:00:00.000000000 Z
+date: 2018-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: terraform-enterprise-client
@@ -138,8 +138,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: CLI tool for interacting with Terraform Enterprise
 test_files: []
+has_rdoc: