imapt

Green Rain Deployment Guide – Fedr8 Green Rain

Green Rain Deployment Guide

Get Green Rain as SaaS or a deployed virtual appliance.

This Deployment Guide helps users deploy their own Green Rain virtual appliance either on their premises, co-location or Amazon Web Services.

 

I want to deploy my own Green Rain appliance - vmdk, vhd or ami

I'd like Fedr8 to run Green Rain for me as SaaS

Introduction

This guide has been written for technical staff to set up the Green Rain Virtual Appliance (GRVA) on their premises or cloud. This is an actionable technical guide and the reader is expected to be reasonably proficient in the target environment for the virtual appliance.

Each action should be done in sequence:

  1. Get the GRVA files from Fedr8.
  2. Prepare your target environment
  3. Deploy the GRVA to the target
  4. Validate and troubleshoot
  5. Import and analyse a sample application

On completion of this guide you should have a working GRVA and insights to a sample application for its Cloud Ready, Container Ready and Licence Discover.

Where to get this guide

This guide is available the Fedr8 website:

Alternatives to using the Green Rain Virtual Appliance

Green Rain is also available as an online Software-as-a-Service (SaaS) platform. Fedr8 will provide a dedicated Green Rain Virtual Appliance hosted on our cloud and you only pay a single package fee.

Contact Fedr8 about using SaaS instead of the virtual appliance

Feedback

The Fedr8 team welcome feedback on this Deployment Guide and the Green Rain product. Please let us know if there are any errors, or how we can otherwise improve it.

Provide feedback to the Fedr8 team.

Preparation

The activities in this step are key to avoid common target platform integration problems such as correct network settings. Please ensure you complete preparation before trying to deploy the virtual appliance.
 
  1. Get the Green Rain Virtual Appliance from Fedr8
  2. Prepare the target environment

Get the Green Rain Virtual Appliance

The Green Rain Virtual Appliance (GRVA) is currently only available directly from a Fedr8 representative. For VMDK this will require a download. For AMI your Fedr8 contact will share a private AMI with you in a specific AWS Region.

NOTE: The appliance files are approximately 6GB in size and will take some time to download.

Prepare the target environment

The GRVA can be deployed to:

  • VirtualBox
  • VMware
  • Amazon Web Services

For VirtualBox and VMware, a GRVA file download will be provided when you contact Fedr8. For AWS, the steps are different and no download is required.

Administrator access

Administrator access must include the capability of controlling compute, memory and storage resources and to be able to connect to the network.

The deployment will fail if you don’t have the authority to:

  • Configure and deploy virtual machines
  • Connect to the network
  • Enable access between end-user locations and the Appliance
Access to enough compute and memory

The GRVA deep-learning engine is highly parallel and will consume as much compute and memory that you provide. Fedr8 recommends a minimum of 16 vCPU and 64GB RAM.

DHCP and networking

The appliance is configured to use DHCP to get an IP address automatically. The network segment you deploy the appliance to must have a DHCP service available otherwise the network won’t be configured and you won’t be able to access your appliance.

The appliance uses the equivalent of a bridge networking device and will acquire an IP address from the network it is connected to. This IP address must be accessible from the browser and devices of GRVA users. This may require routing or load balancing or other networking to create end-to-end connectivity.

AMI Deployment

Make sure you have read and complete Prepariation.

The process for running Green Rain on AWS EC2 is as follows:

  1. Contact Fedr8 and share the AWS Account ID where Green Rain will run on EC2. This is a 12-digit number.
  2. Agree with Fedr8 what size of Green Rain instance you will run – small or large.
  3. Fedr8 will share the correct-sized AMI with your AWS Account.
  4. Launch an EC2 instance from the Fedr8 AMI.
  5. Make sure you have a note of the usernames and passwords for Green Rain Virtual Appliance (GRVA).
  6. Start the GRVA.
  7. Log on to the GRVA using the credentials provided by Fedr8.

Now go to the Validate section.

VMDK Deployment

Make sure you have read and complete Preparation.

The process for using the VirtualBox and VMware GRVA is much the same.

The Amazon Web Services is different as it doesn’t require a download and instead requires some AWS Identity and Access Management (IAM) and EC2 steps to share access the GRVA AWS Machine Image (AMI).

However, the general steps are the same:

  1. Import the GRVA onto the target platform using the platform’s native management interface.
  2. Fine-tune the GRVA machine settings on the platform (network, memory etc)
  3. Make sure you have a note of the usernames and passwords for Green Rain.
  4. Start the GRVA.
  5. Log on to the GRVA using the credentials provided by Fedr8.

NOTE: The GRVA engine will not run fast on a laptop or small instance. The best starting spec is a minimum of 16 vCPU and 64GB RAM. However, it will work with limited resources but poor performance should be expected. There are different sized instances to suit your environment from small to large and your Fedr8 contact will help you with this.

For best results, deploy the GRVA on an enterprise-scale virtualization platform or cloud..

We recommend 16 vCPU and 64GB of memory as a minimum. More resources means faster results.

Now go to the Validate section.

Validate

Once you have logged on to your GRVA using the credentials provided by Fedr8, check the network configuration of the appliance by:

  1. SSH to the GRVA IP address and log on using the credentials provided by Fedr8.
  2. Find the ‘superadmin’ credentials that are autogenerated the first time the appliance is started.
  3. Issue the ‘docker ps’ command to check the GRVA docker containers are running.
  4. Using a browser, connect over HTTP/S to the IP address to see the Green Rain logon screen, logon with the ‘superadmin’ credentials

Common issues that might occur:

  • If you can’t browse the IP address, then you need to trouble shoot your network with tools like traceroute.
  • If the containers aren’t running, see Manually Reinitialising the GRVA below.

Manually re-initializing the GRVA

You can manually control the Docker containers that run the software inside the GRVA:

  1. SSH to the GRVA and logon using the credentials supplied by Fedr8 (note, these are not the ‘superadmin’ credentials used to logon to the software via the browser).
  2. Check if any containers are running using ‘docker ps’. Make a not of their ‘Container IDs’
  3. Stop any running containers with ‘docker stop <Container ID>’
  4. Run ‘sudo nohup docker-compose up &’
  5. Run ‘sudo docker-compose run –rm app rake db:create db:migrate db:populate’
  6. Make a note of the newly-generated ‘superadmin’ credentials.

Analyze your first application

Importing your first application is a good test of the GRVA.

To do this you need to have a running GRVA and be able to logon to the software with a browser using the ‘superadmin’ credentials.

When you first logon as ‘superadmin’ you will be presented with the Client Interface:

  1. Create a new client for your organization.
  2. Create a new Admin user in your organization.
  3. Logout as ‘superadmin’
  4. Login as your new Admin user in your organization.
  5. Import a new sample application:
    1. Create a new project called Validation
    2. Click Import and select the Validation project
    3. Import this sample application (go to GitLab, download zipfile)
    4. Click Create once the import is complete.
    5. Await your results and monitor In Progress status using the title navigation bar option.

Once your application has been analyzed it will be shown in the main Dashboard.

Click the application at the bottom of the page to open up the application summary page and navigate from their into the Technical Report.

Check that the PPT and CSV export features work ok in your environment.

Contact Us