Skip to content

Commit

Permalink
Updates for v3.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
JimTharioAmazon committed Aug 30, 2021
1 parent c2a30e9 commit 89dfa0a
Show file tree
Hide file tree
Showing 26 changed files with 438 additions and 21,949 deletions.
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior.

**Expected behavior**
A clear and concise description of what you expected to happen.

**Please complete the following information about the solution:**
- [ ] Version: [e.g. v1.0.0]
- [ ] Region: [e.g. us-east-1]
- [ ] Was the solution modified from the version published on this repository?
- [ ] If the answer to the previous question was yes, are the changes available on GitHub?
- [ ] Have you checked your [service quotas](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) for the sevices this solution uses?
- [ ] Were there any errors in the CloudWatch Logs?

**Screenshots**
If applicable, add screenshots to help explain your problem (please **DO NOT include sensitive information**).

**Additional context**
Add any other context about the problem here.
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: Feature request
about: Suggest an idea for this solution
title: ''
labels: enhancement
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the feature you'd like**
A clear and concise description of what you want to happen.

**Additional context**
Add any other context or screenshots about the feature request here.
5 changes: 5 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
*Issue #, if available:*

*Description of changes:*

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,18 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [3.0.0] - 2020-8-5
### Changed
- The AWS MediaLive default CloudFormation parameter for channel start has been changed to false.

### Updated
- The Amazon CloudFront distribution TTL values were modified to 1 second for all http error codes. 403, 404, 405, 500, 501, 503, and 504.
- Updated packages glob-parent, ssri, y18n, react-dev-utils, elliptic, axios, and others.

### Fixed
- Readme file updates.
- Removed Lambda from logging AWS MediaLive input details which could contain passwords.

## [2.3.0] - 2019-10-30
### Added
- CHANGELOG version 2.3.0 release
Expand Down
2 changes: 1 addition & 1 deletion NOTICE.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Live Streaming on AWS

Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
27 changes: 19 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ As part of the CloudFormation template a Demo HTML preview player is deployed to

## Deployment
The solution is deployed using a CloudFormation template with a lambda backed custom resource, available in both NodeJS and Python.
For details on deploying the solution please see the details on the Solution home page: [Live Streaming on AWS](https://aws.amazon.com/solutions/implementations/live-streaming-on-aws)
For details on deploying the solution please see the details on the Solution home page: [Live Streaming on AWS](https://aws.amazon.com/solutions/implementations/live-streaming-on-aws/?did=sl_card&trk=sl_card)

## Encoding Profiles
To solution Configures AWS Elemental MediaLive with one of three encoding profiles based on the source resolution defined at launch as a CloudFormation parameter. The three options are 1080, 720, 540 and correspond to the following encoding profiles:
Expand Down Expand Up @@ -57,22 +57,22 @@ The CloudFormation template is configured to pull the source code from Amazon S3
SourceCode:
General:
S3Bucket: CODE_BUCKET //This is the name of the S3 bucket
KeyPrefix: SOLUTION_NAME/CODE_VERSION //This is the path to the source code (eg: live-streaming-on-aws/v2.3.0)
KeyPrefix: SOLUTION_NAME/CODE_VERSION //This is the path to the source code (eg: live-streaming-on-aws/v3.0.0)
```

The example bellow assumes the following:
* The solution is going to be deployed to us-east-1
* the bucket name is mybucket-us-east-1
* the solution name is live streaming-on-aws
* the version is v2.3.0
* the version is v3.0.0


### Prerequisites:
* [AWS Command Line Interface](https://aws.amazon.com/cli/)
* Node.js 12.x or later

### 1. Create an Amazon S3 Bucket
Create a bucket in us-east-1 region with the region appended to the name:
Create a bucket in us-east-1 region with the region appended to the name. Please consider using randomized bucket names, ensure your buckets are not public, and verify bucket ownership prior to uploading application code or templates.

```
aws s3 mb s3://mybucket-us-east-1
Expand All @@ -83,7 +83,7 @@ Run the build-s3-dist.sh script passing in 3 parameters for CODE_BUCKET, SOLUTIO

```
cd deployment/ && chmod +x ./build-s3-dist.sh
./build-s3-dist.sh mybucket live-streaming-on-aws v2.3.0
./build-s3-dist.sh mybucket live-streaming-on-aws v3.0.0
```

**note**
Expand All @@ -94,8 +94,15 @@ S3Bucket: !Join ["-", [!FindInMap ["SourceCode", "General", "S3Bucket"], Ref: "A
```

### 3. Deploy the source code to S3:

Ensure that you are owner of the AWS S3 bucket.
```
aws s3 sync ./regional-s3-assets/ s3://mybucket-us-east-1/live-streaming-on-aws/v2.3.0/
aws s3api head-bucket --bucket mybucket-us-east-1 --expected-bucket-owner YOUR-AWS-ACCOUNT-NUMBER
```

Uploads the files to your S3 bucket.
```
aws s3 sync ./regional-s3-assets/ s3://mybucket-us-east-1/live-streaming-on-aws/v3.0.0/
```

### 4. Launch the CloudFormation template.
Expand All @@ -104,11 +111,15 @@ The buid-s3-dist.sh script creates a copy of the template in deployment/global-a
SourceCode:
General:
S3Bucket: mybucket
KeyPrefix: live-streaming-on-aws/v2.3.0
KeyPrefix: live-streaming-on-aws/v3.0.0

Launch the Template through the AWS Console in us-east-1.


## License

* This project is licensed under the terms of the Apache 2.0 license. See `LICENSE`.
* This project is licensed under the terms of the Apache 2.0 license. See `LICENSE`.

This solution collects anonymous operational metrics to help AWS improve the
quality of features of the solution. For more information, including how to disable
this capability, please see the [implementation guide](https://docs.aws.amazon.com/solutions/latest/live-streaming/welcome.html).
2 changes: 1 addition & 1 deletion deployment/build-s3-dist.sh
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ npm ci --production
zip -q -r9 $build_dist_dir/custom-resource.zip *

echo "------------------------------------------------------------------------------"
echo "Buildinbg console"
echo "Building console"
echo "------------------------------------------------------------------------------"
cd $source_dir/console
[ -e build ] && rm -r build
Expand Down
42 changes: 36 additions & 6 deletions deployment/live-streaming-on-aws.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Amazon Software License (the "License").
# You may not use this file except in compliance with the License.
Expand All @@ -10,7 +10,7 @@
# on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
# express or implied. See the License for the specific language governing
# permissions and limitations under the License.
Description: '(SO0013) - Live Streaming on AWS - v2.4.0'
Description: '(SO0013) - Live Streaming on AWS - CODE_VERSION'

Parameters:

Expand Down Expand Up @@ -84,7 +84,7 @@ Parameters:
ChannelStart:
Description: If your source is ready to stream, select true. This will start the MediaLive Channel as part of the deployment. If you select false, you will need to manually start the MediaLive Channel when your source is ready.
Type: String
Default: Yes
Default: No
AllowedValues:
- Yes
- No
Expand Down Expand Up @@ -337,6 +337,16 @@ Resources:
S3Key: !Join ["/", [!FindInMap ["SourceCode", "General", "KeyPrefix"], "custom-resource.zip"]]
Runtime: nodejs12.x
Timeout: 180
Environment:
Variables:
SOLUTION_IDENTIFIER: 'AwsSolution/SO0013/CODE_VERSION'
Metadata:
cfn_nag:
rules_to_suppress:
- id: W89
reason: "W89: We do not need a VPC for this custom resource lambda."
- id: W92
reason: "W92: Custom resource does not need ReservedConcurrentExecution. "

MediaPackageChannel:
Type: Custom::MediaPackageChannel
Expand Down Expand Up @@ -454,8 +464,28 @@ Resources:
- Origin
ViewerProtocolPolicy: allow-all
CustomErrorResponses:
- ErrorCode: '404'
ErrorCachingMinTTL: '2'
- ErrorCode: 400
ErrorCachingMinTTL: 1
- ErrorCode: 403
ErrorCachingMinTTL: 1
- ErrorCode: 404
ErrorCachingMinTTL: 1
- ErrorCode: 405
ErrorCachingMinTTL: 1
- ErrorCode: 414
ErrorCachingMinTTL: 1
- ErrorCode: 416
ErrorCachingMinTTL: 1
- ErrorCode: 500
ErrorCachingMinTTL: 1
- ErrorCode: 501
ErrorCachingMinTTL: 1
- ErrorCode: 502
ErrorCachingMinTTL: 1
- ErrorCode: 503
ErrorCachingMinTTL: 1
- ErrorCode: 504
ErrorCachingMinTTL: 1
ViewerCertificate:
CloudFrontDefaultCertificate: true
Tags:
Expand Down Expand Up @@ -635,7 +665,7 @@ Resources:
Resource: AnonymousMetric
SolutionId: "SO0013"
UUID: !GetAtt Uuid.UUID
Version: "2.0"
Version: "CODE_VERSION"
InputType: !Ref InputType
EncodingProfile: !Ref EncodingProfile

Expand Down
Loading

0 comments on commit 89dfa0a

Please sign in to comment.