Entorno de desarrollo

Entorno de desarrollo

Acerca de este codelab

subjectÚltima actualización: mar 22, 2023
account_circleEscrito por Andrey Shakirov

1. Descripción general

En este lab, se muestran las funciones y capacidades diseñadas para optimizar el flujo de trabajo de desarrollo de los ingenieros de software encargados de desarrollar aplicaciones de Python en un entorno alojado en contenedores. El desarrollo típico de contenedores requiere que el usuario comprenda sus detalles y el proceso de compilación de estos. Además, por lo general, los desarrolladores tienen que interrumpir el flujo y salir del IDE para probar y depurar sus aplicaciones en entornos remotos. Con las herramientas y tecnologías mencionadas en este instructivo, los desarrolladores pueden trabajar de manera eficaz con aplicaciones alojadas en contenedores sin salir de su IDE.

58a4cdd3ed7a123a.png

¿Qué es Cloud Workstations?

Cloud Workstations proporciona entornos de desarrollo administrados en Google Cloud con seguridad integrada y entornos de desarrollo preconfigurados pero personalizables. Accede a Cloud Workstations a través de un IDE basado en el navegador, desde varios editores de código locales (como los IDE de VSCode o JetBrains, como IntelliJ IDEA Ultimate y PyCharm Professional), o bien a través de SSH.

Cloud Workstations usa los siguientes recursos:

  • Los administradores crean clústeres de estaciones de trabajo
  • En cada clúster de estación de trabajo, los administradores crean una o más configuraciones de estaciones de trabajo que actúan como plantillas para ellas.
  • Los desarrolladores pueden crear estaciones de trabajo que definan los entornos de desarrollo que proporcionan un IDE de Cloud, herramientas de lenguaje, bibliotecas y mucho más.

Cloud Workstations permite a los administradores de TI y seguridad aprovisionar, escalar, administrar y proteger fácilmente sus entornos de desarrollo, y permite que los desarrolladores accedan a entornos de desarrollo con parámetros de configuración coherentes y herramientas personalizables.

Cloud Workstations ayuda a desplazar la seguridad a la izquierda, ya que mejora la postura de seguridad de tus entornos de desarrollo de aplicaciones. Tiene funciones de seguridad como los Controles del servicio de VPC, la entrada o salida privadas, la actualización de imágenes forzada y las políticas de acceso de Identity and Access Management.

¿Qué es Cloud Code?

Cloud Code proporciona compatibilidad con IDE durante todo el ciclo de desarrollo de las aplicaciones de Kubernetes y Cloud Run, desde la creación y personalización de una aplicación nueva desde plantillas de muestra hasta la ejecución de tu aplicación terminada. Cloud Code te asiste en el camino con muestras listas para ejecutar, fragmentos de configuración listos para usar y una experiencia de depuración personalizada, lo que facilita mucho el desarrollo con Kubernetes y Cloud Run.

Estas son algunas de las funciones de Cloud Code:

  • Compila y ejecuta aplicaciones de forma continua
  • Asistencia para la depuración de tu aplicación de Kubernetes en desarrollo
  • Transmisión y visualización de registros

Obtén más información sobre otras funciones de Cloud Code.

Qué aprenderás

En este lab, aprenderás métodos para desarrollar con contenedores en GCP, incluidos los siguientes:

  • Revisa Cloud Workstations
  • Iniciar estación de trabajo
  • Revisa Cloud Code
  • Cómo depurar en Kubernetes

2. Configuración y requisitos

Cómo configurar el entorno a tu propio ritmo

  1. Accede a Google Cloud Console y crea un proyecto nuevo o reutiliza uno existente. Si aún no tienes una cuenta de Gmail o de Google Workspace, debes crear una.

b35bf95b8bf3d5d8.png

a99b7ace416376c4.png

bd84a6d3004737c5.png

  • El Nombre del proyecto es el nombre visible de los participantes de este proyecto. Es una cadena de caracteres que no se utiliza en las APIs de Google. Puedes actualizarla en cualquier momento.
  • El ID del proyecto es único en todos los proyectos de Google Cloud y es inmutable (no se puede cambiar después de configurarlo). La consola de Cloud genera automáticamente una cadena única. por lo general, no te importa qué es. En la mayoría de los codelabs, deberás hacer referencia al ID del proyecto (por lo general, se identifica como PROJECT_ID). Si no te gusta el ID generado, puedes generar otro aleatorio. También puedes probar el tuyo propio y ver si está disponible. No se puede cambiar después de este paso y se mantendrá mientras dure el proyecto.
  • Para tu información, hay un tercer valor, un número de proyecto que usan algunas APIs. Obtén más información sobre estos tres valores en la documentación.
  1. A continuación, deberás habilitar la facturación en la consola de Cloud para usar las APIs o los recursos de Cloud. Ejecutar este codelab no debería costar mucho, tal vez nada. Para cerrar recursos y evitar que se te facture más allá de este instructivo, puedes borrar los recursos que creaste o borrar todo el proyecto. Los usuarios nuevos de Google Cloud son aptos para participar en el programa Prueba gratuita de USD 300.

Configuración del entorno

Configura tu ID y número de proyecto en Cloud Shell. Guárdalas como variables PROJECT_ID y PROJECT_ID.

export PROJECT_ID=$(gcloud config get-value project)
export PROJECT_NUMBER=$(gcloud projects describe $PROJECT_ID \
   
--format='value(projectNumber)')

En este lab, implementarás código en GKE. También usarás las estaciones de trabajo de Cloud como IDE.

La siguiente secuencia de comandos de configuración prepara esta infraestructura por ti.

  1. Descarga la secuencia de comandos de configuración y haz que sea ejecutable.
wget https://raw.githubusercontent.com/GoogleCloudPlatform/container-developer-workshop/main/labs/python/setup_with_cw.sh
chmod +x setup_with_cw.sh
  1. Abre el archivo setup_with_cw.sh y edita los valores de las contraseñas que actualmente están configuradas como CHANGEME
  2. Ejecuta la secuencia de comandos de configuración para crear un clúster de GKE que usarás en este lab. El proceso de configuración tardará unos 20 minutos.
./setup_with_cw.sh &
  1. Abre Cloud Workstations en la consola de Cloud. Espera a que el clúster tenga el estado READY antes de continuar con los siguientes pasos.
  2. Si se desconectó tu sesión de Cloud Shell, haz clic en “Volver a conectar” y, luego, ejecuta el comando gcloud cli para configurar el ID del proyecto. Reemplaza el ID del proyecto de muestra que aparece a continuación por el ID de tu proyecto de Qwiklabs antes de ejecutar el comando.
gcloud config set project qwiklabs-gcp-project-id
  1. Descarga y ejecuta la siguiente secuencia de comandos en la terminal para crear la configuración de Cloud Workstations.
wget https://raw.githubusercontent.com/GoogleCloudPlatform/container-developer-workshop/main/labs/python/workstation_config_setup.sh
chmod +x workstation_config_setup.sh
./workstation_config_setup.sh

Clúster y configuración de Cloud Workstations

Abre Cloud Workstations en la consola de Cloud. Verifica que el clúster tenga el estado READY.

305e1a3d63ac7ff6.png

Verifica el estado de los parámetros de configuración existentes.

2e23c2e9983d1ccf.png

Crea una estación de trabajo nueva.

a53adeeac81a78c8.png

Cambia el nombre a my-workstation y selecciona la configuración existente: codeoss-python.

f052cd47701ec774.png

Iniciar estación de trabajo

  1. Inicia y, luego, inicia la estación de trabajo. La estación de trabajo tardará unos minutos en iniciarse.

682f8a307032cba3.png

  1. Permite las cookies de terceros haciendo clic en el ícono de la barra de direcciones. 1b8923e2943f9bc4.png

fcf9405b6957b7d7.png

  1. Haz clic en "¿El sitio no funciona?".

36a84c0e2e3b85b.png

  1. Haz clic en "Permitir cookies".

2259694328628fba.png

  1. Una vez que se inicie la estación de trabajo, verás que aparece Code OSS IDE.

Haz clic en "Marcar como hecho". En la página Primeros pasos, el IDE de la estación de trabajo

94874fba9b74cc22.png

3. Descripción general de Cloud Code

Revisa las diferentes secciones disponibles en Cloud Code.

  • Desarrollo de Kubernetes. Obtén un entorno de desarrollo y depuración de Kubernetes completamente integrado dentro de tu IDE. Crea y administra clústeres directamente desde el IDE.
  • Depura las aplicaciones en ejecución. Depura el código en tus IDE con Cloud Code para VS Code y Cloud Code para IntelliJ aprovechando las funciones de depuración de IDE integradas.
  • Explora las implementaciones. Visualiza los metadatos y recursos subyacentes para tus clústeres de Kubernetes y servicios de Cloud Run. Puedes recuperar una descripción, ver registros, administrar Secrets o conseguir una terminal directamente en un Pod.
  • Simplifica el desarrollo local de Kubernetes. Cloud Code para IDE usa herramientas populares como Skaffold, Jib y kubectl para proporcionar comentarios continuos sobre tu código en tiempo real.

e4e89eea9ff45dff.png

Accede a Google Cloud

  1. Haz clic en el ícono de Cloud Code y selecciona “Acceder a Google Cloud”:

1769afd39be372ff.png

  1. Haz clic en "Continuar para acceder".

923bb1c8f63160f9.png

  1. Verifica el resultado en la terminal y abre el vínculo:

517fdd579c34aa21.png

  1. Accede con tus credenciales de estudiantes de Qwiklabs.

db99b345f7a8e72c.png

  1. Selecciona "Permitir":

a5376553c430ac84.png

  1. Copia el código de verificación y regresa a la pestaña Workstation.

6719421277b92eac.png

  1. Pega el código de verificación y presiona Intro.

e9847cfe3fa8a2ce.png

Haz clic en "Permitir" si ves este mensaje, de modo que puedas copiar y pegar en la estación de trabajo.

58149777e5cc350a.png

4. Crea una aplicación de inicio de Python nueva

En esta sección, crearás una nueva aplicación de Python.

  1. Abre una terminal nueva.

c31d48f2e4938c38.png

  1. Crea un directorio nuevo y ábrelo como lugar de trabajo.
mkdir music-service && cd music-service

code-oss-cloud-workstations -r --folder-uri="$PWD"
  1. Crea un archivo llamado requirements.txt y copia el siguiente contenido en él

827e8389170bd900.png

Flask
gunicorn
ptvsd==4.3.2
  1. Crea un archivo llamado app.py y pega en él el siguiente código.
import os
from flask import Flask, request, jsonify

app = Flask(__name__)

@app.route("/")
def hello_world():
   
message="Hello, World!"
   
return message

if __name__ == '__main__':
   
server_port = os.environ.get('PORT', '8080')
   
app.run(debug=False, port=server_port, host='0.0.0.0')

  1. Crea un archivo llamado Dockerfile y pega lo siguiente en él
FROM python:3.8
ARG FLASK_DEBUG=0
ENV FLASK_DEBUG=$FLASK_DEBUG
ENV FLASK_APP=app.py
WORKDIR /app
COPY requirements.txt .
RUN pip install --trusted-host pypi.python.org -r requirements.txt
COPY . .
ENTRYPOINT ["python3", "-m", "flask", "run", "--port=8080", "--host=0.0.0.0"]

Nota: FLASK_DEBUG=1 te permite volver a cargar automáticamente los cambios de código a una app de flask de Python. Este Dockerfile te permite pasar este valor como un argumento de compilación.

Generar manifiestos

En la terminal, ejecuta el siguiente comando para generar una skaffold.yaml y una deployment.yaml predeterminadas.

  1. Inicializa Skaffold con el siguiente comando
skaffold init --generate-manifests

Cuando se te indique, usa las flechas para mover el cursor y la barra espaciadora para seleccionar las opciones.

Elige:

  • 8080 para el puerto
  • y para guardar la configuración

Actualiza los parámetros de configuración de Skaffold

  • Cambia el nombre predeterminado de la aplicación
  • Abrir skaffold.yaml
  • Selecciona el nombre de la imagen establecido actualmente como dockerfile-image
  • Haz clic con el botón derecho y elige Cambiar todos los casos.
  • Escribe el nombre nuevo como python-app.
  • Edita la sección de compilación para
  • agrega docker.buildArgs para pasar FLASK_DEBUG=1
  • La configuración de sincronización para cargar los cambios en los archivos *.py del IDE al contenedor en ejecución

Después de las modificaciones, la sección de compilación del archivo skaffold.yaml se verá de la siguiente manera:

build:
 
artifacts:
 
- image: python-app
   
docker:
     
buildArgs:
       
FLASK_DEBUG: "1"
     
dockerfile: Dockerfile
   
sync:
     
infer:
     
- '**/*.py'

Modificar el archivo de configuración de Kubernetes

  1. Cómo cambiar el nombre predeterminado
  • Abrir archivo deployment.yaml
  • Selecciona el nombre de la imagen establecido actualmente como dockerfile-image
  • Haz clic con el botón derecho y elige Cambiar todos los casos.
  • Escribe el nombre nuevo como python-app.

5. Explicación del proceso de desarrollo

Con la lógica empresarial agregada, ahora puedes implementar y probar tu aplicación. En la siguiente sección, se mostrará el uso del complemento de Cloud Code. Entre otras cosas, este complemento se integra con Skaffold para optimizar tu proceso de desarrollo. Cuando sigas estos pasos para implementar en GKE, Cloud Code y Skaffold compilarán automáticamente tu imagen de contenedor, la enviarán a Container Registry y, luego, implementarán la aplicación your en GKE. Esto sucede detrás de escena, abstrae los detalles del flujo del desarrollador.

Agregar clúster de Kubernetes

  1. Agrega un clúster

62a3b97bdbb427e5.png

  1. Selecciona Google Kubernetes Engine:

9577de423568bbaa.png

  1. Selecciona un proyecto.

c5202fcbeebcd41c.png

  1. Selecciona “python-cluster” que se creó en la configuración inicial.

80c8c2556655.png

  1. El clúster ahora aparece en la lista de clústeres de Kubernetes en Cloud Code. Navega y explora el clúster desde aquí.

7e5f50662d4eea3c.png

Implementar en Kubernetes

  1. En el panel ubicado en la parte inferior del editor de Cloud Shell, selecciona Cloud Code pago.

d99a88992e15fea9.png

  1. En el panel que aparece en la parte superior, selecciona Ejecutar en Kubernetes.

Si se te solicita, selecciona Sí para usar el contexto actual de Kubernetes.

bfd65e9df6d4a6cb.png

Este comando inicia una compilación del código fuente y, luego, ejecuta las pruebas. La compilación y las pruebas tardarán unos minutos en ejecutarse. Estas pruebas incluyen pruebas de unidades y un paso de validación que comprueba las reglas establecidas para el entorno de implementación. Este paso de validación ya está configurado y garantiza que recibas advertencias de problemas de implementación, incluso mientras sigues trabajando en tu entorno de desarrollo.

  1. La primera vez que ejecutes el comando, aparecerá un mensaje en la parte superior de la pantalla en el que se te preguntará si quieres conocer el contexto de Kubernetes actual. Selecciona “Yes” aceptar y usar el contexto actual.
  2. A continuación, se mostrará un mensaje en el que se te preguntará qué registro de contenedores usar. Presiona Intro para aceptar el valor predeterminado proporcionado
  3. Selecciona la "Salida". en el panel inferior para ver el progreso y las notificaciones. En el menú desplegable, selecciona “Kubernetes: Run/Debug”

9c87ccbf5d06f50a.png

  1. Selecciona “Kubernetes: Run/Debug - Detail”. En el menú desplegable de canales que se encuentra a la derecha para ver detalles adicionales y registros que se transmiten en vivo desde los contenedores

804abc8833ffd571.png

Cuando finalice la compilación y las pruebas, los registros de la pestaña Salida mostrarán la URL http://localhost:8080 en el campo “Kubernetes: Run/Debug” vista.

  1. En la terminal de Cloud Code, coloca el cursor sobre la primera URL del resultado (http://localhost:8080) y, luego, en la sugerencia de herramientas que aparece, selecciona Open Web Preview.
  2. Se abrirá una nueva pestaña del navegador y se mostrará el siguiente mensaje: Hello, World!

Recarga en caliente

  1. Abre el archivo app.py.
  2. Cambiar el mensaje de saludo a Hello from Python

Observa inmediatamente que en la ventana Output, en la vista Kubernetes: Run/Debug, el observador sincroniza los archivos actualizados con el contenedor en Kubernetes.

Update initiated
Build started for artifact python-app
Build completed for artifact python-app

Deploy started
Deploy completed

Status check started
Resource pod/python-app-6f646ffcbb-tn7qd status updated to In Progress
Resource deployment/python-app status updated to In Progress
Resource deployment/python-app status completed successfully
Status check succeeded
...
  1. Si cambias a la vista Kubernetes: Run/Debug - Detailed, notarás que reconoce los cambios en el archivo y, luego, compila y vuelve a implementar la app.
files modified: [app.py]
Syncing 1 files for gcr.io/veer-pylab-01/python-app:3c04f58-dirty@sha256:a42ca7250851c2f2570ff05209f108c5491d13d2b453bb9608c7b4af511109bd
Copying files:map[app.py:[/app/app.py]]togcr.io/veer-pylab-01/python-app:3c04f58-dirty@sha256:a42ca7250851c2f2570ff05209f108c5491d13d2b453bb9608c7b4af511109bd
Watching for changes...
[python-app] * Detected change in '/app/app.py', reloading
[python-app] * Restarting with stat
[python-app] * Debugger is active!
[python-app] * Debugger PIN: 744-729-662
  1. Actualiza la pestaña del navegador donde viste los resultados anteriores para verlos actualizados.

Depuración

  1. Ve a la vista de depuración y detén el subproceso actual 647213126d7a4c7b.png. Si te lo solicita, puedes optar por realizar una limpieza después de cada ejecución.
  2. 70d6bd947d04d1e6.png
  3. Haz clic en Cloud Code en el menú inferior y selecciona Debug on Kubernetes para ejecutar la aplicación en modo debug.

b9465c6825caf685.png

  • En la vista Kubernetes Run/Debug - Detailed de la ventana Output, observa que Skaffold implementará esta aplicación en modo de depuración.
  1. La primera vez que se ejecute, un mensaje te preguntará dónde está la fuente dentro del contenedor. Este valor está relacionado con los directorios en el Dockerfile.

Presiona Intro para aceptar

fccc866f32b5ed86.png

La aplicación tardará algunos minutos en compilarse e implementarse. Si la sesión de depuración está desconectada, vuelve a ejecutar los pasos para “Depurar en Kubernetes”. de las "Sesiones de desarrollo" sección.

  1. Cuando se complete el proceso. Verás que adjuntas un depurador y la pestaña Salida dice: Attached debugger to container "python-app-8476f4bbc-h6dsl" successfully. y aparece la URL http://localhost:8080.
Port forwarding pod/python-app-8bd64cf8b-cskfl in namespace default, remote port 5678 -> http://127.0.0.1:5678
  1. La barra de estado inferior cambia de color de azul a naranja, lo que indica que está en modo de depuración.

b2abd61a129ed76.png

  1. En la vista Kubernetes Run/Debug, observa que se inicia un contenedor Debuggable.
**************URLs*****************
Forwarded URL from service python-app: http://localhost:8080
Debuggable container started pod/python-app-8bd64cf8b-cskfl:python-app (default)
Update succeeded
***********************************

Utiliza puntos de interrupción

  1. Abre el archivo app.py.
  2. Busca la sentencia que dice return message.
  3. Para agregar un punto de interrupción a esa línea, haz clic en el espacio en blanco a la izquierda del número de línea. Se mostrará un indicador rojo para indicar que se estableció el punto de interrupción
  4. Vuelve a cargar el navegador y observa que el depurador detiene el proceso en el punto de interrupción y te permite investigar las variables y el estado de la aplicación que se ejecuta de forma remota en GKE.
  5. Haz clic en la sección VARIABLES.
  6. Haz clic en Locales y encontrarás la variable "message".
  7. Haz doble clic en el nombre de variable "message" En la ventana emergente, cambia el valor a uno diferente, como "Greetings from Python".
  8. Haz clic en el botón Continuar en el panel de control de depuración 607c33934f8d6b39.png
  9. Revisa la respuesta en tu navegador, que ahora muestra el valor actualizado que acabas de ingresar.
  10. Cómo detener la "depuración" si presionas el botón de detención 647213126d7a4c7b.png y, para quitar el punto de interrupción, vuelves a hacer clic en él.

6. Limpieza

¡Felicitaciones! En este lab, creaste una nueva aplicación de Python desde cero y la configuraste para que funcione de manera eficaz con contenedores. Luego, implementaste y depuraste tu aplicación en un clúster de GKE remoto con el mismo flujo de desarrollador que se encuentra en las pilas de aplicaciones tradicionales.

Sigue estos pasos para realizar una limpieza después de completar el lab:

  1. Borra los archivos utilizados en el lab
cd ~ && rm -rf ~/music-service
  1. Borra el proyecto para quitar toda la infraestructura y los recursos relacionados.

Última actualización: 22 de marzo de 2023