KubernetesIngressResource Constructors

Docs/Reference/Search C# APIs/Aspire.Hosting.Kubernetes/KubernetesIngressResource/Constructors

Constructors

Docs Reference Search C# APIs Aspire.Hosting.Kubernetes KubernetesIngressResource Constructors

ClassConstructors1 member

Represents a Kubernetes Ingress as a first-class resource in the Aspire application model. An Ingress defines HTTP routing rules that direct external traffic to services in the cluster.

Constructor(string, KubernetesEnvironmentResource)

Represents a Kubernetes Ingress as a first-class resource in the Aspire application model. An Ingress defines HTTP routing rules that direct external traffic to services in the cluster.

public class KubernetesIngressResource
{
    public KubernetesIngressResource(
        string name,
        KubernetesEnvironmentResource environment)
    {
        // ...
    }
}

KubernetesIngressResource.cs#L38-L76

Parameters

namestringThe name of the ingress resource.

environmentKubernetesEnvironmentResourceThe parent Kubernetes environment resource.

Remarks

Create an ingress using KubernetesIngressExtensions.AddIngress and configure path rules using KubernetesIngressExtensions.WithPath.

At publish time, the ingress generates a Kubernetes networking.k8s.io/v1 Ingress resource in the Helm chart output with rules derived from the configured paths.

Examples

var k8s = builder.AddKubernetesEnvironment("k8s");
var ingress = k8s.AddIngress("public")
    .WithIngressClass("nginx");

var api = builder.AddProject<MyApi>("api");
ingress.WithPath("/api", api.GetEndpoint("http"));