terraspace 0.3.2 → 0.4.0

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/all.md

@@ -0,0 +1,10 @@
+## Examples
+
+    $ terraspace clean all
+    Will remove Terraspace cache and logs.
+    Are you sure? (y/N) y
+    Removed .terraspace-cache
+    Removed /tmp/terraspace
+    Removing all files in log/
+    Logs removed
+    $

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

@@ -0,0 +1,12 @@
+## Example
+
+    $ terraspace clean cache
+    Will remove these folders and all their files:
+
+        .terraspace-cache
+        /tmp/terraspace
+
+    Are you sure? (y/N)
+    Removed .terraspace-cache
+    Removed /tmp/terraspace
+    $

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

@@ -0,0 +1,17 @@
+## Examples
+
+Remove logs completely:
+
+    $ terraspace clean logs
+    Will remove all the log files in log/ folder
+    Are you sure? (y/N) y
+    Removing all files in log/
+    Logs removed
+
+Truncate logs. IE: Keeps the files but removes contents and zero bytes the files.
+
+    $ terraspace clean logs --truncate
+    Will truncate all the log files in log/ folder
+    Are you sure? (y/N) y
+    Logs truncated
+    $

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

@@ -1,4 +1,4 @@
-This leaves the to most recent run alone. The top run will immediately start planning. Runs that are also in "Needs Confirmation" will be cancelled.
+This leaves the top run alone. The top run usually starts immediately planning once the other runs are pruned. Runs that are also in "Needs Confirmation" will be cancelled.
 
 ## Examples
 
@@ -7,7 +7,7 @@ This leaves the to most recent run alone. The top run will immediately start pla
 
 ## 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/logs.md

@@ -0,0 +1,48 @@
+The log commands will filter out the logs for the last ran terraspace command. It does this by filtering for the last found PID in the log files.
+
+## Quick Start
+
+Follow all the logs as you're running `terraspace all up`:
+
+    terraspace logs -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.
+
+    terraspace logs up network # view up log on specific stack
+    terraspace logs up         # view all up logs
+    terraspace logs down       # view all down logs
+    terraspace logs            # view all logs: up, down, etc
+
+By default, the log command shows the last 10 lines of the logs for each log file. You can use the `-n` option to adjust this.
+
+    terraspace logs -n 2       # view last 2 lines of all logs: up, down, etc
+
+To show all logs, use the `-a` option.
+
+    terraspace logs up -a
+
+Note, if both an action and stack is specified, then it defaults to showing all logs. If you want not to show all logs, use `--no-all`.
+
+## Tail Logs
+
+To tail logs, use the `-f` option.
+
+    terraspace logs up network -f # view up log on specific stack
+    terraspace logs up -f         # view all up logs
+    terraspace logs down -f       # view all down logs
+    terraspace logs -f            # view all logs: up, down, etc
+
+## Timestamps
+
+The timestamps are shown by default when you are looking for multiple files.  When you specify both the action and stack for a single log file, then timestamps are not shown.
+
+    terraspace logs up         # timestamps will be shown in this case
+    terraspace logs up network # timestamps not be shown in this case
+
+To show timestamps:
+
+    terraspace logs up network --timestamps

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

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

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

@@ -0,0 +1,5 @@
+## Example
+
+    $ terraspace logs truncate
+    Truncating log files in log/
+    $

data/lib/terraspace/cli/help/new/bootstrap_test.md

@@ -0,0 +1,8 @@
+## Example
+
+    $ terraspace new bootstrap_test
+    => Creating test bootstrap structure
+           exist
+          create  .rspec
+          create  spec/spec_helper.rb
+    $

data/lib/terraspace/cli/help/new/example.md

@@ -0,0 +1,8 @@
+## Example
+
+    => Creating test for new module: example
+          create  app/modules/example
+          create  app/modules/example/main.tf
+          create  app/modules/example/outputs.tf
+          create  app/modules/example/variables.tf
+    $

data/lib/terraspace/cli/help/new/git_hook.md

@@ -0,0 +1,6 @@
+## Example
+
+    $ terraspace new git_hook
+          create  .git/hooks/pre-push
+           chmod  .git/hooks/pre-push
+    $

data/lib/terraspace/cli/help/new/module.md

@@ -0,0 +1,9 @@
+## Example
+
+    $ terraspace new module example
+    => Creating test for new module: example
+          create  app/modules/example
+          create  app/modules/example/main.tf
+          create  app/modules/example/outputs.tf
+          create  app/modules/example/variables.tf
+    $

data/lib/terraspace/cli/help/new/module_test.md

@@ -0,0 +1,12 @@
+## Example
+
+    $ terraspace new module_test example
+    => Creating module test: example
+           exist  app/modules/example
+          create  app/modules/example/test/.rspec
+          create  app/modules/example/test/Gemfile
+          create  app/modules/example/test/spec/fixtures/stack/main.tf
+          create  app/modules/example/test/spec/fixtures/stack/outputs.tf
+          create  app/modules/example/test/spec/main_spec.rb
+          create  app/modules/example/test/spec/spec_helper.rb
+    $