https://github.com/mvillarrealb/inretail-tpo-challenge
Intercorp Retail Technical Product Owner Challenge
https://github.com/mvillarrealb/inretail-tpo-challenge
Last synced: 3 days ago
JSON representation
Intercorp Retail Technical Product Owner Challenge
- Host: GitHub
- URL: https://github.com/mvillarrealb/inretail-tpo-challenge
- Owner: mvillarrealb
- Created: 2020-01-07T13:52:37.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-01-14T02:05:41.000Z (over 5 years ago)
- Last Synced: 2025-01-12T14:47:40.115Z (5 months ago)
- Language: Java
- Size: 872 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Intercorp retail TPO CHALLENGE
###
Reto técnico full stack Intercorp retail **Marco A Villarreal B**
Contenidos
* [Componentes](#components)
* [Plataforma GCP](#cloud)
* [Instalación](#installation)
* [Aprovisionamiento con Terraform](#terraform)
* [Configuraciones de Kubernetes](#kubernetes)
* [Ajustes del cert manager](#certmanager)
* [Configuración de la base de datos](#database)
* [Microservicio customer-api](#api)
* [Frontend App](#web)
* [Test de la Api](#test)
* [Roadmap](#roadmap)
Plataforma GCP
A continuación se ilustra la plataforma de GCP desplegada para el reto
La plataforma GCP consiste de los siguientes componentes:
* Subred para cluster kubernetes y base de datos
* Ip Estática global para resolución a la calle
* Configuración cloud DNS(dominio mvillarreal.com)
* Cluster GKE(2 nodos)
* Instancia Cloud SQL
* Container Registry de Google GKE
Instalación
Aprovisionamiento con Terraform
A continuación se describen los pasos para instalar la plataforma GCP con terraform
### Requerimientos
* Cli de Google cloud
* Terraform v0.12.12
```sh
gcloud projects list
# Creación del proyecto de GCP
gcloud projects create mvillarreal-tpo-challenge
# Setear el proyecto como el proyecto actual
gcloud config set project mvillarreal-tpo-challenge
# Habilita la api de kubernetes para el projecto(debe haber billing account asociada)
gcloud services enable container.googleapis.com
# Habilita la api de container registry para el projecto(debe haber billing account asociada)
gcloud services enable containerregistry.googleapis.com
# Habilita la api de sqladmin(para creas instancias de cloud SQL)
gcloud services enable sqladmin.googleapis.com
# Habilita la api de servicenetworking(para las subredes)
gcloud services enable servicenetworking.googleapis.com
# Creación del service account para terraform
gcloud iam service-accounts create inretail-tpo-saccount \
--description "Main service account for terraform" \
--display-name "inretail-tpo-service-account"
# Asignar rol editor al service account(revisar comando)
gcloud projects add-iam-policy-binding mvillarreal-tpo-challenge \
--member serviceAccount:inretail-tpo-saccount@mvillarreal-tpo-challenge.iam.gserviceaccount.com \
--role roles/editor
gcloud projects add-iam-policy-binding mvillarreal-tpo-challenge \
--member serviceAccount:inretail-tpo-saccount@mvillarreal-tpo-challenge.iam.gserviceaccount.com \
--role roles/servicenetworking.networksAdmin
# Se exporta la key del service account para ser usada por terraform
gcloud iam service-accounts keys create $(pwd)/platform/service-account-key.json \
--iam-account inretail-tpo-saccount@mvillarreal-tpo-challenge.iam.gserviceaccount.com
#Init de terraform
terraform init
# Ver el plan de terraform(antes de ejecutar)
terraform plan
#Que comience la fiesta!(esto puede tardar varios minutos, recordemos que se esta aprovisionando una plataforma entera)
terraform apply
```
Configuraciones de Kubernetes
### Requerimientos
* kubectl
* Kubeconfig apuntando a nuestro cluster
```sh
# Configura el acceso al cluster a través de kubectl
gcloud container clusters get-credentials inretail-tpo-challenge-cluster --zone us-central1-a --project mvillarreal-tpo-challenge
# Crea el namespace de aplicaciones
kubectl create namespace apps
# Crear el secret para los deploy tengan permiso de hacer pull al registry gcr.io
kubectl create secret docker-registry gcr-json-key \
--docker-server=gcr.io \
--docker-username=_json_key \
--docker-password="$(cat $(pwd)/platform/service-account-key.json)" \
[email protected] \
-n apps
```
Ajustes del cert manager
A continuación de describen los pasos para configurar el cert-manager
de kubernetes configurado para el issuer del let's encrypt
### Requerimientos
* Kubeconfig apuntando a nuestro cluster
* Helm v2.14.3 (Para el ingress)
```sh
# Crea service account tiller para helm
kubectl create serviceaccount -n kube-system tiller
# Crea cluster role binding para tiller
kubectl create clusterrolebinding tiller-binding \
--clusterrole=cluster-admin \
--serviceaccount kube-system:tiller
# Inicializa el helm con el service account
helm init --service-account tiller
# Actualización de repos de helm
helm repo update
# Instalación del cert-manager
helm install --name cert-manager --version v0.5.2 \
--namespace kube-system stable/cert-manager
export [email protected]
# Creación del cert issuer de letsencrypt
curl -sSL https://rawgit.com/ahmetb/gke-letsencrypt/master/yaml/letsencrypt-issuer.yaml | \
sed -e "s/email: ''/email: $EMAIL/g" | \
kubectl apply -f-
```
Configuración de la base de datos
```sh
# Listar las instancias
gcloud sql instances list
NAME DATABASE_VERSION LOCATION TIER PRIMARY_ADDRESS PRIVATE_ADDRESS STATUS
inretail-tpo-challenge-database MYSQL_5_6 us-central1-a db-f1-micro - 10.35.0.3
kubectl apply -f ./platform/kubernetes/database -n apps
```
Microservicio customer-api
Se despliega usando el pipeline en el directorio .github, en el diagrama se observan las etapas del pipeline
* BUILD/TEST MAVEN: Ejecuta las pruebas unitarias y compila el archivo Jar
* BUILD/PUSH IMAGE: Construye la imagen docker basada en el Dockerfile encontrado en la raíz del este proyecto, así mismo hace un push al Google Container Registry(GCR).
* KUBERNETES DEPLOY: Despliega ó actualiza en Google Kubernetes Engine los cambios realizados.
* NEWMAN TESTS una vez desplegados los cambios se usa newman para correr un test funcional básico.
Frontend App
Se despliega usando firebase cli usando el comando
```sh
firebase deploy
```
Test de la Api
Para probar la api rest de customers puede usar la colección de postman del directorio customers-api e invocarla usando newman como se muestra:
```sh
npm install -g newman
cd ./customers-api && newman run customer-api.postman_collection.json
```
ROADMAP
* Agregar sonar cloud en el pipeline (Necesito pagar porque ahorita esta privado mi repo XD )
* Implementar certificado y dominio en firebase hosting
* Probar con Ingress de traefik (soĺo porque es divertido)