Skip to content

Commit

Permalink
feat: Added getting-started documentation for quickstart with Simple …
Browse files Browse the repository at this point in the history
…Build Pipeline (#177)

Co-authored-by: Kyle Somers <17753062+kylesomers@users.noreply.github.com>
  • Loading branch information
henrykie and kylesomers authored Aug 6, 2024
1 parent d5469d8 commit 4710f8e
Show file tree
Hide file tree
Showing 10 changed files with 253 additions and 13 deletions.
4 changes: 3 additions & 1 deletion docs/assets/dockerfiles.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# Dockerfiles
# Dockerfiles

Coming soon.
4 changes: 2 additions & 2 deletions docs/assets/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@
| Asset Type | Description |
| :--------------------------------------------------------------- | :- |
| [:simple-packer: __Packer Templates__](./packer/index.md) | Packer templates provide an easy way to build machine images for commonly used game dev infrastructure. Currently the project includes Packer templates for UE5 build agents for Linux and Windows, as well as a Packer template for building a Perforce Helix Core version control AMI. |
| [:simple-jenkins: __Jenkins Pipelines__](./jenkins-pipelines.md) | Jenkins Pipelines for common game dev automation workflows |
| [:simple-ansible: __Ansible Playbooks__](./playbooks.md) | Automation scripts for reusable system level configurations. |
| [:simple-jenkins: __Jenkins Pipelines__](./jenkins-pipelines/jenkins-pipelines.md) | Jenkins Pipelines for common game dev automation workflows |
| [:simple-ansible: __Ansible Playbooks__](./ansible-playbooks/ansible-playbooks.md) | Automation scripts for reusable system level configurations. |
| [:simple-docker: __Dockerfiles (Coming Soon!)__](./dockerfiles.md) | Dockerfiles for creating Docker images of commonly used game dev infrastructure. These are primarily used in scenarios where there aren't openly available pre-built images that address a use case, or significant customization is needed that warrants building an image |
1 change: 0 additions & 1 deletion docs/assets/jenkins-pipelines.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/assets/jenkins-pipelines/jenkins-pipelines.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Jenkins Pipelines
--8<-- "assets/jenkins-pipelines/README.md"
2 changes: 1 addition & 1 deletion docs/assets/packer/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
!!! info
**Don't see a Packer template that solves your needs?** Create a [feature request](https://github.com/aws-games/cloud-game-development-toolkit/issues/new?assignees=&labels=feature-request&projects=&template=feature_request.yml&title=Feature+request%3A+TITLE) for a new template or learn [how to contribute new assets to the project below](#Contribute new Assets to the Cloud Game Development Toolkit)

| Asset Type | Description |
| Template | Description |
| :--------------------------------------------------------------- | :- |
| [:simple-linux: __Linux Build Agents__](./build-agents/linux.md) | Provision C++ compilation machines on Amazon Linux 2023 and Ubuntu machines on both x86 and ARM based architectures with useful tools like compiler caches such as [Octobuild](https://github.com/octobuild/octobuild) preinstalled.|
| [:material-microsoft-windows-classic: __Windows Build Agents__](./build-agents/windows.md) | Create Windows 2022 based instances capable of Unreal Engine compilation out of the box. |
Expand Down
1 change: 0 additions & 1 deletion docs/assets/playbooks.md

This file was deleted.

240 changes: 240 additions & 0 deletions docs/getting-started.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/modules/jenkins/jenkins.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ There are a few prerequisites to the deployment of Jenkins which are not directl
AWS Secrets Manager can be used to store sensitive information such as SSH keys and access tokens, which can then be made available to Jenkins. We recommend using the service to store the private key for the Jenkins agents which the Jenkins orchestrator uses to communicate over SSH.

!!! warning
To grant Jenkins access to the secrets stored in the AWS Secrets Manager, the `AWS Secrets Manager Credentials Provider` Jenkins plugin is recommended. **There are requirements around tagging your secrets for the plugin to work properly**. See the [AWS Secrets Manager Credentials Provider Plugin Documentation](https://plugins.jenkins.io/aws-secrets-manager-credentials-provider/) for additional details. Step-by-step instructions for uploading SSH keys into AWS Secrets Manager can be found in the [Configure Pluings]() section.
To grant Jenkins access to the secrets stored in the AWS Secrets Manager, the `AWS Secrets Manager Credentials Provider` Jenkins plugin is recommended. **There are requirements around tagging your secrets for the plugin to work properly**. See the [AWS Secrets Manager Credentials Provider Plugin Documentation](https://plugins.jenkins.io/aws-secrets-manager-credentials-provider/) for additional details. Step-by-step instructions for uploading SSH keys into AWS Secrets Manager can be found in the [Configure Plugins](#configuring-plugins) section.

??? note "How to Upload Secrets to AWS Secrets Manager"

Expand Down
4 changes: 2 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,8 @@ nav:
- Linux Build Agents: assets/packer/build-agents/linux.md
- Windows Build Agent: assets/packer/build-agents/windows.md
- Perforce Helix Core: assets/packer/helix-core.md
- Jenkins Pipelines: assets/jenkins-pipelines.md
- Ansible Playbooks: assets/playbooks.md
- Jenkins Pipelines: assets/jenkins-pipelines/jenkins-pipelines.md
- Ansible Playbooks: assets/ansible-playbooks/ansible-playbooks.md
- Dockerfiles: assets/dockerfiles.md
- Modules:
- Overview: modules/index.md
Expand Down
6 changes: 3 additions & 3 deletions samples/simple-build-pipeline/local.tf
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ locals {
fully_qualified_domain_name = "PLACEHOLDER" # update this to the root domain name you own

# IPV4 CIDR blocks that need Jenkins access. For example:
# <my personal ip>/32
# "<my personal ip>/32"
allowlist = []

# Jenkins and Build Farm Configurations
Expand All @@ -15,11 +15,11 @@ locals {
/* Example Configuration
graviton_builders : {
ami = "ami-0a1b2c3d4e5f"
instance_type = c7g.large
instance_type = "c7g.large"
}
windows_builders : {
ami = "ami-9z8y7x6w5v"
instance_type = c7a.large
instance_type = "c7a.large"
}
*/
}
Expand Down

0 comments on commit 4710f8e

Please sign in to comment.