KubernetesEnvironmentResource

Handle

📦 Aspire.Hosting.Kubernetes v13.3.0-preview.1.26254.5

interface KubernetesEnvironmentResource
  extends IComputeEnvironmentResource,
    IResource {
  dashboardEnabled: boolean;
  defaultImagePullPolicy: string;
  defaultServiceType: string;
  defaultStorageClassName: string;
  defaultStorageReadWritePolicy: string;
  defaultStorageSize: string;
  defaultStorageType: string;
  helmChartDescription: string;
  helmChartName: string;
  helmChartVersion: string;
  kubeConfigPath: string;
  addGateway(name: string): KubernetesGatewayResource;
  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;
}

29 members

Properties

property dashboardEnabled boolean get · set

Gets the DashboardEnabled property

property defaultImagePullPolicy string get · set

Gets the DefaultImagePullPolicy property

property defaultServiceType string get · set

Gets the DefaultServiceType property

property defaultStorageClassName string get · set

Gets the DefaultStorageClassName property

property defaultStorageReadWritePolicy string get · set

Gets the DefaultStorageReadWritePolicy property

property defaultStorageSize string get · set

Gets the DefaultStorageSize property

property defaultStorageType string get · set

Gets the DefaultStorageType property

property helmChartDescription string get · set

Gets the HelmChartDescription property

property helmChartName string get · set

Gets the HelmChartName property

property helmChartVersion string get · set

Gets the HelmChartVersion property

property kubeConfigPath string get · set

Gets the KubeConfigPath property

Methods

method addGateway builder

Adds a Kubernetes Gateway API Gateway resource

addGateway(name: string): KubernetesGatewayResource

Parameters

name string

Returns

KubernetesGatewayResource

method addIngress builder

Adds a Kubernetes Ingress resource for HTTP routing

addIngress(name: string): KubernetesIngressResource

Parameters

name string

Returns

KubernetesIngressResource

method addNodePool builder

Adds a named node pool to a Kubernetes environment

addNodePool(name: string): KubernetesNodePoolResource

Parameters

name string

Returns

KubernetesNodePoolResource

method configureDashboard builder

Configures the Aspire dashboard resource for the Kubernetes environment

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

Parameters

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

Returns

KubernetesEnvironmentResource

method withDashboard builder

Enables or disables the Aspire dashboard for the Kubernetes environment

withDashboard(enabled?: boolean): KubernetesEnvironmentResource

Parameters

enabled boolean optional = True

Returns

KubernetesEnvironmentResource

method withHelm builder

Configures Helm chart deployment settings

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

Parameters

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

Returns

KubernetesEnvironmentResource

method withProperties builder

Configures properties of a Kubernetes environment

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

Parameters

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

Returns

KubernetesEnvironmentResource