KubernetesEnvironmentResource

Handle

📦 Aspire.Hosting.Kubernetes v13.4.0-preview.1.26281.18

interface KubernetesEnvironmentResource
  extends IComputeEnvironmentResource,
    IResource {
  dashboardEnabled: boolean;
  defaultImagePullPolicy: string;
  defaultServiceType: string;
  defaultStorageClassName: string;
  defaultStorageReadWritePolicy: string;
  defaultStorageSize: string;
  defaultStorageType: string;
  kubeConfigPath: string;
  addCertManager(
      name: string,
      chartVersion?: string): CertManagerResource;
  addGateway(name: string): KubernetesGatewayResource;
  addHelmChart(
      name: string,
      chartReference: string,
      chartVersion: string): KubernetesHelmChartResource;
  addIngress(name: string): KubernetesIngressResource;
  addNodePool(name: string): KubernetesNodePoolResource;
  configureDashboard(configure: (obj: KubernetesAspireDashboardResource) => Promise<void>): KubernetesEnvironmentResource;
  withDashboard(enabled?: boolean): KubernetesEnvironmentResource;
  withHelm(configure?: (obj: HelmChartOptions) => Promise<void>): KubernetesEnvironmentResource;
  withProperties(configure: (obj: KubernetesEnvironmentResource) => Promise<void>): KubernetesEnvironmentResource;
}

25 members

Properties

propertydashboardEnabledbooleanget · set

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

propertydefaultImagePullPolicystringget · set

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".

propertydefaultServiceTypestringget · set

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

propertydefaultStorageClassNamestringget · set

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.

propertydefaultStorageReadWritePolicystringget · set

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

propertydefaultStorageSizestringget · set

Gets or sets the default storage size for persistent volumes.

propertydefaultStorageTypestringget · set

Specifies the default type of storage used for Kubernetes deployments.

propertykubeConfigPathstringget · set

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`.

Methods

methodaddCertManagerbuilder

Installs cert-manager into a Kubernetes environment

addCertManager(
    name: string,
    chartVersion?: string): CertManagerResource

Parameters

namestring

chartVersionstringoptional

Returns

CertManagerResource

methodaddGatewaybuilder

Adds a Kubernetes Gateway API Gateway resource to the application model as a child of the specified Kubernetes environment. The gateway generates a `gateway.networking.k8s.io/v1 Gateway` resource and one or more `HTTPRoute` resources in the Helm chart output at publish time.

addGateway(name: string): KubernetesGatewayResource

Parameters

namestring

Returns

KubernetesGatewayResource

methodaddHelmChartbuilder

Adds an external Helm chart to be installed in the Kubernetes environment. The chart is installed via `helm upgrade --install` as a pipeline step after the main application Helm chart is deployed.

addHelmChart(
    name: string,
    chartReference: string,
    chartVersion: string): KubernetesHelmChartResource

Parameters

namestring

chartReferencestring

chartVersionstring

Returns

KubernetesHelmChartResource

methodaddIngressbuilder

Adds a Kubernetes Ingress resource to the application model as a child of the specified Kubernetes environment. The ingress generates a `networking.k8s.io/v1 Ingress` resource in the Helm chart output at publish time.

addIngress(name: string): KubernetesIngressResource

Parameters

namestring

Returns

KubernetesIngressResource

methodaddNodePoolbuilder

Adds a named node pool to the Kubernetes environment.

addNodePool(name: string): KubernetesNodePoolResource

Parameters

namestring

Returns

KubernetesNodePoolResource

methodconfigureDashboardbuilder

Configures the dashboard properties for this Kubernetes environment.

configureDashboard(configure: (obj: KubernetesAspireDashboardResource) => Promise<void>): KubernetesEnvironmentResource

Parameters

configure(obj: KubernetesAspireDashboardResource) => Promise<void>

Returns

KubernetesEnvironmentResource

methodwithDashboardbuilder

Enables the Aspire dashboard for telemetry visualization in this Kubernetes environment.

withDashboard(enabled?: boolean): KubernetesEnvironmentResource

Parameters

enabledbooleanoptional= True

Returns

KubernetesEnvironmentResource

methodwithHelmbuilder

Configures the Kubernetes environment to deploy using Helm charts.

withHelm(configure?: (obj: HelmChartOptions) => Promise<void>): KubernetesEnvironmentResource

Parameters

configure(obj: HelmChartOptions) => Promise<void>optional

Returns

KubernetesEnvironmentResource

methodwithPropertiesbuilder

Allows setting the properties of a Kubernetes environment resource.

withProperties(configure: (obj: KubernetesEnvironmentResource) => Promise<void>): KubernetesEnvironmentResource

Parameters

configure(obj: KubernetesEnvironmentResource) => Promise<void>

Returns

KubernetesEnvironmentResource