KubernetesEnvironmentResource

Classsealednet10.0

📦 Aspire.Hosting.Kubernetes v13.6.0-preview.1.26478.8

Represents a Kubernetes environment resource that can host application resources.

namespace Aspire.Hosting.Kubernetes;

public sealed class KubernetesEnvironmentResource
    : Aspire.Hosting.ApplicationModel.Resource,
      Aspire.Hosting.ApplicationModel.IComputeEnvironmentResource,
      Aspire.Hosting.ApplicationModel.IComputeEnvironmentWithVolumeMounts,
      Aspire.Hosting.ApplicationModel.IResource
{
    // ...
}

ResourceIComputeEnvironmentResourceIComputeEnvironmentWithVolumeMountsIResource

11 members

Remarks

This resource models the Kubernetes publishing environment used by Aspire when generating Helm charts and other Kubernetes manifests for application resources that will run on a Kubernetes cluster.

Constructors1

KubernetesEnvironmentResource(string)

Initializes a new instance of the KubernetesEnvironmentResource class.

View all constructors

Properties9

DashboardEnabledget; set

bool

Determines whether to include an Aspire dashboard for telemetry visualization in this environment.

DefaultImagePullPolicyget; set

string

Gets or sets the default policy that determines how Docker images are pulled during deployment. Possible values are: "Always" - Always attempt to pull the image from the registry. "IfNotPresent" - Pull the image only if it is not already present locally. "Never" - Never pull the image, use only the local image. The default value is "IfNotPresent".

DefaultServiceTypeget; set

string

Gets or sets the default Kubernetes service type to be used when generating artifacts.

DefaultStorageClassNameget; set

string?

Specifies the default name of the storage class to be used for persistent volume claims in Kubernetes. This property allows customization of the storage class for specifying storage requirements such as performance, retention policies, and provisioning parameters. If set to null, the default storage class for the cluster will be used.

DefaultStorageReadWritePolicyget; set

string

Gets or sets the default access policy for reading and writing to the storage.

DefaultStorageSizeget; set

string

Gets or sets the default storage size for persistent volumes.

DefaultStorageTypeget; set

string

Specifies the default type of storage used for Kubernetes deployments.

KubeConfigPathget; set

string?

Gets or sets the path to an explicit kubeconfig file for Helm and kubectl commands. When set, all Helm and kubectl commands will use --kubeconfig to target this file instead of the default ~/.kube/config.

OwningComputeEnvironmentget; set

IComputeEnvironmentResource?

Gets or sets the parent compute environment resource that owns this Kubernetes environment. When set, resources with WithComputeEnvironment targeting the parent will also be processed by this Kubernetes environment.

View all properties

Methods1

GetHostAddressExpression(EndpointReference)experimental

ReferenceExpression

Gets a ApplicationModel.ReferenceExpression representing the host address or host name for the specified ApplicationModel.EndpointReference.

View all methods