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 (tanto correcciones como funcionalidades) se integran en nuestra rama principal de desarrollo (main) a través de 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.

Normalmente, main (la rama de desarrollo por defecto) se integra diariamente en la rama prod-staging y se publica en una infraestructura 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 ciertos días a la rama prod-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 GitHub Actions 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 a la 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.

Pushing changes to Staging Applications.

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 main sea impecable y esté sincronizada con la corriente ascendente.

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

3. Comprueba que el GitHub CI este aprobado en la rama main para el flujo upstream.

   Las pruebas de integración continua deben estar en verde y en estado PASSING para la rama main. Haz clic en la marca de verificación verde junto al hash del commit si estás viendo el código de la rama main.

   Comprobando el estado en GitHub actions (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. Mueve los cambios desde main a prod-staging mediante una fusión fast-forward

   git checkout prod-staging
   git merge main
   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 prod-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.

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 prod-staging este sin cambios y sincronizada con el upstream.

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

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

   git checkout prod-current
   git merge prod-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 prod-current. Una vez que un artefacto de compilación está listo, este activará la ejecución en el flujo de publicación.

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.

Estado de la Compilación, Pruebas y Despliegue

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

Rama	Pruebas de unidad	Pruebas de integración	Compilación y Despliegue
main			-
prod-staging			Azure Pipelines
prod-current			Azure Pipelines
prod-next (experimental, próximamente)	-	-	-

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:

Aplicación	Idioma	URL
Aprende	Inglés	https://www.freecodecamp.dev
	Español	https://www.freecodecamp.dev/espanol
	Chino	https://chinese.freecodecamp.dev
Noticias	Inglés	https://www.freecodecamp.dev/news
Foro	Inglés	https://forum.freecodecamp.dev
	Chino	https://chinese.freecodecamp.dev/forum
API	-	https://api.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 confusiones para los usuarios habituales de la plataforma.

La lista anterior no es exhaustiva de todas las aplicaciones que proporcionamos. Además, no todas variantes de idiomas se despliegan al mismo tiempo en staging para conservar recursos.

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 prod-staging a prod-current cuando 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. Alternativamente, puedes enviarnos un ping en la sala de chat de colaboradores para 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 inicio de sesión puede verse diferente a la de producción

  Usamos un entorno de prueba para freeCodeCamp.dev en Auth0 y por lo tanto, no tenemos la capacidad de establecer 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 la producción que podemos conseguir.

Reportando problemas y dejando retroalimentación

Por favor abre un nuevo reporte (issue) para discusiones e informes de errores.

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.

Aquí hay algunos comandos útiles que puedes usar para trabajar en las máquinas virtuales (MV), por ejemplo, realizar actualizaciones de mantenimiento o realizar tareas de limpieza 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"

Ejecutar nuevos recursos

Estamos trabajando para crear nuestra configuración de "laC", y mientras esta en proceso, puedes usar el portal de Azure o Azure CLI para poner en marcha nuevas maquinas virtuales y otros recursos.

[!TIP] Independientemente de tu elección de ejecución de recursos, tenemos algunos archivos de configuración de inicio útiles en la nube para ayudarte a realizar parte del aprovisionamiento básico, como instalar docker o agregar claves SSH, etc.

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úrate de que la máquina virtual ha sido provisionada completamente y no hay pasos post-instalación ejecutandose.
• 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. Instala NGINX y configúralo desde el repositorio.

   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. Instala los certificados de origen de Cloudflare y la configuración de la aplicación upstream.

   Obtén los certificados de origen de Cloudflare del almacenamiento seguro e instálalos en las ubicaciones requeridas.

   O

   Mueve los certificados existentes:

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

   Actualiza las configuraciones upstream:

   vi configs/upstreams.conf
   

   Agrega/actualiza las direcciones IP fuente/origen de la aplicación.

3. Configurar redes y cortafuegos.

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

4. Agregue la MV al grupo de backend del balanceador de carga.

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

Registro de Eventos y Monitoreo

1. Compruebe 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:

   NGINX Amplify: https://amplify.nginx.com, nuestro panel de control básico actual. Estamos trabajando en métricas más granulares para una mejor visibilidad de los datos

Actualización de las Instancias (Mantenimiento)

Los cambios en la configuración de nuestras instancias NGINX son mantenidos en GitHub, y se deben desplegar 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/main

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 MVs con el código

1. Instala Node LTS.

2. Actualiza npm, instala PM2 y configura logrotate e inicio en arranque

   npm i -g npm@6
   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 prod-current # or any other branch to be deployed
   

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. Compila el servidor

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

8. Inicia las Instancias

   cd api-server
   pm2 start ./lib/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 de la API cada tanto. 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.

[!ATTENTIÓN] 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. Manual Updates - Used for updating dependencies, env variables.

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:curriculum && npm run build:server

4. Inicia las Instancias

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

2. Rolling updates - Used for logical changes to code.

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

[!NOTE] We are handling rolling updates to code, logic, via pipelines. You should not need to run these commands. These are here for documentation.

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

Provisioning VMs with the Code

1. Instala Node LTS.

2. Update npm and install PM2 and setup logrotate and startup on boot

   npm i -g npm@6
   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
   

   Start placeholder instances for the web client, these will be updated with artifacts from the Azure pipeline.

   Todo: This setup needs to move to S3 or 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

pm2 logs

pm2 monit

Actualización de las Instancias (Mantenimiento)

Code changes need to be deployed to the API instances from time to time. It can be a rolling update or a manual update. The later is essential when changing dependencies or adding environment variables.

[!ATTENTION] The automated pipelines are not handling dependencies updates at the minute. We need to do a manual update before any deployment pipeline runs.

1. Manual Updates - Used for updating dependencies, env variables.

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. Rolling updates - Used for logical changes to code.

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

[!NOTE] We are handling rolling updates to code, logic, via pipelines. You should not need to run these commands. These are here for documentation.

Work on Chat Servers

Our chat servers are available with a HA configuration recommended in Rocket.Chat docs. The docker-compose file for this is available here.

We provision redundant NGINX instances which are themselves load balanced (Azure Load Balancer) in front of the Rocket.Chat cluster. The NGINX configuration file are available here.

First Install

Provisioning VMs with the Code

NGINX Cluster:

1. Install NGINX and configure from repository.

   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/chat-nginx-config nginx
   
   cd /etc/nginx
   

2. Install Cloudflare origin certificates and upstream application config.

   Get the Cloudflare origin certificates from the secure storage and install at required locations.

   OR

   Move over existing certificates:

   # 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 ./
   

   Update Upstream Configurations:

   vi configs/upstreams.conf
   

   Add/update the source/origin application IP addresses.

3. Setup networking and firewalls.

   Configure Azure firewalls and ufw as needed for ingress origin addresses.

4. Add the VM to the load balancer backend pool.

   Configure and add rules to load balancer if needed. You may also need to add the VMs to load balancer backend pool if needed.

Docker Cluster:

1. Install Docker and configure from the repository

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

2. Configure the required environment variables and instance IP addresses.

3. Run rocket-chat server

   docker-compose config
   docker-compose up -d
   

Logging and Monitoring

1. Check status for NGINX service using the below command:

   sudo systemctl status nginx
   

2. Check status for running docker instances with:

   docker ps
   

Updating Instances (Maintenance)

NGINX Cluster:

Config changes to our NGINX instances are maintained on GitHub, these should be deployed on each instance like so:

1. SSH into the instance and enter sudo

   sudo su
   

2. Get the latest config code.

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

3. Test and reload the config with Signals.

   nginx -t
   nginx -s reload
   

Docker Cluster:

1. SSH into the instance and navigate to the chat config path

   cd ~/chat
   

2. Get the latest config code.

   git fetch --all --prune
   git reset --hard origin/main
   

3. Pull down the latest docker image for Rocket.Chat

   docker-compose pull
   

4. Update the running instances

   docker-compose up -d
   

5. Validate the instances are up

   docker ps
   

6. Cleanup extraneous resources

   docker system prune --volumes
   

   Output:

   WARNING! This will remove:
     - all stopped containers
     - all networks not used by at least one container
     - all volumes not used by at least one container
     - all dangling images
     - all dangling build cache
   
   Are you sure you want to continue? [y/N] y
   

   Select yes (y) to remove everything that is not in use. This will remove all stopped containers, all networks and volumes not used by at least one container, and all dangling images and build caches.

Updating Node.js versions on VMs

List currently installed node & npm versions

nvm -v
node -v
npm -v

nvm ls

Install the latest Node.js LTS, and reinstall any global packages

nvm install 'lts/*' --reinstall-packages-from=default

Verify installed packages

npm ls -g --depth=0

Alias the default Node.js version to the current LTS

nvm alias default lts/*

(Optional) Uninstall old versions

nvm uninstall <version>

[!WARNING] If using PM2 for processes you would also need to bring up the applications and save the process list for automatic recovery on restarts.

Quick commands for PM2 to list, resurrect saved processes, etc.

pm2 ls

pm2 resurrect

pm2 save

pm2 logs

[!ATTENTION] For client applications, the shell script can't be resurrected between Node.js versions with pm2 resurrect. Deploy processes from scratch instead. This should become nicer when we move to a docker based setup.

Installing and Updating Azure Pipeline Agents

See: https://docs.microsoft.com/en-us/azure/devops/pipelines/agents/v2-linux?view=azure-devops and follow the instructions to stop, remove and reinstall agents. Broadly you can follow the steps listed here.

You would need a PAT, that you can grab from here: https://dev.azure.com/freeCodeCamp-org/_usersSettings/tokens

Installing agents on Deployment targets

Navigate to Azure Devops and register the agent from scratch in the requisite deployment groups.

[!NOTE] You should run the scripts in the home directory, and make sure no other azagent directory exists.

Updating agents

Currently updating agents requires them to be removed and reconfigured. This is required for them to correctly pick up PATH values and other system environment variables. We need to do this for instance updating Node.js on our deployment target VMs.

1. Navigate and check status of the service

   cd ~/azagent
   sudo ./svc.sh status
   

2. Stop the service

   sudo ./svc.sh stop
   

3. Uninstall the service

   sudo ./svc.sh uninstall
   

4. Remove the agent from the pipeline pool

   ./config.sh remove
   

5. Remove the config files

   cd ~
   rm -rf ~/azagent
   

Once You have completed the steps above, you can repeat the same steps as installing the agent.

Flight Manual - Email Blast

We use a CLI tool to send out the weekly newsletter. To spin this up and begin the process:

1. Sign in to DigitalOcean, and spin up new droplets under the Sendgrid project. Use the Ubuntu Sendgrid snapshot with the most recent date. This comes pre-loaded with the CLI tool and the script to fetch emails from the database. With the current volume, three droplets are sufficient to send the emails in a timely manner.

2. Set up the script to fetch the email list.

   cd /home/freecodecamp/scripts/emails
   cp sample.env .env
   

   You will need to replace the placeholder values in the .env file with your credentials.

3. Run the script.

   node get-emails.js emails.csv
   

   This will save the email list in an emails.csv file.

4. Break the emails down into multiple files, depending on the number of droplets you need. This is easiest to do by using scp to pull the email list locally and using your preferred text editor to split them into multiple files. Each file will need the email,unsubscribeId header.

5. Switch to the CLI directory with cd /home/sendgrid-email-blast and configure the tool per the documentation.

6. Run the tool to send the emails, following the usage documentation.

7. When the email blast is complete, verify that no emails have failed before destroying the droplets.