terraspace 0.3.1 → 0.3.6

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.
@@ -23,7 +25,7 @@ To show all logs, use the `-a` option.
 
     terraspace log up -a
 
-Note, if both an action and stack is specified, then it defaults to showing all logs. If you want to not show all logs in thta case, then you can use `--no-all`.
+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
 
@@ -36,7 +38,11 @@ To tail logs, use the `-f` option.
 
 ## Timestamps
 
-The timestamps are shown by default when you are looking for multiple files.  When you specify a both the action and stack for a single log file, then timestamps are not shown.
+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 log up         # timestamps will be shown in this case
     terraspace log up network # timestamps not be shown in this case
+
+To show timestamps:
+
+    terraspace up 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
+    $

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

@@ -0,0 +1,49 @@
+## Example
+
+    $ terraspace new plugin mycloud
+    => Creating new plugin: mycloud
+          create  terraspace_plugin_mycloud
+          create  terraspace_plugin_mycloud/.gitignore
+          create  terraspace_plugin_mycloud/.rspec
+          create  terraspace_plugin_mycloud/CHANGELOG.md
+          create  terraspace_plugin_mycloud/Gemfile
+          create  terraspace_plugin_mycloud/LICENSE.txt
+          create  terraspace_plugin_mycloud/README.md
+          create  terraspace_plugin_mycloud/Rakefile
+          create  terraspace_plugin_mycloud/bin/console
+          create  terraspace_plugin_mycloud/bin/setup
+          create  terraspace_plugin_mycloud/lib/templates/hcl/module/main.tf
+          create  terraspace_plugin_mycloud/lib/templates/hcl/module/outputs.tf
+          create  terraspace_plugin_mycloud/lib/templates/hcl/module/variables.tf
+          create  terraspace_plugin_mycloud/lib/templates/hcl/project/config/terraform/backend.tf
+          create  terraspace_plugin_mycloud/lib/templates/hcl/project/config/terraform/provider.tf
+          create  terraspace_plugin_mycloud/lib/templates/hcl/stack/main.tf
+          create  terraspace_plugin_mycloud/lib/templates/hcl/stack/outputs.tf
+          create  terraspace_plugin_mycloud/lib/templates/hcl/stack/variables.tf
+          create  terraspace_plugin_mycloud/lib/templates/ruby/module/main.rb
+          create  terraspace_plugin_mycloud/lib/templates/ruby/module/outputs.rb
+          create  terraspace_plugin_mycloud/lib/templates/ruby/module/variables.rb
+          create  terraspace_plugin_mycloud/lib/templates/ruby/project/config/terraform/backend.rb
+          create  terraspace_plugin_mycloud/lib/templates/ruby/project/config/terraform/provider.rb
+          create  terraspace_plugin_mycloud/lib/templates/ruby/stack/main.rb
+          create  terraspace_plugin_mycloud/lib/templates/ruby/stack/outputs.rb
+          create  terraspace_plugin_mycloud/lib/templates/ruby/stack/variables.rb
+          create  terraspace_plugin_mycloud/lib/templates/test/rspec/module/test/.rspec
+          create  terraspace_plugin_mycloud/lib/templates/test/rspec/module/test/Gemfile
+          create  terraspace_plugin_mycloud/lib/templates/test/rspec/module/test/spec/fixtures/stack/main.tf
+          create  terraspace_plugin_mycloud/lib/templates/test/rspec/module/test/spec/fixtures/stack/outputs.tf
+          create  terraspace_plugin_mycloud/lib/templates/test/rspec/module/test/spec/fixtures/stack/variables.tf
+          create  terraspace_plugin_mycloud/lib/templates/test/rspec/module/test/spec/main_spec.rb
+          create  terraspace_plugin_mycloud/lib/templates/test/rspec/module/test/spec/spec_helper.rb
+          create  terraspace_plugin_mycloud/lib/terraspace_plugin_mycloud.rb
+          create  terraspace_plugin_mycloud/lib/terraspace_plugin_mycloud/autoloader.rb
+          create  terraspace_plugin_mycloud/lib/terraspace_plugin_mycloud/clients.rb
+          create  terraspace_plugin_mycloud/lib/terraspace_plugin_mycloud/interfaces/backend.rb
+          create  terraspace_plugin_mycloud/lib/terraspace_plugin_mycloud/interfaces/config.rb
+          create  terraspace_plugin_mycloud/lib/terraspace_plugin_mycloud/interfaces/expander.rb
+          create  terraspace_plugin_mycloud/lib/terraspace_plugin_mycloud/interfaces/layer.rb
+          create  terraspace_plugin_mycloud/lib/terraspace_plugin_mycloud/version.rb
+          create  terraspace_plugin_mycloud/spec/spec_helper.rb
+          create  terraspace_plugin_mycloud/spec/terraspace_provider_mycloud_spec.rb
+          create  terraspace_plugin_mycloud/terraspace_plugin_mycloud.gemspec
+    $

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

@@ -0,0 +1,40 @@
+## Example
+
+    $ terraspace new project infra --plugin aws --examples
+    => Creating new project called infra.
+          create  infra
+          create  infra/.gitignore
+          create  infra/Gemfile
+          create  infra/README.md
+          create  infra/Terrafile
+          create  infra/config/app.rb
+           exist  infra
+          create  infra/config/terraform/backend.tf
+          create  infra/config/terraform/provider.tf
+    => Creating test for new module: example
+          create  infra/app/modules/example
+          create  infra/app/modules/example/main.tf
+          create  infra/app/modules/example/outputs.tf
+          create  infra/app/modules/example/variables.tf
+    => Creating new stack called demo.
+          create  infra/app/stacks/demo
+          create  infra/app/stacks/demo/main.tf
+          create  infra/app/stacks/demo/outputs.tf
+          create  infra/app/stacks/demo/variables.tf
+    => Creating test bootstrap structure
+           exist  infra
+          create  infra/.rspec
+          create  infra/spec/spec_helper.rb
+    => Installing dependencies with: bundle install
+    Bundle complete! 3 Gemfile dependencies, 88 gems now installed.
+    Use `bundle info [gemname]` to see where a bundled gem is installed.
+    ================================================================
+    Congrats! You have successfully created a terraspace project.
+    Check out the created files. Adjust to the examples and then deploy with:
+
+        cd infra
+        terraspace up demo -y   # to deploy
+        terraspace down demo -y # to destroy
+
+    More info: https://terraspace.cloud/
+    $

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

@@ -0,0 +1,8 @@
+## Example
+
+    $ terraspace new project_test demo
+    => Creating project test: demo
+           exist
+          create  spec/fixtures/tfvars/demo.tfvars
+          create  spec/stacks/demo/main_spec.rb
+    $

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

@@ -0,0 +1,21 @@
+## Example
+
+    $ terraspace new shim
+    A terraspace shim as been generated at /usr/local/bin/terraspace
+    Please make sure that it is found in the $PATH.
+
+    You can double check with:
+
+        which terraspace
+
+    You should see
+
+        $ which terraspace
+        /usr/local/bin/terraspace
+
+    If you do not, please add /usr/local/bin to your PATH.
+    You can usually do so by adding this line to ~/.bash_profile and opening a new terminal to check.
+
+        export PATH=/usr/local/bin:/$PATH
+
+    $

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

@@ -0,0 +1,9 @@
+## Example
+
+    $ terraspace new stack demo
+    => Creating new stack called demo.
+          create  app/stacks/demo
+          create  app/stacks/demo/main.tf
+          create  app/stacks/demo/outputs.tf
+          create  app/stacks/demo/variables.tf
+    $

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

@@ -0,0 +1,6 @@
+## Example
+
+    $ terraspace output demo
+    => terraform output
+    bucket_name = bucket-fond-sheep
+    $

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

@@ -0,0 +1,29 @@
+## Example
+
+    $ terraspace plan demo
+    => terraform plan
+    Refreshing Terraform state in-memory prior to plan...
+    The refreshed state will be used to calculate this plan, but will not be
+    persisted to local or remote state storage.
+
+    random_pet.this: Refreshing state... [id=fond-sheep]
+    module.bucket.aws_s3_bucket.this: Refreshing state... [id=bucket-fond-sheep]
+
+    ------------------------------------------------------------------------
+
+    An execution plan has been generated and is shown below.
+    Resource actions are indicated with the following symbols:
+    -/+ destroy and then create replacement
+    ...
+    Plan: 2 to add, 0 to change, 2 to destroy.
+
+    Changes to Outputs:
+      ~ bucket_name = "bucket-fond-sheep" -> (known after apply)
+
+    ------------------------------------------------------------------------
+
+    Note: You didn't specify an "-out" parameter to save this plan, so Terraform
+    can't guarantee that exactly these actions will be performed if
+    "terraform apply" is subsequently run.
+
+    $

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

@@ -0,0 +1,18 @@
+## Example
+
+    $ terraspace providers demo
+    => terraform providers
+
+    Providers required by configuration:
+    .
+    ├── provider[registry.terraform.io/hashicorp/random]
+    └── module.bucket
+        └── provider[registry.terraform.io/hashicorp/aws]
+
+    Providers required by state:
+
+        provider[registry.terraform.io/hashicorp/aws]
+
+        provider[registry.terraform.io/hashicorp/random]
+
+    $

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

@@ -0,0 +1,11 @@
+## Example
+
+    $ terraspace refresh demo
+    => terraform refresh
+    random_pet.this: Refreshing state... [id=fond-sheep]
+    module.bucket.aws_s3_bucket.this: Refreshing state... [id=bucket-fond-sheep]
+
+    Outputs:
+
+    bucket_name = bucket-fond-sheep
+    $

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

@@ -0,0 +1,7 @@
+## Example
+
+    $ terraspace seed demo
+    Seeding tfvar files for demo
+    Reading: .terraspace-cache/us-west-2/dev/stacks/demo/variables.tf
+          create  app/stacks/demo/tfvars/dev.tfvars
+    $

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

@@ -0,0 +1,36 @@
+## Example
+
+    $ terraspace show demo
+    => terraform show
+    # random_pet.this:
+    resource "random_pet" "this" {
+        id        = "fond-sheep"
+        length    = 2
+        separator = "-"
+    }
+
+    # module.bucket.aws_s3_bucket.this:
+    resource "aws_s3_bucket" "this" {
+        acl                         = "private"
+        arn                         = "arn:aws:s3:::bucket-fond-sheep"
+        bucket                      = "bucket-fond-sheep"
+        bucket_domain_name          = "bucket-fond-sheep.s3.amazonaws.com"
+        bucket_regional_domain_name = "bucket-fond-sheep.s3.us-west-2.amazonaws.com"
+        force_destroy               = false
+        hosted_zone_id              = "Z3BJ6K6RIION7M"
+        id                          = "bucket-fond-sheep"
+        region                      = "us-west-2"
+        request_payer               = "BucketOwner"
+        tags                        = {}
+
+        versioning {
+            enabled    = false
+            mfa_delete = false
+        }
+    }
+
+
+    Outputs:
+
+    bucket_name = "bucket-fond-sheep"
+    $

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

@@ -0,0 +1,11 @@
+## Example
+
+    $ terraspace summary
+    Summary of resources based on backend storage statefiles
+    Downloading statefiles to /tmp/terraspace/statefiles/terraform-state-111111111111-us-west-2-dev/us-west-2/dev/
+    stacks/demo/terraform.tfstate
+        random_pet this: sunny-chicken
+        aws_s3_bucket this: bucket-sunny-chicken
+    $
+
+Also, check out `terraspace all show`.

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

@@ -0,0 +1,35 @@
+## Example
+
+Terraspace test just calls the configured test framework, by default, rspec.
+Here's an example with output cleaned up to reduce noise:
+
+    $ terraspace test
+    => rspec
+
+    main
+    Building test harness...
+    ...
+    Test harness built: /tmp/terraspace/test-harnesses/demo-harness
+    => terraspace up demo -y
+    Building .terraspace-cache/us-west-2/test/stacks/demo
+    Built in .terraspace-cache/us-west-2/test/stacks/demo
+    Current directory: .terraspace-cache/us-west-2/test/stacks/demo
+    => terraform init -get >> /tmp/terraspace/log/init/demo.log
+    => terraform plan -out /tmp/terraspace/plans/demo-20200920160313.plan
+    ...
+    => terraform apply -auto-approve  /tmp/terraspace/plans/demo-20200920160313.plan
+    ...
+    => terraform destroy -auto-approve
+    random_pet.this: Refreshing state... [id=hopelessly-outgoing-serval]
+    module.bucket.aws_s3_bucket.this: Refreshing state... [id=bucket-hopelessly-outgoing-serval]
+    module.bucket.aws_s3_bucket.this: Destroying... [id=bucket-hopelessly-outgoing-serval]
+    module.bucket.aws_s3_bucket.this: Destruction complete after 0s
+    random_pet.this: Destroying... [id=hopelessly-outgoing-serval]
+    random_pet.this: Destruction complete after 0s
+
+    Destroy complete! Resources: 2 destroyed.
+    Time took: 5s
+
+    Finished in 22.08 seconds (files took 0.48602 seconds to load)
+    1 example, 0 failures
+    $