K3sServiceEndpointResource

Classsealednet10.0

📦 CommunityToolkit.Aspire.Hosting.K3s v13.4.1-beta.706

Represents a Kubernetes Service exposed from a k3s cluster as an Aspire endpoint resource.

namespace Aspire.Hosting.ApplicationModel;

public sealed class K3sServiceEndpointResource
    : Aspire.Hosting.ApplicationModel.Resource,
      Aspire.Hosting.ApplicationModel.IExpressionValue,
      Aspire.Hosting.ApplicationModel.IManifestExpressionProvider,
      Aspire.Hosting.ApplicationModel.IResource,
      Aspire.Hosting.ApplicationModel.IResourceWithConnectionString,
      Aspire.Hosting.ApplicationModel.IResourceWithParent,
      Aspire.Hosting.ApplicationModel.IResourceWithParent<Aspire.Hosting.ApplicationModel.K3sClusterResource>,
      Aspire.Hosting.ApplicationModel.IResourceWithWaitSupport,
      Aspire.Hosting.ApplicationModel.IValueProvider,
      Aspire.Hosting.ApplicationModel.IValueWithReferences
{
    // ...
}

ResourceIExpressionValueIManifestExpressionProviderIResourceIResourceWithConnectionStringIResourceWithParentIResourceWithParent<K3sClusterResource>IResourceWithWaitSupportIValueProviderIValueWithReferences

9 members

Remarks

An in-process WebSocket port-forward bridges the cluster service to a host port when the cluster is ready. Dependent resources receive the service URL via the standard Aspire service-discovery environment variable services__{name}__url:

Host processes receive http(s)://localhost:{port}.
Containers receive http(s)://host.docker.internal:{port}.

Use WaitFor(endpoint) on dependent resources to ensure the port-forward is active before they start.

Constructors1

K3sServiceEndpointResource(string, string, int, string, K3sClusterResource)

Represents a Kubernetes Service exposed from a k3s cluster as an Aspire endpoint resource.

View all constructors

Properties7

ConnectionStringEnvironmentVariableget

string?

The environment variable name used to inject the service URL into dependents ( services__{name}__url), following the Aspire service-discovery convention.

ConnectionStringExpressionget

ReferenceExpression

Gets the manifest expression for the service URL. Resolves to http(s)://localhost:{hostPort} when the endpoint is ready.

HostPortget

int

Gets the host port bound by the port-forward listener.

Namespaceget

string

Gets the Kubernetes namespace that contains the Service.

Parentget

K3sClusterResource

Gets the parent resource of type K3sClusterResource.

ServiceNameget

string

Gets the name of the Kubernetes Service being forwarded.

ServicePortget

int

Gets the port number declared on the Kubernetes Service.

View all properties

Methods1

GetConnectionStringAsync(CancellationToken)

ValueTask<string?>

Returns the host-accessible service URL, or null if the port-forward is not yet active.

View all methods