Added v1.0.0 Artifacts

Signed-off-by: Brian Presley <[email protected]>

Author: sumobrian

CHANGELOG.md

@@ -0,0 +1,12 @@
+# Change Log
+
+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).
+
+## [1.0.0] - 2023-11-17
+
+### Added
+
+- All files, initial release

CODE_OF_CONDUCT.md

@@ -1,4 +1,4 @@
 ## Code of Conduct
 This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
 For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
-[email protected] with any additional questions or comments.
+[email protected] with any additional questions or comments.

CONTRIBUTING.md

@@ -11,7 +11,7 @@ information to effectively respond to your bug report or contribution.
 
 We welcome you to use the GitHub issue tracker to report bugs or suggest features.
 
-When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already
+When filing an issue, please check [existing open](https://github.com/opensearch-project/opensearch-migrations), or [recently closed](https://github.com/opensearch-project/opensearch-migrations/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
 reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
 
 * A reproducible test case or series of steps
@@ -23,25 +23,26 @@ reported the issue. Please try to include as much information as you can. Detail
 ## Contributing via Pull Requests
 Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
 
-1. You are working against the latest source on the *main* branch.
+1. You are working against the latest source on the *master* branch.
 2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
 3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
 
 To send us a pull request, please:
 
 1. Fork the repository.
 2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
-3. Ensure local tests pass.
-4. Commit to your fork using clear commit messages.
-5. Send us a pull request, answering any default questions in the pull request interface.
-6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
+3. Ensure all build processes execute successfully (see README.md for additional guidance).
+4. Ensure all unit, integration, and/or snapshot tests pass, as applicable.
+5. Commit to your fork using clear commit messages.
+6. Send us a pull request, answering any default questions in the pull request interface.
+7. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
 
 GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
 [creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
 
 
 ## Finding contributions to work on
-Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.
+Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels ((enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/awslabs/opensearch-migrations/labels/help%20wanted) issues is a great place to start.
 
 
 ## Code of Conduct
@@ -51,9 +52,11 @@ [email protected] with any additional questions or comments.
 
 
 ## Security issue notifications
-If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
+If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public GitHub issue.
 
 
 ## Licensing
 
-See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
+See the [LICENSE](https://github.com/aws-solutions/migration-assistant-for-amazon-opensearch/blob/main/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
+
+We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.

LICENSE renamed to LICENSE.txt

@@ -172,4 +172,4 @@
       of any other Contributor, and only if You agree to indemnify,
       defend, and hold each Contributor harmless for any liability
       incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
+      of your accepting any such warranty or additional liability.

NOTICE

@@ -0,0 +1,52 @@
+Migration Assistant for Amazon OpenSearch Service
+
+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. A copy of the License is located at http://www.apache.org/licenses/
+or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, express or implied. See the License for the
+specific language governing permissions and limitations under the License.
+
+**********************
+THIRD PARTY COMPONENTS
+**********************
+This software includes third party software subject to the following copyrights:
+
+AWS SDK under the Apache License Version 2.0
+source-map-support under the MIT License
+attrs under the MIT License
+boolean.py under the BSD-2-Clause
+coverage under the Apache License Version 2.0
+iniconfig under the MIT License
+jsondiff under the MIT License
+license-expression under the Apache License Version 2.0
+pluggy under the MIT License
+prometheus-client under the Apache License Version 2.0
+pytest under the MIT License
+responses under the Apache License Version 2.0
+types-PyYAML under the Apache License Version 2.0
+@aws-cdk/aws-servicecatalogappregistry-alpha under the Apache License Version 2.0
+Jinja2 under the BSD License (BSD-3-Clause)
+MarkupSafe under the BSD License (BSD-3-Clause)
+Werkzeug under the BSD License
+awscli under the Apache License Version 2.0
+boto3 under the Apache License Version 2.0
+botocore under the Apache License Version 2.0
+cffi under the MIT License
+click under the BSD 3-Clause "New"
+colorama under the BSD License
+cryptography under the BSD License
+docutils under the BSD License
+jmespath under MIT License (MIT)
+jsonpath-ng under Apache Software License Apache 2.0
+moto under Apache Software License (Apache License 2.0)
+ply under the BSD License
+pur under the BSD License
+pyasn1 under the BSD License (BSD-2-Clause)
+pycparser under the BSD License (BSD)
+python-dateutil under the Apache Software License, BSD License (Dual License)
+requests-aws under the BSD License
+requests-aws4auth is under MIT License (MIT License)
+rsa under the Apache Software License (Apache-2.0)
+s3transfer under the Apache Software License (Apache License 2.0)
+xmltodict under the MIT License (MIT)

NOTICE.txt

@@ -1,17 +1,80 @@
-## My Project
+# Migration Assistant for Amazon OpenSearch
 
-TODO: Fill this README out!
+The Migration Assistant for Amazon OpenSearch Service solution is a toolkit designed to ease the transition to OpenSearch, facilitate upgrades to the latest OpenSearch versions, and refine cluster configurations based on observed traffic patterns. Whether you're looking to set up a proof-of-concept in AWS, transition production workloads with confidence, or enhance your current OpenSearch clusters, this guide provides references to step-by-step instructions, best practices, and insights to leverage the full potential of the OpenSearch migrations package.
 
-Be sure to:
+## Table of content
 
-* Change the title in this README
-* Edit your repository description on GitHub
+- [Migration Assistant for Amazon OpenSearch](#migration-assistant-for-amazon-opensearch)
+  - [Table of content](#table-of-content)
+  - [Use Cases](#use-cases)
+  - [Solution Overview](#solution-overview)
+  - [Architecture](#architecture)
+  - [Deployment](#deployment)
+  - [OpenSearch Migrations Repo](#opensearch-migrations-repo)
+  - [Collection of Operational Metrics](#collection-of-operational-metrics)
+  - [License](#license)
 
-## Security
 
-See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
+## Solution Overview
+
+The solution has the following features:
+
+### Historical backfill with capture and restore
+This solution guides users through the process of transferring data from an originating (source) cluster to a designated (target) cluster.
+
+### Live traffic capture and replay
+The solution offers guidance and tools to intercept traffic intended for an original cluster and archive it for future replay on a destination cluster. Typically, the replay occurs at the same rate and concurrency as the original traffic to precisely mimic the workload experienced by the source cluster. Users can choose to replay the recorded traffic subsequently or adjust the replay speed. This flexibility enables users to fine-tune the target cluster, enhancing its performance to suit their requirements.
+
+### Traffic verification
+The solution records requests and responses between the source and destination clusters for comparison. It then forwards the latency metrics and response codes to an analytics platform, enabling users to analyze the data essential for transitioning their traffic from a legacy system to a new Amazon OpenSearch destination.
+
+## Use Cases
+### Migrating historical data
+Migration Assistant for Amazon OpenSearch Service offers various options for migrating historical data, including detailed guidance on running a historical migration applicable across all supported migration routes, such as from Elasticsearch 7.10.2 to OpenSearch 1.0.
+
+### Near real-time migration of HTTP traffic between clusters
+The solution offers you the option to capture data destined for a source cluster and store this data for reuse. A user can replay this data to a target cluster in near real-time to migrate as soon as possible, or replay at a later time. 
+
+### Replay traffic to multiple targets
+The solution allows you to capture traffic for replay through multiple instances or in sequential runs, facilitating the validation of diverse cluster workloads and configurations.
+
+### Precise simulation of your cluster workloads
+The solution allows users to capture and replay traffic either simultaneously with multiple instances, or in separate sequential runs. This feature aids in validating different cluster workloads and configurations. By default, the Replayer preserves the original concurrency and request rate to accurately simulate production loads, ensuring a fair like-for-like comparison.
+
+### Verify target cluster results
+The solution facilitates user comparisons of source and target traffic in terms of accuracy and performance. It captures metrics and logs for analysis, providing users with the necessary confidence to migrate their production traffic to a new target.
+
 
-## License
 
-This project is licensed under the Apache-2.0 License.
+## Architecture
 
+Deploying this solution with the default parameters builds the following environment in the AWS Cloud.
+
+![Architecture](AWSSolutionsArchitecture.png)
+
+The high-level process flow for the solution components deployed with the AWS CloudFormation template is as follows:
+
+1.	Traffic is directed to the existing cluster, reaching each coordinator node.
+2.	A Capture Proxy is added before each coordinator node in the cluster, allowing for traffic capture and storage in Amazon MSK.
+3.	With continuous traffic capture in place, the user initiates a historical backfill.
+4.	Following the backfill, the user replays the captured traffic using a Replayer.
+5.	The user evaluates the outcomes from routing traffic to both the original and the new cluster.
+6.	After confirming the new cluster’s functionality meets expectations, the user dismantles all related stacks, retaining only the new cluster’s setup. Additionally, the user can retire and discard the old cluster’s legacy infrastructure and all Migration Assistant for Amazon OpenSearch Service stacks, keeping only the new cluster.
+
+
+## Deployment
+
+Please follow the [Implementation Guide](https://docs.aws.amazon.com/solutions/latest/migration-assistant-for-amazon-opensearch/) to deploy the solution in your AWS account.
+
+## OpenSearch Migrations Repo
+This solution is open-source. The tools developed in this solution can be found in the [OpenSearch Project Migration Repo](https://github.com/opensearch-project/opensearch-migrations).
+
+Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+
+## Collection of Operational Metrics
+This solution collects anonymous operational metrics to help AWS improve the quality and 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/migration-assistant-for-amazon-opensearch-service/).
+
+## License
+Licensed under the Apache License Version 2.0 (the "License"). You may not use this file except in compliance with the License. A copy of the License is located at
+    [https://www.apache.org/licenses/](https://www.apache.org/licenses/)
+or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, express or implied. See the License for the specific language governing permissions and limitations under the License.

README.md

@@ -0,0 +1,52 @@
+#!/usr/bin/env bash
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+
+# Check to see if input has been provided:
+if [ -z "$1" ] || [ -z "$2" ] || [ -z "$3" ]; then
+    echo "Please provide the base source bucket name, trademark approved solution name and version where the lambda code will eventually reside."
+    echo "For example: ./build-s3-dist.sh solutions trademarked-solution-name v1.0.0"
+    exit 1
+fi
+
+set -e
+
+# Get reference for all important folders
+template_dir="$PWD"
+template_dist_dir="${template_dir}/global-s3-assets"
+build_dist_dir="${template_dir}/regional-s3-assets"
+source_dir="${template_dir}/../source"
+
+echo "------------------------------------------------------------------------------"
+echo "Rebuild distribution"
+echo "------------------------------------------------------------------------------"
+rm -rf "${template_dist_dir}"
+mkdir -p "${template_dist_dir}"
+rm -rf "${build_dist_dir}"
+mkdir -p "${build_dist_dir}"
+
+[ -e "${template_dist_dir}" ] && rm -r "${template_dist_dir}"
+[ -e "${build_dist_dir}" ] && rm -r "${build_dist_dir}"
+mkdir -p "${template_dist_dir}" "${build_dist_dir}"
+touch "$build_dist_dir"/test.txt
+
+echo "--------------------------------------------------------------------------------------"
+echo "CloudFormation Template generation"
+echo "--------------------------------------------------------------------------------------"
+export CODE_BUCKET=$1
+export SOLUTION_NAME=$2
+export CODE_VERSION=$3
+
+cd "$source_dir"/solutions-infrastructure
+npm install
+node_modules/aws-cdk/bin/cdk synth --asset-metadata false --path-metadata false > "$template_dist_dir"/"$SOLUTION_NAME".template
+
+if [ $? -eq 0 ]
+then
+  echo "Build for $SOLUTION_NAME.template succeeded"
+else
+  echo "******************************************************************************"
+  echo "Build FAILED for $SOLUTION_NAME.template"
+  echo "******************************************************************************"
+  exit 1
+fi