diff --git a/.projenrc.ts b/.projenrc.ts index a6f7646..0f0b730 100644 --- a/.projenrc.ts +++ b/.projenrc.ts @@ -32,6 +32,9 @@ const project = new cdk.JsiiProject({ distName: 'cdk8s-plone', module: 'cdk8s_plone', }, + // publishToGo: { + // moduleName: 'github.com/bluedynamics/cdk8s-plone-go', + // }, npmProvenance: true, npmAccess: NpmAccess.PUBLIC, }); diff --git a/API.md b/API.md index 7a4a337..818dcca 100644 --- a/API.md +++ b/API.md @@ -144,14 +144,14 @@ public readonly frontendServiceName: string; ```typescript import { PloneHttpcache } from '@bluedynamics/cdk8s-plone' -new PloneHttpcache(scope: Construct, id: string, options: PloneHttpCacheOptions) +new PloneHttpcache(scope: Construct, id: string, options: PloneHttpcacheOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | -| options | PloneHttpCacheOptions | *No description.* | +| options | PloneHttpcacheOptions | *No description.* | --- @@ -169,7 +169,7 @@ new PloneHttpcache(scope: Construct, id: string, options: PloneHttpCacheOptions) ##### `options`Required -- *Type:* PloneHttpCacheOptions +- *Type:* PloneHttpcacheOptions --- @@ -500,32 +500,32 @@ public readonly requestMemory: string; --- -### PloneHttpCacheOptions +### PloneHttpcacheOptions -#### Initializer +#### Initializer ```typescript -import { PloneHttpCacheOptions } from '@bluedynamics/cdk8s-plone' +import { PloneHttpcacheOptions } from '@bluedynamics/cdk8s-plone' -const ploneHttpCacheOptions: PloneHttpCacheOptions = { ... } +const ploneHttpcacheOptions: PloneHttpcacheOptions = { ... } ``` #### Properties | **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. | +| 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. | --- -##### `plone`Required +##### `plone`Required ```typescript public readonly plone: Plone; @@ -538,7 +538,7 @@ plone chart. --- -##### `existingSecret`Optional +##### `existingSecret`Optional ```typescript public readonly existingSecret: string; @@ -551,7 +551,7 @@ existingSecret - Read admin credentials from user provided secret. --- -##### `limitCpu`Optional +##### `limitCpu`Optional ```typescript public readonly limitCpu: string; @@ -561,7 +561,7 @@ public readonly limitCpu: string; --- -##### `limitMemory`Optional +##### `limitMemory`Optional ```typescript public readonly limitMemory: string; @@ -571,7 +571,7 @@ public readonly limitMemory: string; --- -##### `requestCpu`Optional +##### `requestCpu`Optional ```typescript public readonly requestCpu: string; @@ -581,7 +581,7 @@ public readonly requestCpu: string; --- -##### `requestMemory`Optional +##### `requestMemory`Optional ```typescript public readonly requestMemory: string; @@ -591,7 +591,7 @@ public readonly requestMemory: string; --- -##### `varnishVcl`Optional +##### `varnishVcl`Optional ```typescript public readonly varnishVcl: string; @@ -604,7 +604,7 @@ varnishVcl. --- -##### `varnishVclFile`Optional +##### `varnishVclFile`Optional ```typescript public readonly varnishVclFile: string; diff --git a/src/httpcache.ts b/src/httpcache.ts index c5c6af1..672eb87 100644 --- a/src/httpcache.ts +++ b/src/httpcache.ts @@ -4,7 +4,7 @@ import { Helm } from 'cdk8s'; import { Construct } from 'constructs'; import { Plone } from './plone'; -export interface PloneHttpCacheOptions { +export interface PloneHttpcacheOptions { /** * plone chart * @default - none @@ -38,7 +38,7 @@ export class PloneHttpcache extends Construct { public readonly httpcacheServiceName: string; - constructor(scope: Construct, id: string, options: PloneHttpCacheOptions) { + constructor(scope: Construct, id: string, options: PloneHttpcacheOptions) { super(scope, id); let varnishVcl: string; if (!options.varnishVcl) { @@ -49,7 +49,6 @@ export class PloneHttpcache extends Construct { vclPath = options.varnishVclFile; } varnishVcl = fs.readFileSync(vclPath, 'utf8'); - throw new Error(varnishVcl); } else { varnishVcl = options.varnishVcl; } diff --git a/src/index.ts b/src/index.ts index 8596e84..4386166 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,2 +1,2 @@ export { Plone, PloneOptions, PloneBaseOptions } from './plone'; -export { PloneHttpcache, PloneHttpCacheOptions } from './httpcache'; +export { PloneHttpcache, PloneHttpcacheOptions } from './httpcache';