From 1d07ac0bf96798a31a1d4dc9297b1e360f2489e2 Mon Sep 17 00:00:00 2001 From: sfran69269 <110411320+sfran69269@users.noreply.github.com> Date: Tue, 2 Aug 2022 09:22:17 -0600 Subject: [PATCH 1/5] Linked to GitHub fork docs from the main README The README stresses that this repo is intended for forks, but GitHub newbies may have no idea what these are about, so we link to the official docs! --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 78b29c8..756b269 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ A great example repo you can fork to your heart’s content, that serves as a la ## Getting started -The first thing you want to do with this repo is quite likely **fork it**. Use the Fork button in the top-right section of the page to do this. +The first thing you want to do with this repo is quite likely [**fork it**](https://help.github.com/articles/fork-a-repo/). Use the Fork button in the top-right section of the page to do this. Once you’re on your fork, you can experiment however you like with it, play with branches, issues, milestones, labels, the wiki, and more. From 01b3ca95a163236798c0cb2b51e02c1e7e66330f Mon Sep 17 00:00:00 2001 From: sfran69269 <110411320+sfran69269@users.noreply.github.com> Date: Thu, 4 Aug 2022 09:00:32 -0600 Subject: [PATCH 2/5] Add more GitHub help links in README We provide even more links to GitHub help for newbies: branch management, issues, milestones, labels and wikis. --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 756b269..3bdb09f 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,12 @@ A great example repo you can fork to your heart’s content, that serves as a la The first thing you want to do with this repo is quite likely [**fork it**](https://help.github.com/articles/fork-a-repo/). Use the Fork button in the top-right section of the page to do this. -Once you’re on your fork, you can experiment however you like with it, play with branches, issues, milestones, labels, the wiki, and more. +Once you’re on your fork, you can experiment however you like with it, play with +[branches](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/), +[issues](https://help.github.com/articles/about-issues), +[milestones](https://help.github.com/articles/associating-milestones-with-issues-and-pull-requests/), +[labels](https://help.github.com/articles/applying-labels-to-issues-and-pull-requests/), the +[wiki](https://help.github.com/articles/about-github-wikis/), and more. ## What’s in there? From 943e4d20f9f74be6fd7614ed54b94227e36337c4 Mon Sep 17 00:00:00 2001 From: sfran69269 <110411320+sfran69269@users.noreply.github.com> Date: Thu, 4 Aug 2022 09:14:31 -0600 Subject: [PATCH 3/5] Update the branches help link This uses a better link as per discussion in #1. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3bdb09f..158f93f 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ A great example repo you can fork to your heart’s content, that serves as a la The first thing you want to do with this repo is quite likely [**fork it**](https://help.github.com/articles/fork-a-repo/). Use the Fork button in the top-right section of the page to do this. Once you’re on your fork, you can experiment however you like with it, play with -[branches](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/), +[branches](https://help.github.com/articles/viewing-branches-in-your-repository/), [issues](https://help.github.com/articles/about-issues), [milestones](https://help.github.com/articles/associating-milestones-with-issues-and-pull-requests/), [labels](https://help.github.com/articles/applying-labels-to-issues-and-pull-requests/), the From bb6b953d19af5667dce745d501bca1a37bcd0151 Mon Sep 17 00:00:00 2001 From: Steven Franiok Date: Tue, 9 Aug 2022 11:14:16 -0600 Subject: [PATCH 4/5] Draft of contributing guidelines This still needs a lot of work --- CONTRIBUTING.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..34522cc --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,15 @@ +# Contributing + +1. Fork the project and clone your fork. + +2. Create a local feature branch: + + $ git checkout -b + +3. Do something awesome + +4. Push to your fork: + + $ git push origin + +5. Open a pull request. From 02e289cd5a6edd9878b5540acda625d40668dec8 Mon Sep 17 00:00:00 2001 From: sfran69269 <110411320+sfran69269@users.noreply.github.com> Date: Wed, 30 Nov 2022 14:09:13 -0700 Subject: [PATCH 5/5] Add files via upload --- LICENSE | 396 ++++++++++++++++++++++++++++++++++++++++++++--- README.md | 62 +++++--- backend.tf | 13 ++ main.tf | 38 +++++ provider.tf | 13 ++ scripts/setup.sh | 286 ++++++++++++++++++++++++++++++++++ 6 files changed, 764 insertions(+), 44 deletions(-) create mode 100644 backend.tf create mode 100644 main.tf create mode 100644 provider.tf create mode 100644 scripts/setup.sh diff --git a/LICENSE b/LICENSE index ea0abb6..ebfd7bf 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,375 @@ -The MIT License (MIT) - -Copyright (c) 2015 Christophe Porteneuve - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +Copyright (c) 2020 HashiCorp, Inc. + +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. diff --git a/README.md b/README.md index 158f93f..35c7396 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,39 @@ -My Lovely Project -================= - -A great example repo you can fork to your heart’s content, that serves as a launchpad for working your way through the amazing **[Learning GitHub](http://shop.oreilly.com/category/videos/programming.do)** video training series. - -## Getting started - -The first thing you want to do with this repo is quite likely [**fork it**](https://help.github.com/articles/fork-a-repo/). Use the Fork button in the top-right section of the page to do this. - -Once you’re on your fork, you can experiment however you like with it, play with -[branches](https://help.github.com/articles/viewing-branches-in-your-repository/), -[issues](https://help.github.com/articles/about-issues), -[milestones](https://help.github.com/articles/associating-milestones-with-issues-and-pull-requests/), -[labels](https://help.github.com/articles/applying-labels-to-issues-and-pull-requests/), the -[wiki](https://help.github.com/articles/about-github-wikis/), and more. - -## What’s in there? - -Various files to support upcoming GitHub tasks the series trains you for, but more importantly, demonstration out-of-codebase contents (e.g. issues and milestones) so you can get a feeling of what features GitHub offers without having to first create such content or data. The video series frequently uses this repository as a way of touring trainees briefly through these features before tackling them. - -## License - -This repository is © 2015 Christophe Porteneuve, provided under the [MIT license](LICENSE), and part of a video training series produced for and distributed by O’Reilly. +# TFC Getting Started + +In this repo, you'll find a quick and easy path to get started using [Terraform Cloud](https://app.terraform.io/) with the [Terraform CLI](https://github.com/hashicorp/terraform). + +## What's here? + +This repo contains two main things: + +1. An example Terraform configuration which provisions some mock infrastructure to a fictitious cloud provider called "Fake Web Services" using the [`fakewebservices`](https://registry.terraform.io/providers/hashicorp/fakewebservices/latest) provider. +1. A [script](./scripts/setup.sh) which automatically handles all the setup required to start using Terraform with Terraform Cloud. + +## Requirements + +- Terraform 0.14 or higher +- The ability to run a bash script in your terminal +- [`sed`](https://www.gnu.org/software/sed/) +- [`curl`](https://curl.se/) +- [`jq`](https://stedolan.github.io/jq/) + +## Usage + +### 1. Log in to Terraform Cloud via the CLI + +Run `terraform login` and follow the prompts to get an API token for Terraform to use. If you don't have a Terraform Cloud account, you can create one during this step. + +### 2. Clone this repo + +```sh +git clone https://github.com/hashicorp/tfc-getting-started.git +cd tfc-getting-started +``` + +### 3. Run the setup script and follow the prompts + +``` +./scripts/setup.sh +``` + +Welcome to Terraform Cloud! diff --git a/backend.tf b/backend.tf new file mode 100644 index 0000000..9f8a8b7 --- /dev/null +++ b/backend.tf @@ -0,0 +1,13 @@ +# The block below configures Terraform to use the 'remote' backend with Terraform Cloud. +# For more information, see https://www.terraform.io/docs/backends/types/remote.html +terraform { + backend "remote" { + organization = "{{ORGANIZATION_NAME}}" + + workspaces { + name = "{{WORKSPACE_NAME}}" + } + } + + required_version = ">= 0.14.0" +} diff --git a/main.tf b/main.tf new file mode 100644 index 0000000..1a6263d --- /dev/null +++ b/main.tf @@ -0,0 +1,38 @@ +# The following configuration uses a provider which provisions [fake] resources +# to a fictitious cloud vendor called "Fake Web Services". Configuration for +# the fakewebservices provider can be found in provider.tf. +# +# After running the setup script (./scripts/setup.sh), feel free to change these +# resources and 'terraform apply' as much as you'd like! These resources are +# purely for demonstration and created in Terraform Cloud, scoped to your TFC +# user account. +# +# To review the provider and documentation for the available resources and +# schemas, see: https://registry.terraform.io/providers/hashicorp/fakewebservices +# +# If you're looking for the configuration for the remote backend, you can find that +# in backend.tf. + + +resource "fakewebservices_vpc" "primary_vpc" { + name = "Primary VPC" + cidr_block = "0.0.0.0/1" +} + +resource "fakewebservices_server" "servers" { + count = 2 + + name = "Server ${count.index + 1}" + type = "t2.micro" + vpc = fakewebservices_vpc.primary_vpc.name +} + +resource "fakewebservices_load_balancer" "primary_lb" { + name = "Primary Load Balancer" + servers = fakewebservices_server.servers[*].name +} + +resource "fakewebservices_database" "prod_db" { + name = "Production DB" + size = 256 +} diff --git a/provider.tf b/provider.tf new file mode 100644 index 0000000..ac19d8c --- /dev/null +++ b/provider.tf @@ -0,0 +1,13 @@ +# The following variable is used to configure the provider's authentication +# token. You don't need to provide a token on the command line to apply changes, +# though: using the remote backend, Terraform will execute remotely in Terraform +# Cloud where your token is already securely stored in your workspace! + +variable "provider_token" { + type = string + sensitive = true +} + +provider "fakewebservices" { + token = var.provider_token +} diff --git a/scripts/setup.sh b/scripts/setup.sh new file mode 100644 index 0000000..de3184b --- /dev/null +++ b/scripts/setup.sh @@ -0,0 +1,286 @@ +#!/usr/bin/env bash +set -euo pipefail + +info() { + printf "\r\033[00;35m$1\033[0m\n" +} + +success() { + printf "\r\033[00;32m$1\033[0m\n" +} + +fail() { + printf "\r\033[0;31m$1\033[0m\n" +} + +divider() { + printf "\r\033[0;1m========================================================================\033[0m\n" +} + +pause_for_confirmation() { + read -rsp $'Press any key to continue (ctrl-c to quit):\n' -n1 key +} + +# Set up an interrupt handler so we can exit gracefully +interrupt_count=0 +interrupt_handler() { + ((interrupt_count += 1)) + + echo "" + if [[ $interrupt_count -eq 1 ]]; then + fail "Really quit? Hit ctrl-c again to confirm." + else + echo "Goodbye!" + exit + fi +} +trap interrupt_handler SIGINT SIGTERM + +# This setup script does all the magic. + +# Check for required tools +declare -a req_tools=("terraform" "sed" "curl" "jq") +for tool in "${req_tools[@]}"; do + if ! command -v "$tool" > /dev/null; then + fail "It looks like '${tool}' is not installed; please install it and run this setup script again." + exit 1 + fi +done + +# Get the minimum required version of Terraform +minimumTerraformMajorVersion=0 +minimumTerraformMinorVersion=14 +minimumTerraformVersion=$(($minimumTerraformMajorVersion * 1000 + $minimumTerraformMinorVersion)) + +# Get the current version of Terraform +installedTerraformMajorVersion=$(terraform version -json | jq -r '.terraform_version' | cut -d '.' -f 1) +installedTerraformMinorVersion=$(terraform version -json | jq -r '.terraform_version' | cut -d '.' -f 2) +installedTerraformVersion=$(($installedTerraformMajorVersion * 1000 + $installedTerraformMinorVersion)) + +# Check we meet the minimum required version +if [ $installedTerraformVersion -lt $minimumTerraformVersion ]; then + echo + fail "Terraform $minimumTerraformMajorVersion.$minimumTerraformMinorVersion.x or later is required for this setup script!" + echo "You are currently running:" + terraform version + exit 1 +fi + +# Set up some variables we'll need +HOST="${1:-app.terraform.io}" +BACKEND_TF=$(dirname ${BASH_SOURCE[0]})/../backend.tf +PROVIDER_TF=$(dirname ${BASH_SOURCE[0]})/../provider.tf +TERRAFORM_VERSION=$(terraform version -json | jq -r '.terraform_version') + +# Check that we've already authenticated via Terraform in the static credentials +# file. Note that if you configure your token via a credentials helper or any +# other method besides the static file, this script will not take that in to +# account - but we do this to avoid embedding a Go binary in this simple script +# and you hopefully do not need this Getting Started project if you're using one +# already! +CREDENTIALS_FILE="$HOME/.terraform.d/credentials.tfrc.json" + +# Credentials are located in App/Data/Roaming on Windows +if [[ "$OSTYPE" =~ ^msys || "$OSTYPE" =~ ^cygwin || "$OSTYPE" =~ ^win32 ]]; then + CREDENTIALS_FILE="$APPDATA/terraform.d/credentials.tfrc.json" +fi + +TOKEN=$(jq -j --arg h "$HOST" '.credentials[$h].token' "$CREDENTIALS_FILE") +if [[ ! -f $CREDENTIALS_FILE || $TOKEN == null ]]; then + fail "We couldn't find a token in the Terraform credentials file at $CREDENTIALS_FILE." + fail "Please run 'terraform login', then run this setup script again." + exit 1 +fi + +# Check that this is your first time running this script. If not, we'll reset +# all local state and restart from scratch! +if ! git diff-index --quiet --no-ext-diff HEAD --; then + echo "It looks like you may have run this script before! Re-running it will reset any + changes you've made to backend.tf and provider.tf." + echo + pause_for_confirmation + + git checkout HEAD backend.tf provider.tf + rm -rf .terraform + rm -f *.lock.hcl +fi + +echo +printf "\r\033[00;35;1m +-------------------------------------------------------------------------- +Getting Started with Terraform Cloud +-------------------------------------------------------------------------\033[0m" +echo +echo +echo "Terraform Cloud offers secure, easy-to-use remote state management and allows +you to run Terraform remotely in a controlled environment. Terraform Cloud runs +can be performed on demand or triggered automatically by various events." +echo +echo "This script will set up everything you need to get started. You'll be +applying some example infrastructure - for free - in less than a minute." +echo +info "First, we'll do some setup and configure Terraform to use Terraform Cloud." +echo +pause_for_confirmation + +# Create a Terraform Cloud organization +echo +echo "Creating an organization and workspace..." +sleep 1 +setup() { + curl https://$HOST/api/getting-started/setup \ + --request POST \ + --silent \ + --header "Content-Type: application/vnd.api+json" \ + --header "Authorization: Bearer $TOKEN" \ + --header "User-Agent: tfc-getting-started" \ + --data @- << REQUEST_BODY +{ + "workflow": "remote-operations", + "terraform-version": "$TERRAFORM_VERSION" +} +REQUEST_BODY +} + +response=$(setup) +err=$(echo $response | jq -r '.errors') + +if [[ $err != null ]]; then + err_msg=$(echo $err | jq -r '.[0].detail') + if [[ $err_msg != null ]]; then + fail "An error occurred: ${err_msg}" + else + fail "An unknown error occurred: ${err}" + fi + exit 1 +fi + +# TODO: If there's an active trial, we should just retrieve that and configure +# it instead (especially if it has no state yet) +info=$(echo $response | jq -r '.info') +if [[ $info != null ]]; then + info "\n${info}" + exit 0 +fi + +organization_name=$(echo $response | jq -r '.data."organization-name"') +workspace_name=$(echo $response | jq -r '.data."workspace-name"') + +echo +echo "Writing remote backend configuration to backend.tf..." +sleep 2 + +# We don't sed -i because MacOS's sed has problems with it. +TEMP=$(mktemp) +cat $BACKEND_TF | + # add backend config for the hostname if necessary + if [[ "$HOST" != "app.terraform.io" ]]; then sed "5a\\ +\ hostname = \"$HOST\" + "; else cat; fi | + # replace the organization and workspace names + sed "s/{{ORGANIZATION_NAME}}/${organization_name}/" | + sed "s/{{WORKSPACE_NAME}}/${workspace_name}/" \ + > $TEMP +mv $TEMP $BACKEND_TF + +# add extra provider config for the hostname if necessary +if [[ "$HOST" != "app.terraform.io" ]]; then + TEMP=$(mktemp) + cat $PROVIDER_TF | + sed "11a\\ + \ hostname = var.provider_hostname + " \ + > $TEMP + echo " +variable \"provider_hostname\" { + type = string +}" >> $TEMP + mv $TEMP $PROVIDER_TF +fi + +echo +divider +echo +success "Ready to go; the example configuration is set up to use Terraform Cloud!" +echo +echo "An example workspace named '${workspace_name}' was created for you." +echo "You can view this workspace in the Terraform Cloud UI here:" +echo "https://$HOST/app/${organization_name}/workspaces/${workspace_name}" +echo +info "Next, we'll run 'terraform init' to initialize the backend and providers:" +echo +echo "$ terraform init" +echo +pause_for_confirmation + +echo +terraform init +echo +echo "..." +sleep 2 +echo +divider +echo +info "Now it’s time for 'terraform plan', to see what changes Terraform will perform:" +echo +echo "$ terraform plan" +echo +pause_for_confirmation + +echo +terraform plan +echo +echo "..." +sleep 3 +echo +divider +echo +success "The plan is complete!" +echo +echo "This plan was initiated from your local machine, but executed within +Terraform Cloud!" +echo +echo "Terraform Cloud runs Terraform on disposable virtual machines in +its own cloud infrastructure. This 'remote execution' helps provide consistency +and visibility for critical provisioning operations. It also enables notifications, +version control integration, and powerful features like Sentinel policy enforcement +and cost estimation (shown in the output above)." +echo +info "To actually make changes, we'll run 'terraform apply'. We'll also auto-approve +the result, since this is an example:" +echo +echo "$ terraform apply -auto-approve" +echo +pause_for_confirmation + +echo +terraform apply -auto-approve + +echo +echo "..." +sleep 3 +echo +divider +echo +success "You did it! You just provisioned infrastructure with Terraform Cloud!" +echo +info "The organization we created here has a 30-day free trial of the Team & +Governance tier features. After the trial ends, you'll be moved to the Free tier." +echo +echo "You now have:" +echo +echo " * Workspaces for organizing your infrastructure. Terraform Cloud manages" +echo " infrastructure collections with workspaces instead of directories. You" +echo " can view your workspace here:" +echo " https://$HOST/app/$organization_name/workspaces/$workspace_name" +echo " * Remote state management, with the ability to share outputs across" +echo " workspaces. We've set up state management for you in your current" +echo " workspace, and you can reference state from other workspaces using" +echo " the 'terraform_remote_state' data source." +echo " * Much more!" +echo +info "To see the mock infrastructure you just provisioned and continue exploring +Terraform Cloud, visit: +https://$HOST/fake-web-services" +echo +exit 0