ruby-terraform 0.31.0.pre.pre.2 → 0.31.0.pre.pre.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8ab81a9a37f8fbab7fb24fae0322f2e686b423bf67093ab51c74c679e925f72
-  data.tar.gz: e8cfb6b87ff32093608e449d31573554e824d91036f4b17a09422ee791329fff
+  metadata.gz: 4de31f123edc9358c631bbb94022472b0173a6144008c06ccfe35f91e17b26c0
+  data.tar.gz: 5acaa7f8dd31c1e6c27658af497f1a0b82f20cc8fecab1542bdb3b404c95ff23
 SHA512:
-  metadata.gz: 4437914e08d45fabb0cf7b0714db584ea0e5de1b7eb7ff83be54bb72e2881d7016da3d67c545865a1847ed73ca5fdee52aa902ef3930bed47d2392fd14ff259a
-  data.tar.gz: 7cf12ed907f6dbc5866d0b6e1cd07c44bf6576ef4a24c3a022d447b8188930200b7f6976567068cb136f5c12cec2f1a97c691dd6dd7dfa82448b880638cda572
+  metadata.gz: 0e36e65ce356902ce650c48c85e12567bdbb7ecfaca49e2b28c32b6e79608eb427b8f4d7cf737afde02dd46b0f5f243409df0accdd80696511aaf9e84286343d
+  data.tar.gz: 4660bed722de8637b49257ee7142d7f012f3d536dc747c3561e86462b7263fe58dffe3e4aec58b93b59870b6015925fcd6e2c5e8d119f1e4f342d987e8d4e746

data/CHANGELOG.md

@@ -1,4 +1,13 @@
-## 0.29.0 (September 25th, 2019)
+## 0.31.0 (September 25th, 2019)
+
+IMPROVEMENTS
+
+* Add support for `target` and / or `targets` options to be passed to `apply`,
+  `plan`, `refresh` and `destroy` commands.
+* Add support for `plan` option to `apply` command to be more clear when 
+  applying a prebuilt plan.
+
+## 0.30.0 (September 25th, 2019)
 
 IMPROVEMENTS:
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-terraform (0.31.0.pre.pre.2)
+    ruby-terraform (0.31.0.pre.pre.3)
       lino (~> 1.1)
 
 GEM

data/README.md

@@ -47,6 +47,7 @@ Currently, there is partial support for the following commands:
 * `RubyTerraform::Commands::Show`: executes `terraform show`
 * `RubyTerraform::Commands::Destroy`: executes `terraform destroy`
 * `RubyTerraform::Commands::Output`: executes `terraform output`
+* `RubyTerraform::Commands::Refresh`: executes `terraform refresh`
 * `RubyTerraform::Commands::RemoteConfig`: executes `terraform remote config`
 * `RubyTerraform::Commands::Validate`: executes `terraform validate`
 * `RubyTerraform::Commands::Workspace`: executes `terraform workspace`
@@ -137,6 +138,10 @@ The plan command supports the following options passed as keyword arguments:
   `var_files` are provided, all var files will be passed to terraform.
 * `var_files`: an array of paths to terraform var files; if both `var_file` and
   `var_files` are provided, all var files will be passed to terraform.
+* `target`: the address of a resource to target; if both `target` and
+  `targets` are provided, all targets will be passed to terraform.
+* `targets`: and array of resource addresses to target; if both `target` and
+  `targets` are provided, all targets will be passed to terraform.
 * `state`: the path to the state file in which to store state; defaults to
   terraform.tfstate in the working directory or the remote state if configured.
 * `plan`: the name of the file in which to save the generated plan.
@@ -173,6 +178,10 @@ The apply command supports the following options passed as keyword arguments:
   `var_files` are provided, all var files will be passed to terraform.
 * `var_files`: an array of paths to terraform var files; if both `var_file` and
   `var_files` are provided, all var files will be passed to terraform.
+* `target`: the address of a resource to target; if both `target` and
+  `targets` are provided, all targets will be passed to terraform.
+* `targets`: and array of resource addresses to target; if both `target` and
+  `targets` are provided, all targets will be passed to terraform.
 * `state`: the path to the state file in which to store state; defaults to
   terraform.tfstate in the working directory or the remote state if configured.
 * `backup`: the path to the backup file in which to store the state backup.
@@ -185,6 +194,26 @@ The apply command supports the following options passed as keyword arguments:
   confirm the changes; defaults to `false`.
 
 
+### RubyTerraform::Commands::Show
+
+The show command produces human-readable output from a state file or a plan 
+file. It can be called in the following ways:
+
+```ruby
+RubyTerraform.show(
+  path: 'infra/networking')
+RubyTerraform::Commands::Apply.new.execute(
+  path: 'infra/networking')
+```
+
+The show command supports the following options passed as keyword arguments:
+* `path`: the path to a state or plan file; required.
+* `no_color`: whether or not the output from the command should be in color;
+  defaults to `false`.
+* `module_depth`: the depth of modules to show in the output; defaults to 
+  showing all modules.
+
+
 ### RubyTerraform::Commands::Destroy
 
 The destroy command destroys all resources defined in the terraform
@@ -211,6 +240,10 @@ The destroy command supports the following options passed as keyword arguments:
   `var_files` are provided, all var files will be passed to terraform.
 * `var_files`: an array of paths to terraform var files; if both `var_file` and
   `var_files` are provided, all var files will be passed to terraform.
+* `target`: the address of a resource to target; if both `target` and
+  `targets` are provided, all targets will be passed to terraform.
+* `targets`: and array of resource addresses to target; if both `target` and
+  `targets` are provided, all targets will be passed to terraform.
 * `state`: the path to the state file containing the current state; defaults to
   terraform.tfstate in the working directory or the remote state if configured.
 * `force`: if `true`, the command destroys without prompting the user to confirm
@@ -240,10 +273,48 @@ The output command supports the following options passed as keyword arguments:
 * `module`: the name of a module to retrieve output from.
 
 
+### RubyTerraform::Commands::Refresh
+
+The refresh command will reconcile state with resources found in the target
+environment. It can be called in the following ways:
+
+```ruby
+RubyTerraform.refresh(
+  directory: 'infra/networking',
+  vars: {
+    region: 'eu-central'
+  })
+RubyTerraform::Commands::Refresh.new.execute(
+  directory: 'infra/networking',
+  vars: {
+    region: 'eu-central'
+  })
+```
+
+The refresh command supports the following options passed as keyword arguments:
+* `directory`: the directory containing terraform configuration; required.
+* `vars`: a map of vars to be passed in to the terraform configuration.
+* `var_file`: the path to a terraform var file; if both `var_file` and
+  `var_files` are provided, all var files will be passed to terraform.
+* `var_files`: an array of paths to terraform var files; if both `var_file` and
+  `var_files` are provided, all var files will be passed to terraform.
+* `target`: the address of a resource to target; if both `target` and
+  `targets` are provided, all targets will be passed to terraform.
+* `targets`: and array of resource addresses to target; if both `target` and
+  `targets` are provided, all targets will be passed to terraform.
+* `state`: the path to the state file in which to store state; defaults to
+  terraform.tfstate in the working directory or the remote state if configured.
+* `input`: when `false`, will not ask for input for variables not directly set; 
+  defaults to `true`.
+* `no_color`: whether or not the output from the command should be in color;
+  defaults to `false`.
+
+
 ### RubyTerraform::Commands::RemoteConfig
 
 The remote config command configures storage of state using a remote backend. It
-can be called in the following ways:
+has been deprecated and since removed from terraform but is retained in this 
+library for backwards compatibility. It can be called in the following ways:
 
 ```ruby
 RubyTerraform.remote_config(
@@ -271,6 +342,37 @@ arguments:
   defaults to `false`.
 
 
+### RubyTerraform::Commands::Validate
+
+The validate command validates terraform configuration in the provided terraform
+configuration directory. It can be called in the following ways:
+
+```ruby
+RubyTerraform.validate(
+  directory: 'infra/networking',
+  vars: {
+    region: 'eu-central'
+  })
+RubyTerraform::Commands::Validate.new.execute(
+  directory: 'infra/networking',
+  vars: {
+    region: 'eu-central'
+  })
+```
+
+The validate command supports the following options passed as keyword arguments:
+* `directory`: the directory containing terraform configuration; required.
+* `vars`: a map of vars to be passed in to the terraform configuration.
+* `var_file`: the path to a terraform var file; if both `var_file` and
+  `var_files` are provided, all var files will be passed to terraform.
+* `var_files`: an array of paths to terraform var files; if both `var_file` and
+  `var_files` are provided, all var files will be passed to terraform.
+* `no_color`: whether or not the output from the command should be in color;
+  defaults to `false`.
+* `check_variables`: if `true`, the command checks whether all variables have
+  been provided; defaults to `true`.
+
+
 ### RubyTerraform::Commands::Workspace
 
 The `workspace` command configures 

data/lib/ruby_terraform/commands/show.rb

@@ -7,15 +7,17 @@ module RubyTerraform
   module Commands
     class Show < Base
       def configure_command(builder, opts)
+        path = opts[:path] || opts[:directory]
         no_color = opts[:no_color]
         module_depth = opts[:module_depth]
+
         builder
           .with_subcommand('show') do |sub|
           sub = sub.with_option('-module-depth', module_depth) if module_depth
           sub = sub.with_flag('-no-color') if no_color
           sub
         end
-          .with_argument(opts[:directory])
+          .with_argument(path)
       end
     end
   end

data/lib/ruby_terraform/version.rb

@@ -1,3 +1,3 @@
 module RubyTerraform
-  VERSION = "0.31.0-pre.2"
+  VERSION = "0.31.0-pre.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-terraform
 version: !ruby/object:Gem::Version
-  version: 0.31.0.pre.pre.2
+  version: 0.31.0.pre.pre.3
 platform: ruby
 authors:
 - Toby Clemson