Skip to content

Commit

Permalink
Addressed feedback to remove some unnecessary info from example readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
grbartel committed Nov 13, 2020
1 parent 757153b commit da47370
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 37 deletions.
23 changes: 5 additions & 18 deletions examples/deadline/All-In-AWS-Infrastructure-SEP/python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,20 +18,7 @@ These instructions assume that your working directory is `examples/deadline/All-
```bash
pip install -r requirements.txt
```
3. If working on the `release` branch, this step can be skipped. If working on `mainline`, navigate to the base directory where the build and packaging scripts are, then run them and install the result over top of the `aws-rfdk` version that was installed in the previous step:
```bash
# Navigate to the root directory of the RFDK repository
pushd ../../../..
# Enter the Docker container to run the build and pack scripts
./scripts/rfdk_build_environment.sh
./build.sh
./pack.sh
# Exit the Docker container
exit
# Navigate back to the example directory
popd
pip install ../../../../dist/python/aws-rfdk-<version>.tar.gz
4. Stage the Docker recipes for `RenderQueue`:
3. Stage the Docker recipes for `RenderQueue`:

```bash
# Set this value to the version of RFDK your application targets
Expand All @@ -42,22 +29,22 @@ These instructions assume that your working directory is `examples/deadline/All-
npx --package=aws-rfdk@${RFDK_VERSION} stage-deadline --output stage ${RFDK_DEADLINE_VERSION}
```
5. Deploy all the stacks in the sample app:
4. Deploy all the stacks in the sample app:

```bash
cdk deploy "*"
```

6. Connect to your Render Farm and open up the Deadline Monitor.
5. Connect to your Render Farm and open up the Deadline Monitor.

7. Configure the Spot event plugin by following the directions in the [Spot Event Plugin documentation](https://docs.thinkboxsoftware.com/products/deadline/10.1/1_User%20Manual/manual/event-spot.html) with the following considerations:
6. Configure the Spot event plugin by following the directions in the [Spot Event Plugin documentation](https://docs.thinkboxsoftware.com/products/deadline/10.1/1_User%20Manual/manual/event-spot.html) with the following considerations:

Use the default security credentials by using turning "Use Local Credentials" to False and leaving both "Access Key ID" and "Secret Access Key" blank.
Ensure that the Region your Spot workers will be launched in is the same region as your CDK application.
When Creating your Spot Fleet Requests, set the IAM instance profile to "DeadlineSpotWorkerRole" and set the security group to "DeadlineSpotSecurityGroup".
Configure your instances to connect to the Render Queue by either creating your AMI after launching your app and preconfiguring the AMI or by setting up a userdata in the Spot Fleet Request. (see the Spot Event Plugin documentation for additional information on configuring this connection.)

8. Once you are finished with the sample app, you can tear it down by running:
7. Once you are finished with the sample app, you can tear it down by running:

```bash
cdk destroy "*"
Expand Down
25 changes: 6 additions & 19 deletions examples/deadline/All-In-AWS-Infrastructure-SEP/ts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,45 +17,32 @@ These instructions assume that your working directory is `examples/deadline/All-
```
yarn install
```
3. If working on the `release` branch, this step can be skipped. If working on `mainline`, navigate to the base directory where the build and packaging scripts are, then run them and install the result over top of the `aws-rfdk` version that was installed in the previous step:
```bash
# Navigate to the root directory of the RFDK repository
pushd ../../../..
# Enter the Docker container to run the build and pack scripts
./scripts/rfdk_build_environment.sh
./build.sh
./pack.sh
# Exit the Docker container
exit
# Navigate back to the example directory
popd
npm install ../../../../dist/js/aws-rfdk\@<version>.jsii.tgz
4. Modify the `deadline_ver` field in the `config` block of `package.json` as desired (Deadline 10.1.9 and up are supported), then stage the Docker recipes for `RenderQueue`:
3. Modify the `deadline_ver` field in the `config` block of `package.json` as desired (Deadline 10.1.9 and up are supported), then stage the Docker recipes for `RenderQueue`:
```
yarn stage
```
5. Build the sample app:
4. Build the sample app:
```
yarn build
```
6. Deploy all the stacks in the sample app:
5. Deploy all the stacks in the sample app:
```
cdk deploy
```
7. Connect to your Render Farm and open up the Deadline Monitor.
6. Connect to your Render Farm and open up the Deadline Monitor.
8. Configure the Spot event plugin by following the directions in the [Spot Event Plugin documentation](https://docs.thinkboxsoftware.com/products/deadline/10.1/1_User%20Manual/manual/event-spot.html) with the following considerations:
7. Configure the Spot event plugin by following the directions in the [Spot Event Plugin documentation](https://docs.thinkboxsoftware.com/products/deadline/10.1/1_User%20Manual/manual/event-spot.html) with the following considerations:
Use the default security credentials by using turning "Use Local Credentials" to False and leaving both "Access Key ID" and "Secret Access Key" blank.
Ensure that the Region your Spot workers will be launched in is the same region as your CDK application.
When Creating your Spot Fleet Requests, set the IAM instance profile to "DeadlineSpotWorkerRole" and set the security group to "DeadlineSpotSecurityGroup".
Configure your instances to connect to the Render Queue by either creating your AMI after launching your app and preconfiguring the AMI or by setting up a userdata in the Spot Fleet Request. (see the Spot Event Plugin documentation for additional information on configuring this connection.)
9. Once you are finished with the sample app, you can tear it down by running:
8. Once you are finished with the sample app, you can tear it down by running:
```
cdk destroy
Expand Down

0 comments on commit da47370

Please sign in to comment.