terraspace 0.3.3 → 0.3.4

data/lib/terraspace/cli/help/all/plan.md

@@ -0,0 +1,25 @@
+## Example
+
+    $ terraspace all plan
+    Running:
+       terraspace plan c1 # batch 1
+       terraspace plan b1 # batch 2
+       terraspace plan b2 # batch 2
+       terraspace plan a1 # batch 3
+    Batch Run 1:
+    Running: terraspace plan c1 Logs: log/plan/c1.log
+    terraspace plan c1:  Plan: 1 to add, 0 to change, 0 to destroy.
+    terraspace plan c1:  Changes to Outputs:
+    Batch Run 2:
+    Running: terraspace plan b1 Logs: log/plan/b1.log
+    Running: terraspace plan b2 Logs: log/plan/b2.log
+    terraspace plan b1:  Plan: 2 to add, 0 to change, 0 to destroy.
+    terraspace plan b1:  Changes to Outputs:
+    terraspace plan b2:  Plan: 1 to add, 0 to change, 0 to destroy.
+    terraspace plan b2:  Changes to Outputs:
+    Batch Run 3:
+    Running: terraspace plan a1 Logs: log/plan/a1.log
+    terraspace plan a1:  Plan: 2 to add, 0 to change, 0 to destroy.
+    terraspace plan a1:  Changes to Outputs:
+    Time took: 11s
+    $

data/lib/terraspace/cli/help/all/providers.md

@@ -0,0 +1,21 @@
+## Example
+
+    $ terraspace all providers
+    Running:
+       terraspace providers c1 # batch 1
+       terraspace providers b1 # batch 2
+       terraspace providers b2 # batch 2
+       terraspace providers a1 # batch 3
+    Batch Run 1:
+    Running: terraspace providers c1 Logs: log/providers/c1.log
+    terraspace providers c1:  └── provider[registry.terraform.io/hashicorp/random]
+    Batch Run 2:
+    Running: terraspace providers b1 Logs: log/providers/b1.log
+    Running: terraspace providers b2 Logs: log/providers/b2.log
+    terraspace providers b1:  └── provider[registry.terraform.io/hashicorp/random]
+    terraspace providers b2:  └── provider[registry.terraform.io/hashicorp/random]
+    Batch Run 3:
+    Running: terraspace providers a1 Logs: log/providers/a1.log
+    terraspace providers a1:  └── provider[registry.terraform.io/hashicorp/random]
+    Time took: 9s
+    $

data/lib/terraspace/cli/help/all/refresh.md

@@ -0,0 +1,17 @@
+## Example
+
+    $ terraspace all refresh
+    Running:
+       terraspace refresh c1 # batch 1
+       terraspace refresh b1 # batch 2
+       terraspace refresh b2 # batch 2
+       terraspace refresh a1 # batch 3
+    Batch Run 1:
+    Running: terraspace refresh c1 Logs: log/refresh/c1.log
+    Batch Run 2:
+    Running: terraspace refresh b1 Logs: log/refresh/b1.log
+    Running: terraspace refresh b2 Logs: log/refresh/b2.log
+    Batch Run 3:
+    Running: terraspace refresh a1 Logs: log/refresh/a1.log
+    Time took: 11s
+    $

data/lib/terraspace/cli/help/all/show.md

@@ -0,0 +1,21 @@
+## Example
+
+    $ terraspace all show
+    Running:
+       terraspace show c1 # batch 1
+       terraspace show b1 # batch 2
+       terraspace show b2 # batch 2
+       terraspace show a1 # batch 3
+    Batch Run 1:
+    Running: terraspace show c1 Logs: log/show/c1.log
+    terraspace show c1: Resources: 0 Outputs: 1
+    Batch Run 2:
+    Running: terraspace show b1 Logs: log/show/b1.log
+    Running: terraspace show b2 Logs: log/show/b2.log
+    terraspace show b1: Resources: 0 Outputs: 2
+    terraspace show b2: Resources: 0 Outputs: 1
+    Batch Run 3:
+    Running: terraspace show a1 Logs: log/show/a1.log
+    terraspace show a1: Resources: 0 Outputs: 0
+    Time took: 12s
+    $

data/lib/terraspace/cli/help/all/up.md

@@ -0,0 +1,27 @@
+## Example
+
+    $ terraspace all up
+    Will run:
+       terraspace up c1 # batch 1
+       terraspace up b1 # batch 2
+       terraspace up b2 # batch 2
+       terraspace up a1 # batch 3
+    Are you sure? (y/N)
+
+Once you confirm, Terraspace deploys the batches in parallel. Essentially, Terraspace handles the orchestration.
+
+    Are you sure? (y/N) y
+    Batch Run 1:
+    Running: terraspace up c1 Logs: log/up/c1.log
+    terraspace up c1:  Apply complete! Resources: 1 added, 0 changed, 0 destroyed.
+    Batch Run 2:
+    Running: terraspace up b1 Logs: log/up/b1.log
+    Running: terraspace up b2 Logs: log/up/b2.log
+    terraspace up b1:  Apply complete! Resources: 2 added, 0 changed, 0 destroyed.
+    terraspace up b2:  Apply complete! Resources: 1 added, 0 changed, 0 destroyed.
+    Batch Run 3:
+    Running: terraspace up a1 Logs: log/up/a1.log
+    terraspace up a1:  Apply complete! Resources: 2 added, 0 changed, 0 destroyed.
+    Time took: 25s
+
+Terraspace provides a reduced-noise summary of the runs. The full logs are also written for further inspection and debugging. The [terraspace log](https://terraspace.cloud/reference/terraspace-log/) command is useful for viewing the logs.

data/lib/terraspace/cli/help/all/validate.md

@@ -0,0 +1,21 @@
+## Example
+
+    $ terraspace all validate
+    Running:
+       terraspace validate c1 # batch 1
+       terraspace validate b1 # batch 2
+       terraspace validate b2 # batch 2
+       terraspace validate a1 # batch 3
+    Batch Run 1:
+    Running: terraspace validate c1 Logs: log/validate/c1.log
+    terraspace validate c1:  Success! The configuration is valid.
+    Batch Run 2:
+    Running: terraspace validate b1 Logs: log/validate/b1.log
+    Running: terraspace validate b2 Logs: log/validate/b2.log
+    terraspace validate b1:  Success! The configuration is valid.
+    terraspace validate b2:  Success! The configuration is valid.
+    Batch Run 3:
+    Running: terraspace validate a1 Logs: log/validate/a1.log
+    terraspace validate a1:  Success! The configuration is valid.
+    Time took: 13s
+    $

data/lib/terraspace/cli/help/build.md

@@ -0,0 +1,6 @@
+## Example
+
+    $ terraspace build
+    Building .terraspace-cache/us-west-2/dev/stacks/demo
+    Built in .terraspace-cache/us-west-2/dev/stacks/demo
+    $

data/lib/terraspace/cli/help/bundle.md

@@ -4,11 +4,15 @@
 
 ## More commands
 
-    terraspace bundle install # same as bundle
-    terraspace bundle update  # Updates Terrafile.lock
-    terraspace bundle clean   # removes /tmp terraspace bundler folder
+    terraspace bundle install     # same as bundle
+    terraspace bundle update      # Updates Terrafile.lock
+    terraspace bundle purge_cache # removes /tmp terraspace bundler folder
 
 ## Update a single module
 
-    terraspace bundle update MOD_NAME
-    terraspace bundle update demo
+    terraspace bundle update MODULE
+    terraspace bundle update demo
+
+## Info on a module
+
+    terraspace bundle info MODULE

data/lib/terraspace/cli/help/check_setup.md

@@ -0,0 +1,9 @@
+## Example
+
+    $ terraspace check_setup
+    Detected Terrspace version: 0.3.3
+    Detected Terraform bin: /home/ec2-user/.tfenv/bin/terraform
+    Detected Terraform v0.13.2
+    Terraspace requires Terraform v0.12.x and above
+    You're all set!
+    $

data/lib/terraspace/cli/help/clean.md

@@ -0,0 +1,5 @@
+## Example
+
+    $ terraspace clean
+    Removed .terraspace-cache
+    $

data/lib/terraspace/cli/help/cloud/destroy.md

@@ -0,0 +1,16 @@
+## Example
+
+    $ terraspace cloud destroy demo
+    You are about to delete the workspace: demo-dev-us-west-2
+    All variables, settings, run history, and state history will be removed.
+    This cannot be undone.
+
+    This will NOT remove any infrastructure managed by this workspace.
+    If needed, destroy the infrastructure prior to deleting the workspace with:
+
+        terraspace down demo
+
+    This will delete the workspace: demo-dev-us-west-2.
+    Are you sure? (y/N) y
+    Destroying workspace demo-dev-us-west-2
+    $

data/lib/terraspace/cli/help/cloud/list.md

@@ -0,0 +1,7 @@
+## Example
+
+    $ terraspace cloud list
+    Workspaces for boltops:
+    demo-dev-us-west-2
+    demo2-dev-us-west-2
+    $

data/lib/terraspace/cli/help/cloud/runs/list.md

@@ -2,7 +2,7 @@
 
 Statuses of pending and planned are shown by default.
 
-    $ terraspace cloud runs list pet
+    $ terraspace cloud runs list demo
     +----------------------+---------+---------------------------------+---------------------+
     |          Id          | Status  |             Message             |     Created At      |
     +----------------------+---------+---------------------------------+---------------------+
@@ -13,7 +13,7 @@ Statuses of pending and planned are shown by default.
 
 To see all most recent runs, use `--status all`.
 
-    $ terraspace cloud runs list pet --status all
+    $ terraspace cloud runs list demo --status all
     +----------------------+-----------+--------------------------------+---------------------+
     |          Id          |  Status   |            Message             |     Created At      |
     +----------------------+-----------+--------------------------------+---------------------+
@@ -26,7 +26,7 @@ To see all most recent runs, use `--status all`.
 
 You can provide a list of statuses to the `--status` filter option.
 
-    $ terraspace cloud runs list pet --status canceled discarded
+    $ terraspace cloud runs list demo --status canceled discarded
     +----------------------+-----------+--------------------------------+---------------------+
     |          Id          |  Status   |            Message             |     Created At      |
     +----------------------+-----------+--------------------------------+---------------------+

data/lib/terraspace/cli/help/cloud/runs/prune.md

@@ -7,7 +7,7 @@ This leaves the top run alone. The top run usually starts immediately planning o
 
 ## Example with Output
 
-    $ terraspace cloud runs prune pet
+    $ terraspace cloud runs prune demo
     Will keep:
 
         run-9muMrjrd22vhsP4u pending test 2020-09-18T12:47:11

data/lib/terraspace/cli/help/cloud/sync.md

@@ -1,4 +1,6 @@
-## Example
+## Examples
+
+Sync all stacks:
 
     $ terraspace cloud sync
     About to sync these project stacks with Terraform Cloud workspaces:
@@ -16,4 +18,26 @@
     Are you sure? (y/N) y
     Syncing to Terraform Cloud: demo => demo-dev-us-west-2
     Syncing to Terraform Cloud: demo2 => demo2-dev-us-west-2
-    $
+    $
+
+Sync specific stacks:
+
+    $ terraspace cloud sync demo
+    About to sync these project stacks with Terraform Cloud workspaces:
+
+        Stack => Workspace
+        demo => demo-dev-us-west-2
+
+    A sync does the following for each workspace:
+
+      1. Create or update workspace, including the VCS settings.
+      2. Set the working dir.
+      3. Set env and terraform variables.
+
+    Are you sure? (y/N) y
+    Syncing to Terraform Cloud: demo => demo-dev-us-west-2
+    $
+
+Can also specify multiple stacks:
+
+    terraspace cloud sync demo demo2

data/lib/terraspace/cli/help/console.md

@@ -0,0 +1,8 @@
+## Example
+
+    $ terraspace console demo
+    Building .terraspace-cache/us-west-2/dev/stacks/demo
+    Built in .terraspace-cache/us-west-2/dev/stacks/demo
+    Current directory: .terraspace-cache/us-west-2/dev/stacks/demo
+    => terraform console
+    >

data/lib/terraspace/cli/help/down.md

@@ -0,0 +1,26 @@
+## Example
+
+    $ terraspace down demo
+    Building .terraspace-cache/us-west-2/dev/stacks/demo
+    Built in .terraspace-cache/us-west-2/dev/stacks/demo
+    Current directory: .terraspace-cache/us-west-2/dev/stacks/demo
+    => terraform destroy
+    # ...
+    Plan: 0 to add, 0 to change, 2 to destroy.
+
+    Changes to Outputs:
+      - bucket_name = "bucket-trusty-marmoset" -> null
+
+    Do you really want to destroy all resources?
+      Terraform will destroy all your managed infrastructure, as shown above.
+      There is no undo. Only 'yes' will be accepted to confirm.
+      Enter a value: yes
+
+    module.bucket.aws_s3_bucket.this: Destroying... [id=bucket-trusty-marmoset]
+    module.bucket.aws_s3_bucket.this: Destruction complete after 0s
+    random_pet.this: Destroying... [id=trusty-marmoset]
+    random_pet.this: Destruction complete after 0s
+
+    Destroy complete! Resources: 2 destroyed.
+    Time took: 21s
+    $

data/lib/terraspace/cli/help/info.md

@@ -0,0 +1,43 @@
+## Example
+
+    $ terraspace info demo
+    +-----------+---------------------------------------------+
+    |   Name    |                    Value                    |
+    +-----------+---------------------------------------------+
+    | build_dir | stacks/demo                                 |
+    | cache_dir | .terraspace-cache/us-west-2/dev/stacks/demo |
+    | name      | demo                                        |
+    | root      | app/stacks/demo                             |
+    | type      | stack                                       |
+    | type_dir  | stacks                                      |
+    +-----------+---------------------------------------------+
+
+You can also format the output in json:
+
+    $ terraspace info demo --format json
+    [
+      {
+        "Name": "build_dir",
+        "Value": "stacks/demo"
+      },
+      {
+        "Name": "cache_dir",
+        "Value": ".terraspace-cache/us-west-2/dev/stacks/demo"
+      },
+      {
+        "Name": "name",
+        "Value": "demo"
+      },
+      {
+        "Name": "root",
+        "Value": "app/stacks/demo"
+      },
+      {
+        "Name": "type",
+        "Value": "stack"
+      },
+      {
+        "Name": "type_dir",
+        "Value": "stacks"
+      }
+    ]

data/lib/terraspace/cli/help/init.md

@@ -0,0 +1,37 @@
+Typically, Terrasapce auto init should handle initialization. You can run init if you need to though.
+
+## Example
+
+    $ terraspace init demo
+    Building .terraspace-cache/us-west-2/dev/stacks/demo
+    Built in .terraspace-cache/us-west-2/dev/stacks/demo
+    Current directory: .terraspace-cache/us-west-2/dev/stacks/demo
+    => terraform init -get
+    Initializing modules...
+
+    Initializing the backend...
+
+    Initializing provider plugins...
+    - Using previously-installed hashicorp/aws v3.7.0
+    - Using previously-installed hashicorp/random v2.3.0
+
+    The following providers do not have any version constraints in configuration,
+    so the latest version was installed.
+
+    To prevent automatic upgrades to new major versions that may contain breaking
+    changes, we recommend adding version constraints in a required_providers block
+    in your configuration, with the constraint strings suggested below.
+
+    * hashicorp/aws: version = "~> 3.7.0"
+    * hashicorp/random: version = "~> 2.3.0"
+
+    Terraform has been successfully initialized!
+
+    You may now begin working with Terraform. Try running "terraform plan" to see
+    any changes that are required for your infrastructure. All Terraform commands
+    should now work.
+
+    If you ever set or change modules or backend configuration for Terraform,
+    rerun this command to reinitialize your working directory. If you forget, other
+    commands will detect it and remind you to do so if necessary.
+    $

data/lib/terraspace/cli/help/list.md

@@ -0,0 +1,20 @@
+## Examples
+
+List both modules and stacks.
+
+    $ terraspace list
+    app/modules/example
+    app/stacks/demo
+    $
+
+List only stacks.
+
+    $ terraspace list -t stack
+    app/stacks/demo
+    $
+
+List only modules.
+
+    $ terraspace list -t module
+    app/modules/example
+    $

data/lib/terraspace/cli/help/log.md

@@ -6,6 +6,8 @@ Follow all the logs as you're running `terraspace all up`:
 
     terraspace log -f
 
+Note, Terraspace automatically checks every second for new logs and adds them to be followed.
+
 ## View Logs
 
 View last 10 lines of each log file.

data/lib/terraspace/cli/help/logs/remove.md

@@ -0,0 +1,5 @@
+## Example
+
+    $ terraspace logs remove
+    Removing all files in log/
+    $