Cloud SQL for PostgreSQL mit Rails 7 in App Engine verwenden

Beginnen Sie mit der Entwicklung von Ruby on Rails-Anwendungen, die in der flexiblen Umgebung von App Engine ausgeführt werden. Die von Ihnen erstellten Anwendungen werden auf derselben Infrastruktur ausgeführt, auf der alle Google-Produkte basieren. So können Sie sicher sein, dass sie für alle Nutzer skaliert werden können, unabhängig davon, ob es sich um wenige oder Millionen von ihnen handelt.

In dieser Anleitung wird davon ausgegangen, dass Sie mit der Rails-Webentwicklung vertraut sind. In dieser Anleitung wird Ihnen die Einrichtung von Cloud SQL für PostgreSQL mit einer neuen Rails-Anwendung erklärt. Sie können diese Anleitung auch als Referenz zum Konfigurieren vorhandener Rails-Anwendungen für die Verwendung von Cloud SQL for PostgreSQL verwenden.

Für diese Anleitung ist Ruby 3.0 oder höher erforderlich.

Hinweis

Melden Sie sich in Ihrem Google Cloud -Konto an. Wenn Sie mit Google Cloudnoch nicht vertraut sind, erstellen Sie ein Konto, um die Leistungsfähigkeit unserer Produkte in der Praxis sehen und bewerten zu können. Neukunden erhalten außerdem ein Guthaben von 300 $, um Arbeitslasten auszuführen, zu testen und bereitzustellen.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud SQL Admin API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

Installieren Sie die Google Cloud CLI.

Wenn Sie einen externen Identitätsanbieter (IdP) verwenden, müssen Sie sich zuerst mit Ihrer föderierten Identität in der gcloud CLI anmelden.

Führen Sie den folgenden Befehl aus, um die gcloud CLI zu initialisieren:

gcloud init

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud SQL Admin API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

Installieren Sie die Google Cloud CLI.

Wenn Sie einen externen Identitätsanbieter (IdP) verwenden, müssen Sie sich zuerst mit Ihrer föderierten Identität in der gcloud CLI anmelden.

Führen Sie den folgenden Befehl aus, um die gcloud CLI zu initialisieren:

gcloud init

Cloud SQL für PostgreSQL-Instanz vorbereiten

Richten Sie für diese Anleitung eine Cloud SQL für PostgreSQL-Instanz ein.

1. Erstellen Sie eine PostgreSQL-Instanz. In dieser Anleitung lautet der Name der Instanz rails-cloudsql-instance.

2. Erstellen Sie eine Datenbank in der Instanz. In dieser Anleitung lautet der Name der Produktionsdatenbank cat_list_production.

3. Legen Sie das Passwort für den Postgres-Nutzer für die Instanz fest.

Lokale Umgebung für Rails einrichten

So richten Sie eine lokale Umgebung für diese Anleitung ein:

1. Installieren Sie Ruby 3.0 oder höher.

2. Installieren Sie das Gem Rails 7.

3. Installieren Sie das Gem Bundler.

Hinweis: Alternativ können Sie auch Cloud Shell verwenden. Diese enthält Ruby, Rails, Bundler und die Google Cloud CLI ist bereits installiert.

Weitere Informationen zur Installation von Rails und dessen Abhängigkeiten finden Sie im offiziellen Leitfaden Erste Schritte mit Rails.

Nachdem Sie alle vorbereitenden Schritte durchgeführt haben, können Sie eine Rails-Anwendung mit Cloud SQL für PostgreSQL erstellen und bereitstellen. In den folgenden Abschnitten wird gezeigt, wie Sie eine Anwendung konfigurieren, mit Cloud SQL für PostgreSQL verbinden und bereitstellen.

Neue App zum Auflisten von Katzen erstellen

1. Führen Sie den Befehl rails new aus, um eine neue Rails-Anwendung zu erstellen. Diese Anwendung speichert eine Liste von Katzen in Cloud SQL für PostgreSQL.

   rails new cat_sample_app
   

2. Wechseln Sie in das Verzeichnis mit der erstellten Rails-Anwendung:

   cd cat_sample_app
   

Anwendung lokal ausführen

So führen Sie die neue Rails-Anwendung lokal auf Ihrem Computer aus:

1. Starten Sie einen lokalen Webserver:

   bundle exec bin/rails server
   

2. Rufen Sie in einem Browser http://localhost:3000/ auf.

   In der Beispiel-App wird das Rails-Logo mit den Rails- und Ruby-Versionen angezeigt.

Hinweis :Drücken Sie im Terminalfenster Ctrl+C, um den Webserver zu beenden.

Gerüst für eine Liste von Katzen generieren

Generieren Sie ein Gerüst für eine Ressource namens Cat, die zum Erstellen einer Liste von Katzen mit ihrem Namen und ihrem Alter verwendet wird.

1. Generieren Sie das Gerüst:

   bundle exec rails generate scaffold Cat name:string age:integer
   

   Der Befehl generiert ein Modell, einen Controller und Ansichten für die Ressource Cat.

   invoke  active_record
   create    db/migrate/20230922063608_create_cats.rb
   create    app/models/cat.rb
   invoke    test_unit
   create      test/models/cat_test.rb
   create      test/fixtures/cats.yml
   invoke  resource_route
   route    resources :cats
   invoke  scaffold_controller
   create    app/controllers/cats_controller.rb
   invoke    erb
   create      app/views/cats
   create      app/views/cats/index.html.erb
   create      app/views/cats/edit.html.erb
   create      app/views/cats/show.html.erb
   create      app/views/cats/new.html.erb
   create      app/views/cats/_form.html.erb
   create      app/views/cats/_cat.html.erb
   invoke    resource_route
   invoke    test_unit
   create      test/controllers/cats_controller_test.rb
   create      test/system/cats_test.rb
   invoke    helper
   create      app/helpers/cats_helper.rb
   invoke      test_unit
   invoke    jbuilder
   create      app/views/cats/index.json.jbuilder
   create      app/views/cats/show.json.jbuilder
   create      app/views/cats/_cat.json.jbuilder
   

2. Öffnen Sie die Datei config/routes.rb, um die folgenden generierten Inhalte zu sehen.

   Rails.application.routes.draw do
     resources :cats
     get 'cats/index'
     # For details on the DSL available within this file, see http://guides.rubyonrails.org/routing.html
   
   end

3. Fügen Sie der Datei root 'cats#index' hinzu.

   Rails.application.routes.draw do
     resources :cats
     get 'cats/index'
   
     # For details on the DSL available within this file, see http://guides.rubyonrails.org/routing.html
     root 'cats#index'
   end

4. Speichern Sie die Datei und schließen Sie sie.

5. Testen Sie die Rails-App wie zuvor beschrieben.

Cloud SQL für PostgreSQL mit App Engine verwenden

Cloud SQL for PostgreSQL ist ein vollständig verwalteter Datenbankdienst, mit dem Sie Ihre relationalen PostgreSQL-Datenbanken inGoogle Cloudeinrichten, verwalten und verwalten können. Sie können Cloud SQL in einer Rails-Anwendung wie jede andere relationale Datenbank verwenden.

Cloud SQL für PostgreSQL einrichten

So legen Sie die Verwendung von Cloud SQL mit Ihrer Rails-Anwendung in der Produktion fest:

1. Fügen Sie der Datei Gemfile die Gems pg und appengine hinzu:

   bundle add pg
   bundle add appengine
   

   Die Rails Gemfile enthält die folgenden zusätzlichen gem-Einträge:

   gem "appengine", "~> 0.6"
   gem "pg", "~> 1.2"

   Hinweis: Der appengine-Gem stellt eine Rake-Aufgabe zum Ausführen von Datenbankmigrationen in der Produktion bereit.

2. Öffnen Sie die Datei config/database.yml, um die Rails-Anwendung für die Verbindung zu Cloud SQL zu konfigurieren. Es werden die folgenden Datenbankeinstellungen für SQLite angezeigt:

   # SQLite version 3.x
   #   gem install sqlite3
   #
   #   Ensure the SQLite 3 gem is defined in your Gemfile
   #   gem 'sqlite3'
   #
   default: &default
     adapter: sqlite3
     pool: 5
     timeout: 5000
   
   development:
     <<: *default
     database: db/development.sqlite3
   
   # Warning: The database defined as "test" will be erased and
   # re-generated from your development database when you run "rake".
   # Do not set this db to the same as development or production.
   test:
     <<: *default
     database: db/test.sqlite3
   
   production:
     <<: *default
     database: db/production.sqlite3

3. Konfigurieren Sie den Cloud SQL-Instanzverbindungsnamen für die App Engine-Produktionsumgebung.

   1. Rufen Sie den Instanzverbindungsnamen ab:

      gcloud sql instances describe rails-cloudsql-instance
      

   2. Kopieren Sie den Wert neben connectionName.

4. Ändern Sie die Konfiguration der Produktionsdatenbank database.yml wie folgt:

   production:
     adapter: postgresql
     encoding: unicode
     pool: 5
     timeout: 5000
     username: "[YOUR_POSTGRES_USERNAME]"
     password: "[YOUR_POSTGRES_PASSWORD]"
     database: "cat_list_production"
     host:   "/cloudsql/[YOUR_INSTANCE_CONNECTION_NAME]"

   Wobei:

   • [YOUR_POSTGRES_USERNAME] ist der Nutzername der Cloud SQL for PostgreSQL-Instanz.
   • [YOUR_POSTGRES_PASSWORD] ist das Passwort Ihrer Cloud SQL for PostgreSQL-Instanz.
   • [YOUR_INSTANCE_CONNECTION_NAME] ist der im vorherigen Schritt kopierte Instanzverbindungsname

Die Rails-App ist nun so eingerichtet, dass sie Cloud SQL bei der Bereitstellung in der flexiblen App Engine-Umgebung verwendet.

App in der flexiblen App Engine-Umgebung bereitstellen

Die flexible App Engine-Umgebung verwendet eine Datei mit dem Namen app.yaml zur Konfiguration der Anwendungsbereitstellung. Wenn diese Datei nicht vorhanden ist, versucht die gcloud CLI, die Konfiguration selbst zu bestimmen. Sie sollten jedoch die Datei definieren, um die erforderlichen Konfigurationseinstellungen für den geheimen Schlüssel für Rails und Cloud SQL bereitzustellen.

Erstellen Sie eine neue Datei mit dem Namen app.yaml im Stammverzeichnis der Rails-Anwendung und fügen Sie Folgendes hinzu, um die Beispielanwendung für die Bereitstellung in App Engine zu konfigurieren:

entrypoint: bundle exec rackup --port $PORT
env: flex
runtime: ruby

Konfigurieren Sie den geheimen Rails-Schlüssel in der Datei app.yaml

Wenn eine Rails-Anwendung in der production - Umgebung bereitgestellt wird, legen Sie die Umgebungsvariable SECRET_KEY_BASE mit einem geheimen Schlüssel fest, um die Sitzungsdaten der Nutzer zu schützen. Diese Umgebungsvariable wird aus der Datei config/secrets.yml in Ihrer Rails-Anwendung gelesen.

1. Erzeugen Sie einen neuen geheimen Schlüssel.

   bundle exec bin/rails secret
   

2. Kopieren Sie den generierten geheimen Schlüssel.

3. .ffnen Sie die zuvor erstellte Datei app.yaml und fügen Sie den Abschnitt env_variables hinzu. env_variables definiert Umgebungsvariablen in der flexiblen App Engine-Umgebung. Die Datei app.yaml sollte ähnlich wie im folgenden Beispiel aussehen, wobei [SECRET_KEY] durch Ihren geheimen Schlüssel ersetzt wird.

   entrypoint: bundle exec rackup --port $PORT
   env: flex
   runtime: ruby
   
   env_variables:
     SECRET_KEY_BASE: [SECRET_KEY]

Konfigurieren Sie die Cloud SQL-Instanz in der Datei app.yaml

Konfigurieren Sie als Nächstes die flexible App Engine-Umgebung für die Verwendung einer bestimmten Cloud SQL-Instanz, indem Sie den Verbindungsnamen der Cloud SQL-Instanz in der app.yaml - Konfigurationsdatei angeben.

1. Öffnen Sie die Datei app.yaml und fügen Sie einen neuen Abschnitt mit dem Namen beta_settings hinzu.

2. Definieren Sie einen verschachtelten Parameter cloud_sql_instances mit dem Instanzverbindungsnamen als Wert.

   Hinweis: Mit diesem Befehl können Sie den Namen der Cloud SQL-Instanzverbindung abrufen, indem Sie gcloud sql instances describe rails-cloudsql-instance ausführen.

   app.yaml sollte in etwa so aussehen:

   entrypoint: bundle exec rackup --port $PORT
   env: flex
   runtime: ruby
   
   env_variables:
     SECRET_KEY_BASE: [SECRET_KEY]
   
   beta_settings:
     cloud_sql_instances: [YOUR_INSTANCE_CONNECTION_NAME]

App in einer flexiblen App Engine-Umgebung erstellen

Wenn Sie zum ersten Mal eine Anwendung bereitstellen, müssen Sie eine Anwendung in der flexiblen App Engine-Umgebung erstellen und die Region auswählen, in der Sie die Rails-Anwendung ausführen möchten.

1. Erstellen Sie eine App Engine-Anwendung:

   gcloud app create
   

2. Wählen Sie eine Region aus, die die flexible App Engine-Umgebung für Ruby-Anwendungen unterstützt. Weitere Informationen finden Sie unter Regionen und Zonen.

Neue Version bereitstellen

Als Nächstes stellen Sie mit dem folgenden Befehl eine neue Version der Rails-Anwendung bereit, die in der Datei app.yaml beschrieben wird, ohne den Traffic von der aktuellen Standardbereitstellungsversion weiterzuleiten:

gcloud app deploy --no-promote

Es kann einige Minuten dauern, bis die Bereitstellung abgeschlossen ist. Warten Sie, bis die erfolgreiche Bereitstellung angezeigt wird. Bereitgestellte Versionen werden in der App Engine-Versionsliste aufgeführt.

Warnung:Die älteren Versionen der Anwendung und die zugehörigen VM-Instanzen werden beibehalten. Beachten Sie, dass all diese Anwendungsversionen und VM-Instanzen kostenpflichtige Ressourcen sind.

Wenn Sie nach dem Bereitstellen der neuen Version versuchen, auf diese neue Version zuzugreifen, wird die folgende Fehlermeldung angezeigt, da die Datenbank nicht migriert wurde.

Erteilen Sie die erforderliche Berechtigung für das Gem appengine

Als Nächstes gewähren Sie Zugriff auf das Cloudbuild-Dienstkonto, um mit dem Gem appengine Migrationen von Produktionsdatenbanken auszuführen.

1. Listen Sie die verfügbaren Projekte auf:

   gcloud projects list
   

2. Suchen Sie in der Ausgabe das Projekt, das Sie zur Bereitstellung der Anwendung verwenden möchten, und kopieren Sie die Projektnummer.

3. Fügen Sie der Projekt-IAM-Richtlinie ein neues Mitglied für die Rolle roles/editor hinzu, um Datenbankmigrationen auszuführen. Ersetzen Sie PROJECT_ID durch die ID Ihres Projekts in Google Cloud und PROJECT_NUMBER durch die Projektnummer, die Sie im vorherigen Schritt kopiert haben.

   gcloud projects add-iam-policy-binding PROJECT_ID \
     --member=serviceAccount:[e-mail] \
     --role=roles/editor
   

Rails-Datenbank migrieren

Mit Rails-Datenbankmigrationen kann das Schema Ihrer Datenbank ohne SQL-Syntax direkt aktualisiert werden. Als Nächstes migrieren Sie Ihre cat_list_production - Datenbank.

Das Gem appengine stellt die Rake-Aufgabe appengine:exec bereit, um einen Befehl für die neueste bereitgestellte Version Ihrer Anwendung in der flexiblen App Engine-Produktionsumgebung auszuführen.

1. Migrieren Sie die Cloud SQL für PostgreSQL-Datenbank cat_list_production in der Produktion:

   bundle exec rake appengine:exec -- bundle exec rake db:migrate
   

   Die Ausgabe sollte etwa so aussehen:

   ---------- EXECUTE COMMAND ----------
   bundle exec rake db:migrate
   Debuggee gcp:787021104993:8dae9032f8b02004 successfully registered
   == 20230922063608 CreateCats: migrating =======================================
   -- create_table(:cats)
      -> 0.0219s
   == 20230922063608 CreateCats: migrated (0.0220s) ==============================
   
   ---------- CLEANUP ----------
   

   Hinweis :Wenn beim Ausführen von Datenbankmigrationen ein Berechtigungsfehler auftritt, prüfen Sie, ob [e-mail] die Rolle roles/editor hat.

2. Geben Sie zur Überprüfung der Datenbankmigration die folgende URL in Ihren Browser ein:

   https://VERSION_ID-dot-PROJECT_ID.REGION_ID.r.appspot.com
   

   Dabei gilt:

   • VERSION_ID: Die neue Version der Anwendung, die Sie zuvor bereitgestellt haben. Verwenden Sie gcloud app versions list, um eine Liste der Versionen abzurufen. Der letzte Eintrag der Standarddienstversion ist die aktuelle Bereitstellung.
   • PROJECT_ID: Ihre Google Cloud Projekt-ID
   • REGION_ID: Code, der Ihrer Anwendung von App Engine zugewiesen wird

Bei einer erfolgreichen Bereitstellung wird Folgendes angezeigt:

Traffic zu neuer Version migrieren

Abschließend können Sie mithilfe des folgenden Befehls den Traffic zur neu erstellten Version umleiten:

gcloud app services set-traffic default --splits VERSION=1

Die neue Version der Anwendung kann jetzt über die folgende URL aufgerufen werden:

https://PROJECT_ID.REGION_ID.r.appspot.com

App Engine-Logs aufrufen

Wenn Sie nach der Erstellung der Rails-Anwendung die Logs aufrufen möchten, Sie können die Anwendungslogs mit dem Log-Explorer in der Google Cloud Console lesen.

Weitere Informationen zum Lesen von Logs mit der gcloud CLI

Ressourcen bereinigen

Nachdem Sie die Anleitung abgeschlossen haben, können Sie die erstellten Ressourcen bereinigen, damit sie keine Kontingente mehr nutzen und keine Gebühren mehr anfallen. In den folgenden Abschnitten erfahren Sie, wie Sie diese Ressourcen löschen oder deaktivieren.

Projekt löschen

Am einfachsten vermeiden Sie weitere Kosten, wenn Sie das zum Ausführen der Anleitung erstellte Projekt löschen.

So löschen Sie das Projekt:

Achtung: Das Löschen von Projekten hat folgende Auswirkungen:

• Alle Inhalte des Projekts werden gelöscht. Wenn Sie für die Aufgaben in diesem Dokument ein bereits bestehendes Projekt verwendet haben und dieses löschen, werden auch alle anderen im Rahmen des Projekts erstellten Daten gelöscht.
• Benutzerdefinierte Projekt-IDs gehen verloren. Beim Erstellen dieses Projekts haben Sie möglicherweise eine benutzerdefinierte Projekt-ID erstellt, die Sie weiterhin verwenden möchten. Damit die URLs, die die Projekt-ID nutzen, zum Beispiel eine appspot.com-URL, erhalten bleiben, sollten Sie ausgewählte Ressourcen innerhalb des Projekts löschen, anstatt das gesamte Projekt.

Wenn Sie mehrere Architekturen, Anleitungen und Kurzanleitungen durcharbeiten möchten, können Sie die Überschreitung von Projektkontingenten verhindern, indem Sie Projekte wiederverwenden.

1. Wechseln Sie in der Google Cloud -Console zur Seite Ressourcen verwalten.

   Zur Seite „Ressourcen verwalten“

2. Wählen Sie in der Projektliste das Projekt aus, das Sie löschen möchten, und klicken Sie dann auf Löschen.
3. Geben Sie im Dialogfeld die Projekt-ID ein und klicken Sie auf Shut down (Beenden), um das Projekt zu löschen.

App Engine-Version löschen

So löschen Sie eine Anwendungsversion:

1. Rufen Sie in der Google Cloud Console die Seite Versionen für App Engine auf.

   Zur Seite "Versionen"

2. Klicken Sie auf das Kästchen für die nicht standardmäßige Anwendungsversion, die Sie löschen möchten.
   Hinweis:Die einzige Möglichkeit, die Standardversion Ihrer App Engine-Anwendung zu löschen, besteht im Löschen Ihres Projekts. Sie können jedoch die Standardversion in der Google Cloud Console anhalten. Diese Aktion fährt alle mit der Version verbundenen Instanzen herunter. Sie können diese Instanzen später neu starten.

   In der Standardumgebung der App Engine können Sie die Standardversion nur dann anhalten, wenn Ihre Anwendung eine manuelle oder einfache Skalierung aufweist.

3. Klicken Sie zum Löschen der Anwendungsversion auf Löschen.

Cloud SQL-Instanz löschen

So löschen Sie eine Cloud SQL-Instanz:

1. Rufen Sie in der Google Cloud Console die Seite Instanzen auf.

   Zur Seite „VM-Instanzen“

2. Klicken Sie auf den Namen der SQL-Instanz, die Sie löschen möchten.
3. Klicken Sie zum Löschen der Instanz auf Löschen und folgen Sie der Anleitung.

Nächste Schritte

• Ruby Bookshelf-Beispielanwendung in der flexiblen App Engine-Umgebung ausführen

• Ruby Bookshelf-Beispielanwendung in Compute Engine ausführen

• Ruby Bookshelf-Beispielanwendung in Google Kubernetes Engine ausführen