# Aspire.Hosting.Kubernetes

- Module: `Aspire.Hosting.Kubernetes`
- Version: `13.3.0-preview.1.26254.5`
- Source: [GitHub](https://github.com/microsoft/aspire)
- Functions: `36`
- Types: `8`

## Types

- [HelmChartOptions](/reference/api/typescript/aspire.hosting.kubernetes/helmchartoptions.md) -- `handle` - 3 members
- [KubernetesAspireDashboardResource](/reference/api/typescript/aspire.hosting.kubernetes/kubernetesaspiredashboardresource.md) -- `handle` - 5 members
- [KubernetesEnvironmentResource](/reference/api/typescript/aspire.hosting.kubernetes/kubernetesenvironmentresource.md) -- `handle` - 29 members
- [KubernetesGatewayResource](/reference/api/typescript/aspire.hosting.kubernetes/kubernetesgatewayresource.md) -- `handle` - 11 members
- [KubernetesIngressResource](/reference/api/typescript/aspire.hosting.kubernetes/kubernetesingressresource.md) -- `handle` - 12 members
- [KubernetesNodePoolResource](/reference/api/typescript/aspire.hosting.kubernetes/kubernetesnodepoolresource.md) -- `handle` - 0 members
- [KubernetesResource](/reference/api/typescript/aspire.hosting.kubernetes/kubernetesresource.md) -- `handle` - 1 members

## Functions

- [addGateway](/reference/api/typescript/aspire.hosting.kubernetes/addgateway.md) -- `method` -- Adds a Kubernetes Gateway API Gateway resource
- [addIngress](/reference/api/typescript/aspire.hosting.kubernetes/addingress.md) -- `method` -- Adds a Kubernetes Ingress resource for HTTP routing
- [addKubernetesEnvironment](/reference/api/typescript/aspire.hosting.kubernetes/addkubernetesenvironment.md) -- `method` -- Adds a Kubernetes publishing environment
- [addNodePool](/reference/api/typescript/aspire.hosting.kubernetes/addnodepool.md) -- `method` -- Adds a named node pool to a Kubernetes environment
- [configureDashboard](/reference/api/typescript/aspire.hosting.kubernetes/configuredashboard.md) -- `method` -- Configures the Aspire dashboard resource for the Kubernetes environment
- [publishAsKubernetesService](/reference/api/typescript/aspire.hosting.kubernetes/publishaskubernetesservice.md) -- `method` -- Publishes the resource as a Kubernetes service
- [withDashboard](/reference/api/typescript/aspire.hosting.kubernetes/withdashboard.md) -- `method` -- Enables or disables the Aspire dashboard for the Kubernetes environment
- [withDefaultBackend](/reference/api/typescript/aspire.hosting.kubernetes/withdefaultbackend.md) -- `method` -- Sets the default backend for a Kubernetes Ingress
- [withForwardedHeaders](/reference/api/typescript/aspire.hosting.kubernetes/withforwardedheaders.md) -- `method` -- Enables or disables forwarded headers support for the Aspire dashboard
- [withGatewayAnnotation](/reference/api/typescript/aspire.hosting.kubernetes/withgatewayannotation.md) -- `method` -- Adds a Kubernetes metadata annotation to a Gateway
- [withGatewayAnnotationParam](/reference/api/typescript/aspire.hosting.kubernetes/withgatewayannotationparam.md) -- `method` -- Adds a parameterized Kubernetes metadata annotation to a Gateway
- [withGatewayClass](/reference/api/typescript/aspire.hosting.kubernetes/withgatewayclass.md) -- `method` -- Sets the GatewayClass for a Kubernetes Gateway
- [withGatewayClassParam](/reference/api/typescript/aspire.hosting.kubernetes/withgatewayclassparam.md) -- `method` -- Sets a parameterized GatewayClass for a Kubernetes Gateway
- [withGatewayHostnameParam](/reference/api/typescript/aspire.hosting.kubernetes/withgatewayhostnameparam.md) -- `method` -- Adds a parameterized hostname to a Kubernetes Gateway
- [withGatewayHostRoute](/reference/api/typescript/aspire.hosting.kubernetes/withgatewayhostroute.md) -- `method` -- Adds a host-and-path route to a Kubernetes Gateway
- [withGatewayPathRoute](/reference/api/typescript/aspire.hosting.kubernetes/withgatewaypathroute.md) -- `method` -- Adds a path-based route to a Kubernetes Gateway
- [withGatewayTlsAuto](/reference/api/typescript/aspire.hosting.kubernetes/withgatewaytlsauto.md) -- `method` -- Configures TLS on a Kubernetes Gateway with an auto-generated secret
- [withGatewayTlsParam](/reference/api/typescript/aspire.hosting.kubernetes/withgatewaytlsparam.md) -- `method` -- Configures TLS on a Kubernetes Gateway with a parameterized secret
- [withHelm](/reference/api/typescript/aspire.hosting.kubernetes/withhelm.md) -- `method` -- Configures Helm chart deployment settings
- [withHostname](/reference/api/typescript/aspire.hosting.kubernetes/withhostname.md) -- `method` -- Adds a hostname to a Kubernetes Gateway
- [withHostname](/reference/api/typescript/aspire.hosting.kubernetes/withhostname.md) -- `method` -- Adds a hostname to a Kubernetes Ingress
- [withIngressAnnotation](/reference/api/typescript/aspire.hosting.kubernetes/withingressannotation.md) -- `method` -- Adds a Kubernetes metadata annotation to a Kubernetes Ingress
- [withIngressAnnotationParam](/reference/api/typescript/aspire.hosting.kubernetes/withingressannotationparam.md) -- `method` -- Adds a parameterized Kubernetes metadata annotation to an Ingress
- [withIngressClass](/reference/api/typescript/aspire.hosting.kubernetes/withingressclass.md) -- `method` -- Sets the ingress class for a Kubernetes Ingress
- [withIngressClassParam](/reference/api/typescript/aspire.hosting.kubernetes/withingressclassparam.md) -- `method` -- Sets a parameterized ingress class for a Kubernetes Ingress
- [withIngressHostnameParam](/reference/api/typescript/aspire.hosting.kubernetes/withingresshostnameparam.md) -- `method` -- Adds a parameterized hostname to a Kubernetes Ingress
- [withIngressHostRoute](/reference/api/typescript/aspire.hosting.kubernetes/withingresshostroute.md) -- `method` -- Adds a host-and-path route to a Kubernetes Ingress
- [withIngressPathRoute](/reference/api/typescript/aspire.hosting.kubernetes/withingresspathroute.md) -- `method` -- Adds a path-based route to a Kubernetes Ingress
- [withIngressTlsAuto](/reference/api/typescript/aspire.hosting.kubernetes/withingresstlsauto.md) -- `method` -- Configures TLS for a Kubernetes Ingress with an auto-generated secret
- [withIngressTlsParam](/reference/api/typescript/aspire.hosting.kubernetes/withingresstlsparam.md) -- `method` -- Configures TLS for a Kubernetes Ingress with a parameterized secret
- [withNodePool](/reference/api/typescript/aspire.hosting.kubernetes/withnodepool.md) -- `method` -- Schedules a workload on a specific Kubernetes node pool
- [withOtlpServicePort](/reference/api/typescript/aspire.hosting.kubernetes/withotlpserviceport.md) -- `method` -- Sets the Kubernetes Service ports for the OTLP endpoints
- [withProperties](/reference/api/typescript/aspire.hosting.kubernetes/withproperties.md) -- `method` -- Configures properties of a Kubernetes environment
- [withServicePort](/reference/api/typescript/aspire.hosting.kubernetes/withserviceport.md) -- `method` -- Sets the Kubernetes Service port for the Aspire dashboard
- [withTls](/reference/api/typescript/aspire.hosting.kubernetes/withtls.md) -- `method` -- Configures TLS on a Kubernetes Gateway listener
- [withTls](/reference/api/typescript/aspire.hosting.kubernetes/withtls.md) -- `method` -- Configures TLS for a Kubernetes Ingress using a K8S secret

## Enums

- [IngressPathType](/reference/api/typescript/aspire.hosting.kubernetes/ingresspathtype.md) -- `enum` - 3 values