-
Notifications
You must be signed in to change notification settings - Fork 13
/
example_config.sh
158 lines (116 loc) · 5.06 KB
/
example_config.sh
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
# This is an example configuration for the deadline-cloud-test-fixtures package
# If "true", the Docker worker is used instead of the EC2 worker. Default is to use the EC2 worker.
# For EC2 Worker configuration, see the "EC2 WORKER OPTIONS" section below
# For Docker Worker configuration, see the "DOCKER WORKER OPTIONS" section below
export USE_DOCKER_WORKER
# ====================== #
# === COMMON OPTIONS === #
# ====================== #
# --- REQUIRED --- #
# The AWS account ID to deploy infrastructure into
export SERVICE_ACCOUNT_ID
# CodeArtifact repository information to configure pip to pull Python dependencies from
#
# The domain owner AWS account ID
export CODEARTIFACT_ACCOUNT_ID
# The domain the repository is in
export CODEARTIFACT_DOMAIN
# The name of the repository
export CODEARTIFACT_REPOSITORY
# The region the repository is in
export CODEARTIFACT_REGION
# --- OPTIONAL --- #
# The AWS region to use
# Falls back to AWS_DEFAULT_REGION, then defaults to us-west-2
export REGION
# Extra local path for boto to look for AWS models in
# Does not apply to the worker
export AWS_DATA_PATH
# Local path to the Worker agent .whl file to use for the tests
# Default is to pip install the latest "deadline-cloud-worker-agent" package
export WORKER_AGENT_WHL_PATH
# DEPRECATED: Use REGION instead
# The AWS region to configure the worker for
# Falls back to AWS_DEFAULT_REGION, then defaults to us-west-2
# export WORKER_REGION
# The POSIX user to configure the worker for
# Defaults to "deadline-worker"
export WORKER_POSIX_USER
# The shared POSIX group to configure the worker user and job user with
# Defaults to "shared-group"
export WORKER_POSIX_SHARED_GROUP
# PEP 508 requirement specifier for the Worker agent package
# If WORKER_AGENT_WHL_PATH is provided, this option is ignored
export WORKER_AGENT_REQUIREMENT_SPECIFIER
# The S3 URI for the "deadline" service model to use for the tests
# Falls back to LOCAL_MODEL_PATH, then defaults to your locally installed service model
export DEADLINE_SERVICE_MODEL_S3_URI
# Path to a local Deadline model file to use for API calls
# If DEADLINE_SERVICE_MODEL_S3_URI is provided, this option is ignored
# Default is to use the locally installed service model on your machine
export LOCAL_MODEL_PATH
# The endpoint to use for requests to the AWS Deadline Cloud service
# Default is the endpoint specified in your AWS model file for "deadline"
export DEADLINE_ENDPOINT
# The CredentialVending service principal to configure the Worker IAM roles with
# If you don't know what this is, then you probably don't need to provide this
export CREDENTIAL_VENDING_PRINCIPAL
# Used as an infix for the S3 bucket deployed by the "deploy_job_attachment_resources" fixture
# Defaults to "dev"
export STAGE
# If set to "true", does not stop the worker after test failure. Useful for debugging.
export KEEP_WORKER_AFTER_FAILURE
# If BYO_DEADLINE is "true", uses existing Deadline resource IDs as specified below
# By default, new resources are deployed for you that get deleted after test runs
export BYO_DEADLINE
# Required - The ID of the farm to use
export FARM_ID
# Required - The ID of the queue to use
export QUEUE_ID
# Required - The ID of the fleet to use
export FLEET_ID
# Optional - The ID of the KMS key association with your farm
# If you use this option, then you must BYO_BOOTSTRAP because the default IAM role created for
# the Worker will not have sufficient permissions to access this key
export FARM_KMS_KEY_ID
# Optional - The name of the S3 buckets to use for Job Attachments
export JOB_ATTACHMENTS_BUCKET
# If BYO_BOOTSTRAP is "true", uses existing bootstrap resources as specified below
# By default, new resources are deployed for you in a CloudFormation stack.
# This stack is not destroyed automatically after test runs.
export BYO_BOOTSTRAP
# Required - The name of the S3 bucket to use for bootstrapping files
export BOOTSTRAP_BUCKET_NAME
# Required - ARN of the IAM role to use for the Worker
export WORKER_ROLE_ARN
# Optional - ARN of the IAM role to use for sessions running on the Worker
export SESSION_ROLE_ARN
# Optional - Name of the IAM instance profile to bootstrap the Worker instance with
# This option does not apply if you USE_DOCKER_WORKER
export WORKER_INSTANCE_PROFILE_NAME
# ========================== #
# === EC2 WORKER OPTIONS === #
# ========================== #
# --- REQUIRED --- #
# Subnet to deploy the EC2 instance into
export SUBNET_ID
# Security group to deploy the EC2 instance into
export SECURITY_GROUP_ID
# --- OPTIONAL --- #
# AMI ID to use for the EC2 instance
# Defaults to latest AL2023 AMI
export AMI_ID
# ============================= #
# === DOCKER WORKER OPTIONS === #
# ============================= #
# --- REQUIRED --- #
# The AWS credentials the Worker agent will use to bootstrap itself
export AWS_ACCESS_KEY_ID
export AWS_SECRET_ACCESS_KEY
export AWS_SESSION_TOKEN
export AWS_DEFAULT_REGION
# --- OPTIONAL --- #
# The pip index to use for installing Worker agent dependencies
# See https://pip.pypa.io/en/stable/cli/pip_install/
export PIP_INDEX_URL