Gruntwork

https://docs.gruntwork.io
Admin
Gruntwork provides a platform with a comprehensive library of pre-built modules, tools, and...
Tokens:1,025,267
Snippets:5,947
Trust Score:9.7
Update:11 months ago
Show doc for...
Tokens:
Raw
### Basic Markdown Document Structure Example

Source: https://docs.gruntwork.io/guides/style/markdown-style-guide

This example demonstrates the recommended layout for Markdown documents, including a main title, introduction, and subsequent topic headings.

```markdown
# Document Title  
  
Short introduction.  
  
## Topic  
  
Content.  
  
## Another Topic  
  
More content.  


```

--------------------------------

### Install sign-binary-helpers using Gruntwork Installer

Source: https://docs.gruntwork.io/reference/modules/terraform-aws-ci/sign-binary-helpers

Installs the 'sign-binary-helpers' module using the Gruntwork Installer. This is the recommended method for setting up the signing utilities.

```bash
gruntwork-install --module-name "sign-binary-helpers" --repo "https://github.com/gruntwork-io/terraform-aws-ci" --tag "0.0.1"
```

--------------------------------

### Terraform Output Definition with Description

Source: https://docs.gruntwork.io/guides/style/terraform-style-guide

Provides an example of a Terraform output block, highlighting the requirement for a 'description' argument placed before the 'value' argument for clarity.

```Terraform
output "greeting" {
  description = "This is a greeting for everyone."
  value       = "hello world!"
}

```

--------------------------------

### Clone Project with Git

Source: https://docs.gruntwork.io/2.0/docs/pipelines/installation/addingexistinggitlabrepo

This command clones a specified Git repository to your local machine. Ensure Git is installed before executing. This is a prerequisite for navigating into the project directory and proceeding with infrastructure setup.

```bash
git clone git@gitlab.com:acme/infrastructure-live.git  
cd infrastructure-live  
```

--------------------------------

### Execute setup-minikube Helper Script

Source: https://docs.gruntwork.io/reference/modules/terraform-aws-ci/kubernetes-circleci-helpers

Executes the `setup-minikube` script after the Gruntwork Installer and the kubernetes-circleci-helpers module have been installed. This script configures and starts a minikube cluster suitable for use within a CircleCI job.

```shell
setup-minikube
```

--------------------------------

### Install Gruntwork Installer and Kubernetes CircleCI Helpers

Source: https://docs.gruntwork.io/reference/modules/terraform-aws-ci/kubernetes-circleci-helpers

Installs the Gruntwork Installer and then uses it to install the 'kubernetes-circleci-helpers' module from a specified repository and tag. This is typically the first step in setting up the helpers in a CircleCI job.

```shell
gruntwork-install --module-name "kubernetes-circleci-helpers" --repo "https://github.com/gruntwork-io/terraform-aws-ci" --tag "0.0.1"
```

```shell
# Install the Gruntwork Installer
curl -Ls https://raw.githubusercontent.com/gruntwork-io/gruntwork-installer/main/bootstrap-gruntwork-installer.sh | bash /dev/stdin --version 0.0.22

# Use the Gruntwork Installer to install the kubernetes-circleci-helpers modulegruntwork-install --module-name "kubernetes-circleci-helpers" --repo "https://github.com/gruntwork-io/terraform-aws-ci" --tag "0.13.12"
```

```shell
# Install the Gruntwork Installer
curl -Ls https://raw.githubusercontent.com/gruntwork-io/gruntwork-installer/main/bootstrap-gruntwork-installer.sh | bash /dev/stdin --version 0.0.9

# Use the Gruntwork Installer to install the kubernetes-circleci-helpers modulegruntwork-install --module-name "kubernetes-circleci-helpers" --repo "https://github.com/gruntwork-io/terraform-aws-ci" --tag "0.0.5"
```

--------------------------------

### Install Jenkins using Gruntwork Installer

Source: https://docs.gruntwork.io/reference/modules/terraform-aws-ci/install-jenkins

This command installs the Jenkins module using the Gruntwork Installer. It clones the repository, fetches the specified tag, and copies the `install.sh` and `run-jenkins` scripts to the server. The `install.sh` script is then executed to install Jenkins and the `run-jenkins` script is placed in `/usr/local/bin`.

```bash
gruntwork-install \
  --module-name 'install-jenkins' \
  --repo 'https://github.com/gruntwork-io/terraform-aws-ci' \
  --tag '<VERSION>' \
  --version 2.164.3
```

--------------------------------

### Install Entrypoint CLI with Gruntwork Installer (Dockerfile)

Source: https://docs.gruntwork.io/reference/modules/terraform-aws-lambda/run-lambda-entrypoint

This Dockerfile snippet demonstrates how to install the `run-lambda-entrypoint` CLI using the Gruntwork Installer. It bootstraps the installer and then uses it to fetch and install the specified module version. This method requires a GitHub Personal Access Token with access to the private Gruntwork repository.

```dockerfile
ARG terraform_aws_lambda_version=v0.19.0

RUN curl -Ls https://raw.githubusercontent.com/gruntwork-io/gruntwork-installer/main/bootstrap-gruntwork-installer.sh | bash /dev/stdin --version v0.0.37 \
    && gruntwork-install \
      --repo "https://github.com/gruntwork-io/terraform-aws-lambda" \
      --module-name "run-lambda-entrypoint" \
      --tag "$terraform_aws_lambda_version"
```

--------------------------------

### Install Boilerplate with Mise

Source: https://docs.gruntwork.io/2.0/docs/pipelines/installation/addingexistinggitlabrepo

Installs the latest version of Boilerplate using the 'mise' version manager. Mise simplifies the installation and management of various development tools. Ensure Mise is installed prior to running this command.

```bash
mise use -g boilerplate@latest  
```

--------------------------------

### Clone Gruntwork Service Catalog Repo - Git

Source: https://docs.gruntwork.io/ecs-deploy-runner/tutorial

Clones the Gruntwork Service Catalog repository to access tutorial code. Requires Git to be installed.

```bash
git clone https://github.com/gruntwork-io/terraform-aws-service-catalog.git  
```

--------------------------------

### Terratest Setup and Teardown with Go Subtests

Source: https://docs.gruntwork.io/guides/style/terraform-style-guide

Demonstrates the setup and teardown pattern using Go's subtest functionality within Terratest. This example shows how to deploy a VPC, run multiple parallel tests that depend on it, and ensure the VPC is torn down only after all subtests complete. It addresses potential issues with parallel execution and range variable updates.

```go
func TestECS(t *testing.T) {
    t.Parallel()

    defer tearDownVPC()
    deployVPC()

    // Wrap the parallel tests in a synchronous test group to ensure that the main test function (the one calling 
    // `tearDownVPC` and `deployVPC`) waits until all the subtests are done before running the deferred function.
    t.Run("group", func(t *testing.T) {
        for _, testCase := range testCases {
            // To avoid the range variable from getting updated in the parallel tests, we bind a new name that is within
            // the scope of the for block.
            testCase := testCase
            t.Run(testCase.name, func(t *testing.T) {
                t.Parallel()
                testCase.testCode()
            })
        }
    })
}
```

--------------------------------

### Initialize Terraform - Terraform

Source: https://docs.gruntwork.io/ecs-deploy-runner/tutorial

Initializes the Terraform working directory, downloading necessary provider plugins and modules. Requires Terraform to be installed and configured.

```bash
terraform init  
```

--------------------------------

### Go: Example of Skipping Test Stages with Environment Variables

Source: https://docs.gruntwork.io/guides/style/terraform-style-guide

Illustrates how to use environment variables in Go to skip specific stages of a test function. This is particularly helpful during development when you want to focus on a particular part of the test, such as validation, without re-running resource-intensive setup or deployment stages. The commented-out `os.Setenv` lines provide clear examples of how to disable stages.

```Go
// Uncomment the items below to skip certain parts of the test
//os.Setenv("SKIP_build_ami", "true")
//os.Setenv("SKIP_deploy_terraform", "true")
//os.Setenv("SKIP_validate", "true")
os.Setenv("SKIP_cleanup", "true")
os.Setenv("SKIP_cleanup_ami", "true")
```

--------------------------------

### Navigate to Gruntwork Pipelines Example Directory - Bash

Source: https://docs.gruntwork.io/ecs-deploy-runner/tutorial

Changes the current directory to the Gruntwork Pipelines example within the cloned repository. Requires Bash or a compatible shell.

```bash
cd terraform-aws-service-catalog/examples/for-learning-and-testing/gruntwork-pipelines  
```

--------------------------------

### Go: Composition Example - Idiomatic vs Non-Idiomatic Functions

Source: https://docs.gruntwork.io/guides/style/golang-style-guide

This snippet demonstrates the difference between non-idiomatic and idiomatic Go code regarding function composition. The non-idiomatic example uses a single function for multiple operations, while the idiomatic example breaks down the logic into smaller, reusable functions (add and mul) for better composition.

```Go
// Don't do this  
func main() {  
    fmt.Println(mulOfSums(1, 1))  
}  
  
func mulOfSums(a, b int) int {  
    return (a + b) * (a + b)  
}  
```

```Go
// Do this instead  
func main() {  
    fmt.Println(mul(add(1, 1), add(1, 1)))  
}  
  
func add(a, b int) int {  
    return a + b  
}  
  
func mul(a, b int) int {  
    return a * b  
}  
```

--------------------------------

### Install infrastructure-deployer CLI Tool

Source: https://docs.gruntwork.io/ecs-deploy-runner/tutorial

Installs the 'infrastructure-deployer' command-line interface (CLI) tool using the 'gruntwork-install' binary. This tool is required to invoke the Gruntwork Pipelines Lambda function.

```bash
gruntwork-install --binary-name "infrastructure-deployer" --repo "https://github.com/gruntwork-io/terraform-aws-ci" --tag "$TERRAFORM_AWS_CI_VERSION"
```

--------------------------------

### AWS STS Get Caller Identity Output Example

Source: https://docs.gruntwork.io/guides/build-it-yourself/achieve-compliance/deployment-walkthrough/deploy-landing-zone-solution/apply-account-baseline-app-to-other-child-accounts

This is an example of the expected JSON output when successfully assuming an IAM role using the 'aws sts get-caller-identity' command. It includes the User ID, Account ID, and the ARN of the assumed role.

```json
{
  "UserId": "AIDAXXXXXXXXXXXX:1111111111111111111",
  "Account": "${local.accounts.stage}",
  "Arn": "arn:aws:sts::${local.accounts.stage}:assumed-role/OrganizationAccountAccessRole/1111111111111111111"
}

```

--------------------------------

### Move Patcher Binary to PATH (Bash)

Source: https://docs.gruntwork.io/2.0/docs/patcher/installation

This snippet demonstrates how to move the downloaded Patcher binary to a directory included in the system's PATH, enabling command-line access from any location. It first shows how to check the current PATH and then how to move the binary.

```bash
mv patcher_linux_amd64 patcher
```

```bash
$ echo $PATH
/opt/homebrew/bin:/opt/homebrew/sbin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/go/bin:/Library/Apple/usr/bin:/Users/grunty/bin:/Users/grunty/go/bin
$ mv patcher /usr/local/bin
```

--------------------------------

### Initialize Terraform

Source: https://docs.gruntwork.io/ecs-deploy-runner/tutorial

Initializes the Terraform working directory. This command downloads the necessary provider plugins and modules required for the Terraform configuration.

```bash
terraform init
```

--------------------------------

### Clone Repository using Git

Source: https://docs.gruntwork.io/2.0/docs/pipelines/installation/addingexistingrepo

Clones a Git repository to your local machine. Ensure Git is installed before use. This command initializes the project directory.

```bash
git clone git@github.com:acme/infrastructure-live.git
cd infrastructure-live
```

--------------------------------

### Markdown Paragraph Formatting Example

Source: https://docs.gruntwork.io/guides/style/markdown-style-guide

Shows the correct way to format paragraphs in Markdown using a single blank line for separation and avoiding indentation.

```markdown
This is a paragraph. Make it as long as you want,  
and wrap text as needed.  
  
This is the beginning of a second paragraph.  


```

--------------------------------

### Terraform HCL Example for ECR Permissions

Source: https://docs.gruntwork.io/2.0/docs/accountfactory/guides/setup-delegated-repo

This example defines IAM policies in Terraform HCL for granting ECR push permissions and ECR authorization token retrieval. It specifies actions and resources required for interacting with the Elastic Container Registry. Ensure you replace placeholders like `<ACCOUNT_ID>` and `<REPOSITORY_NAME>` with your actual values.

```hcl
iam_policy = {
    "ECRPushPermissions" = {
        effect = "Allow"
        actions = [
            "ecr:CompleteLayerUpload",
            "ecr:UploadLayerPart",
            "ecr:InitiateLayerUpload",
            "ecr:BatchCheckLayerAvailability",
            "ecr:PutImage",
            "ecr:BatchGetImage"
        ]
        resources = "arn:aws:ecr:region:${<ACCOUNT_ID>}:repository/<REPOSITORY_NAME>"
    },
    "ECRAuthorizationToken" = {
        effect = "Allow",
        actions = ["ecr:GetAuthorizationToken"]
        resources = ["*"]
    }
}
```

--------------------------------

### Go: Example of Skipping Deployment and Cleanup Stages

Source: https://docs.gruntwork.io/guides/style/terraform-style-guide

Shows a Go code snippet for selectively skipping test stages using environment variables. This example focuses on skipping the 'build_ami' and 'deploy_terraform' stages while enabling 'validate'. This is useful when debugging validation logic after a successful deployment, allowing for faster iteration without redeploying resources.

```Go
// Uncomment the items below to skip certain parts of the test
os.Setenv("SKIP_build_ami", "true")
os.Setenv("SKIP_deploy_terraform", "true")
//os.Setenv("SKIP_validate", "true")
os.Setenv("SKIP_cleanup", "true")
os.Setenv("SKIP_cleanup_ami", "true")
```

--------------------------------

### Example config.yaml Entry

Source: https://docs.gruntwork.io/2.0/docs/patcher/tutorials/authoring-first-patch

This is an example of a fully populated entry in the `.patcher/config.yaml` file. It demonstrates how to fill in the `tag`, `slug`, and `modules_affected` fields for a specific breaking change, such as 'sample-breaking-change' affecting the 'patcher-test' module at version 'v0.10.4'.

```yaml
  - tag: v0.10.4
    patches:
      - slug: "sample-breaking-change"
        modules_affected:
          - patcher-test

```

--------------------------------

### Initialize Go Module and Install Terratest Dependencies

Source: https://docs.gruntwork.io/2.0/docs/library/tutorials/deploying-your-first-gruntwork-module

Initializes a new Go module and installs necessary dependencies, including Terratest and assertion libraries, for writing infrastructure tests. Runs within the test directory.

```shell
cd gw_module_guide/test  
go mod init github.com/<YOUR GITHUB USERNAME>/gw_module_guide  
go get github.com/gruntwork-io/terratest  
go get github.com/stretchr/testify/assert  
go get github.com/aws/aws-sdk-go/aws  
go mod tidy  
```

--------------------------------

### Markdown Bulleted List Formatting

Source: https://docs.gruntwork.io/guides/style/markdown-style-guide

Prefer dashes (-) for all bulleted lists over asterisks (*) or plus signs (+). This improves typeability and readability, especially when list items start with bold text.

```markdown
- Foo.  
- Bar.  
- Baz.  

```

```markdown
- **Foo.** foo foo  
- **Bar.** bar bar  
- **Baz.** baz baz  

```

```markdown
* **Foo.** foo foo  
* **Bar.** bar bar  
* **Baz.** baz baz  

```

--------------------------------

### Indented Codeblock Example

Source: https://docs.gruntwork.io/guides/style/markdown-style-guide

Shows how to use four-space indentation to create code blocks, useful for short snippets where language specification isn't critical. This method aids readability in source Markdown.

```shell
You'll need to run:

    bazel run :thing -- --foo

And then:

    bazel run :another_thing -- --bar

And again:

    bazel run :yet_again -- --baz

```

--------------------------------

### Bootstrap infrastructure-live Repository with Boilerplate

Source: https://docs.gruntwork.io/2.0/docs/pipelines/installation/addingnewrepo

Scaffolds the 'infrastructure-live' repository using Boilerplate with a specified template URL and output folder. This command initializes the repository with necessary content for CI/CD pipelines.

```bash
boilerplate \
  --template-url 'github.com/gruntwork-io/terragrunt-scale-catalog//templates/boilerplate/azure/github/infrastructure-live?ref=v1.1.0' \
  --output-folder .
```

--------------------------------

### Initialize Terraform Working Directory

Source: https://docs.gruntwork.io/2.0/docs/library/tutorials/creating-service-module

This command initializes the Terraform working directory. It downloads the necessary provider plugins and prepares the environment for subsequent Terraform commands like 'plan' and 'apply'.

```bash
terraform init

```

--------------------------------

### Deploy VPC-App Network ACLs Module

Source: https://docs.gruntwork.io/reference/modules/terraform-aws-vpc/vpc-app-network-acls

This is a basic example of how to deploy the Gruntwork VPC-App Network ACLs module within a Terraform configuration. It serves as a starting point for integrating the module into your infrastructure.

```Terraform
# ------------------------------------------------------------------------------------------------------
# DEPLOY GRUNTWORK'S VPC-APP-NETWORK-ACLS MODULE

```

--------------------------------

### Initialize Terraform and Terragrunt Projects

Source: https://docs.gruntwork.io/2.0/docs/library/tutorials/deploying-your-first-gruntwork-module

Initializes the working directory for Terraform or Terragrunt. This command performs necessary setup steps before running other commands like 'plan' or 'apply'.

```shell
terraform init
```

```shell
terragrunt init
```

--------------------------------

### Nested Codeblock within a List (C++)

Source: https://docs.gruntwork.io/guides/style/markdown-style-guide

Provides an example of nesting a code block within a Markdown list item. Proper indentation is crucial to maintain list structure and ensure the code block is recognized.

```c++
int foo;

```

--------------------------------

### Configure EC2 Instance Metadata Service version via script

Source: https://docs.gruntwork.io/reference/modules/terraform-aws-server/require-instance-metadata-service-version

These examples demonstrate how to use the require-instance-metadata-service-version script to configure the EC2 Instance Metadata Service. The first example requires version 2.0 and disables 1.0, while the second allows both versions to be used. The script must be run on an EC2 instance with appropriate IAM permissions and installed prerequisites like AWS CLI, unzip, and jq.

```bash
# Require that only IMDS version 2.0 be used, disabling version 1.0  
require-instance-metadata-service-version --version-2-state 'required'  
```

```bash
# Allow either IMDS 1.0 or 2.0 versions to be used  
require-instance-metadata-service-version --version-2-state 'optional'  
```

--------------------------------

### Initialize Go Module and Install Terratest Dependencies

Source: https://docs.gruntwork.io/guides/working-with-code/using-modules

Initializes a Go module within the test directory and installs essential dependencies for Terratest, including Terratest itself, testify/assert for assertions, and the AWS SDK for Go. `go mod tidy` cleans up the module dependencies.

```shell
cd gw_module_guide/test
go mod init github.com/<YOUR GITHUB USERNAME>/gw_module_guide
go get github.com/gruntwork-io/terratest
go get github.com/stretchr/testify/assert
go get github.com/aws/aws-sdk-go/aws
go mod tidy
```

--------------------------------

### Configure MSK Server Properties

Source: https://docs.gruntwork.io/reference/modules/terraform-aws-messaging/msk

This example demonstrates how to configure the server.properties file for an MSK cluster. It allows customization of Kafka broker settings. Supported properties are detailed in the AWS MSK Developer Guide. Ensure property values are correctly formatted as strings.

```hcl
{
  "auto.create.topics.enable" = "true"
  "default.replication.factor" = "2"
}
```

--------------------------------

### Install Boilerplate Tool

Source: https://docs.gruntwork.io/2.0/docs/accountfactory/installation/addingnewrepo

This command installs the `boilerplate` tool, which is used for generating code and configurations from templates. It specifies a particular version (`@0.8.1`) to ensure consistency and reproducibility.

```bash
mise install boilerplate@0.8.1

```

--------------------------------

### Install Terragrunt and OpenTofu with Mise

Source: https://docs.gruntwork.io/2.0/docs/pipelines/installation/addingexistinggitlabrepo

Installs the latest versions of Terragrunt and OpenTofu using the 'mise' version manager. This ensures you have the necessary tools for provisioning and managing cloud infrastructure.

```bash
mise use -g terragrunt@latest opentofu@latest  
```

--------------------------------

### Reset IAM User Password with Gruntwork CLI

Source: https://docs.gruntwork.io/refarch/access/setup-auth

This command rotates the password for a specified IAM user within your AWS account. It is a convenient way to manage user credentials, especially when accessing sensitive Terraform state.

```bash
gruntwork aws reset-password --iam-user-name <IAM_username>
```

--------------------------------

### Dockerfile for Node.js Application

Source: https://docs.gruntwork.io/refarch/usage/maintain-your-refarch/deploying-your-apps

A Dockerfile used to build a container image for the Node.js application. It sets the base image to Node.js 14, installs dependencies using npm, copies application files, exposes port 8080, and defines the command to start the application.

```dockerfile
FROM node:14  
  
# Create app directory  
WORKDIR /usr/app  
  
COPY package*.json ./  
  
RUN npm install  
COPY . .  
  
# Ensure that our Docker image is configured to `EXPOSE`  
# the port that our app is going to need for external communication.  
EXPOSE 8080  
CMD [ "npm", "start" ]  

```

--------------------------------

### Install Terragrunt and OpenTofu with Mise

Source: https://docs.gruntwork.io/2.0/docs/pipelines/installation/addingexistingrepo

Installs the latest versions of Terragrunt and OpenTofu using the Mise package manager. Ensure Mise is installed. These tools are necessary for managing infrastructure.

```bash
mise use -g terragrunt@latest opentofu@latest
```

--------------------------------

### Go: Functional Options Pattern for Struct Instantiation

Source: https://docs.gruntwork.io/guides/style/golang-style-guide

This snippet illustrates the functional options pattern in Go, used as an alternative to instantiating a struct with numerous arguments. It shows how to use variadic functions with options to configure struct creation more cleanly and readably.

```Go
// Instead of instantiating a struct with many arguments:  
patcher, err := patcher.New(opts, true, true)  
```

```Go
// Use functional options instead:  
patcher, err := patcher.New(opts, options.WithResolveDependencies(), options.WithApplyPatches())  
```

--------------------------------

### Install CircleCI Helpers using Gruntwork Installer

Source: https://docs.gruntwork.io/reference/modules/terraform-aws-ci/circleci-helpers

Installs the 'circleci-helpers' module using the Gruntwork Installer. This is typically run in the 'dependencies' section of a CircleCI configuration file. It first bootstraps the Gruntwork Installer and then uses it to install the specified module.

```bash
gruntwork-install --module-name "circleci-helpers" --repo "https://github.com/gruntwork-io/terraform-aws-ci" --tag "0.0.1"
```

```bash
dependencies:
  override:
    # Install the Gruntwork Installer
    - curl -Ls https://raw.githubusercontent.com/gruntwork-io/gruntwork-installer/main/bootstrap-gruntwork-installer.sh | bash /dev/stdin --version 0.0.9

    # Use the Gruntwork Installer to install the gruntwork-module-circleci-helpers module
    - gruntwork-install --module-name "circleci-helpers" --repo "https://github.com/gruntwork-io/terraform-aws-ci" --tag "0.0.5"
```

--------------------------------

### API Gateway Method Settings Example

Source: https://docs.gruntwork.io/reference/modules/terraform-aws-lambda/api-gateway-proxy

Defines specific settings for HTTP methods on an API Gateway REST API. This allows for granular control over metrics and logging levels for each method (e.g., GET, POST, or all methods represented by '*').

```terraform
api_settings = {
  GET = {
    metrics_enabled = true
    logging_level   = "INFO"
  }
}
```

--------------------------------

### Markdown Link Formatting Examples

Source: https://docs.gruntwork.io/guides/style/markdown-style-guide

Demonstrates correct and incorrect ways to format Markdown links for better readability and accessibility. Avoids generic link text and bare URLs, favoring natural sentence integration or explicit inline code formatting for non-interactive links.

```markdown
See the syntax guide for more info: [link](syntax_guide.md).
Or, check out the style guide [here](style_guide.md).

```

```markdown
See the [syntax guide](syntax_guide.md) for more info.
Or, check out the [style guide](style_guide.md).

```

```markdown
This is a bare link to https://docs.gruntwork.io.

```

```markdown
This is a proper link to [https://docs.gruntwork.io](https://docs.gruntwork.io)

```

```markdown
This link to `https://docs.gruntwork.io` is for informational purposes only.

```

--------------------------------

### Construct a PEX Binary using pex CLI

Source: https://docs.gruntwork.io/reference/modules/terraform-aws-utilities/prepare-pex-environment

This example demonstrates how to construct a PEX binary using the pex command-line interface. It specifies the Python shebang, requirements file, Python versions, platforms, and output file. The pex tool searches PyPI for compatible packages, downloads them, and creates an executable zip file.

```bash
pex --python-shebang='/usr/bin/env python' \
    -r requirements.txt \
    --python=python2.7 \
    --platform macosx_10.12-x86_64 \
    --platform macosx_10.13-x86_64 \
    --platform macosx_10.14-x86_64 \
    --platform linux-x86_64 \
    --platform linux-x86_64-cp-27-mu \
    --platform win32 \
    --platform win_amd64 \
    --disable-cache \
    -o ../bin/sample_python_script_py27_env.pex
```

--------------------------------

### Boilerplate Command for Interactive Account Setup

Source: https://docs.gruntwork.io/2.0/docs/pipelines/installation/addingexistingrepo

This command uses Boilerplate to scaffold necessary content for an AWS account. It requires manual input for account-specific values during execution. Run this from the root of your repository for each account you wish to manage.

```bash
boilerplate \
  --template-url 'github.com/gruntwork-io/terragrunt-scale-catalog//templates/boilerplate/aws/github/account?ref=v1.1.0' \
  --output-folder .
```

--------------------------------

### Install Persistent EBS Volume Scripts using Gruntwork Installer

Source: https://docs.gruntwork.io/reference/modules/terraform-aws-server/persistent-ebs-volume

Installs the persistent EBS volume module using the Gruntwork Installer. Ensure you have the Gruntwork Installer configured and available in your PATH.

```bash
gruntwork-install --module-name "persistent-ebs-volume" --repo "https://github.com/gruntwork-io/terraform-aws-server" --tag "0.0.3"  
```
Tokens:
Raw