feat(examples): Added examples for Spot Event Plugin Deployment #180
Conversation
There was a problem hiding this comment.
This is incomplete, unless I'm missing something.
Don't you think that we should also demonstrate creating the resources that the SEP will need? ex: A security group for the worker fleet? A LaunchConfiguration that is set up to connect to their RenderQueue, that they could then copy the json configuration from to copy into the SEP plugin settings?
| # A bastion host to connect to the render farm with. | ||
| # The bastion host is for convenience (e.g. SSH into RenderQueue and WorkerFleet instances). | ||
| # This is not a critical component of the farm, so can safely be removed. | ||
| self.bastion = BastionHostLinux( |
There was a problem hiding this comment.
imo, it would be better if we strip the example down to just what's needed for the SEP. It makes the delta for adding SEP components clearer. The example can be framed as demonstrating just the SEP parts, and that the user could add the parts to the basic example.
Also reduces the amount of copy/paste that exists between the examples.
| There should little to no "business-logic" constructs in this stack. | ||
| """ | ||
|
|
||
| def __init__(self, scope: Construct, stack_id: str, *, props: StorageTierProps, **kwargs): |
There was a problem hiding this comment.
Since the storage tier isn't relevant to the SEP we could either:
- Leave it in, but empty with a comment that directs the customer to the basic example for a demonstration of the storage tier.
- Remove the storage tier entirely, and leave a comment in the app that says that the storage tier was removed to focus the example and direct the customer to the basic example for the storage tier.
I.e. in either case, just use the self-contained Repository in the service tier.
| @@ -0,0 +1,106 @@ | |||
| # RFDK Sample Application - Deadline Spot Event Plugin | |||
|
|
|||
| This is a sample RFDK application that deploys the basic infrastructure for a Deadline render farm. This application is structured in tiers, each representing a CloudFormation stack. The tiers are: | |||
There was a problem hiding this comment.
A whole bunch of this isn't accurate anymore.
| # Set this value to the version of AWS Thinkbox Deadline you'd like to deploy to your farm. Deadline 10.1.9 and up are supported. | ||
| RFDK_DEADLINE_VERSION=<version_of_deadline> | ||
|
|
||
| npx --package=aws-rfdk@${RFDK_VERSION} stage-deadline \ |
There was a problem hiding this comment.
There's a newer form for stage-deadline that doesn't require providing the full S3 URLs. Would probably be better to use that.
| !license-header.js | ||
|
|
||
| # The staged files for Deadline | ||
| stage |
There was a problem hiding this comment.
nit: File should end with a newline.
There are a couple of files like this. I'll save you the copy/paste by not commenting on all of them.
| packages=setuptools.find_packages(where="package"), | ||
|
|
||
| install_requires=[ | ||
| "aws-cdk.core==1.66.0", |
There was a problem hiding this comment.
These are now out of date. :-(
We're on CDK 1.70.0 & RFDK 0.19.0
| "typescript": "~3.9.7" | ||
| }, | ||
| "dependencies": { | ||
| "@aws-cdk/core": "1.66.0", |
There was a problem hiding this comment.
Same versioning issue as in the Python example.
examples/deadline/All-In-AWS-Infrastructure-SEP/ts/lib/sep-stack.ts
Outdated
Show resolved
Hide resolved
examples/deadline/All-In-AWS-Infrastructure-SEP/ts/package.json
Outdated
Show resolved
Hide resolved
examples/deadline/All-In-AWS-Infrastructure-SEP/ts/package.json
Outdated
Show resolved
Hide resolved
|
@horsmand This has all been updated |
There was a problem hiding this comment.
It seems you had misunderstood my last comment and removed all the additional steps for building and deploying both python and npm packages. The comment was specific to the ts example and suggested to keep the part about how to run build.sh before running the example's build.
Python needs the step you removed, where we explain how to install the locally built and packaged version of aws-rfdk if working on mainline. This is because python will always pull the package from pypi and while the release branch example will always match the package in pypi, the mainline branch will be out of sync when any unreleased features are added.
An example of these instructions are in step 3 here.
TypeScript needs the locally built aws-rfdk package, regardless of which branch is being worked off. This is because we refer to the local package from the example's tsconfig.json, always using it and never trying to fetch anything from npmjs.
An example of these instructions are in step 12 here.
examples/deadline/All-In-AWS-Infrastructure-SEP/python/setup.py
Outdated
Show resolved
Hide resolved
Adds python and TS examples that create a farm that has the requirements to use Deadline's Spot Event Plugin.
grbartel
force-pushed
the
SEP_example
branch
from
da47370 to
8b4a94f
Compare
Adds python and TS examples that create a farm that has the requirements to use Deadline's Spot Event Plugin.
Resolves #152
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license