cdk8s
Version:
This is the core library of Cloud Development Kit (CDK) for Kubernetes (cdk8s). cdk8s apps synthesize into standard Kubernetes manifests which can be applied to any Kubernetes cluster.
110 lines • 12.4 kB
JavaScript
;
var _a;
Object.defineProperty(exports, "__esModule", { value: true });
exports.Chart = void 0;
const JSII_RTTI_SYMBOL_1 = Symbol.for("jsii.rtti");
const constructs_1 = require("constructs");
const api_object_1 = require("./api-object");
const app_1 = require("./app");
const names_1 = require("./names");
const CHART_SYMBOL = Symbol.for('cdk8s.Chart');
const CRONJOB = 'CronJob';
class Chart extends constructs_1.Construct {
/**
* Return whether the given object is a Chart.
*
* We do attribute detection since we can't reliably use 'instanceof'.
*/
static isChart(x) {
return x !== null && typeof (x) === 'object' && CHART_SYMBOL in x;
}
/**
* Implements `instanceof Chart` using the more reliable `Chart.isChart` static method
*
* @param o The object to check
* @internal
*/
static [(_a = JSII_RTTI_SYMBOL_1, Symbol.hasInstance)](o) {
return Chart.isChart(o);
}
/**
* Finds the chart in which a node is defined.
* @param c a construct node
*/
static of(c) {
if (Chart.isChart(c)) {
return c;
}
const parent = c.node.scope;
if (!parent) {
throw new Error('cannot find a parent chart (directly or indirectly)');
}
return Chart.of(parent);
}
constructor(scope, id, props = {}) {
super(scope, id);
this.namespace = props.namespace;
this._labels = props.labels ?? {};
this._disableResourceNameHashes = props.disableResourceNameHashes ?? false;
Object.defineProperty(this, CHART_SYMBOL, { value: true });
}
/**
* Labels applied to all resources in this chart.
*
* This is an immutable copy.
*/
get labels() {
return { ...this._labels };
}
/**
* Generates a app-unique name for an object given it's construct node path.
*
* Different resource types may have different constraints on names
* (`metadata.name`). The previous version of the name generator was
* compatible with DNS_SUBDOMAIN but not with DNS_LABEL.
*
* For example, `Deployment` names must comply with DNS_SUBDOMAIN while
* `Service` names must comply with DNS_LABEL.
*
* Since there is no formal specification for this, the default name
* generation scheme for kubernetes objects in cdk8s was changed to DNS_LABEL,
* since it’s the common denominator for all kubernetes resources
* (supposedly).
*
* You can override this method if you wish to customize object names at the
* chart level.
*
* @param apiObject The API object to generate a name for.
*/
generateObjectName(apiObject) {
return names_1.Names.toDnsLabel(apiObject, {
includeHash: !this._disableResourceNameHashes,
maxLen: apiObject.kind == CRONJOB ? 52 : undefined,
});
}
/**
* Create a dependency between this Chart and other constructs.
* These can be other ApiObjects, Charts, or custom.
*
* @param dependencies the dependencies to add.
*/
addDependency(...dependencies) {
this.node.addDependency(...dependencies);
}
/**
* Renders this chart to a set of Kubernetes JSON resources.
* @returns array of resource manifests
*/
toJson() {
return app_1.App._synthChart(this);
}
/**
* Returns all the included API objects.
*/
get apiObjects() {
return this.node.children.filter((o) => o instanceof api_object_1.ApiObject);
}
}
exports.Chart = Chart;
Chart[_a] = { fqn: "cdk8s.Chart", version: "2.70.4" };
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"chart.js","sourceRoot":"","sources":["../src/chart.ts"],"names":[],"mappings":";;;;;AAAA,2CAAmD;AACnD,6CAAyC;AACzC,+BAA4B;AAC5B,mCAAgC;AAEhC,MAAM,YAAY,GAAG,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;AAC/C,MAAM,OAAO,GAAG,SAAS,CAAC;AA6B1B,MAAa,KAAM,SAAQ,sBAAS;IAClC;;;;OAIG;IACI,MAAM,CAAC,OAAO,CAAC,CAAM;QAC1B,OAAO,CAAC,KAAK,IAAI,IAAI,OAAM,CAAC,CAAC,CAAC,KAAK,QAAQ,IAAI,YAAY,IAAI,CAAC,CAAC;IACnE,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,2BAAC,MAAM,CAAC,WAAW,EAAC,CAAC,CAAU;QACpC,OAAO,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,EAAE,CAAC,CAAa;QAC5B,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;YACrB,OAAO,CAAC,CAAC;QACX,CAAC;QAED,MAAM,MAAM,GAAG,CAAC,CAAC,IAAI,CAAC,KAAkB,CAAC;QACzC,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;QACzE,CAAC;QAED,OAAO,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;IAC1B,CAAC;IAiBD,YAAY,KAAgB,EAAE,EAAU,EAAE,QAAoB,EAAG;QAC/D,KAAK,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACjB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,MAAM,IAAI,EAAE,CAAC;QAClC,IAAI,CAAC,0BAA0B,GAAG,KAAK,CAAC,yBAAyB,IAAI,KAAK,CAAC;QAE3E,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IACH,IAAW,MAAM;QACf,OAAO,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACI,kBAAkB,CAAC,SAAoB;QAC5C,OAAO,aAAK,CAAC,UAAU,CAAC,SAAS,EAAE;YACjC,WAAW,EAAE,CAAC,IAAI,CAAC,0BAA0B;YAC7C,MAAM,EAAE,SAAS,CAAC,IAAI,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS;SACnD,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,aAAa,CAAC,GAAG,YAA0B;QAChD,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,YAAY,CAAC,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACI,MAAM;QACX,OAAO,SAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED;;OAEG;IACH,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAkB,EAAE,CAAC,CAAC,YAAY,sBAAS,CAAC,CAAC;IAClF,CAAC;;AAxHH,sBAyHC","sourcesContent":["import { Construct, IConstruct } from 'constructs';\nimport { ApiObject } from './api-object';\nimport { App } from './app';\nimport { Names } from './names';\n\nconst CHART_SYMBOL = Symbol.for('cdk8s.Chart');\nconst CRONJOB = 'CronJob';\n\nexport interface ChartProps {\n  /**\n   * The default namespace for all objects defined in this chart (directly or\n   * indirectly). This namespace will only apply to objects that don't have a\n   * `namespace` explicitly defined for them.\n   *\n   * @default - no namespace is synthesized (usually this implies \"default\")\n   */\n  readonly namespace?: string;\n\n  /**\n   * Labels to apply to all resources in this chart.\n   *\n   * @default - no common labels\n   */\n  readonly labels?: { [name: string]: string };\n\n  /**\n   * The autogenerated resource name by default is suffixed with a stable hash\n   * of the construct path. Setting this property to true drops the hash suffix.\n   *\n   * @default false\n   */\n  readonly disableResourceNameHashes?: boolean;\n\n}\n\nexport class Chart extends Construct {\n  /**\n   * Return whether the given object is a Chart.\n   *\n   * We do attribute detection since we can't reliably use 'instanceof'.\n   */\n  public static isChart(x: any): x is Chart {\n    return x !== null && typeof(x) === 'object' && CHART_SYMBOL in x;\n  }\n\n  /**\n   * Implements `instanceof Chart` using the more reliable `Chart.isChart` static method\n   *\n   * @param o The object to check\n   * @internal\n   */\n  static [Symbol.hasInstance](o: unknown) {\n    return Chart.isChart(o);\n  }\n\n  /**\n   * Finds the chart in which a node is defined.\n   * @param c a construct node\n   */\n  public static of(c: IConstruct): Chart {\n    if (Chart.isChart(c)) {\n      return c;\n    }\n\n    const parent = c.node.scope as Construct;\n    if (!parent) {\n      throw new Error('cannot find a parent chart (directly or indirectly)');\n    }\n\n    return Chart.of(parent);\n  }\n\n  /**\n   * The default namespace for all objects in this chart.\n   */\n  public readonly namespace?: string;\n\n  /**\n   * Chart-level labels.\n   */\n  private readonly _labels?: { [name: string]: string };\n\n  /**\n   * Determines if resource names in the chart have the suffixed hash.\n   */\n  private readonly _disableResourceNameHashes?: boolean;\n\n  constructor(scope: Construct, id: string, props: ChartProps = { }) {\n    super(scope, id);\n    this.namespace = props.namespace;\n    this._labels = props.labels ?? {};\n    this._disableResourceNameHashes = props.disableResourceNameHashes ?? false;\n\n    Object.defineProperty(this, CHART_SYMBOL, { value: true });\n  }\n\n  /**\n   * Labels applied to all resources in this chart.\n   *\n   * This is an immutable copy.\n   */\n  public get labels(): { [name: string]: string } {\n    return { ...this._labels };\n  }\n\n  /**\n   * Generates a app-unique name for an object given it's construct node path.\n   *\n   * Different resource types may have different constraints on names\n   * (`metadata.name`). The previous version of the name generator was\n   * compatible with DNS_SUBDOMAIN but not with DNS_LABEL.\n   *\n   * For example, `Deployment` names must comply with DNS_SUBDOMAIN while\n   * `Service` names must comply with DNS_LABEL.\n   *\n   * Since there is no formal specification for this, the default name\n   * generation scheme for kubernetes objects in cdk8s was changed to DNS_LABEL,\n   * since it’s the common denominator for all kubernetes resources\n   * (supposedly).\n   *\n   * You can override this method if you wish to customize object names at the\n   * chart level.\n   *\n   * @param apiObject The API object to generate a name for.\n   */\n  public generateObjectName(apiObject: ApiObject) {\n    return Names.toDnsLabel(apiObject, {\n      includeHash: !this._disableResourceNameHashes,\n      maxLen: apiObject.kind == CRONJOB ? 52 : undefined,\n    });\n  }\n\n  /**\n   * Create a dependency between this Chart and other constructs.\n   * These can be other ApiObjects, Charts, or custom.\n   *\n   * @param dependencies the dependencies to add.\n   */\n  public addDependency(...dependencies: IConstruct[]) {\n    this.node.addDependency(...dependencies);\n  }\n\n  /**\n   * Renders this chart to a set of Kubernetes JSON resources.\n   * @returns array of resource manifests\n   */\n  public toJson(): any[] {\n    return App._synthChart(this);\n  }\n\n  /**\n   * Returns all the included API objects.\n   */\n  get apiObjects(): ApiObject[] {\n    return this.node.children.filter((o): o is ApiObject => o instanceof ApiObject);\n  }\n}\n"]}