import { Plone } from '@bluedynamics/cdk8s-plone'
new Plone(scope: Construct, id: string, options?: PloneOptions)
Name | Type | Description |
---|---|---|
scope |
constructs.Construct |
No description. |
id |
string |
No description. |
options |
PloneOptions |
No description. |
- Type: constructs.Construct
- Type: string
- Type: PloneOptions
Name | Description |
---|---|
toString |
Returns a string representation of this construct. |
public toString(): string
Returns a string representation of this construct.
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
import { Plone } from '@bluedynamics/cdk8s-plone'
Plone.isConstruct(x: any)
Checks if x
is a construct.
Use this method instead of instanceof
to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs
library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct
in each copy of the constructs
library
is seen as a different class, and an instance of one class will not test as
instanceof
the other class. npm install
will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof
will behave
unpredictably. It is safest to avoid using instanceof
, and using
this type-testing method instead.
- Type: any
Any object.
Name | Type | Description |
---|---|---|
node |
constructs.Node |
The tree node. |
backendServiceName |
string |
No description. |
siteId |
string |
No description. |
variant |
PloneVariant |
No description. |
frontendServiceName |
string |
No description. |
public readonly node: Node;
- Type: constructs.Node
The tree node.
public readonly backendServiceName: string;
- Type: string
public readonly siteId: string;
- Type: string
public readonly variant: PloneVariant;
- Type: PloneVariant
public readonly frontendServiceName: string;
- Type: string
import { PloneHttpcache } from '@bluedynamics/cdk8s-plone'
new PloneHttpcache(scope: Construct, id: string, options: PloneHttpcacheOptions)
Name | Type | Description |
---|---|---|
scope |
constructs.Construct |
No description. |
id |
string |
No description. |
options |
PloneHttpcacheOptions |
No description. |
- Type: constructs.Construct
- Type: string
- Type: PloneHttpcacheOptions
Name | Description |
---|---|
toString |
Returns a string representation of this construct. |
public toString(): string
Returns a string representation of this construct.
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
import { PloneHttpcache } from '@bluedynamics/cdk8s-plone'
PloneHttpcache.isConstruct(x: any)
Checks if x
is a construct.
Use this method instead of instanceof
to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs
library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct
in each copy of the constructs
library
is seen as a different class, and an instance of one class will not test as
instanceof
the other class. npm install
will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof
will behave
unpredictably. It is safest to avoid using instanceof
, and using
this type-testing method instead.
- Type: any
Any object.
Name | Type | Description |
---|---|---|
node |
constructs.Node |
The tree node. |
httpcacheServiceName |
string |
No description. |
public readonly node: Node;
- Type: constructs.Node
The tree node.
public readonly httpcacheServiceName: string;
- Type: string
import { PloneBaseOptions } from '@bluedynamics/cdk8s-plone'
const ploneBaseOptions: PloneBaseOptions = { ... }
Name | Type | Description |
---|---|---|
environment |
cdk8s-plus-24.Env |
No description. |
image |
string |
No description. |
imagePullPolicy |
string |
No description. |
limitCpu |
string |
No description. |
limitMemory |
string |
No description. |
livenessEnabled |
boolean |
No description. |
livenessFailureThreshold |
number |
No description. |
livenessIimeoutSeconds |
number |
No description. |
livenessInitialDelaySeconds |
number |
No description. |
livenessPeriodSeconds |
number |
No description. |
livenessSuccessThreshold |
number |
No description. |
maxUnavailable |
string | number |
No description. |
minAvailable |
string | number |
No description. |
readinessEnabled |
boolean |
No description. |
readinessFailureThreshold |
number |
No description. |
readinessIimeoutSeconds |
number |
No description. |
readinessInitialDelaySeconds |
number |
No description. |
readinessPeriodSeconds |
number |
No description. |
readinessSuccessThreshold |
number |
No description. |
replicas |
number |
No description. |
requestCpu |
string |
No description. |
requestMemory |
string |
No description. |
public readonly environment: Env;
- Type: cdk8s-plus-24.Env
public readonly image: string;
- Type: string
public readonly imagePullPolicy: string;
- Type: string
public readonly limitCpu: string;
- Type: string
public readonly limitMemory: string;
- Type: string
public readonly livenessEnabled: boolean;
- Type: boolean
public readonly livenessFailureThreshold: number;
- Type: number
public readonly livenessIimeoutSeconds: number;
- Type: number
public readonly livenessInitialDelaySeconds: number;
- Type: number
public readonly livenessPeriodSeconds: number;
- Type: number
public readonly livenessSuccessThreshold: number;
- Type: number
public readonly maxUnavailable: string | number;
- Type: string | number
public readonly minAvailable: string | number;
- Type: string | number
public readonly readinessEnabled: boolean;
- Type: boolean
public readonly readinessFailureThreshold: number;
- Type: number
public readonly readinessIimeoutSeconds: number;
- Type: number
public readonly readinessInitialDelaySeconds: number;
- Type: number
public readonly readinessPeriodSeconds: number;
- Type: number
public readonly readinessSuccessThreshold: number;
- Type: number
public readonly replicas: number;
- Type: number
public readonly requestCpu: string;
- Type: string
public readonly requestMemory: string;
- Type: string
import { PloneHttpcacheOptions } from '@bluedynamics/cdk8s-plone'
const ploneHttpcacheOptions: PloneHttpcacheOptions = { ... }
Name | Type | Description |
---|---|---|
plone |
Plone |
plone chart. |
existingSecret |
string |
existingSecret - Read admin credentials from user provided secret. |
limitCpu |
string |
No description. |
limitMemory |
string |
No description. |
requestCpu |
string |
No description. |
requestMemory |
string |
No description. |
varnishVcl |
string |
varnishVcl. |
varnishVclFile |
string |
varnishVclFile. |
public readonly plone: Plone;
- Type: Plone
- Default: none
plone chart.
public readonly existingSecret: string;
- Type: string
- Default: undefined
existingSecret - Read admin credentials from user provided secret.
public readonly limitCpu: string;
- Type: string
public readonly limitMemory: string;
- Type: string
public readonly requestCpu: string;
- Type: string
public readonly requestMemory: string;
- Type: string
public readonly varnishVcl: string;
- Type: string
- Default: file in config folder
varnishVcl.
public readonly varnishVclFile: string;
- Type: string
- Default: undefined
varnishVclFile.
import { PloneOptions } from '@bluedynamics/cdk8s-plone'
const ploneOptions: PloneOptions = { ... }
Name | Type | Description |
---|---|---|
backend |
PloneBaseOptions |
No description. |
frontend |
PloneBaseOptions |
No description. |
imagePullSecrets |
string[] |
No description. |
siteId |
string |
No description. |
variant |
PloneVariant |
No description. |
version |
string |
No description. |
public readonly backend: PloneBaseOptions;
- Type: PloneBaseOptions
public readonly frontend: PloneBaseOptions;
- Type: PloneBaseOptions
public readonly imagePullSecrets: string[];
- Type: string[]
public readonly siteId: string;
- Type: string
public readonly variant: PloneVariant;
- Type: PloneVariant
public readonly version: string;
- Type: string
Name | Description |
---|---|
VOLTO |
No description. |
CLASSICUI |
No description. |