Python (FastAPI) के साथ Hello Cloud Run

1. परिचय

Cloud Run, मैनेज किया गया कंप्यूट प्लैटफ़ॉर्म है. इसकी मदद से, स्टेटलेस कंटेनर चलाए जा सकते हैं. इन कंटेनर को एचटीटीपी अनुरोधों का इस्तेमाल करके शुरू किया जा सकता है. इसे Knative ओपन-सोर्स प्रोजेक्ट पर बनाया गया है. इससे, आपके वर्कलोड को अलग-अलग प्लैटफ़ॉर्म पर पोर्ट किया जा सकता है. Cloud Run, सर्वरलेस है: यह सभी इन्फ़्रास्ट्रक्चर मैनेजमेंट को अलग कर देता है, ताकि आप सबसे ज़रूरी काम पर फ़ोकस कर सकें. यानी, शानदार ऐप्लिकेशन बनाना.

इस ट्यूटोरियल का मकसद, एक सामान्य FastAPI वेब ऐप्लिकेशन बनाना और उसे Cloud Run पर डिप्लॉय करना है.

आपको क्या सीखने को मिलेगा

• FastAPI "नमस्ते, दुनिया के लोगों" ऐप्लिकेशन बनाने का तरीका.
• dev मोड में FastAPI सर्वर चलाकर, ऐप्लिकेशन की टेस्टिंग की जा रही है.
• Cloud Buildpacks और requirements.txt में fastapi और uvicorn की मौजूदगी की वजह से, Dockerfile की ज़रूरत नहीं पड़ती.
• FastAPI ऐप्लिकेशन को Cloud Run पर डिप्लॉय करने का तरीका.

2. सेटअप और ज़रूरी शर्तें

अपने हिसाब से एनवायरमेंट सेट अप करना

1. Google Cloud Console में साइन इन करें और नया प्रोजेक्ट बनाएं या किसी मौजूदा प्रोजेक्ट का फिर से इस्तेमाल करें. अगर आपके पास पहले से कोई Gmail या Google Workspace खाता नहीं है, तो आपको एक खाता बनाना होगा.

• प्रोजेक्ट का नाम, इस प्रोजेक्ट में हिस्सा लेने वाले लोगों के लिए डिसप्ले नेम होता है. यह एक वर्ण स्ट्रिंग है, जिसका इस्तेमाल Google API नहीं करते हैं. इसे कभी भी अपडेट किया जा सकता है.
• प्रोजेक्ट आईडी, सभी Google Cloud प्रोजेक्ट के लिए यूनीक होता है. साथ ही, इसे बदला नहीं जा सकता. Cloud Console, अपने-आप एक यूनीक स्ट्रिंग जनरेट करता है. आम तौर पर, आपको इससे कोई फ़र्क़ नहीं पड़ता कि यह क्या है. ज़्यादातर कोडलैब में, आपको अपने प्रोजेक्ट आईडी (आम तौर पर PROJECT_ID के तौर पर पहचाना जाता है) का रेफ़रंस देना होगा. अगर आपको जनरेट किया गया आईडी पसंद नहीं है, तो आपके पास कोई दूसरा रैंडम आईडी जनरेट करने का विकल्प होता है. इसके अलावा, आपके पास अपना नाम आज़माने का विकल्प भी है. इससे आपको पता चलेगा कि वह नाम उपलब्ध है या नहीं. इस चरण के बाद, इसे बदला नहीं जा सकता. यह प्रोजेक्ट की अवधि तक बना रहता है.
• आपकी जानकारी के लिए बता दें कि एक तीसरी वैल्यू भी होती है, जिसे प्रोजेक्ट नंबर कहते हैं. इसका इस्तेमाल कुछ एपीआई करते हैं. इन तीनों वैल्यू के बारे में ज़्यादा जानने के लिए, दस्तावेज़ देखें.

चेतावनी: प्रोजेक्ट आईडी, दुनिया भर में यूनीक होता है. इसे चुनने के बाद, कोई और व्यक्ति इसका इस्तेमाल नहीं कर सकता. उस आईडी का इस्तेमाल सिर्फ़ आपके पास हो. प्रोजेक्ट मिटाने के बाद भी, आईडी का दोबारा इस्तेमाल नहीं किया जा सकता

ध्यान दें: अगर Gmail खाते का इस्तेमाल किया जाता है, तो डिफ़ॉल्ट जगह को कोई संगठन नहीं पर सेट किया जा सकता है. अगर Google Workspace खाते का इस्तेमाल किया जा रहा है, तो अपने संगठन के हिसाब से कोई जगह चुनें.

2. इसके बाद, Cloud संसाधनों/एपीआई का इस्तेमाल करने के लिए, आपको Cloud Console में बिलिंग चालू करनी होगी. इस कोडलैब को पूरा करने में ज़्यादा खर्च नहीं आएगा. इस ट्यूटोरियल के बाद बिलिंग से बचने के लिए, संसाधनों को शट डाउन करें. इसके लिए, बनाए गए संसाधनों को मिटाएं या प्रोजेक्ट को मिटाएं. Google Cloud के नए उपयोगकर्ताओं को, 300 डॉलर का क्रेडिट मुफ़्त में आज़माने का प्रोग्राम मिलता है.

Cloud Shell शुरू करें

Google Cloud को अपने लैपटॉप से रिमोटली ऑपरेट किया जा सकता है. हालांकि, इस ट्यूटोरियल में Cloud Shell का इस्तेमाल किया जाएगा. यह क्लाउड में चलने वाला कमांड लाइन एनवायरमेंट है.

Cloud Shell चालू करें

1. Cloud Console में, Cloud Shell चालू करें पर क्लिक करें

अगर Cloud Shell को पहली बार शुरू किया जा रहा है, तो आपको एक इंटरमीडिएट स्क्रीन दिखेगी. इसमें Cloud Shell के बारे में बताया गया होगा. अगर आपको इंटरमीडिएट स्क्रीन दिखती है, तो जारी रखें पर क्लिक करें.

Cloud Shell से कनेक्ट होने में कुछ ही सेकंड लगेंगे.

इस वर्चुअल मशीन में, डेवलपमेंट के लिए ज़रूरी सभी टूल पहले से मौजूद होते हैं. यह 5 जीबी की होम डायरेक्ट्री उपलब्ध कराता है और Google Cloud में चलता है. इससे नेटवर्क की परफ़ॉर्मेंस और पुष्टि करने की प्रोसेस बेहतर होती है. इस कोडलैब में ज़्यादातर काम ब्राउज़र से किया जा सकता है.

Cloud Shell से कनेक्ट होने के बाद, आपको दिखेगा कि आपने पुष्टि कर ली है और प्रोजेक्ट को आपके प्रोजेक्ट आईडी पर सेट कर दिया गया है.

2. पुष्टि करें कि आपने Cloud Shell में पुष्टि कर ली है. इसके लिए, यह कमांड चलाएं:

gcloud auth list

कमांड का आउटपुट

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

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

ध्यान दें: gcloud कमांड-लाइन टूल, Google Cloud में सबसे ज़्यादा इस्तेमाल किया जाने वाला और एक जैसा कमांड-लाइन टूल है. यह Cloud Shell में पहले से इंस्टॉल होता है. आपको टैब पूरा करने की सुविधा दिखेगी. पहली बार कोई कमांड चलाने पर, आपसे पुष्टि करने के लिए कहा जा सकता है. ज़्यादा जानकारी के लिए, gcloud कमांड-लाइन टूल की खास जानकारी देखें.

3. यह पुष्टि करने के लिए कि gcloud कमांड को आपके प्रोजेक्ट के बारे में पता है, Cloud Shell में यह कमांड चलाएं:

gcloud config list project

कमांड का आउटपुट

[core]
project = <PROJECT_ID>

अगर ऐसा नहीं है, तो इस कमांड का इस्तेमाल करके इसे सेट किया जा सकता है:

gcloud config set project <PROJECT_ID>

कमांड का आउटपुट

Updated property [core/project].

ध्यान दें: अगर आपको यह ट्यूटोरियल Cloud Shell के बाहर पूरा करना है, तो ऐप्लिकेशन के डिफ़ॉल्ट क्रेडेंशियल सेट अप करें लेख पढ़ें.

3. एपीआई चालू करना

Cloud Shell से, Artifact Registry, Cloud Build, और Cloud Run API चालू करें:

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

इससे, इस तरह का 'हो गया' मैसेज दिखता है:

Operation "operations/..." finished successfully.

Cloud Run, आपके ऐप्लिकेशन को डिप्लॉय करने के लिए, कंटेनर इकोसिस्टम के साथ काम करता है:

• Cloud Build, आपके सोर्स कोड से कंटेनर इमेज अपने-आप बनाता है और उसे Artifact Registry में पुश करता है.
• Artifact Registry, आपकी कंटेनर इमेज को मैनेज करता है.

अब आप काम शुरू करने और आवेदन लिखने के लिए तैयार हैं...

4. आवेदन लिखना

इस चरण में, एचटीटीपी अनुरोधों का जवाब देने वाला "नमस्ते, दुनिया के लोगों" FastAPI Python ऐप्लिकेशन बनाया जाएगा.

वर्किंग डायरेक्ट्री

helloworld-fastapi नाम की वर्किंग डायरेक्ट्री बनाने और उस पर स्विच करने के लिए, Cloud Shell का इस्तेमाल करें:

mkdir ~/helloworld-fastapi && cd ~/helloworld-fastapi

main.py

main.py नाम की फ़ाइल बनाने के लिए:

touch main.py

अपनी पसंद के कमांड लाइन एडिटर (nano, vim या emacs) का इस्तेमाल करके फ़ाइल में बदलाव करें. इसके अलावा, Cloud Shell Editor बटन पर क्लिक करके भी फ़ाइल में बदलाव किया जा सकता है:

Cloud Shell Editor की मदद से फ़ाइल में सीधे तौर पर बदलाव करने के लिए, इस कमांड का इस्तेमाल करें:

cloudshell edit main.py

main.py

from fastapi import FastAPI

app = FastAPI()


@app.get("/")
def hello(name: str = "World"):
    """Return a friendly HTTP greeting."""
    return {
        "message": f"Hello {name}!"
    }

यह कोड, एचटीटीपी GET अनुरोधों का जवाब देने वाली एक बुनियादी वेब सेवा बनाता है. इसमें लोगों को आसानी से समझ आने वाला मैसेज होता है.

requirements.txt

टर्मिनल को फिर से खोलें और डिपेंडेंसी तय करने के लिए, requirements.txt नाम की फ़ाइल जोड़ें:

touch requirements.txt

Cloud Shell Editor की मदद से फ़ाइल में सीधे तौर पर बदलाव करने के लिए, इस कमांड का इस्तेमाल करें:

cloudshell edit requirements.txt

requirements.txt

# https://pypi.org/project/fastapi
fastapi[standard]==0.116.1

# https://pypi.org/project/uvicorn
uvicorn==0.35.0

Cloud Run का इस्तेमाल शुरू करने के लिए, कई अन्य भाषाओं में दस्तावेज़ उपलब्ध हैं. Go, Node.js, Java, C#, C++, PHP, Ruby, शेल स्क्रिप्ट वगैरह के लिए निर्देश यहां दिए गए हैं: https://cloud.google.com/run/docs/quickstarts/build-and-deploy

FastAPI ऐप्लिकेशन को डिप्लॉय किया जा सकता है. हालांकि, इससे पहले इसे टेस्ट करना ज़रूरी है...

5. ऐप्लिकेशन को टेस्ट करना

ऐप्लिकेशन की जांच करने के लिए, uv का इस्तेमाल करें. यह Python का बहुत तेज़ पैकेज और प्रोजेक्ट मैनेजर है. यह Cloud Shell में पहले से इंस्टॉल होता है.

ऐप्लिकेशन को टेस्ट करने के लिए, वर्चुअल एनवायरमेंट बनाएं:

uv venv

डिपेंडेंसी इंस्टॉल करें:

uv pip install -r requirements.txt

ऐप्लिकेशन को dev मोड में शुरू करें:

uv run fastapi dev main.py --port=8080

लॉग से पता चलता है कि आप डेवलपमेंट मोड में हैं:

FastAPI   Starting development server 🚀

          Searching for package file structure from directories with __init__.py files
          Importing from /home/user/code/helloworld-fastapi

  module  🐍 main.py

    code  Importing the FastAPI app object from the module with the following code:

          from main import app

     app  Using import string: main:app

  server   Server started at http://127.0.0.1:8080
  server   Documentation at http://127.0.0.1:8080/docs

     tip   Running in development mode, for production use: fastapi run

           Logs:

    INFO   Will watch for changes in these directories: ['/home/user/code/helloworld-fastapi']
    INFO   Uvicorn running on http://127.0.0.1:8080 (Press CTRL+C to quit)
    INFO   Started reloader process [19627] using WatchFiles
    INFO   Started server process [19629]
    INFO   Waiting for application startup.
    INFO   Application startup complete.

Cloud Shell विंडो में, Web Preview आइकॉन पर क्लिक करें और Preview on port 8080 चुनें:

ऐसा करने पर, एक ब्राउज़र विंडो खुलेगी. इसमें Hello World! मैसेज दिखेगा.

+ आइकॉन पर क्लिक करके, दूसरा Cloud Shell सेशन (नया टर्मिनल टैब) भी खोला जा सकता है. इसके बाद, स्थानीय तौर पर चल रहे ऐप्लिकेशन को वेब का अनुरोध भेजा जा सकता है:

curl localhost:8080

आपको यह जवाब मिलेगा:

{"message": "Hello World!"}

जब आपका काम पूरा हो जाए, तो मुख्य Cloud Shell सेशन पर वापस जाएं और CTRL+C की मदद से FastAPI dev server को बंद करें.

ऐप्लिकेशन उम्मीद के मुताबिक काम कर रहा है: इसे डिप्लॉय करने का समय...

6. Cloud Run पर डिप्लॉय करना

Cloud Run, रीजनल सेवा है. इसका मतलब है कि Cloud Run की सेवाओं को चलाने वाला इन्फ़्रास्ट्रक्चर, किसी खास रीजन में मौजूद होता है. इसे Google मैनेज करता है, ताकि यह उस रीजन के सभी ज़ोन में उपलब्ध रहे. उस क्षेत्र को तय करें जिसका इस्तेमाल आपको डिप्लॉयमेंट के लिए करना है. उदाहरण के लिए:

REGION=europe-west4

जिन इलाकों में यह सुविधा उपलब्ध है उनकी पूरी सूची देखने के लिए, Cloud Run (पूरी तरह से मैनेज किया गया) की लोकेशन देखें.

पक्का करें कि आप अब भी वर्किंग डायरेक्ट्री में हों:

ls

इसमें ये फ़ाइलें शामिल होनी चाहिए:

main.py  requirements.txt

डप्लॉय करने से पहले, .venv/ वाली .gcloudignore फ़ाइल बनाएं. इससे Cloud Run डिप्लॉयमेंट में, लोकल टेस्टिंग के दौरान uv से बनाया गया वर्चुअल एनवायरमेंट शामिल नहीं होता है.

नीचे दिए गए कमांड का इस्तेमाल करके .gcloudignore बनाएं:

echo ".venv/" > .gcloudignore

ऐप्लिकेशन को Cloud Run पर डिप्लॉय करें:

gcloud run deploy helloworld-fastapi \
  --source . \
  --region $REGION \
  --allow-unauthenticated

• --allow-unauthenticated विकल्प चुनने पर, सेवा सार्वजनिक तौर पर उपलब्ध हो जाती है. बिना पुष्टि वाले अनुरोधों से बचने के लिए, --no-allow-unauthenticated का इस्तेमाल करें.

सभी विकल्प देखने के लिए, gcloud run deploy --help का इस्तेमाल करें.

पहली बार, आपको Artifact Registry में डेटाबेस बनाने के लिए एक प्रॉम्प्ट दिखेगा. पुष्टि करने के लिए, 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)?

इससे, Artifact Registry रिपॉज़िटरी में आपका सोर्स कोड अपलोड हो जाएगा और कंटेनर इमेज बन जाएगी:

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, Buildpacks का इस्तेमाल करता है. यह आपके सोर्स कोड की भाषा का अपने-आप पता लगाता है और Python इंटरप्रेटर के सबसे नए स्टेबल वर्शन (लिखते समय Python 3.13) के आधार पर कंटेनर इमेज बनाता है.

uvicorn जैसे किसी ASGI वेब सर्वर के साथ Buildpacks का इस्तेमाल करने के लिए, requirements.txt फ़ाइल में uvicorn मौजूद होना चाहिए. FastAPI के लिए इसकी ज़रूरत होती है. ऐसा न करने पर, Buildpacks डिफ़ॉल्ट रूप से gunicorn का इस्तेमाल करने वाले WSGI वेब सर्वर पर सेट हो जाएंगे. इससे FastAPI में गड़बड़ियां होंगी.

ज़्यादा जानकारी के लिए, Python ऐप्लिकेशन बनाना लेख पढ़ें.

इसके बाद, डिप्लॉयमेंट पूरा होने तक इंतज़ार करें. सफल होने पर, कमांड लाइन में सेवा का यूआरएल दिखता है:

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

इस कमांड का इस्तेमाल करके, सेवा का यूआरएल पाया जा सकता है:

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

यह कुछ ऐसा दिखना चाहिए:

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

अब वेब ब्राउज़र में सेवा का यूआरएल खोलकर, अपने ऐप्लिकेशन का इस्तेमाल किया जा सकता है:

Cloud Shell से भी ऐप्लिकेशन को कॉल किया जा सकता है:

curl $SERVICE_URL?name=me

इससे आपको उम्मीद के मुताबिक जवाब मिलेगा:

{"message": "Hello me!"}

इस छोटे से लैब को gcloud कमांड-लाइन का इस्तेमाल करके पूरा किया गया था. हालांकि, Cloud Run को Cloud Console ( console.cloud.google.com/run) का इस्तेमाल करके भी ऐक्सेस किया जा सकता है. आपको अपनी helloworld-fastapi सेवा की लिस्टिंग दिखेगी:

Cloud Run सेवाओं को डिप्लॉय करने के लिए, कंसोल का भी इस्तेमाल किया जा सकता है.

बधाई हो! आपने अभी-अभी Cloud Run पर एक ऐप्लिकेशन डिप्लॉय किया है. Cloud Run, मिले हुए अनुरोधों को मैनेज करने के लिए, आपकी कंटेनर इमेज को अपने-आप और हॉरिज़ॉन्टल तरीके से स्केल करता है. इसके बाद, मांग कम होने पर इसे स्केल डाउन कर देता है. आपको इस Cloud Run सेवा के लिए, अनुरोध को प्रोसेस करने के दौरान इस्तेमाल किए गए सीपीयू, मेमोरी, और नेटवर्किंग के लिए ही पेमेंट करना होता है.

7. व्यवस्थित करें

Cloud Run, सेवा का इस्तेमाल न किए जाने पर कोई शुल्क नहीं लेता. हालांकि, Artifact Registry में कंटेनर इमेज सेव करने के लिए आपसे शुल्क लिया जा सकता है. शुल्क से बचने के लिए, अपनी रिपॉज़िटरी या Cloud प्रोजेक्ट मिटाया जा सकता है. Cloud प्रोजेक्ट मिटाने पर, उस प्रोजेक्ट में इस्तेमाल किए गए सभी संसाधनों के लिए बिलिंग बंद हो जाती है.

कंटेनर इमेज रिपॉज़िटरी मिटाने के लिए:

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

Cloud Run सेवा मिटाने के लिए:

gcloud run services delete helloworld-fastapi \
  --region $REGION

Google Cloud प्रोजेक्ट मिटाने के लिए,

1. अपना मौजूदा प्रोजेक्ट आईडी वापस पाएं:

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

2. पक्का करें कि आपको यही प्रोजेक्ट मिटाना है:

echo $PROJECT_ID

3. प्रोजेक्ट मिटाने के लिए:

gcloud projects delete $PROJECT_ID

8. बधाई हो!

आपने "नमस्ते, दुनिया के लोगों" FastAPI वेब ऐप्लिकेशन बनाया और उसे Cloud Run पर डिप्लॉय किया!

हमने क्या-क्या शामिल किया है

• FastAPI "नमस्ते, दुनिया के लोगों" ऐप्लिकेशन बनाने का तरीका.
• dev मोड में FastAPI सर्वर चलाकर, ऐप्लिकेशन की टेस्टिंग की जा रही है.
• Cloud Buildpacks और requirements.txt में fastapi और uvicorn की मौजूदगी की वजह से, Dockerfile की ज़रूरत नहीं पड़ती.
• FastAPI ऐप्लिकेशन को Cloud Run पर डिप्लॉय करना.

ज़्यादा जानें

• Cloud Run से जुड़ा दस्तावेज़ देखें
• ज़्यादा विकल्पों के बारे में जानने के लिए, Cloud Run की मदद से, तीन आसान चरणों में डेवलपमेंट से प्रोडक्शन तक पूरा करें
• Cloud SQL DB बनाने, Secret Manager की मदद से क्रेडेंशियल मैनेज करने, और Django को डिप्लॉय करने के लिए, Cloud Run पर Django को पूरा करें
• Cloud Run के अन्य कोडलैब देखें...