diff --git a/.github/AUTOMATION_README.md b/.github/AUTOMATION_README.md index ec35b77e8..378bc4074 100644 --- a/.github/AUTOMATION_README.md +++ b/.github/AUTOMATION_README.md @@ -1,6 +1,6 @@ # Github Actions and Integration -This directory is used to hold all templates and github actions that are integrated into the AWS RFDK Github Repository. +This directory is used to hold all templates and github actions that are integrated into the RFDK Github Repository. ## Pull Request Template diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a81d965b7..1779bb3a2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ -# Contributing to the AWS Render Farm Deployment Kit (AWS RFDK) +# Contributing to the Render Farm Deployment Kit on AWS (RFDK) -Thanks for your interest in contributing to the AWS RFDK! ❤️ +Thanks for your interest in contributing to the RFDK! ❤️ This document describes how to set up a development environment and submit your contributions. Please read it carefully and let us know if it's not up-to-date (even better, submit a PR with your corrections ;-)). @@ -24,7 +24,7 @@ and let us know if it's not up-to-date (even better, submit a PR with your corr ## Prerequisites -The AWS RFDK is written in Typescript and converted, using [jsii](https://github.com/aws/jsii), into Python. Thus, the +The RFDK is written in Typescript and converted, using [jsii](https://github.com/aws/jsii), into Python. Thus, the minimal development environment must include: - Node.js >= 10.21.0 @@ -100,7 +100,7 @@ To build, we use the [jsii/superchain docker container](https://hub.docker.com/r >>> bash-4.2$ ./pack.sh - # To build & test your changes to the AWS RFDK package + # To build & test your changes to the RFDK package # Note: Must have done at least one run of ./build.sh to build the build tools. >>> bash-4.2$ cd packages/aws-rfdk @@ -128,16 +128,16 @@ One can use the `postinstall` script to symlink this repo. For example: This assumes this repo is a sibling of the target repo and will install the CDK as a linked dependency during __yarn install__. -#### Option 2 -- Use npm/pip to install the AWS RFDK packages into your environment +#### Option 2 -- Use npm/pip to install the RFDK packages into your environment The packages that are created by the `./pack.sh` script can be installed directly into an npm or Python environment. ```bash # Installing into a local npm environment -npm install /dist/js/aws-rfdk@0.15.0.jsii.tgz +npm install /dist/js/aws-rfdk@0.15.0.jsii.tgz # Installing into a Python environment -pip install --force /dist/python/aws-rfdk-0.15.0.tar.gz +pip install --force /dist/python/aws-rfdk-0.15.0.tar.gz ``` ### Cleaning up stale build artifacts diff --git a/NOTICE b/NOTICE index 7ceefb6ae..b0de3ffd4 100644 --- a/NOTICE +++ b/NOTICE @@ -1,2 +1,2 @@ -AWS Render Farm Deployment Kit (AWS RFDK) +Render Farm Deployment Kit on AWS (RFDK) Copyright 2018-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. diff --git a/README.md b/README.md index d2d157b30..fe2266fd0 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# AWS Render Farm Deployment Kit (AWS RFDK) +# Render Farm Deployment Kit on AWS (RFDK) -The AWS Render Farm Deployment Kit is an open-source library for use with the +The Render Farm Deployment Kit on AWS is an open-source library for use with the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) that is designed to help you deploy, configure, and maintain your render farm infrastructure in the cloud. @@ -41,7 +41,7 @@ If you discover a potential security issue in this project we ask that you notif ## Contributing -Contributions to the AWS RFDK are encouraged. If you want to fix a problem, or want to enhance the library in any way, then +Contributions to the RFDK are encouraged. If you want to fix a problem, or want to enhance the library in any way, then we are happy to accept your contribution. Information on contributing to the RFDK can be found [in CONTRIBUTING.md](https://github.com/aws/aws-rfdk/blob/mainline/CONTRIBUTING.md). diff --git a/examples/deadline/All-In-AWS-Infrastructure-Basic/ts/README.md b/examples/deadline/All-In-AWS-Infrastructure-Basic/ts/README.md index 0918271e4..33f7a4656 100644 --- a/examples/deadline/All-In-AWS-Infrastructure-Basic/ts/README.md +++ b/examples/deadline/All-In-AWS-Infrastructure-Basic/ts/README.md @@ -133,7 +133,7 @@ Network ACLs act as a firewall for controlling traffic in or out of your VPC sub --- **NOTE** -These instructions assume that your working directory is `examples/deadline/All-In-AWS-Infrastructure-Basic-Tiered/ts/` relative to the root of the AWS-RFDK package. +These instructions assume that your working directory is `examples/deadline/All-In-AWS-Infrastructure-Basic-Tiered/ts/` relative to the root of the RFDK package. --- diff --git a/integ/NOTICE b/integ/NOTICE index 7ceefb6ae..b0de3ffd4 100644 --- a/integ/NOTICE +++ b/integ/NOTICE @@ -1,2 +1,2 @@ -AWS Render Farm Deployment Kit (AWS RFDK) +Render Farm Deployment Kit on AWS (RFDK) Copyright 2018-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. diff --git a/integ/README.md b/integ/README.md index 124d42432..3ab924373 100644 --- a/integ/README.md +++ b/integ/README.md @@ -2,7 +2,7 @@ To run all test suites: -1. Build and install dependencies by running build.sh from the top-level AWS-RFDK directory +1. Build and install dependencies by running build.sh from the top-level RFDK directory 1. Configure AWS credentials (tests will use the default AWS profile, so either set up a default profile in .aws/credentials or use temporary credentials). diff --git a/lambda-layers/NOTICE b/lambda-layers/NOTICE index 7ceefb6ae..b0de3ffd4 100644 --- a/lambda-layers/NOTICE +++ b/lambda-layers/NOTICE @@ -1,2 +1,2 @@ -AWS Render Farm Deployment Kit (AWS RFDK) +Render Farm Deployment Kit on AWS (RFDK) Copyright 2018-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. diff --git a/packages/aws-rfdk/NOTICE b/packages/aws-rfdk/NOTICE index 7ceefb6ae..b0de3ffd4 100644 --- a/packages/aws-rfdk/NOTICE +++ b/packages/aws-rfdk/NOTICE @@ -1,2 +1,2 @@ -AWS Render Farm Deployment Kit (AWS RFDK) +Render Farm Deployment Kit on AWS (RFDK) Copyright 2018-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. diff --git a/packages/aws-rfdk/README.md b/packages/aws-rfdk/README.md index abe386b35..b50852835 100644 --- a/packages/aws-rfdk/README.md +++ b/packages/aws-rfdk/README.md @@ -1,6 +1,6 @@ -# AWS Render Farm Deployment Kit +# Render Farm Deployment Kit on AWS -The AWS Render Farm Deployment Kit (RFDK) is an open-source software development kit (SDK) that can be used to deploy, configure, and manage your render farm +The Render Farm Deployment Kit on AWS (RFDK) is an open-source software development kit (SDK) that can be used to deploy, configure, and manage your render farm infrastructure in the cloud. The RFDK is built to operate with the AWS Cloud Development Kit (CDK) and provides a library of classes, called constructs, that each deploy and configure a component of your cloud-based render farm. The current version of the RFDK supports render farms built using AWS Thinkbox Deadline render management software, and provides the ability for you to easily go from nothing to a production-ready render farm in the cloud. @@ -11,7 +11,7 @@ an object from the CDK and RFDK libraries represents the creation of a resource, via AWS CloudFormation by the CDK toolkit. The parameters of an object’s creation control the configuration of the resource. Please see the following sources for additional information: -* The [AWS RFDK Developer Guide](https://docs.aws.amazon.com/rfdk/latest/guide/what-is-rfdk.html) -* The [AWS RFDK API Documentation](https://docs.aws.amazon.com/rfdk/api/latest/docs/aws-rfdk-construct-library.html) +* The [RFDK Developer Guide](https://docs.aws.amazon.com/rfdk/latest/guide/what-is-rfdk.html) +* The [RFDK API Documentation](https://docs.aws.amazon.com/rfdk/api/latest/docs/aws-rfdk-construct-library.html) * The [README for the main module](https://github.com/aws/aws-rfdk/blob/mainline/packages/aws-rfdk/lib/core/README.md) * The [README for the Deadline module](https://github.com/aws/aws-rfdk/blob/mainline/packages/aws-rfdk/lib/deadline/README.md) diff --git a/packages/aws-rfdk/lib/core/README.md b/packages/aws-rfdk/lib/core/README.md index 50a89249b..2bb12ed23 100644 --- a/packages/aws-rfdk/lib/core/README.md +++ b/packages/aws-rfdk/lib/core/README.md @@ -204,7 +204,7 @@ _**Note:** When suspending the fleet, `HealthMonitor` sets the `maxCapacity` pro The fleets are attached to a load balancer and health checks are made against an HTTP endpoint being served by the fleet instances ( see [Health checks for your target groups](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/target-group-health-checks.html) ). There are certain AWS service limits for each load balancer, hence an array of load balancers and listeners is created internally based on the size of the registered fleets. -By default, the load balancers array is created with default limits for AWS account. Since these limits can differ (can be increased by requesting AWS support), AWS-RFDK provides an option to modify them using `elbAccountLimits` property. +By default, the load balancers array is created with default limits for AWS account. Since these limits can differ (can be increased by requesting AWS support), RFDK provides an option to modify them using `elbAccountLimits` property. The object you assign to `elbAccountLimits` should be the output of the [describeAccountLimits API](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/ELBv2.html#describeAccountLimits-property). We provide a `Limit` interface which consists of the name of the limit and its value. You can find the whole list of possible names at [API_Limit documentation](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_Limit.html). @@ -768,7 +768,7 @@ const importedCertificate = new ImportedAcmCertificate(stack, 'ImportedAcmCertif ## Connecting To An Instance -AWS-RFDK provides a few constructs that can create instances (for example, [StaticPrivateIpServer](#staticprivateipserver) or [MongoDbInstance](#mongodbinstance)) and there are multiple ways to connect to these instances. +The RFDK provides a few constructs that can create instances (for example, [StaticPrivateIpServer](#staticprivateipserver) or [MongoDbInstance](#mongodbinstance)) and there are multiple ways to connect to these instances. ### Session Manager diff --git a/packages/aws-rfdk/lib/core/lambdas/nodejs/asg-attach-eni/README.md b/packages/aws-rfdk/lib/core/lambdas/nodejs/asg-attach-eni/README.md index 1d7fad803..9ff728f2b 100644 --- a/packages/aws-rfdk/lib/core/lambdas/nodejs/asg-attach-eni/README.md +++ b/packages/aws-rfdk/lib/core/lambdas/nodejs/asg-attach-eni/README.md @@ -1,8 +1,8 @@ # Contents -This directory contains the implementation of the EC2_LAUNCH_INSTANCE Lifecycle Hook handler for the AWS-RFDK EniInstance construct. +This directory contains the implementation of the EC2_LAUNCH_INSTANCE Lifecycle Hook handler for the RFDK StaticIpServer construct. -This lambda is responsible for attaching an Elastic Network Interface (ENI) to the single instance in the EniInstance's Auto Scaling Group when that +This lambda is responsible for attaching an Elastic Network Interface (ENI) to the single instance in the StaticIpServer's Auto Scaling Group when that instance is launched. The ID for the ENI is required to be passed to it in the NotificationMetadata of the lifecycle hook event. Specifically, NotificationMetadata is required to be stringified JSON of the following: diff --git a/packages/aws-rfdk/lib/core/lib/staticip-server.ts b/packages/aws-rfdk/lib/core/lib/staticip-server.ts index 1e3e724b2..c7e852b43 100644 --- a/packages/aws-rfdk/lib/core/lib/staticip-server.ts +++ b/packages/aws-rfdk/lib/core/lib/staticip-server.ts @@ -313,7 +313,7 @@ export class StaticPrivateIpServer extends Construct implements IConnectable, IG code: handlerCode, handler: 'index.handler', runtime: Runtime.NODEJS_12_X, - description: `Created by AWS-RFDK StaticPrivateIpServer to process instance launch lifecycle events in stack '${stack.stackName}'. This lambda attaches an ENI to newly launched instances.`, + description: `Created by RFDK StaticPrivateIpServer to process instance launch lifecycle events in stack '${stack.stackName}'. This lambda attaches an ENI to newly launched instances.`, logRetention: RetentionDays.THREE_DAYS, }); singletonPreExists = false; @@ -399,7 +399,7 @@ export class StaticPrivateIpServer extends Construct implements IConnectable, IG }); notificationTopic = new Topic(stack, notificationTopicUniqueId, { - displayName: `For AWS-RFDK instance-launch notifications for stack '${stack.stackName}'`, + displayName: `For RFDK instance-launch notifications for stack '${stack.stackName}'`, masterKey: notificationTopicEncryptKey, }); diff --git a/packages/aws-rfdk/lib/core/test/staticip-server.test.ts b/packages/aws-rfdk/lib/core/test/staticip-server.test.ts index 725ee79ba..9833fef73 100644 --- a/packages/aws-rfdk/lib/core/test/staticip-server.test.ts +++ b/packages/aws-rfdk/lib/core/test/staticip-server.test.ts @@ -90,7 +90,7 @@ describe('Test StaticIpServer', () => { cdkExpect(stack).to(haveResourceLike('AWS::Lambda::Function', { Handler: 'index.handler', Runtime: 'nodejs12.x', - Description: 'Created by AWS-RFDK StaticPrivateIpServer to process instance launch lifecycle events in stack \'StackName\'. This lambda attaches an ENI to newly launched instances.', + Description: 'Created by RFDK StaticPrivateIpServer to process instance launch lifecycle events in stack \'StackName\'. This lambda attaches an ENI to newly launched instances.', })); expectCDK(stack).to(haveResourceLike('AWS::KMS::Key', { @@ -128,7 +128,7 @@ describe('Test StaticIpServer', () => { EnableKeyRotation: true, })); cdkExpect(stack).to(haveResourceLike('AWS::SNS::Topic', { - DisplayName: 'For AWS-RFDK instance-launch notifications for stack \'StackName\'', + DisplayName: 'For RFDK instance-launch notifications for stack \'StackName\'', KmsMasterKeyId: { Ref: 'SNSEncryptionKey255e9e52ad034ddf8ff8274bc10d63d1EDF79FFE', }, diff --git a/packages/aws-rfdk/lib/deadline/README.md b/packages/aws-rfdk/lib/deadline/README.md index 9dd16650c..e1f17eab8 100644 --- a/packages/aws-rfdk/lib/deadline/README.md +++ b/packages/aws-rfdk/lib/deadline/README.md @@ -246,7 +246,7 @@ const ubl = new UsageBasedLicensing(stack, 'UsageBasedLicensing', { ### Usage-Based Licensing Docker Container Images -`UsageBasedLicensing` currently requires only one Docker container image for the Deadline License Forwarder. A License Forwarder image must satisfy the following criteria to be compatible with AWS RFDK: +`UsageBasedLicensing` currently requires only one Docker container image for the Deadline License Forwarder. A License Forwarder image must satisfy the following criteria to be compatible with RFDK: - Deadline Client must be installed - The default command must launch the License Forwarder diff --git a/packages/aws-rfdk/lib/deadline/lib/database-connection.ts b/packages/aws-rfdk/lib/deadline/lib/database-connection.ts index a943ededa..c606b5aea 100644 --- a/packages/aws-rfdk/lib/deadline/lib/database-connection.ts +++ b/packages/aws-rfdk/lib/deadline/lib/database-connection.ts @@ -257,7 +257,7 @@ class DocDBDatabaseConnection extends DatabaseConnection { if (docdbInstance) { child.node.addDependency(docdbInstance); } else if (this.props.database.node.defaultChild) { - throw new Error('The internal implementation of the AWS CDK\'s DocumentDB cluster construct may have changed. Please update to a newer AWS RFDK for an updated implementation, or file a ticket if this is the latest release.'); + throw new Error('The internal implementation of the AWS CDK\'s DocumentDB cluster construct may have changed. Please update to a newer RFDK for an updated implementation, or file a ticket if this is the latest release.'); } } } diff --git a/scripts/rfdk_build_environment.sh b/scripts/rfdk_build_environment.sh index c62ee3aa1..3e74e105f 100755 --- a/scripts/rfdk_build_environment.sh +++ b/scripts/rfdk_build_environment.sh @@ -10,11 +10,11 @@ # Make sure we're running from the root of the CDK repo if ! test -f package.json || ! grep '"name": "aws-rfdk-project",' package.json > /dev/null || ! grep '"private": true,' package.json > /dev/null then - echo "Usage: Run from the root of the AWS RFDK repository" + echo "Usage: Run from the root of the RFDK repository" exit 1 fi -echo "Entering jsii/superchain docker container so you can interactively build/test AWS RFDK." +echo "Entering jsii/superchain docker container so you can interactively build/test RFDK." USER_OPT="-u $(id -u):$(id -g)" USERFILE_MOUNTS="-v /etc/passwd:/etc/passwd:ro -v /etc/shadow:/etc/shadow:ro -v /etc/group:/etc/group:ro" diff --git a/tools/pkglint/lib/licensing.ts b/tools/pkglint/lib/licensing.ts index f7b9eef62..de3d418ff 100644 --- a/tools/pkglint/lib/licensing.ts +++ b/tools/pkglint/lib/licensing.ts @@ -203,6 +203,6 @@ export const LICENSE = `; export const NOTICE = -`AWS Render Farm Deployment Kit (AWS RFDK) +`Render Farm Deployment Kit on AWS (RFDK) Copyright 2018-${new Date().getFullYear()} Amazon.com, Inc. or its affiliates. All Rights Reserved. `;