Cómo ejecutar Bookshelf en Python en Kubernetes Engine

Este instructivo muestra cómo ejecutar la app de Bookshelf·en Python en Google Kubernetes Engine (GKE). Sigue este instructivo para organizar en contenedores y también implementar una aplicación web de Python existente en GKE. Se recomienda que revises la documentación de la app de Bookshelf como parte del instructivo del entorno estándar de App Engine.

Objetivos

  • Crear un clúster de GKE.
  • Organizar una aplicación de Python en contenedores.
  • Crear un frontend replicado para la app de Bookshelf.
  • Crear un backend replicado para la app de Bookshelf.
  • Crear un servicio con balanceo de cargas para dirigir el tráfico HTTP al frontend de Bookshelf.

Costos

Este instructivo utiliza componentes facturables de Google Cloud Platform (GCP), incluidos:

  • GKE
  • Compute Engine
  • Cloud Storage
  • Cloud Datastore
  • Cloud Pub/Sub

Usa la calculadora de precios para generar una estimación de los costos según el uso previsto. Los usuarios nuevos de GCP pueden optar a una prueba gratuita.

Antes de comenzar

  1. Sign in to your Google Account.

    If you don't already have one, sign up for a new account.

  2. Select or create a GCP project.

    Go to the Project selector page

  3. Comprueba que la facturación esté habilitada en tu proyecto.

    Descubre cómo puedes habilitar la facturación

  4. Habilita las Cloud Datastore, Kubernetes Engine, Cloud Storage, Cloud Pub/Sub y Google+ API necesarias.

    Habilita las API

  5. Install and initialize the Cloud SDK.
  6. Instala Docker. Docker se usa para compilar imágenes de contenedores de manera local.
  7. Instala kubectl.
    gcloud components install kubectl

Crear un clúster de GKE

Un clúster de GKE es un conjunto administrado de máquinas virtuales de Compute Engine que operan como un clúster de GKE único. Este instructivo necesita un clúster con un mínimo de dos nodos, y estos nodos necesitan acceder a todas las API de Google.

  1. Crea el clúster. Reemplaza [YOUR_GCP_ZONE] con la zona de GCP donde quieres alojar tu clúster.

    gcloud container clusters create bookshelf \
        --scopes "cloud-platform" \
        --num-nodes 2 \
        --enable-basic-auth \
        --issue-client-certificate \
        --enable-ip-alias \
        --zone [YOUR_GCP_ZONE]
    
  2. Verifica que tienes acceso al clúster. Cuando ejecutas el siguiente comando, aparece una lista de los nodos en el clúster de tu contenedor y, además, indica que el clúster está activo y funcionando, y que puedes acceder a él.

    kubectl get nodes
    

Usa el comando kubectl para crear recursos en un clúster de GKE. Para obtener más información acerca de kubectl, consulta operaciones del clúster de GKE. En general, usa gcloud para administrar recursos en tu proyecto de GCP y kubectl para administrar recursos en tu clúster de GKE. Un proyecto único puede tener varios clústeres, lo que facilita tener clústeres creados a partir de diferentes tipos de máquinas a fin de satisfacer necesidades distintas.

Cuando creas un clúster con gcloud, automáticamente se configura una autenticación para kubectl. Los clústeres creados con Google Cloud Platform Console pueden configurar la autenticación a través del comando gcloud container clusters get-credentials.

Clona la app de muestra

La app de muestra está disponible en GitHub en GoogleCloudPlatform/getting-started-python.

  1. Clona el repositorio.

    git clone https://github.com/GoogleCloudPlatform/getting-started-python.git
    
  2. Navega al directorio de muestra.

    cd getting-started-python/optional-kubernetes-engine
    

Inicializa Cloud Datastore

La app de Bookshelf utiliza Cloud Datastore para almacenar los libros. Para inicializar Cloud Datastore en tu proyecto por primera vez, completa los siguientes pasos:

  1. En GCP Console, abre Cloud Datastore.

    Ir a Cloud Datastore

  2. Selecciona una región para tu almacén de datos y haz clic en Continuar hasta que llegues a la página Crear una entidad. Cierra la ventana, ya que la app de Bookshelf está lista para crear entidades en Cloud Datastore.

Crea un depósito de Cloud Storage

La app de Bookshelf utiliza Cloud Storage para almacenar archivos de imagen.

Las instrucciones siguientes muestran cómo crear un depósito de Cloud Storage. Los depósitos son los contenedores básicos que conservan tus datos en Cloud Storage.

  1. En una ventana de terminal, ingresa el siguiente comando:

    gsutil mb gs://[YOUR-BUCKET-NAME]

    Leyenda:

    • [YOUR-BUCKET-NAME] representa el nombre de tu depósito de Cloud Storage.
  2. Para ver las imágenes subidas en la app de Bookshelf, configura la lista de control de acceso (LCA) predeterminada del depósito en public-read.

    gsutil defacl set public-read gs://[YOUR-BUCKET-NAME]

    Configura la app

    1. Abre config.py para editarlo.
    2. Actualiza [PROJECT_ID] con el ID del proyecto.
    3. Actualiza [CLOUD_STORAGE_BUCKET] con el nombre del depósito que creaste en el paso anterior.

    No cambies los otros valores de la configuración.

    Crea contenedores para la app

    La app de muestra incluye un Dockerfile que se usa para crear la imagen de Docker de la app. Esta imagen de Docker ejecuta la aplicación en GKE.

    # The Google App Engine python runtime is Debian Jessie with Python installed
    # and various os-level packages to allow installation of popular Python
    # libraries. The source is on github at:
    #   https://github.com/GoogleCloudPlatform/python-docker
    FROM gcr.io/google-appengine/python
    
    # Create a virtualenv for the application dependencies.
    # If you want to use Python 2, add the -p python2.7 flag.
    RUN virtualenv -p python3.4 /env
    
    # Set virtualenv environment variables. This is equivalent to running
    # source /env/bin/activate. This ensures the application is executed within
    # the context of the virtualenv and will have access to its dependencies.
    ENV VIRTUAL_ENV /env
    ENV PATH /env/bin:$PATH
    
    # Install dependencies.
    ADD requirements.txt /app/requirements.txt
    RUN pip install -r /app/requirements.txt
    
    # Add application code.
    ADD . /app
    
    # Instead of using gunicorn directly, we'll use Honcho. Honcho is a python port
    # of the Foreman process manager. $PROCESSES is set in the pod manifest
    # to control which processes Honcho will start.
    CMD honcho start -f /app/procfile $PROCESSES
    
    La app de muestra también incluye un archivo .dockerignore que muestra una lista de rutas de archivos que no se incluyen en el contenedor de Docker resultante. Por lo general, esto incluye artefactos de compilación y también instalaciones de dependencias locales.

    __pycache__
    *.pyc
    *.pyo
    *.pyd
    .Python
    env
    pip-log.txt
    pip-delete-this-directory.txt
    .tox
    .coverage
    .coverage.*
    .cache
    nosetests.xml
    coverage.xml
    *,cover
    *.log
    .git
    
  3. Compila la imagen de Docker de la aplicación.

    docker build -t gcr.io/[YOUR_PROJECT_ID]/bookshelf
    
  4. Envía la imagen a Google Container Registry para que tu clúster pueda acceder a ella.

    gcloud docker -- push gcr.io/[YOUR_PROJECT_ID]/bookshelf
    

Implementa el frontend de Bookshelf

La app de Bookshelf tiene un servidor de frontend que controla las solicitudes web y un trabajador de backend que procesa los libros y agrega información adicional.

Los recursos del clúster que se necesitan para ejecutar el frontend se definen en bookshelf-frontend.yaml. Estos recursos se describen como una implementación de Kubernetes. Las implementaciones facilitan la creación y la actualización de un conjunto de réplicas y sus pods asociados.

# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License

# This file configures the bookshelf application frontend. The frontend serves
# public web traffic.

apiVersion: extensions/v1beta1
kind: Deployment
metadata:
  name: bookshelf-frontend
  labels:
    app: bookshelf
# The bookshelf frontend replica set ensures that at least 3
# instances of the bookshelf app are running on the cluster.
# For more info about Pods see:
#   https://cloud.google.com/kubernetes-engine/docs/pods/
spec:
  replicas: 3
  template:
    metadata:
      labels:
        app: bookshelf
        tier: frontend
    spec:
      containers:
      - name: bookshelf-app
        # Replace [GCLOUD_PROJECT] with your project ID or use `make template`.
        image: gcr.io/[GCLOUD_PROJECT]/bookshelf
        # This setting makes nodes pull the docker image every time before
        # starting the pod. This is useful when debugging, but should be turned
        # off in production.
        imagePullPolicy: Always
        # The PROCESSES environment variable is used by Honcho in the
        # Dockerfile's CMD to control which processes are started. In this
        # case, only the bookshelf process is needed.
        env:
        - name: PROCESSES
          value: bookshelf
        # The bookshelf process listens on port 8080 for web traffic by default.
        ports:
        - name: http-server
          containerPort: 8080
  1. En bookshelf-frontend.yaml, reemplaza [GCLOUD_PROJECT] por el ID del proyecto.

  2. Implementa los recursos en el clúster.

    kubectl create -f bookshelf-frontend.yaml
    
  3. Haz un seguimiento del estado de la implementación.

    kubectl get deployments
    

    La implementación estará completa cuando tenga la misma cantidad de pods disponibles y de pods deseados. Si tienes problemas con la implementación, bórrala y empieza de nuevo.

    kubectl delete deployments bookshelf-frontend
    
  4. Cuando la implementación finalice, podrás ver los pods que esta creó.

    kubectl get pods
    

Implementa el backend de Bookshelf

El backend de Bookshelf se implementa del mismo modo que el frontend.

# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License

# This file configures the bookshelf task worker. The worker is responsible
# for processing book requests and updating book information.

apiVersion: extensions/v1beta1
kind: Deployment
metadata:
  name: bookshelf-worker
  labels:
    app: bookshelf
# The bookshelf worker replica set ensures that at least 2 instances of the
# bookshelf worker pod are running on the cluster.
# For more info about Pods see:
#   https://cloud.google.com/kubernetes-engine/docs/pods/
spec:
  replicas: 2
  template:
    metadata:
      labels:
        app: bookshelf
        tier: worker
    spec:
      containers:
      - name: bookshelf-app
        # Replace [GCLOUD_PROJECT] with your project ID or use `make template`.
        image: gcr.io/[GCLOUD_PROJECT]/bookshelf
        # This setting makes nodes pull the docker image every time before
        # starting the pod. This is useful when debugging, but should be turned
        # off in production.
        imagePullPolicy: Always
        # The PROCESSES environment variable is used by Honcho in the
        # Dockerfile's CMD to control which processes are started. In this
        # case, only the worker process is needed.
        env:
        - name: PROCESSES
          value: worker
  1. En bookshelf-worker.yaml, reemplaza [GCLOUD_PROJECT] por el ID del proyecto.

  2. Implementa los recursos en el clúster.

    kubectl create -f bookshelf-worker.yaml
    
  3. Verifica que los pods se estén ejecutando.

    kubectl get pods
    

Crea el servicio de Bookshelf

Los servicios de Kubernetes proporcionan un solo punto de acceso a un conjunto de pods. Si bien es posible acceder a un solo pod, los pods son efímeros, por lo que te recomendamos dirigirte a un conjunto de pods con un solo extremo. En la app de Bookshelf, el servicio de Bookshelf te permite acceder a los pods de frontend de Bookshelf desde una dirección IP única. Este servicio se define en bookshelf-service.yaml.

# Copyright 2016 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License

# The bookshelf service provides a load-balancing proxy over the bookshelf
# frontend pods. By specifying the type as a 'LoadBalancer', Kubernetes Engine
# will create an external HTTP load balancer.
# For more information about Services see:
#   https://cloud.google.com/kubernetes-engine/docs/services/
# For more information about external HTTP load balancing see:
#   https://cloud.google.com/kubernetes-engine/docs/load-balancer
apiVersion: v1
kind: Service
metadata:
  name: bookshelf-frontend
  labels:
    app: bookshelf
    tier: frontend
spec:
  type: LoadBalancer
  ports:
  - port: 80
    targetPort: http-server
  selector:
    app: bookshelf
    tier: frontend

Ten en cuenta que los pods y el servicio que usa los pods son independientes. Kubernetes usa etiquetas para seleccionar los pods a los que se dirige un servicio. Gracias a las etiquetas, puedes tener un servicio que se dirija a los pods desde conjuntos de réplicas diferentes y tener varios servicios que apunten a un pod en particular.

  1. Crea el servicio de Bookshelf.

    kubectl create -f bookshelf-service.yaml
    
  2. Obtén la dirección IP externa del servicio.

    kubectl describe service bookshelf
    

    Ten en cuenta que la dirección IP puede tardar hasta 60 segundos en asignarse. La dirección IP externa aparecerá en LoadBalancer Ingress.

Accede a la app de Bookshelf

Ya implementaste todos los recursos necesarios para ejecutar la app de Bookshelf en GKE. Usa la dirección IP externa del paso anterior a fin de cargar la app en el navegador web y crear libros. Si implementaste el trabajador, los libros se actualizan automáticamente con la información de la API de Google Libros.

Cómo realizar una limpieza

Sigue estos pasos para evitar que se apliquen cargos a tu cuenta de Google Cloud Platform por los recursos que usaste en este instructivo:

Borra el proyecto

La manera más fácil de eliminar la facturación es borrar el proyecto que creaste para el instructivo.

Para borrar el proyecto, haz lo siguiente:

  1. In the GCP Console, go to the Projects page.

    Go to the Projects page

  2. In the project list, select the project you want to delete and click Delete .
  3. In the dialog, type the project ID, and then click Shut down to delete the project.

Borra el clúster

Borrar el clúster quita todos los recursos de GKE y Compute Engine, pero tendrás que eliminar todos los recursos en Cloud Storage, Cloud Datastore y Cloud Pub/Sub de forma manual.

Usa el siguiente comando para borrar el clúster. Reemplaza [YOUR_GCP_ZONE] con la zona que usaste cuando creaste el clúster.

gcloud container clusters delete bookshelf --zone [YOUR_GCP_ZONE]

Pasos siguientes

¿Te ha resultado útil esta página? Enviar comentarios:

Enviar comentarios sobre...