aws-cloudformation-webapp-demo

If you are beginning your journey with Senzing, please start with Senzing Quick Start guides.

You are in the Senzing Garage where projects are "tinkered" on. Although this GitHub repository may help you understand an approach to using Senzing, it's not considered to be "production ready" and is not considered to be part of the Senzing product. Heck, it may not even be appropriate for your application of Senzing!

Synopsis

The aws-cloudformation-webapp-demo AWS Cloudformation template deploys Senzing for use with a previously deployed aws-cloudformation-database-cluster Cloudformation stack.

This stack provides a web application interface to the senzing engine. It allows records to be loaded and entities and their connections explored through the web application.

How to deploy without much thinking

1. ⚠️ Warning: This Cloudformation deployment will accrue AWS costs. With appropriate permissions, the AWS Cost Explorer can help evaluate costs.

2. ⚠️ Warning: This Cloudformation deployment only runs in supported AWS Regions.

3. Download the appropriate AWS Cloudformation template example from this repository to your local device. Example:

   curl -X GET \
       --output ~/cloudformation.yaml \
       https://raw.githubusercontent.com/Senzing/aws-cloudformation-webapp-demo/main/cloudformation.yaml

4. It is highly suggested to take a look at the AWS Cloudformation Template that has been downloaded. This template is an example that deploys and configures a number of services and facilities. While it is a working and complete example, each business may have different requirements and their account may not have all the privledges required to deploy it. Furthermore, the examples change over time and these files are meant to be treated as code files so they should be put under source control.

5. Visit the AWS Cloudformation home.

6. At the upper-right, click the "Create stack" drop-down and choose "With new resources (standard)".

7. In the "Specify template" area choose the "Upload a template file" radio button.

8. Select the "Choose file" button and choose the AWS Cloudformation template that was downloaded previously.

9. At lower-right, click on "Next" button.

10. In Specify stack details

    1. In Stack name
       1. Choose a stack name that is unique to you and 21 characters or less. (Several resource types have a limit of 32 character names. The CFT uses the stack name and an 11 character suffix to name resources uniquely.)
    2. In Parameters
       1. In Senzing installation
          1. Accept the End User License Agreement.
          2. Optionally, choose a version of Senzing to install.
          3. Optionally, add a license string.
       2. In Identify existing resources
          1. Enter the stack name of the previously deployed aws-cloudformation-database-cluster Cloudformation stack Example: senzing-db
       3. In Security
          1. Provide the email address for the administrative user. Example: me@example.com
          2. Provide the permitted IP address block allowed to connect using CIDR notation. Note: to open the installation to any IP address use: 0.0.0.0/0. For more on CIDR, see Classless Inter-Domain Routing
       4. In Security responsibility
          1. Understand the nature of the security in the deployment.
          2. Once understood, enter "I AGREE".
    3. At lower-right, click "Next" button.

11. In Configure stack options

    1. At lower-right, click "Next" button.

12. In Review senzing stack

    1. Near the bottom, in Capabilities
       1. Check ":ballot_box_with_check: I acknowledge that AWS CloudFormation might create IAM resources."
    2. At lower-right, click "Create stack" button.

Additional topics

1. Details of deployment
2. How to load AWS Cloudformation queue