hiver-buddy-cli v0.2.10

hiver-cli

A command line utility to setup Hiver dev and QA environments.

Prerequisites (All steps are mandatory before starting up with the setup)

1. Working SSH connection with Hiver Github Org Setup Guide

ssh-keygen -t ed25519 -C "user@grexit.com"
cat ~/.ssh/id_ed25519.pub

• Copy the output and add a new ssh key on your github account Guide

3. Install aws-cli

aws --version

• Should be > 2.7.20

• Install aws-cli by following Guide

3. AWS configure step from AWS configure

4. Install Nodejs : Version should be > 12

• Download and Install if not present

5. Install devspace

sudo npm install -g devspace@~6.2.4

NOTE: Do not upgrade devspace till further notice

6. Make sure you are part of https://github.com/orgs/GrexIt/teams/engg/members, if not send a email to itsupport@grexit.com to get yourself added.

7. Install brew Guide

Note: If brew command does not work -follow the instructions mentioned the logs for adding brew to your path

9. Install kubectl

brew install kubectl

Installation

Buddy cli is hosted on npm and can be installed and updated via the below command.

sudo npm install -g hiver-buddy-cli

Updating hosts file

We will be doing local DNS mapping, to do this we have to add 3 lines to /etc/hosts file.

sudo vim /etc/hosts

Add these 3 lines in the end then press esc : wq and finally enter.

127.0.0.1 localhost dev.hiver.space
127.0.0.1 localhost v2dev.hiver.space
127.0.0.1 localhost analytics-dev.hiver.space

Selecting a folder for work

This folder should be the default for all the buddy commands related to this area. You can name this folder anything but keyword dev is preferred.

cd ~/
mkdir dev; cd dev

Creating a new area

This command creates confuguration files necessary for hiver services to work. It does not start any services but creates base for next step.

Use buddy create command to create/use a new buddy for the setup. Replace git-username with your Git account username.

Make sure has only smallcase letters and no underscore (hyphens are allowed)

buddy create <git-username>

Starting buddy

Buddy starts by default starts all the services enabled for yor area. In the beginning only essential services are running and we can add more services on demand.

buddy start

Sarting UI to see logs

buddy ui

Visit to see all the containers running http://localhost:8090/

Buddy serve

Buddy serve starts mapping for remote hiver apis to local machine.

Note 1: This command will need sudo permissions as we are going to use local 443 port. Note 2: You have to run this command in every login/wifi reconnect

sudo buddy serve

To List all the area details

buddy describe

Verification

Verify if https://v2dev.hiver.space works, it takes some time to be up as v2 does database migrations and is very slow to start. It ususally takes 60-120s.

You can also use buddy ui to see the logs for v2 service.

Setting up extension

1. Use @hiver.space email to create a new chrome profile

2. You will find a folder named chrome_extension in your local folder. Install this extension in your new chrome profile.

3. Create a SM with your newly recieved email @hiver.space

4. Send a test email to see if email is now synced.

Setup service for development

buddy setup-dev <service-name>

Ex:

buddy setup-dev v2api

Starting development environment

bash hiver/dev.sh <service-name>

Example

bash hiver/dev.sh v2api