@openfabr/cdf / Exports / cdk8s
Namespace: cdk8s
Table of contents
For project creators
For project creators
• ProjectChart<IPC, GC, NC, CC, SC, RC>: Object
Chart as top-level construct with cdk8s as IaC runtime.
Type parameters
| Name | Type |
|---|---|
IPC | extends InfraPlanConstructs |
GC | extends GeneralConfig |
NC | extends NetworkConfig |
CC | extends ComponentConfig |
SC | extends ServiceConfig |
RC | extends RelationConfig |
Defined in
src/lib/bootstrap/cdk8s/chart.ts:38
• ProjectChartProps<IPC, GC, NC, CC, SC, RC>: Object
Properties for ProjectChart.
Type parameters
| Name | Type |
|---|---|
IPC | extends InfraPlanConstructs |
GC | extends GeneralConfig |
NC | extends NetworkConfig |
CC | extends ComponentConfig |
SC | extends ServiceConfig |
RC | extends RelationConfig |
Defined in
src/lib/bootstrap/cdk8s/chart.ts:21
initProjectChart
▸ initProjectChart<IPC, GC, NC, CC, SC, RC>(scope, config, planner, modules, name?, handler?): ProjectChart<IPC, GC, NC, CC, SC, RC>
Convenient function that constructs a top-level chart with cdk8s as IaC runtime.
Type parameters
| Name | Type |
|---|---|
IPC | extends InfraPlanConstructs |
GC | extends GeneralConfig |
NC | extends NetworkConfig |
CC | extends ComponentConfig |
SC | extends ServiceConfig |
RC | extends RelationConfig |
Parameters
| Name | Type | Description |
|---|---|---|
scope | App | Parent construct, usually an App instance in cdk8s. |
config | InfraConfig<GC, NC, CC, SC, RC> | The project configuration. |
planner | Planner<IPC, GC, NC, CC, SC, RC> | The planner offered by the package. |
modules | Custom<IPC, GC, NC, CC, SC, RC>[] | Custom code modules for the project. |
name? | string | Optionally the name of the resulting chart. |
handler? | ResultHandler | Optionally the result handler. |
Returns
ProjectChart<IPC, GC, NC, CC, SC, RC>
A top-level chart to be provisioned in a project.