IBL CLI Start Script

This script automates the process of setting up an IBL server. It checks the system requirements, installs necessary dependencies, configures AWS and IBL services, and launches the IBL services.

Requirements

• Ubuntu 20.04 or later
• At least 20G of memory
• At least 30G of storage
• (OPTIONAL: If Image registry is on GCP) You will need a JSON key of a service account with read access to the GCP artifact registry. The setup process will require you to paste the Service account email and the contents of the key.json. The following permissions need to be attached to the Service Account:
  • Artifact Registry Reader
  • Service Account Token Creator
• (OPTIONAL: If Image registry is on AWS ECR) You will need read access from IBL ECR that looks like:

  {
      "Version": "2012-10-17",
      "Statement": [
          {
              "Effect": "Allow",
              "Action": [
                  "ecr:GetAuthorizationToken",
                  "ecr:BatchGetImage",
                  "ecr:GetDownloadUrlForLayer",
                  "ecr-public:GetAuthorizationToken",
                  "sts:GetServiceBearerToken",
                  "ecr:ListTagsForResource"
              ],
              "Resource": "*"
          }
      ]
  }
  

  So make sure to get your AWS Access Key ID and AWS Secret Access Key form IBL. The region and output format default to.

  Default region name:  us-east-1
  Default output format:  json
  

Dependencies

• Docker
• Docker Compose
• AWS CLI
• Pyenv
• Python 3.8.3
• Cargo
• Pip
• Unzip

Usage

1. (OPTIONAL: If you're using your own image regisry) Update the default.yml file in https://github.com/<ORG>/ibl-cli-ops/blob/master/ibl/templates/config/defaults.yml (In appropriate branch) with the latest ECR/GCP image URI for the following:
   • IBL_EDX_IMAGE: <IBL_EDX_IMAGE IMAGE-URI>
   • IBL_DM_IMAGE: <IBL_DM_IMAGE IMAGE-URI>
   • IBL_AXD_REPORTER_IMAGE: <IBL_AXD_REPORTER_IMAGE IMAGE-URI>
   • IBL_AXD_WEB_ANALYTICS_IMAGE: <IBL_AXD_WEB_ANALYTICS IMAGE-URI>
2. Clone the script on your server git clone https://github.com/iblai/ibl-cli-start.git
3. Enter ibl-cli-start dir.
4. Make the script executable:

chmod +x ibl-cli-start.sh

Run the script:

./ibl-cli-start.sh

During the execution of the script, you will be prompted to enter your AWS Access Key ID, AWS Secret Access Key OR GCP credentials.json and the service account email, and Git Access Token. These are necessary for the configuration of AWS and the installation of the IBL CLI.

NOTE: These are prompts to avoid leaving secrets and keys in the bash history and also store them in the script.

Overriding Default Variables

The script uses default values for some variables like the AWS region, output format, and the repository branch. You can override these defaults by setting the following environment variables before running the script:

• AWS_DEFAULT_REGION: The default AWS region to use. Default is "us-east-1".
• AWS_DEFAULT_OUTPUT_FORMAT: The default AWS output format to use. Default is "json".
• BRANCH: The branch of the repository to use. Default is "develop".

For example, to use the "us-west-2" region, "text" output format, and "main" branch, you can run:

export AWS_DEFAULT_REGION="us-west-2"
export AWS_DEFAULT_OUTPUT_FORMAT="text"
export BRANCH="main"

./ibl-cli-start.sh