freeCodeCamp/docs/i18n/espanol/devops.md

Manual de DevOps

Esta guía te ayudará a comprender nuestra infraestructura y cómo le damos mantenimiento a nuestras plataformas. Si bien esta guía no contiene detalles exhaustivos de todas las operaciones, ésta podría utilizarse como referencia para tu comprensión de los sistemas.

Déjanos saber, si tienes algún comentario o consulta, y la aclararemos con mucho gusto.

Manual de Vuelo - Despliegues de código

Este repositorio se construye, prueba y despliega continuamente para ** separar conjuntos de infraestructura (Servidores, Bases de Datos, CDNs, etc.)**.

Esto involucra tres pasos que deben seguirse en secuencia:

1. Los nuevos cambios (ambos, correcciones y funcionalidades) son mezclados en nuestra rama principal de desarrollo (master) mediante pull requests.
2. Estos cambios son ejecutados a través de una serie de pruebas automatizadas.
3. Una vez que las pruebas se completan de forma satisfactoria, publicamos los cambios (o los actualizamos si es necesario) para desplegarlos en nuestra infraestructura.

Construyendo la base de código - Mapeando las Ramas de Git con los Despliegues.

Usualmente, master (la rama de desarrollo por defecto) es fusionada con la rama production-staging una vez al día, y publicada dentro de una infraestructura que se encuentra aislada.

Esta es una publicación intermedia para nuestros desarrolladores y colaboradores voluntarios. También es conocida como nuestra publicación "staging" o "beta".

Este es idéntico a nuestro entorno de producción en freeCodeCamp.org, excepto que utiliza un conjunto separado de bases de datos, servidores, web-proxies, etc. Este aislamiento nos permite probar el desarrollo y las funcionalidades de manera continua en un escenario similar al de "producción", sin afectar a los usuarios regulares de las principales plataformas de freeCodeCamp.org.

Una vez que el equipo de desarrolladores @freeCodeCamp/dev-team está satisfecho con los cambios en la plataforma de staging, estos cambios se trasladan cada pocos días a la rama production-current.

Esta es la versión final que despliega los cambios a nuestras plataformas de producción en freeCodeCamp.org.

Pruebas de cambios - Pruebas de Integración y Aceptación del Usuario.

Empleamos varios niveles de pruebas de integración y aceptación para verificar la calidad del código. Todas nuestras pruebas se realizan a través de software como Travis CI y Azure Pipelines.

Contamos con pruebas unitarias para probar nuestras soluciones a los desafíos, las API del Servidor y las interfaces de Usuario. Estas nos ayudan a probar la integración entre diferentes componentes.

[!NOTE] También estamos en el proceso de redactar pruebas de usuario final que nos ayudarán a replicar escenarios del mundo real, como actualizar un correo electrónico o hacer una llamada al API o servicios de terceros.

Juntas, estas pruebas ayudan a evitar que los problemas se repitan y garantizan que no introduzcamos un error mientras trabajamos en otro error o en una funcionalidad.

Desplegando los Cambios: Enviando los cambios a los servidores.

Hemos configurado un software de entrega continua para publicar los cambios en nuestros servidores de desarrollo y producción.

Una vez que los cambios se envían a las ramas de publicación protegidas, se activa automáticamente un flujo de compilación para la rama. Los flujos de compilación son responsables de construir artefactos y mantenerlos en un almacenamiento en frío para su uso posterior.

El flujo de compilación dispara el flujo de publicación correspondiente si este completa una ejecución exitosa. Los flujos de publicación son responsables de recopilar los artefactos de compilación, moverlos a los servidores y ponerlos en funcionamiento.

Los estados de las compilaciones y publicaciones están disponibles aquí.

Ejecutar una compilación, prueba y despliegue

Actualmente, solo los miembros del equipo de desarrolladores pueden enviar cambios a las ramas de producción. Los cambios en las ramas de production-* sólo pueden llegar a través de una fusión fast-forward al upstream.

[!NOTE] En los próximos días mejoraríamos este flujo a través de la implementación de pull-requests, para una mejor administración de acceso y transparencia.

Publicando cambios a las Aplicaciones en Staging.

1. Configura tus repositorios remotos correctamente.

   git remote -v
   

   Resultado:

   origin   git@github.com:raisedadead/freeCodeCamp.git (fetch)
   origin   git@github.com:raisedadead/freeCodeCamp.git (push)
   upstream git@github.com:freeCodeCamp/freeCodeCamp.git (fetch)
   upstream git@github.com:freeCodeCamp/freeCodeCamp.git (push)
   

2. Asegúrate de que tu rama master no tiene cambios pendientes y esté sincronizada con el upstream.

   git checkout master
   git fetch --all --prune
   git reset --hard upstream/master
   

3. Comprueba que Travis CI se está ejecutando sobre la rama master para el flujo upstream.

   Las pruebas de integración continua deben estar en verde y en estado PASSING para la rama master.

   Comprobando el estado en Travis CI (captura de pantalla)

   
   

   Si esto está fallando debes detenerte e investigar los errores.

4. Confirme que puede crear el repositorio localmente.

   npm run clean-and-develop
   

5. Mueva los cambios desde master a production-staging mediante una fusión fast-forward

   git checkout production-staging
   git merge master
   git push upstream
   

   [!NOTE] No podrás forzar un push y si has reescrito el historial de alguna manera, estos comandos arrojarán errores.

   Si esto ocurre, es posible que hayas hecho algo incorrectamente y deberías comenzar de nuevo.

Los pasos anteriores activarán automáticamente un flujo de compilación para la rama production-staging. Una vez que se completa la compilación, los artefactos se guardan como archivos .zip en un almacenamiento en frío para ser recuperados y usados más adelante.

El flujo de publicación se activa automáticamente cuando hay un nuevo artefacto disponible en el flujo de compilación conectado. Para las plataformas de staging, este proceso no implica aprobación manual y los artefactos se envían a los servidores de API y CDN Cliente.

[!TIP|label:Estimates] Por lo general, la ejecución de la compilación tarda entre 20 y 25 minutos en completarse, seguido de la ejecución de publicación que tarda aproximadamente entre 15 y 20 minutos para el cliente, y aproximadamente entre 5 y 10 minutos para que el API estén disponibles en vivo. Desde que el código se envía al servidor hasta que está en vivo en las plataformas de staging, todo el proceso toma aproximadamente 35 a 45 minutos en total.

Publicando cambios a las Aplicaciones en Producción.

El proceso es prácticamente el mismo que el de las plataformas de staging, con algunas comprobaciones adicionales. Esto es solo para asegurarnos de que no rompemos nada en freeCodeCamp.org, el cual puede tener a cientos de usuarios usándolo en cualquier momento.

NO ejecutes estos comandos a menos que hayas verificado que todo funciona en la plataforma de staging. No debes omitir ni evitar ninguna prueba en staging antes de continuar.

1. Asegúrate de que tu rama production-staging no tenga cambios pendientes y esté sincronizada con upstream.

   git checkout production-staging
   git fetch --all --prune
   git reset --hard upstream/production-staging
   

2. Mueve los cambios de production-staging a production-current mediante una fusión fast-forward

   git checkout production-current
   git merge production-staging
   git push upstream
   

   [!NOTE] No podrás forzar un push y si has reescrito el historial de alguna manera, estos comandos arrojarán errores.

   Si esto ocurre, es posible que hayas hecho algo incorrectamente y deberías comenzar de nuevo.

Los pasos anteriores activarán automáticamente un flujo de compilación para la rama production-current. Una vez que un artefacto de compilación está listo, este activará la ejecución en el flujo de publicación.

[!TIP|label:Estimates] Normalmente, la ejecución de la compilación tarda entre 20 y 25 minutos en completarse.

Pasos Adicionales para el Staff Action

Una vez que se activa una ejecución de publicación, los miembros del equipo de desarrollado principal recibirán un correo electrónico automatizado de intervención manual. Pueden aprobar o rechazar la publicación.

Si los cambios funcionan y se han probado en la plataforma de staging, entonces se pueden aprobar. La aprobación debe darse dentro de las 4 horas posteriores a la activación de la publicación antes de sea rechazada automáticamente. Un miembro del personal puede volver a iniciar la ejecución de la publicación de manera manual para publicaciones que fueron rechazados o esperar el siguiente ciclo de publicación.

Para uso del personal:

Revisa tu correo electrónico para ver si hay un enlace directo o ve al panel de publicaciones después de que la ejecución de la compilación haya terminado.

Una vez que uno de los miembros del personal apruebe una publicación, el flujo enviará los cambios a los servidores de API y CDN de producción de freeCodeCamp.org. Por lo general, esto tomará entre 15 y 20 minutos para el cliente y aproximadamente 5 minutos para que los servidores API estén disponibles en vivo respectivamente.

[!TIP|label:Estimates] La publicación suele tardar entre 15 y 20 minutos para cada instancia de cliente, y entre 5 y 10 minutos para que cada instancia de API esté disponible en vivo. Desde el envío del código hasta que está en vivo en las plataformas de producción, todo el proceso toma en total entre 90 y 120 minutos aproximadamente (sin contar el tiempo de espera para la aprobación del personal).

Estado de la Compilación, Pruebas y Despliegue

Aquí está el estado actual de las pruebas, compilación y despliegue del código base.

Tipo	Rama	Estado	Panel
Pruebas CI	master		Ir al panel de estado
Pruebas CI	production-staging		Ir al panel de estado
Flujo de Compilación	production-staging		Ir al panel de estado
Flujo de Publicación	production-staging		Ir al panel de estado
Pruebas CI	production-current		Ir al panel de estado
Flujo de Compilación	production-current		Ir al panel de estado
Flujo de Publicación	production-current		Ir al panel de estado

Acceso anticipado y pruebas beta

Te invitamos a probar estas versiones en un modo "prueba beta pública" y obtener acceso anticipado a las próximas funciones de las plataformas. A veces, estas funcionalidades/cambios se denominan next, beta, staging, etc. indistintamente.

Tus contribuciones a través de comentarios y reporte de errores nos ayudarán a hacer que las plataformas de producción en freeCodeCamp.org sean más resistentes, consistentes y estables para todos.

Te agradecemos por reportar los errores que encuentres y ayudar a mejorar freeCodeCamp.org. ¡Eres genial!

Identificando la próxima version de las plataformas

Actualmente una versión de prueba beta pública está disponible en:

freecodecamp.dev

[!NOTE] El nombre de dominio es diferente a freeCodeCamp.org. Esto es intencional para evitar la indexación de los motores de búsqueda y evitar cualquier confusión en los usuarios habituales de la plataforma.

Identificando la versión actual de las plataformas

La versión actual de la plataforma siempre está disponible en freeCodeCamp.org.

El equipo de desarrollo fusiona los cambios de la rama production-staging a production-current cuando se publican los cambios. El commit más reciente debe ser lo que ves en vivo en el sitio.

Puedes identificar la versión exacta desplegada visitando los registros de compilación y despliegue disponibles en la sección de estado. Adicionalmente, también puedes contactarnos en la sala de chat de contribuyentes para obtener una confirmación.

Limitaciones Conocidas

Existen algunas limitaciones y problemas conocidos al utilizar la versión beta de la plataforma.

• Todos los datos / progreso personal en estas plataformas beta NO se guardarán ni se transferirán a producción.

  Los usuarios de la versión beta tendrán una cuenta separada a la de producción. La versión beta usa una base de datos físicamente separada de la de producción. Esto nos da la capacidad de prevenir cualquier pérdida accidental de datos o modificaciones. El equipo de desarrollo puede purgar la base de datos en esta versión beta según sea necesario.

• No hay garantías sobre el tiempo de disponibilidad y confiabilidad de las plataformas beta.

  Se espera que el despliegue sea frecuente y en iteraciones rápidas, a veces varias veces al día. Como resultado, en ocasiones habrá cierto tiempo de inactividad inesperado o alguna funcionalidad con problemas en la versión beta.

• No envíes a los usuarios habituales a este sitio como una medida para confirmar una solución

  El sitio beta es y siempre ha sido para aumentar el desarrollo y las pruebas locales, nada más. No es una promesa de lo que se avecina, sino un vistazo de lo que se está trabajando.

• La página de registro puede verse diferente a la de producción

  Usamos un entorno de pruebas para freecodecamp.dev en Auth0 y, por lo tanto, no tenemos la capacidad de configurar un dominio personalizado. Esto hace que todas las redirecciones de peticiones y la página de inicio de sesión aparezcan en un dominio predeterminado como: https://freecodecamp-dev.auth0.com/. Esto no afecta la funcionalidad y es lo más cercano a producción que podemos tener.

Reportando problemas y dejando retroalimentación

Por favor abre un nuevo reporte (issue) para discusiones e informes de errores. Puedes etiquetarlos como release: next/beta para clasificación.

Puedes enviar un correo electrónico a dev[at]freecodecamp.org si tienes alguna consulta. Como siempre, todas las vulnerabilidades de seguridad deben notificarse a security[at]freecodecamp.org en lugar del registro público o el foro.

Manual de Vuelo - Mantenimiento del Servidor

Warning

1. La guía se aplica únicamente a los miembros del personal de freeCodeCamp.
2. Estas instrucciones no deben considerarse exhaustivas, por favor ten cuidado.

Como miembro del equipo interno, es posible que se te haya dado acceso a nuestros proveedores de servicios en la nube como Azure, Digital Ocean, etc.

Estos son algunos comandos prácticos que puedes usar para trabajar en las Máquinas Virtuales (VM), por ejemplo, realizar actualizaciones de mantenimiento o realizar un mantenimiento general.

Obtener una lista de las Máquinas Virtuales

[!NOTE] Aunque es posible que ya tengas acceso SSH a las máquinas virtuales, esto solamente no te permitirá enumerar las máquinas virtuales a menos que también se te conceda acceso a los portales en la nube.

Azure

Instala el CLI de Azure az: https://docs.microsoft.com/en-us/cli/azure/install-azure-cli

(Una sola vez) Instalar en macOS con homebrew:

brew install azure-cli

(Una sola vez) Inicio de sesión:

az login

Obtener la lista de nombres de las máquinas virtuales y direcciones IP:

az vm list-ip-addresses --output table

Digital Ocean

Instalar el CLI de Digital Ocean doctl: https://github.com/digitalocean/doctl#installing-doctl

(Una sola vez) Instalar en macOS con homebrew:

brew install doctl

(Una sola vez) Inicio de sesión:

Autenticación y cambio de contexto: https://github.com/digitalocean/doctl#authenticating-with-digitalocean

doctl auth init

Obtener la lista de nombres de las máquinas virtuales y direcciones IP:

doctl compute droplet list --format "ID,Name,PublicIPv4"

Iniciar una VM (o Conjunto de Escalado de VMs)

Todo: Agregar instrucciones para iniciar VM(s)

Mantener las VMs actualizadas

Debes mantener las máquinas virtuales actualizadas mediante la realización de actualizaciones. Esto asegurará que la máquina virtual se ha parcheado con las correcciones de seguridad más recientes.

[!WARNING] Antes de ejecutar estos comandos:

• Asegúreate de que la máquina virtual se ha aprovisionado completamente y no hay en ejecución pasos posteriores a la instalación.
• Si estás actualizando paquetes en una máquina virtual que ya está sirviendo una aplicación, asegúrate de que la aplicación se ha detenido / guardado. Las actualizaciones de paquetes causarán que el ancho de banda de la red, la memoria y/o CPU tengan picos que pueden ocasionar interrupciones en aplicaciones en ejecución.

Actualizar la información de paquetes

sudo apt update

Actualizar los paquetes instalados

sudo apt upgrade -y

Limpieza de paquetes no utilizados

sudo apt autoremove -y

Trabajar en Servidores Web (Proxy)

Estamos ejecutando instancias de balanceo de cargas (Azure Load Balancer) para nuestros servidores web. Estos servidores ejecutan NGINX como proxy inverso, enrutando hacia freeCodeCamp.org el tráfico de varias aplicaciones que se ejecutan en sus propias infraestructuras.

La configuración de NGINX está disponible en este repositorio.

Primera Instalación

Aprovisionamiento de máquinas virtuales con el código

1. (Opcional) Instale NGINX y configúrelo desde el repositorio.

La configuración básica debe estar lista OOTB, mediante la configuración cloud-init. SSH y hacer los cambios según sea necesario para la(s) instancia(s) concreta(s).

Si anteriormente no utilizaste la configuración cloud-init, utiliza lo siguiente para obtener manualmente la configuración de NGINX y páginas de error:

sudo su

cd /var/www/html
git clone https://github.com/freeCodeCamp/error-pages

cd /etc/
rm -rf nginx
git clone https://github.com/freeCodeCamp/nginx-config nginx

cd /etc/nginx

2. Instale los certificados de origen de Cloudflare y la configuración de la aplicación upstream.

Obtén los certificados de origen de almacenamiento seguro de Cloudflare e instálalos en los lugares requeridos.

O

Reemplazar los certificados existentes:

# Local
scp -r username@source-server-public-ip:/etc/nginx/ssl ./
scp -pr ./ssl username@target-server-public-ip:/tmp/

# Remote
rm -rf ./ssl
mv /tmp/ssl ./

Actualizar las Configuraciones de Upstream:

vi configs/upstreams.conf

Agregar/actualizar las direcciones IP source/origin de la aplicación.

3. Configurar redes y firewalls.

Configure los firewalls de Azure y ufw según sea necesario para las direcciones de origen de entrada.

4. Agregar la VM al grupo de backend del balanceador de cargas.

Configura y agrega reglas al balanceador de carga si es necesario. Es posible que también debas agregar las VMs al grupo de backend del balanceador de carga si es necesario.

Registro de Eventos y Monitoreo

1. Comprueba el estado del servicio NGINX utilizando el siguiente comando:

sudo systemctl status nginx

2. El registro de eventos y el monitoreo de los servidores están disponibles en:

https://amplify.nginx.com

Actualización de las Instancias (Mantenimiento)

Los cambios en la configuración de nuestras instancias NGINX son mantenidos en GitHub, y se deben implementar en cada instancia de la siguiente manera:

1. SSH en la instancia y entra en modo sudo

sudo su

2. Obtén el código de configuración más reciente.

cd /etc/nginx
git fetch --all --prune
git reset --hard origin/master

3. Prueba y recarga la configuración con Signals.

nginx -t
nginx -s reload

Trabajar en Instancias del API

1. Instala las herramientas de compilación para archivos binarios de Node (node-gyp) etc.

sudo apt install build-essential

Primera Instalación

Aprovisionamiento de las VMs con el código

1. Instala Node LTS.

2. Actualiza npm, instala PM2, configura logrotate e inícialo en el arranque

   npm i -g npm
   npm i -g pm2
   pm2 install pm2-logrotate
   pm2 startup
   

3. Clona freeCodeCamp, configura las variables de entorno y las llaves.

   git clone https://github.com/freeCodeCamp/freeCodeCamp.git
   cd freeCodeCamp
   git checkout production-current # o cualquier otra rama a desplegar
   

4. Crea el archivo .env desde el almacenamiento de credenciales seguras.

5. Crea el archivo google-credentials.json desde el almacenamiento de credenciales seguras.

6. Instala las dependencias

   npm ci
   

7. Construye el servidor

   npm run ensure-env && npm run build:server
   

8. Inicia las Instancias

   cd api-server
   pm2 start production-start.js -i max --max-memory-restart 600M --name org
   

Registro de Eventos y Monitoreo

pm2 logs

pm2 monit

Actualización de las Instancias (Mantenimiento)

Los cambios en el código deben desplegarse en las instancias del API cada cierto tiempo. Esto puede ser una actualización continua o una actualización manual. La última es esencial al cambiar dependencias o al agregar variables de entorno.

[!DANGER] Los flujos automáticos no están manejando actualizaciones de dependencias en el momento. Necesitamos realizar una actualización manual antes de que se ejecute cualquier flujo de despliegue.

1. Actualizaciones Manuales - Utilizadas para actualizar dependencias, variables de entorno.

1. Detén todas las instancias

pm2 stop all

2. Instala las dependencias

npm ci

3. Construye el servidor

npm run ensure-env && npm run build:server

4. Inicia las Instancias

pm2 start all --update-env && pm2 logs

2. Actualizaciones Continuas - Utilizadas para cambios lógicos en el código.

pm2 reload all --update-env && pm2 logs

[!NOTE] Estamos manejando las actualizaciones continuas de código, lógica, mediante flujos (pipelines). No deberías tener que ejecutar estos comandos. Están aquí para documentación.

Trabajar en Instancias de Cliente

1. Instala las herramientas de compilación para archivos binarios de Node (node-gyp), etc.

sudo apt install build-essential

Primera Instalación

Aprovisionamiento de las VMs con el código

1. Instala Node LTS.

2. Actualiza npm, instala PM2, configura logrotate e inícialo en el arranque

   npm i -g npm
   npm i -g pm2
   npm install -g serve
   pm2 install pm2-logrotate
   pm2 startup
   

3. Clona la configuración del cliente, configura las variables de entorno y las claves.

   git clone https://github.com/freeCodeCamp/client-config.git client
   cd client
   

   git clone https://github.com/freeCodeCamp/client-config.git client
   cd client
   

   Inicia las instancias de marcador para el cliente web, estas se actualizarán con artefactos del flujo de Azure.

   Todo: Esta configuración debe moverse a S3 o Azure Blob Storage

   echo "serve -c ../../serve.json www -p 50505" >> client-start-primary.sh chmod +x client-start-primary.sh pm2 delete client-primary pm2 start ./client-start-primary.sh --name client-primary echo "serve -c ../../serve.json www -p 52525" >> client-start-secondary.sh chmod +x client-start-secondary.sh pm2 delete client-secondary pm2 start ./client-start-secondary.sh --name client-secondary

### Registro de Eventos y Monitoreo

```console
pm2 logs

pm2 monit

Actualización de las Instancias (Mantenimiento)

Los cambios de código deben desplegarse en las instancias de API cada cierto tiempo. Esto puede ser una actualización continua o una actualización manual. La última es esencial al cambiar dependencias o al agregar variables de entorno.

[!DANGER] Los flujos automáticos no están manejando actualizaciones de dependencias en el momento. Necesitamos realizar una actualización manual antes de que se ejecute cualquier flujo de despliegue.

1. Actualizaciones Manuales - Utilizadas para actualizar dependencias, variables de entorno.

1. Detén todas las instancias

   pm2 stop all
   

2. Instala o actualiza las dependencias

3. Inicia las Instancias

   pm2 start all --update-env && pm2 logs
   

2. Actualizaciones Continuas - Utilizadas para cambios lógicos en el código.

pm2 reload all --update-env && pm2 logs

[!NOTE] Estamos manejando las actualizaciones continuas de código, lógica, mediante flujos (pipelines). No deberías tener que ejecutar estos comandos. Están aquí para documentación.