Setting up Organisation Roost Control-plane

Owned by Harish Agrawal
Last updated: Apr 18, 2022 by Aishwarya Rane
6 min read

 

Assumptions: Setting it on AWS EC2 with Google Auth

 

Set up any one oAuth for Roost control-plane

Steps - Set up Google Auth Client

 

Steps - Set up OKTA Auth Client

  • Sign-in to your OKTA account with admin privileges (If you do not have an existing Okta account then sign-up at http://developer.okta.com )

  • From the left navigation menu, go to Applications -> Applications

  • Select Create App Integration → OIDC - OpenID Connect → Web Application, then click Next

  • Fill in the suitable App integration name, upload the logo

  • Add Sign-in redirect URIs

  • Allow Access to users thru Assignments → Controlled Access

    • Select the groups of users or Allow access to everyone

  • Save and Make a note of the Okta Client ID and the Client Secret (It is needed later in the config below)

  • From the left navigation menu, go to Security -> API

  • Make note of Issuer URI for default Authorization Server

    • something like https://{your_domain}.okta.com/oauth2/default

Optional Step - Set up AWS RDS database

  1. Select RDS

  2. Choose Create Database

  3. You can select “Easy Create” for “Amazon Aurora with MYSQL compatibility”

  4. Make a note of the writer instance database end-point, user and password (It is needed later in the config below)

  5. As a good practice, you can create a new user with read-write privileges and avoid using admin login.

  6. Download and execute this sql as a one-time exercise

  7.  

    curl -L https://remote-roostprod.s3.us-west-1.amazonaws.com/roost.sql -o /tmp/roost.sql chmod +x /tmp/roost.sql sudo mysql # CREATE USER 'roost'@'localhost' identified WITH mysql_native_password by 'zbioRoost#123'; # GRANT ALL on *.* to 'roost'@'localhost'; \. /tmp/roost.sql

 

Optional Step - Set up Local Mysql database on Ubuntu instance

sudo apt update sudo apt install mysql-server sudo mysql_secure_installation curl -L https://remote-roostprod.s3.us-west-1.amazonaws.com/roost.sql -o /tmp/roost.sql chmod +x /tmp/roost.sql sudo mysql CREATE USER 'roost'@'localhost' identified WITH mysql_native_password by 'zbioRoost#123'; GRANT ALL on *.* to 'roost'@'localhost'; \. /tmp/roost.sql

 

Optional Step - Set up Load Balancer

  1. Open the Amazon EC2 console and from the navigation bar, choose a Region for your load balancer. Be sure to select the same Region that you selected for your EC2 instances.

  2. Under LOAD BALANCING, choose Load Balancers, click on Create Load Balancer.

  3. Choose a Application Load Balancer, create.

  4. Define the load balance with a name, scheme as internet-facing and IP address type as IPv4

  5. For Network configuration, choose the default vpc, select a security group with 80 and 443 ports been opened and select the available  Availability Zones

  6. Add listeners with tcp 80 and TLS 443 and route the request to target group. Add a SSL/TLS certificate from ACM (Steps to create target group is given below)

  7. Click on Create Load Balancer

Basic configuration for load balancer
Listener configuration 

Steps to configure Target Group

i. Create a target group with instances as target type. Provide the target  group name

ii. Set protocol as http, select the default vpc

iii. Set health check protocol as http and health check path as /api

iv. Add  the Configured ec2 instances and click on create

v. Edit the target group attribute and enable the Stickiness and set Stickiness type as Load balancer generated cookie

 

Steps - EC2 Instance - Roost ControlPlane

This instance will be facing the team members for any Roost activity.

  1. Launch EC2 instance

  2. Choose Ubuntu 20 (ubuntu-focal-20.04) AMI

  3. Instance Type as t3.medium

  4. Security group to allow from control-plane traffic from any source IP or just the private VPC/Subnets

    1. SSH (port 22)

    2. HTTP (port 80)

    3. HTTPS (port 443) and

    4. Custom TCP Port 2502 (for Stun)

  5. Root volume storage should be 20 GB or more

  6. Preferred separate EBS volume of 100GB

  7. Enable Avoid Accidental Termination and disable EBS delete on termination

  8. Add tags and key-pair and launch

  9. Download key-pair; change permissions to 0400

  10. Review configuration and Launch Instance

  11. Connect to EC2 using SSH once it is running

 

Steps - EC2 Instance - WebConsole proxy

This instance will also act as the default jumpHost for user managed clusters. Optionally, it can host a Docker Host and Docker Insecure Registry

  1. Launch EC2 instance

  2. Choose Ubuntu 20 (ubuntu-focal-20.04) AMI

  3. Instance Type as t3.medium

  4. Security group for web-console proxy to allow TCP traffic from VPC or any source IP

    1. TCP Port 5000 for Docker Host

    2. TCP Port 5002 for Docker Insecure Registry

    3. TCP Port 60001 for JumpHost RoostApi Server

    4. TCP Port 60002 for ClusterLauncher

    5. TCP Port 60003 for EaaS API Server

    6. TCP Port 60005 for Cypress Video Server

    7. TCP Port 60006 for Web-console(gotty) default service - ubuntu user

    8. TCP Port 62020-62050 for dynamic gotty ports - mapped to individual users

  5. Root volume storage should be 20 GB or more

  6. Preferred separate EBS volume of 100GB

  7. Enable Avoid Accidental Termination and disable EBS delete on termination

  8. Add tags and key-pair and launch

  9. Download key-pair; change permissions to 0400

  10. Review configuration and Launch Instance

  11. Connect to EC2 using SSH once it is running

 

Steps - Installing dependencies on EC2 Instance

  1. Mount the EBS volume
    Check the 100GB disk NAME

    lsblk


    Use the EBS disk name that is not mounted

 

Steps - Install SSL Certs

  1. Get the SSL_certs.key and SSL_certs.crt file for your organisation domain and put it under a folder that will be accessible to the current user. Preferred to be kept under /var/tmp/Roost/certs

  2. It is possible to use a self generated certificate (not recommended though)

  3. You can generate a self-signed certificate using command given below

  4. The “root.cer” will have to be installed to the certificate authority on all Roost user systems as a trusted certificate. Article with steps for all OS is mentioned here https://zbio.atlassian.net/wiki/spaces/RFD/pages/1673134089

  5. Instructions for generating the self-signed certs is given below.

6. Update the root.cnf and server.cnf to reflect your organisation name and the DNS entries

7. Run the open_ssl commands displayed in the output of get-certs.sh

 

Steps - Configure Roost Environment and Start Docker containers

Download config.json

Sample Config looks like the below

  1. Replace the values to reflect for your organisation

  2. Keep values empty of the client_id/secrets for the 3rd party that is not needed

  3. Keep ENV_DATABASE detail unchanged if database is not external

  4. Add JWT_SECRET

  5. Recommend value of remote_console_proxy is same as enterprise_dns unless you want to start proxy elsewhere.

  6. If your servers are behind Load Balancer user load_balancer : “true” for different configuration.

 

Starting the Roost.ai containers for the first time

 

Setting up Roost Proxy Server

 

Verifying the Roost.ai components

  1. Connect to the public_ip/login using a browser

  2. Use the 3rd party auth to connect to the control-plane

Next Steps:

Go to Admin Settings and

  1. Enable cloud vendor of choice and provide default settings

  2. Add the webconsole-proxy EC2 details in the “Configure EC2 Launcher”

  3. Enable JumpHost and refresh the page

  4. Go to JumpHost settings and add the webconsole-proxy EC2 details as 'default' jumpHost

 

Update Roost.ai Control-plane, when there is a new Roost release