Wprowadzenie do Cloud Run z użyciem Pythona

1. Wprowadzenie

Cloud Run to zarządzana platforma obliczeniowa, która umożliwia uruchamianie bezstanowych kontenerów wywoływanych przez żądania HTTP. Jest ona oparta na projekcie open source Knative, co umożliwia przenoszenie obciążeń między platformami. Cloud Run jest rozwiązaniem bezserwerowym, które nie wymaga zarządzania infrastrukturą, dzięki czemu możesz skupić się na tym, co najważniejsze, czyli tworzeniu świetnych aplikacji.

Celem tego samouczka jest utworzenie prostej aplikacji internetowej i wdrożenie jej w Cloud Run.

2. Konfiguracja i wymagania

Samodzielne konfigurowanie środowiska

1. Zaloguj się w konsoli Google Cloud i utwórz nowy projekt lub użyj istniejącego. Jeśli nie masz jeszcze konta Gmail ani Google Workspace, musisz je utworzyć.

• Nazwa projektu to wyświetlana nazwa uczestników tego projektu. Jest to ciąg znaków, który nie jest używany przez interfejsy API Google. Zawsze możesz ją zaktualizować.
• Identyfikator projektu jest unikalny we wszystkich projektach Google Cloud i nie można go zmienić po ustawieniu. Konsola Cloud automatycznie generuje unikalny ciąg znaków. Zwykle nie musisz się tym przejmować. W większości ćwiczeń z programowania musisz odwoływać się do identyfikatora projektu (zwykle oznaczanego jako PROJECT_ID). Jeśli wygenerowany identyfikator Ci się nie podoba, możesz wygenerować inny losowy identyfikator. Możesz też spróbować własnej nazwy i sprawdzić, czy jest dostępna. Po tym kroku nie można go zmienić i pozostaje on taki przez cały czas trwania projektu.
• Warto wiedzieć, że istnieje też trzecia wartość, numer projektu, której używają niektóre interfejsy API. Więcej informacji o tych 3 wartościach znajdziesz w dokumentacji.

Ostrzeżenie: identyfikator projektu jest unikalny globalnie i po jego wybraniu nie może być używany przez nikogo innego. Jesteś jedynym użytkownikiem tego identyfikatora. Nawet po usunięciu projektu nie można ponownie użyć jego identyfikatora.

Uwaga: jeśli używasz konta Gmail, możesz pozostawić domyślną lokalizację ustawioną na Brak organizacji. Jeśli używasz konta Google Workspace, wybierz lokalizację odpowiednią dla Twojej organizacji.

2. Następnie musisz włączyć płatności w konsoli Cloud, aby korzystać z zasobów i interfejsów API Google Cloud. Wykonanie tego laboratorium nie będzie kosztować dużo, a może nawet nic. Aby wyłączyć zasoby i uniknąć naliczania opłat po zakończeniu tego samouczka, możesz usunąć utworzone zasoby lub projekt. Nowi użytkownicy Google Cloud mogą skorzystać z bezpłatnego okresu próbnego, w którym mają do dyspozycji środki w wysokości 300 USD.

Uruchamianie Cloud Shell

Z Google Cloud można korzystać zdalnie na laptopie, ale w tym samouczku będziesz używać Cloud Shell, czyli środowiska wiersza poleceń działającego w chmurze.

Aktywowanie Cloud Shell

1. W konsoli Cloud kliknij Aktywuj Cloud Shell .

Jeśli uruchamiasz Cloud Shell po raz pierwszy, zobaczysz ekran pośredni z opisem tego środowiska. Jeśli pojawił się ekran pośredni, kliknij Dalej.

Uzyskanie dostępu do środowiska Cloud Shell i połączenie się z nim powinno zająć tylko kilka chwil.

Ta maszyna wirtualna zawiera wszystkie potrzebne narzędzia dla programistów. Zawiera również stały katalog domowy o pojemności 5 GB i działa w Google Cloud, co znacznie zwiększa wydajność sieci i usprawnia proces uwierzytelniania. Większość zadań w tym module, a być może wszystkie, możesz wykonać w przeglądarce.

Po połączeniu z Cloud Shell zobaczysz, że uwierzytelnianie zostało już przeprowadzone, a projekt jest już ustawiony na Twój identyfikator projektu.

2. Aby potwierdzić, że uwierzytelnianie zostało przeprowadzone, uruchom w Cloud Shell to polecenie:

gcloud auth list

Wynik polecenia

 Credentialed Accounts
ACTIVE  ACCOUNT
*       <my_account>@<my_domain.com>

To set the active account, run:
    $ gcloud config set account `ACCOUNT`

Uwaga: narzędzie wiersza poleceń gcloud to zaawansowane i ujednolicone narzędzie wiersza poleceń w Google Cloud. Jest już zainstalowane w Cloud Shell. Zauważysz, że obsługuje on uzupełnianie za pomocą klawisza Tab. Przy pierwszym uruchomieniu polecenia może pojawić się prośba o uwierzytelnienie. Więcej informacji znajdziesz w omówieniu narzędzia wiersza poleceń gcloud.

3. Aby potwierdzić, że polecenie gcloud zna Twój projekt, uruchom w Cloud Shell to polecenie:

gcloud config list project

Wynik polecenia

[core]
project = <PROJECT_ID>

Jeśli nie, możesz go ustawić za pomocą tego polecenia:

gcloud config set project <PROJECT_ID>

Wynik polecenia

Updated property [core/project].

Uwaga: jeśli wykonujesz ten samouczek poza Cloud Shell, postępuj zgodnie z instrukcjami w artykule Konfigurowanie domyślnego uwierzytelniania aplikacji.

3. Włączanie interfejsów API

W Cloud Shell włącz interfejsy Artifact Registry API, Cloud Build API i Cloud Run API:

gcloud services enable \
  artifactregistry.googleapis.com \
  cloudbuild.googleapis.com \
  run.googleapis.com

Wyświetli się komunikat o powodzeniu podobny do tego:

Operation "operations/..." finished successfully.

Aby wdrożyć aplikację, Cloud Run współpracuje z ekosystemem kontenerów:

• Cloud Build automatycznie kompiluje obraz kontenera z kodu źródłowego i przenosi go do Artifact Registry.
• Artifact Registry zarządza obrazem kontenera.

Możesz teraz zacząć pracę i napisać aplikację…

4. Tworzenie aplikacji

W tym kroku utworzysz prostą aplikację w Pythonie opartą na Flask, która będzie odpowiadać na żądania HTTP.

Katalog roboczy

Za pomocą Cloud Shell utwórz katalog roboczy o nazwie helloworld-python i przejdź do niego:

mkdir ~/helloworld-python
cd ~/helloworld-python

main.py

Utwórz plik o nazwie main.py:

touch main.py

Edytuj plik za pomocą preferowanego edytora wiersza poleceń (nano, vim lub emacs) albo kliknij przycisk edytora Cloud Shell:

Aby bezpośrednio edytować plik za pomocą edytora Cloud Shell, użyj tego polecenia:

cloudshell edit main.py

main.py

from flask import Flask, request

app = Flask(__name__)


@app.get("/")
def hello():
    """Return a friendly HTTP greeting."""
    who = request.args.get("who", default="World")
    return f"Hello {who}!\n"


if __name__ == "__main__":
    # Development only: run "python main.py" and open http://localhost:8080
    # When deploying to Cloud Run, a production-grade WSGI HTTP server,
    # such as Gunicorn, will serve the app.
    app.run(host="localhost", port=8080, debug=True)

Ten kod tworzy podstawową usługę internetową, która odpowiada na żądania HTTP GET przyjazną wiadomością.

requirements.txt

Dodaj plik o nazwie requirements.txt, aby zdefiniować zależności:

touch requirements.txt

Aby bezpośrednio edytować plik za pomocą edytora Cloud Shell, użyj tego polecenia:

cloudshell edit requirements.txt

requirements.txt

# https://pypi.org/project/flask
Flask==3.0.2

# https://pypi.org/project/gunicorn
gunicorn==21.2.0

Procfile

Na koniec dodaj plik o nazwie Procfile, aby określić sposób udostępniania aplikacji:

touch Procfile

Aby bezpośrednio edytować plik za pomocą edytora Cloud Shell, użyj tego polecenia:

cloudshell edit Procfile

Procfile

web: gunicorn --bind :$PORT --workers 1 --threads 8 --timeout 0 main:app

Sprawdź, czy wszystkie pliki znajdują się w katalogu roboczym:

ls

Powinny się na niej znaleźć te pliki:

main.py  Procfile  requirements.txt

Wiele innych języków jest udokumentowanych, aby zacząć korzystać z Cloud Run. Instrukcje dotyczące skryptów w językach takich jak Go, Node.js, Java, C#, C++, PHP i Ruby oraz skryptów powłoki znajdziesz tutaj: https://cloud.google.com/run/docs/quickstarts/build-and-deploy

Aplikacja jest gotowa do wdrożenia, ale najpierw ją przetestujmy...

5. Testowanie aplikacji

Aby przetestować aplikację, utwórz środowisko wirtualne:

virtualenv venv

Aktywuj środowisko wirtualne:

source venv/bin/activate

Zainstaluj zależności:

pip install -r requirements.txt

Powinna pojawić się wiadomość z potwierdzeniem podobna do tej:

...
Successfully installed Flask ... gunicorn ...

Uruchom aplikację:

python main.py

Z logów wynika, że jesteś w trybie deweloperskim:

 * Serving Flask app 'main'
 * Debug mode: on
   WARNING: This is a development server.
   Do not use it in a production deployment.
   Use a production WSGI server instead.
 * Running on http://localhost:8080
   Press CTRL+C to quit
...

W oknie Cloud Shell kliknij ikonę Web Preview i wybierz Preview on port 8080:

Powinno się otworzyć okno przeglądarki z komunikatem Hello World!.

Możesz też otworzyć kolejną sesję Cloud Shell (nową kartę terminala), klikając ikonę + i wysyłając żądanie internetowe do aplikacji działającej lokalnie:

curl localhost:8080

Powinna pojawić się taka odpowiedź:

Hello World!

Gdy skończysz, wróć do głównej sesji Cloud Shell i zatrzymaj polecenie python main.py za pomocą klawisza CTRL+C.

Zamknij środowisko wirtualne:

deactivate

Na koniec usuń katalog środowiska wirtualnego:

rm -r venv/

Aplikacja działa zgodnie z oczekiwaniami: wdróżmy ją…

6. Wdrożenie w Cloud Run

Cloud Run działa regionalnie, co oznacza, że infrastruktura, która uruchamia usługi Cloud Run, znajduje się w określonym regionie i jest zarządzana przez Google w taki sposób, aby była redundantnie dostępna we wszystkich strefach w tym regionie. Określ region, w którym chcesz wdrożyć usługę, np.:

REGION="europe-west9"

Listę obecnie obsługiwanych regionów znajdziesz w artykule Lokalizacje Cloud Run (usługa w pełni zarządzana).

Upewnij się, że nadal jesteś w katalogu roboczym:

ls

Powinny się na niej znaleźć te pliki:

main.py  Procfile  requirements.txt

Wdróż aplikację w Cloud Run:

gcloud run deploy helloworld-python \
  --source . \
  --platform managed \
  --region $REGION \
  --allow-unauthenticated

• Domyślny region możesz zdefiniować za pomocą tego polecenia: gcloud config set run/region $REGION
• Możesz też ustawić Cloud Run jako domyślną usługę zarządzaną za pomocą tego polecenia: gcloud config set run/platform managed
• Opcja --allow-unauthenticated sprawia, że usługa jest dostępna publicznie. Aby uniknąć nieautoryzowanych żądań, użyj zasady --no-allow-unauthenticated.

Aby sprawdzić wszystkie opcje, użyj gcloud run deploy --help.

Gdy zrobisz to po raz pierwszy, pojawi się prośba o utworzenie repozytorium Artifact Registry. Aby sprawdzić poprawność, kliknij Enter:

Deploying from source requires an Artifact Registry Docker repository to store
built containers. A repository named [cloud-run-source-deploy] in region [REGION]
will be created.

Do you want to continue (Y/n)?

Spowoduje to przesłanie kodu źródłowego do repozytorium Artifact Registry i skompilowanie obrazu kontenera:

Building using Buildpacks and deploying container ...
* Building and deploying new service... Building Container.           
  OK Creating Container Repository...
  OK Uploading sources...
  * Building Container... Logs are available at ...

Cloud Build używa pakietów kompilacji, które automatycznie wykrywają język kodu źródłowego i tworzą obraz kontenera na podstawie najnowszej stabilnej wersji interpretera Pythona (Python 3.12 w momencie pisania tego artykułu). W razie potrzeby możesz przypiąć kompilację do konkretnej wersji, umieszczając plik .python-version w katalogu źródłowym. Więcej informacji znajdziesz w artykule Tworzenie aplikacji w Pythonie.

Następnie poczekaj chwilę na zakończenie wdrażania. Kiedy operacja zostanie wykonana, w wierszu poleceń wyświetli się URL usługi:

...
OK Building and deploying new service... Done.
  OK Creating Container Repository...
  OK Uploading sources...
  OK Building Container... Logs are available at ...
  OK Creating Revision... Creating Service.
  OK Routing traffic...
  OK Setting IAM Policy...
Done.
Service [SERVICE]... has been deployed and is serving 100 percent of traffic.
Service URL: https://SERVICE-PROJECTHASH-REGIONID.a.run.app

Adres URL usługi możesz uzyskać za pomocą tego polecenia:

SERVICE_URL=$( \
  gcloud run services describe helloworld-python \
  --platform managed \
  --region $REGION \
  --format "value(status.url)" \
)
echo $SERVICE_URL

Powinien pojawić się ekran podobny do tego:

https://helloworld-python-PROJECTHASH-REGIONID.a.run.app

Możesz teraz korzystać z aplikacji, otwierając URL usługi w przeglądarce:

Możesz też wywołać aplikację z Cloud Shell:

curl $SERVICE_URL?who=me

Powinno pojawić się oczekiwane powitanie:

Hello me!

Ten krótki moduł został wykonany za pomocą wiersza poleceń gcloud, ale usługa Cloud Run jest dostępna w konsoli Cloud ( console.cloud.google.com/run). Powinna być widoczna lista usług helloworld:

Usługi Cloud Run możesz też wdrażać w konsoli.

Gratulacje! Właśnie udało Ci się wdrożyć aplikację w Cloud Run. Cloud Run automatycznie skaluje obraz kontenera w poziomie, aby obsługiwać otrzymane żądania, a następnie skaluje go w dół, gdy zapotrzebowanie maleje. Płacisz tylko za procesor, pamięć i sieć wykorzystywane w trakcie obsługiwania żądań.

7. Czyszczenie danych

Cloud Run nie nalicza opłat, gdy usługa nie jest używana, ale może zostać pobrana należność za przechowywanie obrazu kontenera w Artifact Registry. Aby uniknąć obciążenia konta opłatami, możesz usunąć repozytorium lub projekt w chmurze. Usunięcie projektu w chmurze spowoduje zaprzestanie naliczania opłat za wszelkie zasoby wykorzystywane w ramach tego projektu.

Aby usunąć repozytorium obrazów kontenerów:

gcloud artifacts repositories delete cloud-run-source-deploy \
  --location $REGION

Aby usunąć usługę Cloud Run:

gcloud run services delete helloworld-python \
  --platform managed \
  --region $REGION

Aby usunąć projekt Google Cloud:

1. Pobierz bieżący identyfikator projektu:

PROJECT_ID=$(gcloud config get-value core/project)

2. Sprawdź, czy to jest projekt, który chcesz usunąć:

echo $PROJECT_ID

3. Usuń projekt:

gcloud projects delete $PROJECT_ID

8. Gratulacje!

Utworzono prostą aplikację internetową i wdrożono ją w Cloud Run.

Więcej informacji

• Zapoznaj się z dokumentacją Cloud Run
• Aby poznać więcej opcji, przeczytaj artykuł Dev to Prod in Three Easy Steps with Cloud Run (Wdrożenie w środowisku produkcyjnym w 3 prostych krokach z Cloud Run).
• Wykonaj czynności opisane w artykule Django w Cloud Run, aby utworzyć bazę danych Cloud SQL, zarządzać danymi logowania za pomocą Secret Manager i wdrożyć Django.
• Sprawdź więcej ćwiczeń dotyczących Cloud Run...

Licencja

To zadanie jest licencjonowane na podstawie ogólnej licencji Creative Commons Attribution 2.0.