Add GCP integrations: Pub/Sub and Cloud Storage

[Marcus-V-Freitas]

Aspire issue link

No response

Overview

Summary

Suggesting the addition of two Google Cloud integrations to the CommunityToolkit:

• Google Cloud Pub/Sub
• Google Cloud Storage

Both are widely used in GCP-based environments and currently have no coverage
in the toolkit.

I have working community implementations for both in my open-source project:
MVFC.Aspire.Helpers. The specific docs are below:

• Google Cloud Pub/Sub
• Google Cloud Storage

Happy to contribute if there's interest.

Usage example

PubSub

using Aspire.Hosting;
using MVFC.Aspire.Helpers.GcpPubSub;

var builder = DistributedApplication.CreateBuilder(args);

var messageConfig = new MessageConfig(
    TopicName: "test-topic",
    SubscriptionName: "test-subscription",
    PushEndpoint: "/api/pub-sub-exit")
{
    DeadLetterTopic = "test-dead-letter-topic",
    MaxDeliveryAttempts = 5,
    AckDeadlineSeconds = 300,
};

var pubSubConfig = new PubSubConfig(
    projectId: "test-project",
    messageConfig: messageConfig);

var gcpPubSub = builder.AddGcpPubSub("gcp-pubsub")
    .WithPubSubConfigs([pubSubConfig])
    .WithWaitTimeout(secondsDelay: 5);

var ui = builder.AddGcpPubSubUI("pubsub-ui")
    .WithReference(gcpPubSub)
    .WaitFor(gcpPubSub);

builder.AddProject<Projects.MVFC_Aspire_Helpers_Playground_Api>("api-example")
       .WithReference(gcpPubSub)
       .WaitFor(gcpPubSub);

await builder.Build().RunAsync();

CloudStorage

using Aspire.Hosting;
using MVFC.Aspire.Helpers.CloudStorage;

var builder = DistributedApplication.CreateBuilder(args);

var cloudStorage = builder.AddCloudStorage("cloud-storage")
    .WithBucketFolder("./bucket-data");

builder.AddProject<Projects.MVFC_Aspire_Helpers_Playground_Api>("api-example")
       .WithReference(cloudStorage)
       .WaitFor(cloudStorage);

await builder.Build().RunAsync();

Additional context

No response

Help us help you

Yes, but only if others can assist

[aaronpowell]

Having a look at the two integrations you reference above I come to the same question that we've had in the past about GCP (although I can't find the issue we were discussing it in) - what do you do about deployment? By the looks of it, both integrations are focusing on the local development/emulator story, which is obviously a useful part of working with Aspire, but what happens when you want to deploy to GCP, or deploy somewhere and just use these GCP services?

It could be as simple as it will expect an environment variable (or parameter even) that will get injected into the services that reference the resource, or maybe it generates some deployment script that provisions resources on GCP, I'm not sure because I've not used GCP.

This would mean that the API can be made more compatible with how we'd expect Aspire to work:

builder.AddGcpPubSub("pubsub")
    .WithPubSubConfigs([pubSubConfig])
    .WithWaitTimeout(secondsDelay: 5)
    .RunAsEmulator(emulator => emulator.WithPubSubUI());

[github-actions]

We have noticed this issue has not been updated within 21 days. If there is no action on this issue in the next 14 days, we will automatically close it. You can use /stale-extend to extend the window.