6 |
34 |
7 |
33 |
8 | ![]()
14 |
15 |
16 |
32 | {{ page.meta.hero.title }}
17 |{{ page.meta.hero.subtitle }}
18 | 23 | {{ page.meta.hero.getting_started_button }} 24 | 25 | {{ page.meta.hero.source_button }} 30 | 31 |
39 | {% for feature in page.meta.features %}
40 |
49 | {{ super() }}
50 | {% endblock %}
51 |
--------------------------------------------------------------------------------
/docs/overrides/main.html:
--------------------------------------------------------------------------------
1 | {% extends "base.html" %}
2 |
3 | {% block outdated %}
4 | You're not viewing the latest version.
5 |
6 | Click here to go to latest.
7 |
8 | {% endblock %}
9 |
10 |
11 | {% block extrahead %}
12 |
13 |
14 | {% set title = config.site_name %}
15 |
16 | {% if page and page.title and not page.is_homepage %}
17 | {% set title = config.site_name ~ " - " ~ page.title | striptags %}
18 | {% endif %}
19 |
20 | {% endblock %}
21 |
--------------------------------------------------------------------------------
/docs/requirements.txt:
--------------------------------------------------------------------------------
1 | mkdocs>=1.4.0
2 | mkdocs-material>=9.0.0
3 | pymdown-extensions>=9.0
4 | mike==2.1.3
5 | mkdocs-git-revision-date-plugin>=0.3.2
6 | mkdocs-open-in-new-tab>=1.0.2
7 | mkdocs-same-dir>=0.1.3
8 | mkdocs-redirects>=v1.2.2
9 |
--------------------------------------------------------------------------------
/docs/security.md:
--------------------------------------------------------------------------------
1 | --8<-- "SECURITY.md"
2 |
--------------------------------------------------------------------------------
/docs/stylesheets/companies.css:
--------------------------------------------------------------------------------
1 | @keyframes slider {
2 | 0% {
3 | transform: translateX(calc(100% - 100vw));
4 | }
5 | 50% {
6 | transform: translateX(0);
7 | }
8 | 100% {
9 | transform: translateX(calc(100% - 100vw));
10 | }
11 | }
12 |
13 | .companies {
14 | display: flex;
15 | flex-direction: row-reverse;
16 | white-space: nowrap;
17 | overflow: hidden;
18 | margin: 2rem auto;
19 | }
20 |
21 | .companies-title {
22 | text-transform: uppercase;
23 | }
24 |
25 | .companies-slider {
26 | white-space: nowrap;
27 | animation: 150s linear infinite slider;
28 | }
29 |
30 | .companies .company {
31 | height: 3rem;
32 | opacity: 0.6;
33 | margin: 0 1rem;
34 | filter: grayscale() brightness(25%) invert(0);
35 | }
36 |
37 | .companies .company:hover {
38 | opacity: 1;
39 | }
40 |
41 | [data-md-color-scheme="slate"] .companies .company {
42 | filter: grayscale() brightness(25%) invert(1);
43 | }
44 |
45 | .companies .company img {
46 | height: 100%;
47 | max-height: 2.5em;
48 | }
49 |
--------------------------------------------------------------------------------
/docs/stylesheets/extra.css:
--------------------------------------------------------------------------------
1 | .md-grid {
2 | max-width: 90vw
3 | }
4 |
5 | .md-typeset table td:first-child {
6 | white-space: nowrap;
7 | }
8 |
9 | .video-wrapper {
10 | position: relative;
11 | padding-bottom: 56.25%; /* 16:9 aspect ratio */
12 | height: 0;
13 | overflow: hidden;
14 | max-width: 100%;
15 | }
16 |
17 | .video-wrapper iframe {
18 | position: absolute;
19 | top: 0;
20 | left: 0;
21 | width: 100%;
22 | height: 100%;
23 | }
24 |
--------------------------------------------------------------------------------
/docs/stylesheets/hero.css:
--------------------------------------------------------------------------------
1 | [data-md-color-scheme="default"] .hero-container {
2 | padding: 4rem 0;
3 | background: linear-gradient(
4 | 180deg,
5 | var(--md-primary-fg-color),
6 | var(--mdl-accent-fg-color) 99%,
7 | var(--md-default-bg-color) 0
8 | );
9 | background-repeat: no-repeat;
10 | background-position: bottom;
11 | background-size: contain;
12 | }
13 |
14 | [data-md-color-scheme="slate"] .hero-container {
15 | padding: 4rem 0;
16 | background: linear-gradient(
17 | 180deg,
18 | var(--md-primary-fg-color),
19 | var(--md-accent-fg-color) 99%,
20 | var(--md-default-bg-color) 0
21 | );
22 | background-repeat: no-repeat;
23 | background-position: bottom;
24 | background-size: contain;
25 | }
26 |
27 | .mdx-hero {
28 | margin-bottom: 4rem;
29 | }
30 |
31 | .mdx-hero .md-button {
32 | margin-top: 0.5rem;
33 | margin-right: 0.5rem;
34 | }
35 |
36 | .mdx-hero .md-button--primary {
37 | color: var(--md-primary-fg-color--light);
38 | background-color: var(--md-accent-fg-color);
39 | border-color: var(--md-accent-fg-color);
40 | }
41 |
42 | .mdx-hero .md-button--primary:hover {
43 | color: var(--md-accent-fg-color);
44 | background-color: transparent;
45 | border-color: var(--md-accent-fg-color);
46 | }
47 |
48 | .mdx-hero__image {
49 | display: flex;
50 | justify-content: center;
51 | align-items: flex-start;
52 | }
53 |
54 | .mdx-hero__content {
55 | text-align: center;
56 | }
57 |
58 | .mdx-hero__content h1 {
59 | margin-bottom: 1rem;
60 | font-weight: 700;
61 | color: currentColor;
62 | }
63 |
64 | .mdx-features {
65 | display: grid;
66 | grid-template-columns: repeat(auto-fit, minmax(200px, 1fr));
67 | grid-gap: 3rem;
68 | margin-bottom: 3rem;
69 | }
70 |
71 | .mdx-features img {
72 | height: 160px;
73 | object-fit: fixed;
74 | }
75 |
76 | @media screen and (min-width: 960px) {
77 | .md-sidebar--secondary {
78 | display: none;
79 | }
80 |
81 | .mdx-hero {
82 | display: flex;
83 | align-items: stretch;
84 | }
85 |
86 | .mdx-hero__image {
87 | order: 1;
88 | width: 50%;
89 | }
90 |
91 | .mdx-hero__content {
92 | width: 50%;
93 | margin-top: 5rem;
94 | padding-bottom: 20vh;
95 | text-align: left;
96 | }
97 | }
98 |
--------------------------------------------------------------------------------
/docs/stylesheets/themes.css:
--------------------------------------------------------------------------------
1 | [data-md-color-scheme="default"] {
2 | --md-primary-fg-color: rgb(35, 47, 63);
3 | --md-primary-fg-color--light: rgb(255, 255, 255);
4 | --md-primary-fg-color--dark: rgb(35, 47, 63);
5 | --md-accent-fg-color: rgb(255, 153, 0);
6 | --md-accent-fg-color--light: rgb(255, 153, 0);
7 | --md-accent-fg-color--dark: rgb(255, 153, 0);
8 | --md-typeset-a-color: var(--md-accent-fg-color);
9 | }
10 |
11 | [data-md-color-scheme="slate"] {
12 | --md-primary-fg-color: rgb(35, 47, 63);
13 | --md-primary-fg-color--light: rgb(255, 255, 255);
14 | --md-primary-fg-color--dark: rgb(35, 47, 63);
15 | --md-accent-fg-color: rgb(255, 153, 0);
16 | --md-accent-fg-color--light: rgb(255, 153, 0);
17 | --md-accent-fg-color--dark: rgb(255, 153, 0);
18 | --md-typeset-a-color: var(--md-accent-fg-color);
19 | }
20 |
21 | [data-md-color-scheme="slate"] .md-button {
22 | color: var(--md-accent-fg-color);
23 | }
24 |
25 | [data-md-color-scheme="default"] .md-button {
26 | color: var(--md-accent-fg-color);
27 | }
28 |
--------------------------------------------------------------------------------
/modules/jenkins/asg.tf:
--------------------------------------------------------------------------------
1 | resource "aws_launch_template" "jenkins_build_farm_launch_template" {
2 | for_each = var.build_farm_compute
3 |
4 | name_prefix = "${local.name_prefix}-${each.key}-bf-"
5 | description = "${each.key} build farm launch template."
6 |
7 | image_id = each.value.ami
8 | instance_type = each.value.instance_type
9 | ebs_optimized = each.value.ebs_optimized
10 |
11 | vpc_security_group_ids = [aws_security_group.jenkins_build_farm_sg.id]
12 |
13 | metadata_options {
14 | http_endpoint = "enabled"
15 | http_tokens = "required"
16 | http_put_response_hop_limit = 1
17 | instance_metadata_tags = "enabled"
18 | }
19 | iam_instance_profile {
20 | arn = aws_iam_instance_profile.build_farm_instance_profile.arn
21 | }
22 | }
23 |
24 | resource "aws_autoscaling_group" "jenkins_build_farm_asg" {
25 | for_each = aws_launch_template.jenkins_build_farm_launch_template
26 |
27 | name = "${local.name_prefix}-${each.key}-build-farm"
28 | #TODO: parameterize zones for ASG. Currently deploys to same zones as Jenkins service.
29 | vpc_zone_identifier = var.build_farm_subnets
30 |
31 | launch_template {
32 | id = each.value.id
33 | version = "$Latest"
34 | }
35 |
36 | # These values are controlled by the EC2 Fleet plugin
37 | min_size = 0
38 | max_size = 1
39 |
40 | tag {
41 | key = "ASG"
42 | value = each.key
43 | propagate_at_launch = true
44 | }
45 |
46 | tag {
47 | key = "Name"
48 | value = "${local.name_prefix}-${each.key}-build-farm"
49 | propagate_at_launch = true
50 | }
51 | }
52 |
--------------------------------------------------------------------------------
/modules/jenkins/assets/media/diagrams/jenkins-admin-password.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/aws-games/cloud-game-development-toolkit/60f8177855dfecdede6bf3ddd60c04a0a0906ad7/modules/jenkins/assets/media/diagrams/jenkins-admin-password.png
--------------------------------------------------------------------------------
/modules/jenkins/assets/media/diagrams/jenkins-module-architecture.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/aws-games/cloud-game-development-toolkit/60f8177855dfecdede6bf3ddd60c04a0a0906ad7/modules/jenkins/assets/media/diagrams/jenkins-module-architecture.png
--------------------------------------------------------------------------------
/modules/jenkins/data.tf:
--------------------------------------------------------------------------------
1 | data "aws_caller_identity" "current" {}
2 | data "aws_region" "current" {}
3 |
4 | # If cluster name is provided use a data source to access existing resource
5 | data "aws_ecs_cluster" "jenkins_cluster" {
6 | count = var.cluster_name != null ? 1 : 0
7 | cluster_name = var.cluster_name
8 | }
9 |
10 | # Get target VPC
11 | data "aws_vpc" "build_farm_vpc" {
12 | id = var.vpc_id
13 | }
14 |
--------------------------------------------------------------------------------
/modules/jenkins/efs.tf:
--------------------------------------------------------------------------------
1 | ################################################################################
2 | # Filesystem
3 | ################################################################################
4 |
5 | # File system for Jenkins
6 | resource "aws_efs_file_system" "jenkins_efs_file_system" {
7 | creation_token = "${local.name_prefix}-efs-file-system"
8 | performance_mode = var.jenkins_efs_performance_mode
9 | throughput_mode = var.jenkins_efs_throughput_mode
10 |
11 | #TODO: Parameterize encryption and customer managed key creation
12 | encrypted = true
13 |
14 | lifecycle_policy {
15 | transition_to_ia = "AFTER_30_DAYS"
16 | }
17 |
18 | lifecycle_policy {
19 | transition_to_primary_storage_class = "AFTER_1_ACCESS"
20 | }
21 | #checkov:skip=CKV_AWS_184: CMK encryption not supported currently
22 | tags = merge(local.tags, {
23 | Name = "${local.name_prefix}-efs-file-system"
24 | })
25 | }
26 |
27 | # Mount targets for Jenkins containers
28 | resource "aws_efs_mount_target" "jenkins_efs_mount_target" {
29 | count = length(var.jenkins_service_subnets)
30 | file_system_id = aws_efs_file_system.jenkins_efs_file_system.id
31 | subnet_id = var.jenkins_service_subnets[count.index]
32 | security_groups = [aws_security_group.jenkins_efs_security_group.id]
33 | }
34 |
35 | # Jenkins Home directory access point
36 | resource "aws_efs_access_point" "jenkins_efs_access_point" {
37 | file_system_id = aws_efs_file_system.jenkins_efs_file_system.id
38 | posix_user {
39 | gid = 1001
40 | uid = 1001
41 | }
42 | root_directory {
43 | path = local.jenkins_home_path
44 | creation_info {
45 | owner_gid = 1001
46 | owner_uid = 1001
47 | permissions = 755
48 | }
49 | }
50 | tags = local.tags
51 | }
52 |
53 | resource "aws_efs_backup_policy" "policy" {
54 | count = var.enable_default_efs_backup_plan ? 1 : 0
55 | file_system_id = aws_efs_file_system.jenkins_efs_file_system.id
56 |
57 | backup_policy {
58 | status = "ENABLED"
59 | }
60 | }
61 |
--------------------------------------------------------------------------------
/modules/jenkins/examples/complete/dns.tf:
--------------------------------------------------------------------------------
1 | ##########################################
2 | # Route53 Hosted Zone for FQDN
3 | ##########################################
4 | data "aws_route53_zone" "root" {
5 | name = var.fully_qualified_domain_name
6 | private_zone = false
7 | }
8 |
9 | resource "aws_route53_record" "jenkins" {
10 | zone_id = data.aws_route53_zone.root.id
11 | name = "jenkins.${data.aws_route53_zone.root.name}"
12 | type = "A"
13 | alias {
14 | name = module.jenkins.jenkins_alb_dns_name
15 | zone_id = module.jenkins.jenkins_alb_zone_id
16 | evaluate_target_health = true
17 | }
18 | }
19 |
20 | ##########################################
21 | # Jenkins Certificate Management
22 | ##########################################
23 |
24 | resource "aws_acm_certificate" "jenkins" {
25 | domain_name = "jenkins.${data.aws_route53_zone.root.name}"
26 | validation_method = "DNS"
27 |
28 | tags = {
29 | environment = "dev"
30 | }
31 |
32 | lifecycle {
33 | create_before_destroy = true
34 | }
35 | }
36 |
37 | resource "aws_route53_record" "jenkins_cert" {
38 | for_each = {
39 | for dvo in aws_acm_certificate.jenkins.domain_validation_options : dvo.domain_name => {
40 | name = dvo.resource_record_name
41 | record = dvo.resource_record_value
42 | type = dvo.resource_record_type
43 | }
44 | }
45 |
46 | allow_overwrite = true
47 | name = each.value.name
48 | records = [each.value.record]
49 | ttl = 60
50 | type = each.value.type
51 | zone_id = data.aws_route53_zone.root.id
52 | }
53 |
54 | resource "aws_acm_certificate_validation" "jenkins" {
55 | timeouts {
56 | create = "15m"
57 | }
58 | certificate_arn = aws_acm_certificate.jenkins.arn
59 | validation_record_fqdns = [for record in aws_route53_record.jenkins_cert : record.fqdn]
60 | }
61 |
--------------------------------------------------------------------------------
/modules/jenkins/examples/complete/local.tf:
--------------------------------------------------------------------------------
1 | data "aws_availability_zones" "available" {}
2 |
3 |
4 | locals {
5 |
6 | build_farm_compute = {
7 | example_builders : {
8 | ami = "ami-066784287e358dad1" // Amazon Linux 2023 (64-bit x86)
9 | instance_type = "t3.medium"
10 | }
11 | }
12 |
13 | build_farm_fsx_openzfs_storage = {
14 | cache : {
15 | storage_type = "SSD"
16 | throughput_capacity = 160
17 | storage_capacity = 256
18 | deployment_type = "MULTI_AZ_1"
19 | route_table_ids = [aws_route_table.private_rt.id]
20 | }
21 | }
22 |
23 | # VPC Configuration
24 | vpc_cidr_block = "10.0.0.0/16"
25 | public_subnet_cidrs = ["10.0.1.0/24", "10.0.2.0/24"]
26 | private_subnet_cidrs = ["10.0.3.0/24", "10.0.4.0/24"]
27 |
28 | tags = {
29 | environment = "cgd"
30 | }
31 | azs = slice(data.aws_availability_zones.available.names, 0, 2)
32 | }
33 |
--------------------------------------------------------------------------------
/modules/jenkins/examples/complete/main.tf:
--------------------------------------------------------------------------------
1 | # tflint-ignore: terraform_required_version
2 |
3 | ##########################################
4 | # Shared ECS Cluster for Services
5 | ##########################################
6 |
7 | resource "aws_ecs_cluster" "jenkins_cluster" {
8 | name = "jenkins-cluster"
9 |
10 | setting {
11 | name = "containerInsights"
12 | value = "enabled"
13 | }
14 | }
15 |
16 | resource "aws_ecs_cluster_capacity_providers" "providers" {
17 | cluster_name = aws_ecs_cluster.jenkins_cluster.name
18 |
19 | capacity_providers = ["FARGATE"]
20 |
21 | default_capacity_provider_strategy {
22 | base = 1
23 | weight = 100
24 | capacity_provider = "FARGATE"
25 | }
26 | }
27 |
28 | ##########################################
29 | # Jenkins
30 | ##########################################
31 |
32 | module "jenkins" {
33 | source = "../.."
34 |
35 | cluster_name = aws_ecs_cluster.jenkins_cluster.name
36 | vpc_id = aws_vpc.jenkins_vpc.id
37 | jenkins_alb_subnets = aws_subnet.public_subnets[*].id
38 | jenkins_service_subnets = aws_subnet.private_subnets[*].id
39 | existing_security_groups = []
40 | internal = false
41 | certificate_arn = aws_acm_certificate.jenkins.arn
42 | jenkins_agent_secret_arns = var.jenkins_agent_secret_arns
43 | create_ec2_fleet_plugin_policy = true
44 | debug = true
45 | enable_jenkins_alb_deletion_protection = false
46 | enable_default_efs_backup_plan = false
47 |
48 | # Build Farms
49 | build_farm_subnets = aws_subnet.private_subnets[*].id
50 |
51 | build_farm_compute = local.build_farm_compute
52 |
53 | build_farm_fsx_openzfs_storage = local.build_farm_fsx_openzfs_storage
54 | # Artifacts
55 | artifact_buckets = {
56 | builds : {
57 | name = "game-builds"
58 | enable_force_destroy = true
59 |
60 | tags = {
61 | Name = "game-builds"
62 | }
63 | },
64 | }
65 |
66 | depends_on = [aws_ecs_cluster.jenkins_cluster, aws_acm_certificate_validation.jenkins]
67 | }
68 |
--------------------------------------------------------------------------------
/modules/jenkins/examples/complete/variables.tf:
--------------------------------------------------------------------------------
1 | variable "fully_qualified_domain_name" {
2 | type = string
3 | description = "A fully qualified domain name (FQDN) to be used for jenkins. A record will be created on the hosted zone with the following patterns 'jenkins.
41 |
42 |
43 |
47 | {% endfor %}
48 | {{ feature.title }}
44 | 45 |{{ feature.description }}
46 |