Skip to content

Commit

Permalink
docs: link to installation instructions for required tools, fix packe…
Browse files Browse the repository at this point in the history
…r command invocation instructions (aws-games#194)
  • Loading branch information
jorisdon authored Aug 15, 2024
1 parent 9394df7 commit 0d7a385
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
2 changes: 1 addition & 1 deletion assets/packer/perforce/helix-core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The `p4_configure.sh` script contains the majority of Helix Core setup. It perfo
Building this AMI is as easy as running:

``` bash
packer build /assets/packer/perforce/helix-core/perforce.pkr.hcl
packer build ./assets/packer/perforce/helix-core/perforce.pkr.hcl
```

Packer will attempt to leverage the default VPC available in the AWS account and Region specified by your CLI credentials. It will provision an instance in a public subnet and communicate with that instance over the public internet. If a default VPC is not provided the above command will fail. This Packer template can take a number of variables as specified in `example.pkrvars.hcl`. Variables can be passed individually through the `-var` command line flag or through a configuration file with the `-var-file` command line flag.
Expand Down
11 changes: 6 additions & 5 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,18 +24,19 @@ This section will walk you through the prerequisites for deploying the [Simple B

You will need the following tools to complete this tutorial:

1. Terraform CLI
2. Packer CLI
3. AWS CLI
1. [Terraform CLI](https://developer.hashicorp.com/terraform/install)
2. [Packer CLI](https://developer.hashicorp.com/packer/install)
3. [AWS CLI v2](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html)

### Step 2. Create Perforce Helix Core Amazon Machine Image

Prior to deploying the infrastructure for running Perforce Helix Core we need to create an [Amazon Machine Image](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html) containing the necessary software and tools. The **Cloud Game Development Toolkit** contains a Packer template for doing just this.

1. From your terminal, run the following command from the root of the repository:
1. From your terminal, run the following commands from the root of the repository:

``` bash
packer build /packer/perforce/helix-core/perforce.pkr.hcl
packer init ./assets/packer/perforce/helix-core/perforce.pkr.hcl
packer build ./assets/packer/perforce/helix-core/perforce.pkr.hcl
```

This will use your AWS credentials to provision an [EC2 instance](https://aws.amazon.com/ec2/instance-types/) in your [Default VPC](https://docs.aws.amazon.com/vpc/latest/userguide/default-vpc.html). The Region, VPC, and Subnet where this instance is provisioned and the AMI is created are configurable - please consult the [`example.pkrvars.hcl`](./assets/packer/perforce/helix-core/example.pkrvars.hcl) file and the [Packer documentation on assigning variables](https://developer.hashicorp.com/packer/guides/hcl/variables#assigning-variables) for more details.
Expand Down

0 comments on commit 0d7a385

Please sign in to comment.