Tworzenie puli instancji roboczych Cloud Run na potrzeby subskrypcji Pub/Sub opartych na pobieraniu

1. Wprowadzenie

Przegląd

Pule instancji roboczych to zasób Cloud Run zaprojektowany specjalnie pod kątem zbiorów zadań niekorzystających z żądań, takich jak kolejki pobierania. Pamiętaj, że pule instancji roboczych nie mają tych funkcji:

  • Brak punktu końcowego lub adresu URL
  • Wdrożony kontener nie musi nasłuchiwać żądań na porcie.
  • Brak automatycznego skalowania

W tym module utworzysz pulę instancji roboczych, która będzie stale pobierać wiadomości z subskrypcji Pub/Sub. Więcej informacji o subskrypcjach pull Pub/Sub znajdziesz w dokumentacji i w tym przykładzie kodu.

Czego się nauczysz

  • Jak utworzyć pulę instancji roboczych Cloud Run i wdrożyć w niej usługę
  • Jak pobierać wiadomości z subskrypcji Pub/Sub opartej na pobieraniu

2. Konfiguracja i wymagania

Najpierw ustaw zmienne środowiskowe dla tego modułu:

export PROJECT_ID=<your_project_id>
export REGION=<your_region>

export WORKER_POOL_NAME=codelab-workers-pubsub
export SERVICE_ACCOUNT=worker-pools-sa
export SERVICE_ACCOUNT_EMAIL=${SERVICE_ACCOUNT}@${PROJECT_ID}.iam.gserviceaccount.com
export TOPIC=pull-pubsub-topic

Następnie skonfiguruj gcloud, aby używać identyfikatora projektu.

gcloud config set project $PROJECT_ID

Zanim zaczniesz korzystać z tego samouczka, włącz te interfejsy API, uruchamiając to polecenie:

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

Utwórz konto usługi, uruchamiając to polecenie:

gcloud iam service-accounts create ${SERVICE_ACCOUNT} \
  --display-name="Service account for worker pool codelab"

Na koniec przyznaj kontu usługi Cloud Run dostęp do PubSub:

gcloud projects add-iam-policy-binding $PROJECT_ID \
    --member serviceAccount:$SERVICE_ACCOUNT_EMAIL \
    --role='roles/pubsub.admin'

3. Tworzenie puli instancji roboczych Cloud Run

Najpierw utwórz katalog dla kodu puli instancji roboczych:

mkdir codelab-worker-pools
cd codelab-worker-pools

Następnie utwórz plik o nazwie package.json.

{
    "name": "codelab-worker-pools",
    "version": "1.0.0",
    "description": "A codelab example of a Cloud Run worker pool retrieving messages from a Pull-based PubSub subscription",
    "main": "index.js",
    "scripts": {
        "start": "node index.js"
    },
    "engines": {
        "node": ">=22.0.0"
    },
    "keywords": [],
    "author": "",
    "license": "ISC",
    "dependencies": {
        "@google-cloud/pubsub": "^5.1.0"
    }
}

Teraz utwórz plik o nazwie index.js:

'use strict';

const subscriptionNameOrId = 'pull-pubsub-topic';

const { PubSub } = require('@google-cloud/pubsub');

// Creates a Pub/Sub client; cache this for further use.
const pubSubClient = new PubSub();

// References an existing subscription.
const subscription = pubSubClient.subscription(subscriptionNameOrId);

// This function is called when a shutdown signal is received.
const handleShutdown = async (signal) => {
  console.log(`\n${signal} signal caught. Shutting down gracefully...`);

  try {
    // 1. Stop listening for new messages. The `close()` method returns a Promise.
    console.log('Closing Pub/Sub subscription...');
    await subscription.close();
    console.log('Pub/Sub subscription closed.');

    // 2. Add any other cleanup logic here, like closing database connections.

  } catch (err) {
    console.error('Error during graceful shutdown:', err);
  } finally {
    console.log('Worker Pool exited.');
    process.exit(0);
  }
};

// Listen for termination signals.
// SIGINT handles Ctrl+C locally.
// SIGTERM handles signals from services like Cloud Run.
process.on('SIGINT', () => handleShutdown('SIGINT'));
process.on('SIGTERM', () => handleShutdown('SIGTERM'));

// ------------------ Pub/Sub Message Handling ------------------

// Create an event handler to process incoming messages.
const messageHandler = message => {
  console.log(`Received message ${message.id}:`);
  console.log(`\tData: ${message.data}`);
  console.log(`\tAttributes: ${JSON.stringify(message.attributes)}`);

  // Ack the message so it is not sent again.
  message.ack();
};

// Register the message handler and listen for messages.
subscription.on('message', messageHandler);

console.log(
  `Worker started. Listening for messages on "${subscriptionNameOrId}".`
);
console.log('If running locally, press Ctrl+C to quit.');

// The application will now listen for messages indefinitely until a shutdown
// signal is received.

4. Wdróż pulę instancji roboczych

Utwórz pulę instancji roboczych Cloud Run, uruchamiając to polecenie:

gcloud beta run worker-pools deploy $WORKER_POOL_NAME --region=$REGION --source .

To polecenie tworzy obraz ze źródła i wdraża zadanie. Może to potrwać kilka minut.

5. Publikowanie wiadomości w PubSub

Tworzenie tematu Pub/Sub

gcloud pubsub topics create $TOPIC

Tworzenie subskrypcji pull Pub/Sub

gcloud pubsub subscriptions create codelab-subscription --topic=$TOPIC

Aby opublikować wiadomość w temacie PubSub, uruchom to polecenie:

gcloud pubsub topics publish $TOPIC --message "Hello Worker Pools"

Sprawdź logi puli instancji roboczych

gcloud logging read 'resource.type="cloud_run_worker_pool" AND resource.labels.worker_pool_name="'$WORKER_POOL_NAME'" AND resource.labels.location="'$REGION'"' --limit 10

W logach powinna pojawić się wartość Hello Worker Pools.

6. Usuwanie puli instancji roboczych

Pule instancji roboczych działają w sposób ciągły, więc należy je usunąć.

gcloud beta run worker-pools delete $WORKER_POOL_NAME --region $REGION

7. Gratulacje!

Gratulujemy ukończenia ćwiczenia!

Zalecamy zapoznanie się z dokumentacją Cloud Run.

Omówione zagadnienia

  • Jak utworzyć pulę instancji roboczych Cloud Run i wdrożyć w niej usługę
  • Jak pobierać wiadomości z subskrypcji Pub/Sub opartej na pobieraniu

8. Czyszczenie danych

Aby usunąć pulę instancji roboczych Cloud Run, otwórz Cloud Run w konsoli Google Cloud pod adresem https://console.cloud.google.com/run i usuń pulę instancji roboczych codelab-workers-pubsub.

Aby usunąć cały projekt, otwórz stronę Zarządzaj zasobami, wybierz projekt utworzony w kroku 2 i kliknij Usuń. Jeśli usuniesz projekt, musisz zmienić projekty w Cloud SDK. Listę wszystkich dostępnych projektów możesz wyświetlić, uruchamiając polecenie gcloud projects list.