Class ApiWSGI

Hierarchy (View Summary)

ApiComponent<ApiWSGIProps>
- ApiWSGI

Implements

IHttpProbable

Index

Constructors

Properties

collectStaticJob config deployment httpProbePath id migrateJob node props scaling? scope vpa? componentName

Accessors

Methods

addContainer addPdb createContainerProps createDeployment createDeploymentProps createHttpProbes getResources mountCsiSecrets supportsProbes

Constructors

constructor

new ApiWSGI(scope: Construct, id: string, props: ApiWSGIProps): ApiWSGI
Parameters
- scope: Construct
- id: string
- props: ApiWSGIProps
Returns ApiWSGI
Overrides ApiComponent.constructor
- Defined in packages/k8s/construct/api/src/api.ts:195

Properties

`Readonly`collectStaticJob

collectStaticJob: Job

`Readonly`config

config: IApiConfig

`Readonly`deployment

deployment: Deployment

`Readonly`httpProbePath

httpProbePath: "/health" = '/health'

`Readonly`id

id: string

`Readonly`migrateJob

migrateJob: Job

`Readonly`node

node: Node

`Readonly`props

props: ApiWSGIProps

`Optional` `Readonly`scaling

scaling?: ComponentScaling

`Readonly`scope

scope: Construct

`Optional` `Readonly`vpa

vpa?: VerticalPodAutoscaler

`Static`componentName

componentName: string = 'wsgi'

Accessors

containers

get containers(): Map<string, Container>
Returns Map<string, Container>
Inherited from ApiComponent.containers
- Defined in packages/k8s/construct/component/dist/index.d.mts:233

Methods

addContainer

addContainer(props: ComponentContainerProps): Container
Parameters
- props: ComponentContainerProps
Returns Container
Inherited from ApiComponent.addContainer
- Defined in packages/k8s/construct/component/dist/index.d.mts:238

addPdb

addPdb(props: PodDisruptionBudgetProps): this
Parameters
- props: PodDisruptionBudgetProps
Returns this
Inherited from ApiComponent.addPdb
- Defined in packages/k8s/construct/component/dist/index.d.mts:239

`Protected`createContainerProps

createContainerProps(
source: Partial<kplus.ContainerProps>,
...props: Partial<ContainerProps>[],
): ContainerProps
Parameters
- source: Partial<kplus.ContainerProps>
- ...props: Partial<ContainerProps>[]
Returns ContainerProps
Inherited from ApiComponent.createContainerProps
- Defined in packages/k8s/construct/component/dist/index.d.mts:237

`Protected`createDeployment

createDeployment(props: DeploymentProps): Deployment
Parameters
- props: DeploymentProps
Returns Deployment
Inherited from ApiComponent.createDeployment
- Defined in packages/k8s/construct/component/dist/index.d.mts:236

`Protected`createDeploymentProps

createDeploymentProps(): DeploymentProps
Returns DeploymentProps
Inherited from ApiComponent.createDeploymentProps
- Defined in packages/k8s/construct/component/dist/index.d.mts:235

`Protected`createHttpProbes

createHttpProbes(
httpPath: string,
): Pick<kplus.ContainerProps, "readiness" | "liveness" | "startup">
Parameters
- httpPath: string
Returns Pick<kplus.ContainerProps, "readiness" | "liveness" | "startup">
Inherited from ApiComponent.createHttpProbes
- Defined in packages/k8s/construct/api/src/api.ts:143

`Protected`getResources

getResources(defaults?: ContainerResourceProps): ContainerResources
Parameters
- Optionaldefaults: ContainerResourceProps
Returns ContainerResources
Inherited from ApiComponent.getResources
- Defined in packages/k8s/construct/component/dist/index.d.mts:234

mountCsiSecrets

mountCsiSecrets(
csiVolume: Volume,
secretNames: [key: string, env_name: EnvValue][],
): void
Parameters
- csiVolume: Volume
- secretNames: [key: string, env_name: EnvValue][]
Returns void
Inherited from ApiComponent.mountCsiSecrets
- Defined in packages/k8s/construct/api/src/api.ts:171

`Static`supportsProbes

supportsProbes<T extends Construct>(
construct: T,
): construct is T & IHttpProbable
Type Parameters
- T extends Construct
Parameters
- construct: T
Returns construct is T & IHttpProbable
Inherited from ApiComponent.supportsProbes
- Defined in packages/k8s/construct/api/src/api.ts:81