This document provides a quick installation guide for setting up Paladin Cloud on AWS Cloud. Please make sure you have the necessary prerequisites before proceeding with the installation. If you need detailed instructions, use the Standard Installation Guide.

Note: Before installing, please review the release notes on the Release page for any important updates or changes.

For Existing Users:

• If you are upgrading from version 2.0.0 or below to the latest version of Paladin Cloud, please take the following steps:
  1. Uninstall Existing Version: Before proceeding with the upgrade, uninstall the current version of Paladin Cloud.
  2. Terminate EC2 Instance: Once the existing version is uninstalled, terminate the EC2 Instance that was used for your previous installation.
  3. IAM Permissions: If you are using the existing IAM role for the new version, please update the AWS IAM permissions

  For detailed, step-by-step instructions on uninstalling the existing version and terminating the EC2 Instance, please refer to this link.

Prerequisites:

• AWS account with relevant permissions
• CloudFormation template to create an IAM role. You can find the document link for this template here.

Install and Deploy Paladin Cloud

Please note that if the AMI, PaladinCloud-Installer, is unavailable in your region, copy the AMI from any other region (listed in the table below) before launching the machine.

Note: Before installing, please review the release notes on the Release page for any important updates or changes.

Region-Specific AMI IDs

Region	AMI ID
Us-east-1(N. Virginia)	ami-00b6f41a7702f09d2
Us-east-2(Ohio)	ami-05008790feb917df7
Us-west-1(N. California)	ami-0344a20ebee057f6e
Us-west-2(Oregon)	ami-0e08a9b6e34fb9b3d

Note: Our AMI is on AWS Linux, and we continuously test our application using Amazon AWS Linux-based installer boards. If you want any other OS flavor, please raise a ticket here.

Step 1: Prepare AWS Environment

1. Create a VPC with 2 public subnets and Enable auto-assign public IPv4 address or use the default VPC provided by AWS. Detailed instructions for creating VPC are here.
2. Launch an EC2 instance using the following settings:

• AMI: Use the appropriate AMI ID for your respective region from the table above.
• Instance Type: t2.xlarge
• VPC: Select the VPC you wish to use.

3. Create an IAM role and attach to the EC2 Instance. It can be run with AdministratorAccess or refer to this document for details on creating and attaching an IAM role with least privilege.

Step 2: Clone Paladin Cloud Repository

1. Open the terminal on the EC2 instance.
2. Clone the Paladin Cloud repository using the following command:

             git clone https://github.com/PaladinCloud/CE

Step 3: Navigate to the CE Directory

Change the directory to the cloned CE repository using the command:

             cd CE

Step 4: Checkout to the Latest Release

Check out the latest release of Paladin Cloud using the command:

           git checkout tags/3.0.0

Step 5: From the installation directory Configure Local Settings

1. Change the directory to the installer directory using the command:

              cd installer

2. Copy the default.local.py to local.py with the following command:

              cp settings/default.local.py settings/local.py

3. Open local.py using the preferred text editor (e.g., vi):

               vi settings/local.py

4.  Update the following configuration values:

• VPC details (created in Step 1):

                 vpc = {

                      "ID": "VPC-1",

                      "CIDR_BLOCKS": ["10.0.0.0/16"],

                      "SUBNETS": ["subnet-1", "subnet-2"]

                  }

• Cognito Configuration:

             COGNITO_ADMIN_EMAIL_ID = "[email protected]"

             COGNITO_DOMAIN = "xyzPaladinCloud"  # Replace with your preferred domain

• Update AWS region:

              AWS_REGION = "update_aws_region"

• Add your base ACCOUNT_ID and ACCOUNT_NAME:

             ACCOUNT_ID = "update_account_id"

             ACCOUNT_NAME = "update_account_name"

• Add Mandatory tags as per your organization policy (This is optional):

              MANDATORY_TAGS = "Application,Environment"

4. Save the local.py file after updating the values.

Step 6: Install Paladin Cloud

1. Proceed with the Paladin Cloud installation using the following command:

             sudo python3 manager.py install

2. You will get a prompt to choose authentication mechanism. Choose option 3 Using the IAM role attached to this instance.

The installation process may take approximately 30-35 minutes. Once the installation is complete, a window named output will be displayed on the screen. This window contains vital information about the URL, hostname, and other essential credentials.

3. Upon successful installation, an email containing your login credentials will be generated and sent to the email address you provided in the local.py file during the installation process.

Final Steps

1. Click here for the steps to connect to the portal.
2. Go to the link you received in the email after installation and sign in using the login credentials provided in the email. 
3. You will be prompted to create a new password. Once you create the password, you can access the web application.

In case of any failures, please check the troubleshooting steps here.

      Installation logs are available in the log directory:

        `tail -f log/debug.log`: To see the debug log

        `tail -f log/error.log`: To see the error log

        `tail -f log/terraform_install.log`: To see the Terraform Installation log

        `tail -f log/terraform_destroy.log`: To see the Terraform Destroy log

Important Notes:

1. After completing the installation process, it is recommended to put your EC2 instance into ‘Stop‘ mode. This practice conserves resources and helps optimize costs, ensuring a more efficient utilization of your infrastructure.
2. Paladin Cloud’s default installation is HTTP-only. If you require an HTTPS connection, please follow this link for detailed instructions.

Congratulations! You have successfully installed Paladin Cloud on AWS Cloud. If you encounter any issues during installation or have further questions, please refer to the Standard Installation Guide or contact our support team for assistance.