Backend - ambientación local

Git

instalar CLI de GIT para poder ejecutar comandos en la consola.

https://git-scm.com/download/mac

MONGO COMPASS

Para conectarse a la base de datos Mongo, usar estas URLs de conexión por ambiente

Descarga en: https://www.mongodb.com/try/download/compass

URLs de conexión

AWS

Create AWS Access Keys

To get or create your access key ID and secret access key:

1. Login to aws https://console.aws.amazon.com/iam/ using iam user option

   1. AccountId: 657809478030

2. Go to the IAM console at https://console.aws.amazon.com/iam/

3. On the navigation menu, choose Users.

4. Click your IAM user name (not the check box).

5. Open the Security credentials tab, and then choose Create access key.

To see the new access key, choose Show. Your credentials resemble the following:

Open

AWS MFA SETUP

Setting Up AWS MFA device

To enable MFA in AWS:

1. Go to the IAM console at https://console.aws.amazon.com/iam/

2. On the navigation menu, choose Users.

3. Click your IAM user name (not the check box).

4. Under Assigned MFA Device, click Manage and follow instructions to set it up

5. Your device AWS DEVICE ARN is shown there e.g. arn:aws:iam::11111111110:mfa/user.lastname (Virtual)

Open

Configurar roles

Después de que te hayan sido entregadas las credenciales de aws y hayas configurado 2FA, configurar los roles.

Haz click en cada una de las siguientes URLs:

dev:  https://signin.aws.amazon.com/switchrole?roleName=developers&account=766717554267

qa/staging:  https://signin.aws.amazon.com/switchrole?roleName=developers&account=549923646310

prod:  https://signin.aws.amazon.com/switchrole?roleName=sre-engineering-l0&account=540086856298

Saldrá la siguiente pantalla donde deberás de configurar con un nombre para identificar el ambiente y un color:

Una vez configurados los roles desconéctate de la cuenta y vuelve a ingresar.

Los roles podrás cambiarlos en la parte superior derecha del portal de aws, asegúrate siempre estar en la región de N. Virginia.

Herramientas a instalar

Java

• Instalar Java version 8 (https://www.oracle.com/java/technologies/javase/javase-jdk8-downloads.html)

• Configurar JAVA_HOME ejecutando el siguiente comando (“abc”: reemplazar con la versión más actual que se instale):

Para zsh:

Para bash:

Visual Studio Code

https://code.visualstudio.com/download

Si estas acostumbrado a los shortcuts de intellij, puedes configurarselos a visual studio code siguiendo las instrucciones del siguiente plugin https://marketplace.visualstudio.com/items?itemName=k--kato.intellij-idea-keybindings

y usando el siguiente archivo

Open

brew

Este paso instalara los Command Line Tools for Xcode lo cual podría tardar varios minutos pero servirá para otras instalaciones.

pip

Una vez que Command Line Tools for Xcode esta instalado correr los siguientes comandos.

docker

https://hub.docker.com/editions/community/docker-ce-desktop-mac/

gradle

awscli

Install VERSION 2

• MAC

• WINDOWS: https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2-windows.html

Configurar (reemplazar Access Key ID, Secret y ARN(arn:aws:iam::657809478030:user/ramon.valdez) por los obtenidos anteriormente en la configuración de AWS: “Create AWS Access Keys”), los mismos valores para todos los ambientes:

DEV:

QA:

STAGING:

PROD:

finalmente validar que existan las 4 ambientes en el archivo:

luego agrega estos dos perfiles adicionales short-term usando tu <access_key> y <secret_access_key>:

aws-mfa

https://github.com/broamski/aws-mfa

Crea un folder llamado bin en el to home user

Se recomienda este otro método más directo de instalación de aws-mfa sin usar git:

kubectl

https://docs.aws.amazon.com/es_es/eks/latest/userguide/install-kubectl.html (install the version that matches the current kubernetes cluster version in AWS EKS 1.17

Copiar el siguiente archivo en la ruta ~/.kube

Open

Scripts de acceso a aws y kubernetes

Copiar el siguiente archivo en la carpeta ~/bin

Open

Dar permisos de ejecución al archivo

Configurar los siguientes comandos en el archivo ~/.bash_profile

Ejecutar el comando para cargar las variables.

Dependiendo de la terminal due uses puede que necesites agregar este comando al archivo de configuración de tu terminal source ~/.bash_profile

configurar tokens de github

Configurar los siguientes comandos en los archivos:

• ~/.bash_profile

• ~/.zshenv

• ~/.zshrc

Ejecutar el comando para cargar las variables.

source ~/.bash_profile

login aws y kubernetes

Si configuraste el archivo de login_aws ejecutar los siguientes comandos para validar el acceso a kubernetes

Ambientes

Si no lo configuraste, puedes correr estos comandos

Notas:

• para otros ambientes únicamente se debe de cambiar la palabra dev por (qa o staging)

• para forzar renovar el token puedes usar la opción --force:
  aws-mfa --profile developers-dev --force

• Si un error de credenciales invalidas aparece:

  • Verifica que tu archivo de ~/.aws/credentials este correcto

  • Si el error persiste regresa a la configuración de aws-mfa y reemplaza python setup.py install por python3 setup.py install

  • Asegurase de tener instalado pip pip --version

Node

Instalar el entorno de node https://nodejs.org/en/

npm

El administrador de paquetes ya está habilitado en el entorno del node

yarn

serverless

DuoMobile (2FA)

install DuoMobile in your phone

Google Authenticator (2FA)

Instalar google autenticathor en tu celular

Clonar repositorios

Se debe contar con la configuración de SSH keys en github

Intellij Community Edition

Instala Intellij y configura la versión default a java 1.8

Plugins

Instalar los siguientes plugins del marketplace

• Lombok *

• Git commit message Helper

• EnvFile

• Gradle *

*Es posible que ya vengan incluidos en la versión

git-commit-template

Seguir la guia para configurar el plugin

https://fintechdigital.atlassian.net/wiki/spaces/PAGOPOP/pages/469663759/GIT+CONVENTIONS#Commit-message-Intellij-Plugin

Code styling SPIN

Todo código que se desarrolle deberá ser formateado con los estándares de styling definidos pod SPIN. Para facilitar esto, IntelliJ permite dar de alta el styler con los las configuraciones de formato de código que serán aplicadas por IntelliJ al presionar CMD + OPTION + L Es importante formatear el código antes de levantar cualquier PR.

Para configurar el styler de SPIN debes seguir estos pasos:

1. Abrir las preferencias de IntelliJ

2. Navegar a Editor → Code Style → Java → Engrane de Scheme → Import Scheme → IntelliJ IDEA code style XML

3. Seleccionar el siguiente archivo:

Open

PAGOPOP-SERVER

HUSKY Commit Validator

En el proyecto pagopop server se usa husky para validar el formato de los commits para instarlo correr el comando.

Después de esto cada commit será validado con husky, si el formato no es correcto no permitirá el commit, para más información consultar https://fintechdigital.atlassian.net/wiki/spaces/PAGOPOP/pages/469663759

Configuración ambiente local

Seguir las instrucciones del README del codebase para configurar kubernetes , AWS etc en local y poder ejecutar los servicios en tu local .

https://github.com/fintechdigitalventure/pagopop-server#readme