Cómo ejecutar la app de Bookshelf para Ruby en Google Kubernetes Engine

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

Objetivos

  • Crear un clúster de GKE.
  • Crear contenedores en una aplicación de Ruby.
  • 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 podrían ser aptos para una prueba gratuita.

Antes de comenzar

  1. Accede a tu Cuenta de Google.

    Si todavía no tienes una cuenta, regístrate para obtener una nueva.

  2. Selecciona o crea un proyecto de GCP.

    Ir a la página Administrar recursos

  3. Asegúrate de tener habilitada la facturación para tu proyecto.

    Aprende a habilitar la facturación

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

    Habilita las API

  5. Realiza la instalación y la inicialización del SDK de Cloud.
  6. Instala Docker. Se usa para compilar imágenes de contenedores de manera local.
  7. Instala kubectl.
    gcloud components install kubectl

Cómo 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. Para este instructivo, se necesita un clúster con un mínimo de dos nodos, los cuales deben tener acceso a todas las API de Google.

  1. Crea el clúster. Reemplaza [YOUR_GCP_ZONE] por la zona de GCP en la que quieres alojarlo.

    gcloud container clusters create bookshelf \
        --scopes "cloud-platform,userinfo-email" \
        --num-nodes 2 \
        --enable-basic-auth \
        --issue-client-certificate \
        --enable-ip-alias \
        --zone [YOUR_GCP_ZONE]
    
  2. Verifica que tengas acceso al clúster. El siguiente comando muestra una lista de los nodos en el clúster del contenedor e indica que este está activo y en funcionamiento, 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 sobre kubectl, consulta operaciones de clúster de GKE. En general, se usa gcloud para administrar recursos en el proyecto de GCP y kubectl para administrar recursos en el 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 para satisfacer necesidades distintas.

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

Cómo clonar la app de muestra

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

  1. Clona el repositorio.

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

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

Cómo inicializar 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.

Cómo crear 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. Ingresa el siguiente comando en una ventana de la terminal:

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

    Donde:

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

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

    Cómo crear un tema y una suscripción de Cloud Pub/Sub

    La app de Bookshelf usa Cloud Pub/Sub para que una cola de solicitudes con procesamiento en segundo plano obtenga datos de la API de Google Libros a fin de agregar un libro a Bookshelf.

    1. Crea un tema de Cloud Pub/Sub nuevo mediante el uso del siguiente comando del SDK de Cloud, donde [YOUR_PUBSUB_TOPIC] representa el nombre de tu tema de Cloud Pub/Sub nuevo.

      gcloud pubsub topics create [YOUR_PUBSUB_TOPIC]
      
    2. Crea una suscripción a Cloud Pub/Sub nueva para el tema que creaste en el paso anterior, donde [YOUR_PUBSUB_SUBSCRIPTION] representa tu suscripción a Cloud Pub/Sub.

      gcloud pubsub subscriptions create --topic [YOUR_PUBSUB_TOPIC] [YOUR_PUBSUB_SUBSCRIPTION]
      

    Cómo configurar la app

    1. Copia los archivos de configuración de ejemplo para crear tus versiones personalizadas. Estos están en .gitignore y no se confirman en el control de versiones.

      cp config/database.example.yml config/database.yml
      cp config/settings.example.yml config/settings.yml
      
    2. Abre config/database.yml para editarlo y reemplaza [YOUR_PROJECT_ID] por el ID de tu proyecto.

    3. Abre el archivo config/settings.yml para editarlo y reemplaza los siguientes valores.

      • [YOUR_PROJECT_ID] por el ID del proyecto:
      • [YOUR_PUBSUB_TOPIC] por tu tema de Cloud Pub/Sub.
      • [YOUR_PUBSUB_SUBSCRIPTION] por tu suscripción a Cloud Pub/Sub.
      • [YOUR_BUCKET_NAME] por el nombre del depósito que creaste en el paso anterior.
      • [YOUR_CLIENT_ID] por tu ID de cliente de OAuth.
      • [YOUR_CLIENT_SECRET] por tu secreto de cliente de OAuth.

    Cómo crear contenedores para la app

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

    # The Google App Engine Ruby runtime is Debian Jessie with Ruby installed
    # and various os-level packages to allow installation of popular Ruby
    # gems. The source is on github at:
    #   https://github.com/GoogleCloudPlatform/ruby-docker
    FROM gcr.io/google_appengine/ruby
    
    # Install 2.4.3 if not already preinstalled by the base image
    RUN cd /rbenv/plugins/ruby-build && \
        git pull && \
        rbenv install -s 2.4.3 && \
        rbenv global 2.4.3 && \
        gem install -q --no-rdoc --no-ri bundler --version 1.16.1
    ENV RBENV_VERSION 2.4.3
    
    # Copy the application files.
    COPY . /app/
    
    # Install required gems.
    RUN bundle install --deployment && rbenv rehash
    
    # Set environment variables.
    ENV RACK_ENV=production \
        RAILS_ENV=production \
        RAILS_SERVE_STATIC_FILES=true
    
    # Run asset pipeline.
    RUN bundle exec rake assets:precompile
    
    # Reset entrypoint to override base image.
    ENTRYPOINT []
    
    # Use foreman to start processes. $FORMATION will be set in the pod
    # manifest. Formations are defined in Procfile.
    CMD bundle exec foreman start --formation "$FORMATION"
    
    La app de muestra también incluye un archivo .dockerignore, que detalla una lista de rutas de archivo 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.

    # 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.
    
    .git
    log/*
    tmp/*
    
  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 el clúster pueda acceder a ella.

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

Cómo implementar 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 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.

# 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
    tier: frontend
# 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 [YOUR_PROJECT_ID] with your project ID.
        image: gcr.io/[YOUR_PROJECT_ID]/bookshelf:latest
        # 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 FORMATION environment variable is used by foreman in the
        # Dockerfile's CMD to control which processes are started. In this
        # case, only the bookshelf process is needed.
        env:
        - name: FORMATION
          value: web=1
        # The bookshelf process listens on port 8080 for web traffic by default.
        ports:
        - name: http-server
          containerPort: 8080
  1. En bookshelf-frontend.yaml, reemplaza [YOUR_PROJECT_ID] 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 finalice la implementación, podrás ver los pods que esta creó.

    kubectl get pods
    

Cómo implementar el backend de Bookshelf

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

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

# This file configures the bookshelf worker. The worker processes
# jobs in the background.

apiVersion: extensions/v1beta1
kind: Deployment
metadata:
  name: bookshelf-worker
  labels:
    app: bookshelf
    tier: worker
# The bookshelf worker replica set ensures that at least 2
# instances of the bookshelf worker 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-worker
        # Replace [YOUR_PROJECT_ID] with your project ID.
        image: gcr.io/[YOUR_PROJECT_ID]/bookshelf:latest
        # 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 FORMATION environment variable is used by foreman in the
        # Dockerfile's CMD to control which processes are started. In this
        # case, only the worker process is needed.
        env:
        - name: FORMATION
          value: worker=1
  1. En bookshelf-worker.yaml, reemplaza [YOUR_PROJECT_ID] 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
    

Cómo crear el servicio de Bookshelf

Los servicios de Kubernetes proporcionan un punto de acceso único 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 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. Con 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.

Cómo acceder 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 para cargarla en tu 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.

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. En la GCP Console, dirígete a la página Proyectos.

    Ir a la página Proyectos

  2. En la lista de proyectos, selecciona el proyecto que deseas borrar y haz clic en Borrar.
  3. En el cuadro de diálogo, escribe el ID del proyecto y, luego, haz clic en Cerrar para borrar el proyecto.

Borra el clúster

Cuando se borra el clúster, se quitan todos los recursos de GKE y Compute Engine. Sin embargo, los recursos de Cloud Storage, Cloud Datastore y Cloud Pub/Sub que hayas usado deben quitarse de forma manual.

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

gcloud container clusters delete bookshelf --zone [YOUR_GCP_ZONE]

¿Qué sigue?

¿Te sirvió esta página? Envíanos tu opinión: