[![build](https://github.com/cloud-native-toolkit/cdk8s-pipelines-lib/actions/workflows/build.yml/badge.svg)](https://github.com/cloud-native-toolkit/cdk8s-pipelines-lib/actions/workflows/build.yml) [![View on Construct Hub](https://constructs.dev/badge?package=cdk8s-pipelines-lib)](https://constructs.dev/packages/cdk8s-pipelines-lib) # Pipeline Library of cdk8s Constructs This is a library of several "pattern" pipelines that are intended to be basic and therefore easily reusable. Additionally, using the `TaskBuilder`, each `Task` (see [Tasks](https://tekton.dev/docs/getting-started/tasks/)) from [Tekton Hub](https://hub.tekton.dev/) can be found in this library as a construct. ## Using tasks from Tekton Hub The following is an example chart that uses a Tekton Hub Task for an [OpenShift client](https://hub.tekton.dev/tekton/task/openshift-client). ```ts import { App, Chart, ChartProps } from 'cdk8s'; import { ParameterBuilder, PipelineBuilder } from 'cdk8s-pipelines'; import { openshift_client } from 'cdk8s-pipelines-lib'; import { Construct } from 'constructs'; export class MyChart extends Chart { constructor(scope: Construct, id: string, props: ChartProps = {}) { super(scope, id, props); const projectName = 'my-project'; const createProject = openshift_client(this, 'create-project') .withStringParam(new ParameterBuilder('SCRIPT') .withValue(`oc create ${projectName}`)); new PipelineBuilder(this, 'create-some-namespace') .withDescription('Creates a namespace and then does some other stuff') .withTask(createProject) // ... more tasks go here .buildPipeline({ includeDependencies: true }); } } const app = new App(); new MyChart(app, 'hello'); app.synth(); ``` The result of this code will include the dependent tasks. The output will look like this: ```yaml apiVersion: tekton.dev/v1 kind: Task metadata: name: openshift-client spec: description: null workspaces: - name: manifest-dir description: The workspace which contains kubernetes manifests which we want to apply on the cluster. - name: kubeconfig-dir description: The workspace which contains the the kubeconfig file if in case we want to run the oc command on another cluster. params: - name: SCRIPT description: "" default: null - name: VERSION description: The OpenShift Version to use default: "4.7" steps: - name: oc image: quay.io/openshift/origin-cli:$(params.VERSION) script: | #!/usr/bin/env bash [[ "$(workspaces.manifest-dir.bound)" == "true" ]] && \ cd $(workspaces.manifest-dir.path) [[ "$(workspaces.kubeconfig-dir.bound)" == "true" ]] && \ [[ -f $(workspaces.kubeconfig-dir.path)/kubeconfig ]] && \ export KUBECONFIG=$(workspaces.kubeconfig-dir.path)/kubeconfig $(params.SCRIPT) workingDir: null env: null --- apiVersion: tekton.dev/v1 kind: Pipeline metadata: name: create-some-namespace spec: description: Creates a namespace and then does some other stuff params: - name: VERSION type: string workspaces: - name: manifest-dir description: The workspace which contains kubernetes manifests which we want to apply on the cluster. - name: kubeconfig-dir description: The workspace which contains the the kubeconfig file if in case we want to run the oc command on another cluster. tasks: - name: create-project taskRef: name: openshift-client params: - name: SCRIPT value: oc create my-project - name: VERSION value: $(params.VERSION) workspaces: - name: manifest-dir workspace: manifest-dir - name: kubeconfig-dir workspace: kubeconfig-dir ``` ## Using in a build The goal of using cdk8s-pipeline and cdk8s-pipeline-lib should be to produce YAML artifacts in a build process that are included in the release of a project. As an example, see [this example AWS CDK project](https://github.ibm.com/Nathan-Good/example-cdk-aws-ec2-vm), which demonstrates how to include the output created by the CDK `synth()` in the output of the build as a versioned release. # API Reference ## Constructs ### AWSCDKPipelineChart The chart for creating a Tekton Pipeline that will use an AWS CDK project to create resources in AWS for re-usable artifacts. #### Initializers ```typescript import { AWSCDKPipelineChart } from 'cdk8s-pipelines-lib' new AWSCDKPipelineChart(scope: Construct, id: string, props?: AWSCDKPipelineChartProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | AWSCDKPipelineChartProps | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- ##### `props`Optional - *Type:* AWSCDKPipelineChartProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | addDependency | Create a dependency between this Chart and other constructs. | | generateObjectName | Generates a app-unique name for an object given it's construct node path. | | toJson | Renders this chart to a set of Kubernetes JSON resources. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `addDependency` ```typescript public addDependency(dependencies: IConstruct): void ``` Create a dependency between this Chart and other constructs. These can be other ApiObjects, Charts, or custom. ###### `dependencies`Required - *Type:* constructs.IConstruct the dependencies to add. --- ##### `generateObjectName` ```typescript public generateObjectName(apiObject: ApiObject): string ``` 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. ###### `apiObject`Required - *Type:* cdk8s.ApiObject The API object to generate a name for. --- ##### `toJson` ```typescript public toJson(): any[] ``` Renders this chart to a set of Kubernetes JSON resources. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isChart | Return whether the given object is a Chart. | | of | Finds the chart in which a node is defined. | --- ##### ~~`isConstruct`~~ ```typescript import { AWSCDKPipelineChart } from 'cdk8s-pipelines-lib' AWSCDKPipelineChart.isConstruct(x: any) ``` Checks if `x` is a construct. ###### `x`Required - *Type:* any Any object. --- ##### `isChart` ```typescript import { AWSCDKPipelineChart } from 'cdk8s-pipelines-lib' AWSCDKPipelineChart.isChart(x: any) ``` Return whether the given object is a Chart. We do attribute detection since we can't reliably use 'instanceof'. ###### `x`Required - *Type:* any --- ##### `of` ```typescript import { AWSCDKPipelineChart } from 'cdk8s-pipelines-lib' AWSCDKPipelineChart.of(c: IConstruct) ``` Finds the chart in which a node is defined. ###### `c`Required - *Type:* constructs.IConstruct a construct node. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | apiObjects | cdk8s.ApiObject[] | Returns all the included API objects. | | labels | {[ key: string ]: string} | Labels applied to all resources in this chart. | | namespace | string | The default namespace for all objects in this chart. | --- ##### `node`Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `apiObjects`Required ```typescript public readonly apiObjects: ApiObject[]; ``` - *Type:* cdk8s.ApiObject[] Returns all the included API objects. --- ##### `labels`Required ```typescript public readonly labels: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Labels applied to all resources in this chart. This is an immutable copy. --- ##### `namespace`Optional ```typescript public readonly namespace: string; ``` - *Type:* string The default namespace for all objects in this chart. --- ## Structs ### AWSCDKPipelineChartProps Initialization properties for the AWSCDKPipelineChart. #### Initializer ```typescript import { AWSCDKPipelineChartProps } from 'cdk8s-pipelines-lib' const aWSCDKPipelineChartProps: AWSCDKPipelineChartProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | disableResourceNameHashes | boolean | The autogenerated resource name by default is suffixed with a stable hash of the construct path. | | labels | {[ key: string ]: string} | Labels to apply to all resources in this chart. | | namespace | string | The default namespace for all objects defined in this chart (directly or indirectly). | | params | string[] | *No description.* | --- ##### `disableResourceNameHashes`Optional ```typescript public readonly disableResourceNameHashes: boolean; ``` - *Type:* boolean - *Default:* false The autogenerated resource name by default is suffixed with a stable hash of the construct path. Setting this property to true drops the hash suffix. --- ##### `labels`Optional ```typescript public readonly labels: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} - *Default:* no common labels Labels to apply to all resources in this chart. --- ##### `namespace`Optional ```typescript public readonly namespace: string; ``` - *Type:* string - *Default:* no namespace is synthesized (usually this implies "default") The default namespace for all objects defined in this chart (directly or indirectly). This namespace will only apply to objects that don't have a `namespace` explicitly defined for them. --- ##### `params`Optional ```typescript public readonly params: string[]; ``` - *Type:* string[] --- ### GitRepoConfig Contains the information for the GitHub repo and the stack so we can go get it and generate the AWS CDK pipeline. #### Initializer ```typescript import { GitRepoConfig } from 'cdk8s-pipelines-lib' const gitRepoConfig: GitRepoConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | ghUrl | string | The URL for the GitHub or GHE API. | | owner | string | The owner of the GitHub repository. | | release | string | The release tag for the release in which the AWS CDK template should be found. | | repo | string | The name of the repository. | | stackName | string | The name of the AWS CDK stack. | | token | string | The personal access token (PAT) for accessing the library in GitHub. | --- ##### `ghUrl`Optional ```typescript public readonly ghUrl: string; ``` - *Type:* string The URL for the GitHub or GHE API. The value should look like https://api.github.com or https://github.mycompany.com/api/v3. --- ##### `owner`Optional ```typescript public readonly owner: string; ``` - *Type:* string The owner of the GitHub repository. --- ##### `release`Optional ```typescript public readonly release: string; ``` - *Type:* string The release tag for the release in which the AWS CDK template should be found. --- ##### `repo`Optional ```typescript public readonly repo: string; ``` - *Type:* string The name of the repository. --- ##### `stackName`Optional ```typescript public readonly stackName: string; ``` - *Type:* string The name of the AWS CDK stack. This should be a generated template that is included in the release. --- ##### `token`Optional ```typescript public readonly token: string; ``` - *Type:* string The personal access token (PAT) for accessing the library in GitHub. --- ## Classes ### ApplyOlmSubscription01 #### Initializers ```typescript import { ApplyOlmSubscription01 } from 'cdk8s-pipelines-lib' new ApplyOlmSubscription01(scope: Construct, id: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | buildTask | Builds the `Task`. | | withAnnotation | Adds an annotation to the `Task` `metadata` with the provided key and value. | | withDescription | Sets the `description` of the `Task` being built. | | withLabel | Adds a label to the `Task` with the provided label key and value. | | withName | Sets the name of the `Task` being built. | | withResult | Allows you to add an result to the Task. | | withStep | Adds the given `step` (`TaskStepBuilder`) to the `Task`. | | withStringParam | Adds a parameter of type string to the `Task`. | | withWorkspace | Adds the specified workspace to the `Task`. | --- ##### `buildTask` ```typescript public buildTask(): void ``` Builds the `Task`. ##### `withAnnotation` ```typescript public withAnnotation(key: string, value: string): TaskBuilder ``` Adds an annotation to the `Task` `metadata` with the provided key and value. > [https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) ###### `key`Required - *Type:* string The annotation's key. --- ###### `value`Required - *Type:* string The annotation's value. --- ##### `withDescription` ```typescript public withDescription(description: string): TaskBuilder ``` Sets the `description` of the `Task` being built. ###### `description`Required - *Type:* string --- ##### `withLabel` ```typescript public withLabel(key: string, value: string): TaskBuilder ``` Adds a label to the `Task` with the provided label key and value. > [https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) ###### `key`Required - *Type:* string --- ###### `value`Required - *Type:* string --- ##### `withName` ```typescript public withName(name: string): TaskBuilder ``` Sets the name of the `Task` being built. ###### `name`Required - *Type:* string --- ##### `withResult` ```typescript public withResult(name: string, description: string): TaskBuilder ``` Allows you to add an result to the Task. > [https://tekton.dev/docs/pipelines/tasks/#emitting-results](https://tekton.dev/docs/pipelines/tasks/#emitting-results) ###### `name`Required - *Type:* string The name of the result. --- ###### `description`Required - *Type:* string The result's description. --- ##### `withStep` ```typescript public withStep(step: TaskStepBuilder): TaskBuilder ``` Adds the given `step` (`TaskStepBuilder`) to the `Task`. ###### `step`Required - *Type:* cdk8s-pipelines.TaskStepBuilder --- ##### `withStringParam` ```typescript public withStringParam(param: ParameterBuilder): TaskBuilder ``` Adds a parameter of type string to the `Task`. ###### `param`Required - *Type:* cdk8s-pipelines.ParameterBuilder --- ##### `withWorkspace` ```typescript public withWorkspace(workspace: WorkspaceBuilder): TaskBuilder ``` Adds the specified workspace to the `Task`. ###### `workspace`Required - *Type:* cdk8s-pipelines.WorkspaceBuilder --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | logicalID | string | *No description.* | | description | string | Gets the `description` of the `Task`. | | name | string | Gets the name of the `Task` built by the `TaskBuilder`. | | parameters | cdk8s-pipelines.ParameterBuilder[] | *No description.* | | workspaces | cdk8s-pipelines.WorkspaceBuilder[] | Gets the workspaces for the `Task`. | | delegate | cdk8s-pipelines.TaskBuilder | *No description.* | --- ##### `logicalID`Required ```typescript public readonly logicalID: string; ``` - *Type:* string --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string Gets the `description` of the `Task`. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string Gets the name of the `Task` built by the `TaskBuilder`. --- ##### `parameters`Optional ```typescript public readonly parameters: ParameterBuilder[]; ``` - *Type:* cdk8s-pipelines.ParameterBuilder[] --- ##### `workspaces`Optional ```typescript public readonly workspaces: WorkspaceBuilder[]; ``` - *Type:* cdk8s-pipelines.WorkspaceBuilder[] Gets the workspaces for the `Task`. --- ##### `delegate`Required ```typescript public readonly delegate: TaskBuilder; ``` - *Type:* cdk8s-pipelines.TaskBuilder --- ### ApplyOlmSubscription02 #### Initializers ```typescript import { ApplyOlmSubscription02 } from 'cdk8s-pipelines-lib' new ApplyOlmSubscription02(scope: Construct, id: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | buildTask | Builds the `Task`. | | withAnnotation | Adds an annotation to the `Task` `metadata` with the provided key and value. | | withDescription | Sets the `description` of the `Task` being built. | | withLabel | Adds a label to the `Task` with the provided label key and value. | | withName | Sets the name of the `Task` being built. | | withResult | Allows you to add an result to the Task. | | withStep | Adds the given `step` (`TaskStepBuilder`) to the `Task`. | | withStringParam | Adds a parameter of type string to the `Task`. | | withWorkspace | Adds the specified workspace to the `Task`. | --- ##### `buildTask` ```typescript public buildTask(): void ``` Builds the `Task`. ##### `withAnnotation` ```typescript public withAnnotation(key: string, value: string): TaskBuilder ``` Adds an annotation to the `Task` `metadata` with the provided key and value. > [https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) ###### `key`Required - *Type:* string The annotation's key. --- ###### `value`Required - *Type:* string The annotation's value. --- ##### `withDescription` ```typescript public withDescription(description: string): TaskBuilder ``` Sets the `description` of the `Task` being built. ###### `description`Required - *Type:* string --- ##### `withLabel` ```typescript public withLabel(key: string, value: string): TaskBuilder ``` Adds a label to the `Task` with the provided label key and value. > [https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) ###### `key`Required - *Type:* string --- ###### `value`Required - *Type:* string --- ##### `withName` ```typescript public withName(name: string): TaskBuilder ``` Sets the name of the `Task` being built. ###### `name`Required - *Type:* string --- ##### `withResult` ```typescript public withResult(name: string, description: string): TaskBuilder ``` Allows you to add an result to the Task. > [https://tekton.dev/docs/pipelines/tasks/#emitting-results](https://tekton.dev/docs/pipelines/tasks/#emitting-results) ###### `name`Required - *Type:* string The name of the result. --- ###### `description`Required - *Type:* string The result's description. --- ##### `withStep` ```typescript public withStep(step: TaskStepBuilder): TaskBuilder ``` Adds the given `step` (`TaskStepBuilder`) to the `Task`. ###### `step`Required - *Type:* cdk8s-pipelines.TaskStepBuilder --- ##### `withStringParam` ```typescript public withStringParam(param: ParameterBuilder): TaskBuilder ``` Adds a parameter of type string to the `Task`. ###### `param`Required - *Type:* cdk8s-pipelines.ParameterBuilder --- ##### `withWorkspace` ```typescript public withWorkspace(workspace: WorkspaceBuilder): TaskBuilder ``` Adds the specified workspace to the `Task`. ###### `workspace`Required - *Type:* cdk8s-pipelines.WorkspaceBuilder --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | logicalID | string | *No description.* | | description | string | Gets the `description` of the `Task`. | | name | string | Gets the name of the `Task` built by the `TaskBuilder`. | | parameters | cdk8s-pipelines.ParameterBuilder[] | *No description.* | | workspaces | cdk8s-pipelines.WorkspaceBuilder[] | Gets the workspaces for the `Task`. | | delegate | cdk8s-pipelines.TaskBuilder | *No description.* | --- ##### `logicalID`Required ```typescript public readonly logicalID: string; ``` - *Type:* string --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string Gets the `description` of the `Task`. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string Gets the name of the `Task` built by the `TaskBuilder`. --- ##### `parameters`Optional ```typescript public readonly parameters: ParameterBuilder[]; ``` - *Type:* cdk8s-pipelines.ParameterBuilder[] --- ##### `workspaces`Optional ```typescript public readonly workspaces: WorkspaceBuilder[]; ``` - *Type:* cdk8s-pipelines.WorkspaceBuilder[] Gets the workspaces for the `Task`. --- ##### `delegate`Required ```typescript public readonly delegate: TaskBuilder; ``` - *Type:* cdk8s-pipelines.TaskBuilder --- ### AWSCDKPipeline Creator for the AWSCDKPipelineChart. #### Initializers ```typescript import { AWSCDKPipeline } from 'cdk8s-pipelines-lib' new AWSCDKPipeline() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Static Functions | **Name** | **Description** | | --- | --- | | createFrom | Generates the AWS CDK Pipeline (AWSCDKPipelineChart) based on the actual project located in GitHub and specified by the configuration. | --- ##### `createFrom` ```typescript import { AWSCDKPipeline } from 'cdk8s-pipelines-lib' AWSCDKPipeline.createFrom(config: GitRepoConfig) ``` Generates the AWS CDK Pipeline (AWSCDKPipelineChart) based on the actual project located in GitHub and specified by the configuration. ###### `config`Required - *Type:* GitRepoConfig --- ### CreateExternalSecrets01 #### Initializers ```typescript import { CreateExternalSecrets01 } from 'cdk8s-pipelines-lib' new CreateExternalSecrets01(scope: Construct, id: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | buildTask | Builds the `Task`. | | withAnnotation | Adds an annotation to the `Task` `metadata` with the provided key and value. | | withDescription | Sets the `description` of the `Task` being built. | | withLabel | Adds a label to the `Task` with the provided label key and value. | | withName | Sets the name of the `Task` being built. | | withResult | Allows you to add an result to the Task. | | withStep | Adds the given `step` (`TaskStepBuilder`) to the `Task`. | | withStringParam | Adds a parameter of type string to the `Task`. | | withWorkspace | Adds the specified workspace to the `Task`. | --- ##### `buildTask` ```typescript public buildTask(): void ``` Builds the `Task`. ##### `withAnnotation` ```typescript public withAnnotation(key: string, value: string): TaskBuilder ``` Adds an annotation to the `Task` `metadata` with the provided key and value. > [https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) ###### `key`Required - *Type:* string The annotation's key. --- ###### `value`Required - *Type:* string The annotation's value. --- ##### `withDescription` ```typescript public withDescription(description: string): TaskBuilder ``` Sets the `description` of the `Task` being built. ###### `description`Required - *Type:* string --- ##### `withLabel` ```typescript public withLabel(key: string, value: string): TaskBuilder ``` Adds a label to the `Task` with the provided label key and value. > [https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) ###### `key`Required - *Type:* string --- ###### `value`Required - *Type:* string --- ##### `withName` ```typescript public withName(name: string): TaskBuilder ``` Sets the name of the `Task` being built. ###### `name`Required - *Type:* string --- ##### `withResult` ```typescript public withResult(name: string, description: string): TaskBuilder ``` Allows you to add an result to the Task. > [https://tekton.dev/docs/pipelines/tasks/#emitting-results](https://tekton.dev/docs/pipelines/tasks/#emitting-results) ###### `name`Required - *Type:* string The name of the result. --- ###### `description`Required - *Type:* string The result's description. --- ##### `withStep` ```typescript public withStep(step: TaskStepBuilder): TaskBuilder ``` Adds the given `step` (`TaskStepBuilder`) to the `Task`. ###### `step`Required - *Type:* cdk8s-pipelines.TaskStepBuilder --- ##### `withStringParam` ```typescript public withStringParam(param: ParameterBuilder): TaskBuilder ``` Adds a parameter of type string to the `Task`. ###### `param`Required - *Type:* cdk8s-pipelines.ParameterBuilder --- ##### `withWorkspace` ```typescript public withWorkspace(workspace: WorkspaceBuilder): TaskBuilder ``` Adds the specified workspace to the `Task`. ###### `workspace`Required - *Type:* cdk8s-pipelines.WorkspaceBuilder --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | logicalID | string | *No description.* | | description | string | Gets the `description` of the `Task`. | | name | string | Gets the name of the `Task` built by the `TaskBuilder`. | | parameters | cdk8s-pipelines.ParameterBuilder[] | *No description.* | | workspaces | cdk8s-pipelines.WorkspaceBuilder[] | Gets the workspaces for the `Task`. | | delegate | cdk8s-pipelines.TaskBuilder | *No description.* | --- ##### `logicalID`Required ```typescript public readonly logicalID: string; ``` - *Type:* string --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string Gets the `description` of the `Task`. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string Gets the name of the `Task` built by the `TaskBuilder`. --- ##### `parameters`Optional ```typescript public readonly parameters: ParameterBuilder[]; ``` - *Type:* cdk8s-pipelines.ParameterBuilder[] --- ##### `workspaces`Optional ```typescript public readonly workspaces: WorkspaceBuilder[]; ``` - *Type:* cdk8s-pipelines.WorkspaceBuilder[] Gets the workspaces for the `Task`. --- ##### `delegate`Required ```typescript public readonly delegate: TaskBuilder; ``` - *Type:* cdk8s-pipelines.TaskBuilder --- ### IbmcloudSecretsManagerGet01 #### Initializers ```typescript import { IbmcloudSecretsManagerGet01 } from 'cdk8s-pipelines-lib' new IbmcloudSecretsManagerGet01(scope: Construct, id: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | buildTask | Builds the `Task`. | | withAnnotation | Adds an annotation to the `Task` `metadata` with the provided key and value. | | withDescription | Sets the `description` of the `Task` being built. | | withLabel | Adds a label to the `Task` with the provided label key and value. | | withName | Sets the name of the `Task` being built. | | withResult | Allows you to add an result to the Task. | | withStep | Adds the given `step` (`TaskStepBuilder`) to the `Task`. | | withStringParam | Adds a parameter of type string to the `Task`. | | withWorkspace | Adds the specified workspace to the `Task`. | --- ##### `buildTask` ```typescript public buildTask(): void ``` Builds the `Task`. ##### `withAnnotation` ```typescript public withAnnotation(key: string, value: string): TaskBuilder ``` Adds an annotation to the `Task` `metadata` with the provided key and value. > [https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) ###### `key`Required - *Type:* string The annotation's key. --- ###### `value`Required - *Type:* string The annotation's value. --- ##### `withDescription` ```typescript public withDescription(description: string): TaskBuilder ``` Sets the `description` of the `Task` being built. ###### `description`Required - *Type:* string --- ##### `withLabel` ```typescript public withLabel(key: string, value: string): TaskBuilder ``` Adds a label to the `Task` with the provided label key and value. > [https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) ###### `key`Required - *Type:* string --- ###### `value`Required - *Type:* string --- ##### `withName` ```typescript public withName(name: string): TaskBuilder ``` Sets the name of the `Task` being built. ###### `name`Required - *Type:* string --- ##### `withResult` ```typescript public withResult(name: string, description: string): TaskBuilder ``` Allows you to add an result to the Task. > [https://tekton.dev/docs/pipelines/tasks/#emitting-results](https://tekton.dev/docs/pipelines/tasks/#emitting-results) ###### `name`Required - *Type:* string The name of the result. --- ###### `description`Required - *Type:* string The result's description. --- ##### `withStep` ```typescript public withStep(step: TaskStepBuilder): TaskBuilder ``` Adds the given `step` (`TaskStepBuilder`) to the `Task`. ###### `step`Required - *Type:* cdk8s-pipelines.TaskStepBuilder --- ##### `withStringParam` ```typescript public withStringParam(param: ParameterBuilder): TaskBuilder ``` Adds a parameter of type string to the `Task`. ###### `param`Required - *Type:* cdk8s-pipelines.ParameterBuilder --- ##### `withWorkspace` ```typescript public withWorkspace(workspace: WorkspaceBuilder): TaskBuilder ``` Adds the specified workspace to the `Task`. ###### `workspace`Required - *Type:* cdk8s-pipelines.WorkspaceBuilder --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | logicalID | string | *No description.* | | description | string | Gets the `description` of the `Task`. | | name | string | Gets the name of the `Task` built by the `TaskBuilder`. | | parameters | cdk8s-pipelines.ParameterBuilder[] | *No description.* | | workspaces | cdk8s-pipelines.WorkspaceBuilder[] | Gets the workspaces for the `Task`. | | delegate | cdk8s-pipelines.TaskBuilder | *No description.* | --- ##### `logicalID`Required ```typescript public readonly logicalID: string; ``` - *Type:* string --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string Gets the `description` of the `Task`. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string Gets the name of the `Task` built by the `TaskBuilder`. --- ##### `parameters`Optional ```typescript public readonly parameters: ParameterBuilder[]; ``` - *Type:* cdk8s-pipelines.ParameterBuilder[] --- ##### `workspaces`Optional ```typescript public readonly workspaces: WorkspaceBuilder[]; ``` - *Type:* cdk8s-pipelines.WorkspaceBuilder[] Gets the workspaces for the `Task`. --- ##### `delegate`Required ```typescript public readonly delegate: TaskBuilder; ``` - *Type:* cdk8s-pipelines.TaskBuilder --- ### IbmLakehouseManage01 #### Initializers ```typescript import { IbmLakehouseManage01 } from 'cdk8s-pipelines-lib' new IbmLakehouseManage01(scope: Construct, id: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | buildTask | Builds the `Task`. | | withAnnotation | Adds an annotation to the `Task` `metadata` with the provided key and value. | | withDescription | Sets the `description` of the `Task` being built. | | withLabel | Adds a label to the `Task` with the provided label key and value. | | withName | Sets the name of the `Task` being built. | | withResult | Allows you to add an result to the Task. | | withStep | Adds the given `step` (`TaskStepBuilder`) to the `Task`. | | withStringParam | Adds a parameter of type string to the `Task`. | | withWorkspace | Adds the specified workspace to the `Task`. | --- ##### `buildTask` ```typescript public buildTask(): void ``` Builds the `Task`. ##### `withAnnotation` ```typescript public withAnnotation(key: string, value: string): TaskBuilder ``` Adds an annotation to the `Task` `metadata` with the provided key and value. > [https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) ###### `key`Required - *Type:* string The annotation's key. --- ###### `value`Required - *Type:* string The annotation's value. --- ##### `withDescription` ```typescript public withDescription(description: string): TaskBuilder ``` Sets the `description` of the `Task` being built. ###### `description`Required - *Type:* string --- ##### `withLabel` ```typescript public withLabel(key: string, value: string): TaskBuilder ``` Adds a label to the `Task` with the provided label key and value. > [https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) ###### `key`Required - *Type:* string --- ###### `value`Required - *Type:* string --- ##### `withName` ```typescript public withName(name: string): TaskBuilder ``` Sets the name of the `Task` being built. ###### `name`Required - *Type:* string --- ##### `withResult` ```typescript public withResult(name: string, description: string): TaskBuilder ``` Allows you to add an result to the Task. > [https://tekton.dev/docs/pipelines/tasks/#emitting-results](https://tekton.dev/docs/pipelines/tasks/#emitting-results) ###### `name`Required - *Type:* string The name of the result. --- ###### `description`Required - *Type:* string The result's description. --- ##### `withStep` ```typescript public withStep(step: TaskStepBuilder): TaskBuilder ``` Adds the given `step` (`TaskStepBuilder`) to the `Task`. ###### `step`Required - *Type:* cdk8s-pipelines.TaskStepBuilder --- ##### `withStringParam` ```typescript public withStringParam(param: ParameterBuilder): TaskBuilder ``` Adds a parameter of type string to the `Task`. ###### `param`Required - *Type:* cdk8s-pipelines.ParameterBuilder --- ##### `withWorkspace` ```typescript public withWorkspace(workspace: WorkspaceBuilder): TaskBuilder ``` Adds the specified workspace to the `Task`. ###### `workspace`Required - *Type:* cdk8s-pipelines.WorkspaceBuilder --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | logicalID | string | *No description.* | | description | string | Gets the `description` of the `Task`. | | name | string | Gets the name of the `Task` built by the `TaskBuilder`. | | parameters | cdk8s-pipelines.ParameterBuilder[] | *No description.* | | workspaces | cdk8s-pipelines.WorkspaceBuilder[] | Gets the workspaces for the `Task`. | | delegate | cdk8s-pipelines.TaskBuilder | *No description.* | --- ##### `logicalID`Required ```typescript public readonly logicalID: string; ``` - *Type:* string --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string Gets the `description` of the `Task`. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string Gets the name of the `Task` built by the `TaskBuilder`. --- ##### `parameters`Optional ```typescript public readonly parameters: ParameterBuilder[]; ``` - *Type:* cdk8s-pipelines.ParameterBuilder[] --- ##### `workspaces`Optional ```typescript public readonly workspaces: WorkspaceBuilder[]; ``` - *Type:* cdk8s-pipelines.WorkspaceBuilder[] Gets the workspaces for the `Task`. --- ##### `delegate`Required ```typescript public readonly delegate: TaskBuilder; ``` - *Type:* cdk8s-pipelines.TaskBuilder --- ### IbmPak01 #### Initializers ```typescript import { IbmPak01 } from 'cdk8s-pipelines-lib' new IbmPak01(scope: Construct, id: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | buildTask | Builds the `Task`. | | withAnnotation | Adds an annotation to the `Task` `metadata` with the provided key and value. | | withDescription | Sets the `description` of the `Task` being built. | | withLabel | Adds a label to the `Task` with the provided label key and value. | | withName | Sets the name of the `Task` being built. | | withResult | Allows you to add an result to the Task. | | withStep | Adds the given `step` (`TaskStepBuilder`) to the `Task`. | | withStringParam | Adds a parameter of type string to the `Task`. | | withWorkspace | Adds the specified workspace to the `Task`. | --- ##### `buildTask` ```typescript public buildTask(): void ``` Builds the `Task`. ##### `withAnnotation` ```typescript public withAnnotation(key: string, value: string): TaskBuilder ``` Adds an annotation to the `Task` `metadata` with the provided key and value. > [https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) ###### `key`Required - *Type:* string The annotation's key. --- ###### `value`Required - *Type:* string The annotation's value. --- ##### `withDescription` ```typescript public withDescription(description: string): TaskBuilder ``` Sets the `description` of the `Task` being built. ###### `description`Required - *Type:* string --- ##### `withLabel` ```typescript public withLabel(key: string, value: string): TaskBuilder ``` Adds a label to the `Task` with the provided label key and value. > [https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) ###### `key`Required - *Type:* string --- ###### `value`Required - *Type:* string --- ##### `withName` ```typescript public withName(name: string): TaskBuilder ``` Sets the name of the `Task` being built. ###### `name`Required - *Type:* string --- ##### `withResult` ```typescript public withResult(name: string, description: string): TaskBuilder ``` Allows you to add an result to the Task. > [https://tekton.dev/docs/pipelines/tasks/#emitting-results](https://tekton.dev/docs/pipelines/tasks/#emitting-results) ###### `name`Required - *Type:* string The name of the result. --- ###### `description`Required - *Type:* string The result's description. --- ##### `withStep` ```typescript public withStep(step: TaskStepBuilder): TaskBuilder ``` Adds the given `step` (`TaskStepBuilder`) to the `Task`. ###### `step`Required - *Type:* cdk8s-pipelines.TaskStepBuilder --- ##### `withStringParam` ```typescript public withStringParam(param: ParameterBuilder): TaskBuilder ``` Adds a parameter of type string to the `Task`. ###### `param`Required - *Type:* cdk8s-pipelines.ParameterBuilder --- ##### `withWorkspace` ```typescript public withWorkspace(workspace: WorkspaceBuilder): TaskBuilder ``` Adds the specified workspace to the `Task`. ###### `workspace`Required - *Type:* cdk8s-pipelines.WorkspaceBuilder --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | logicalID | string | *No description.* | | description | string | Gets the `description` of the `Task`. | | name | string | Gets the name of the `Task` built by the `TaskBuilder`. | | parameters | cdk8s-pipelines.ParameterBuilder[] | *No description.* | | workspaces | cdk8s-pipelines.WorkspaceBuilder[] | Gets the workspaces for the `Task`. | | delegate | cdk8s-pipelines.TaskBuilder | *No description.* | --- ##### `logicalID`Required ```typescript public readonly logicalID: string; ``` - *Type:* string --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string Gets the `description` of the `Task`. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string Gets the name of the `Task` built by the `TaskBuilder`. --- ##### `parameters`Optional ```typescript public readonly parameters: ParameterBuilder[]; ``` - *Type:* cdk8s-pipelines.ParameterBuilder[] --- ##### `workspaces`Optional ```typescript public readonly workspaces: WorkspaceBuilder[]; ``` - *Type:* cdk8s-pipelines.WorkspaceBuilder[] Gets the workspaces for the `Task`. --- ##### `delegate`Required ```typescript public readonly delegate: TaskBuilder; ``` - *Type:* cdk8s-pipelines.TaskBuilder --- ### IbmPak02 #### Initializers ```typescript import { IbmPak02 } from 'cdk8s-pipelines-lib' new IbmPak02(scope: Construct, id: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | buildTask | Builds the `Task`. | | withAnnotation | Adds an annotation to the `Task` `metadata` with the provided key and value. | | withDescription | Sets the `description` of the `Task` being built. | | withLabel | Adds a label to the `Task` with the provided label key and value. | | withName | Sets the name of the `Task` being built. | | withResult | Allows you to add an result to the Task. | | withStep | Adds the given `step` (`TaskStepBuilder`) to the `Task`. | | withStringParam | Adds a parameter of type string to the `Task`. | | withWorkspace | Adds the specified workspace to the `Task`. | --- ##### `buildTask` ```typescript public buildTask(): void ``` Builds the `Task`. ##### `withAnnotation` ```typescript public withAnnotation(key: string, value: string): TaskBuilder ``` Adds an annotation to the `Task` `metadata` with the provided key and value. > [https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) ###### `key`Required - *Type:* string The annotation's key. --- ###### `value`Required - *Type:* string The annotation's value. --- ##### `withDescription` ```typescript public withDescription(description: string): TaskBuilder ``` Sets the `description` of the `Task` being built. ###### `description`Required - *Type:* string --- ##### `withLabel` ```typescript public withLabel(key: string, value: string): TaskBuilder ``` Adds a label to the `Task` with the provided label key and value. > [https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) ###### `key`Required - *Type:* string --- ###### `value`Required - *Type:* string --- ##### `withName` ```typescript public withName(name: string): TaskBuilder ``` Sets the name of the `Task` being built. ###### `name`Required - *Type:* string --- ##### `withResult` ```typescript public withResult(name: string, description: string): TaskBuilder ``` Allows you to add an result to the Task. > [https://tekton.dev/docs/pipelines/tasks/#emitting-results](https://tekton.dev/docs/pipelines/tasks/#emitting-results) ###### `name`Required - *Type:* string The name of the result. --- ###### `description`Required - *Type:* string The result's description. --- ##### `withStep` ```typescript public withStep(step: TaskStepBuilder): TaskBuilder ``` Adds the given `step` (`TaskStepBuilder`) to the `Task`. ###### `step`Required - *Type:* cdk8s-pipelines.TaskStepBuilder --- ##### `withStringParam` ```typescript public withStringParam(param: ParameterBuilder): TaskBuilder ``` Adds a parameter of type string to the `Task`. ###### `param`Required - *Type:* cdk8s-pipelines.ParameterBuilder --- ##### `withWorkspace` ```typescript public withWorkspace(workspace: WorkspaceBuilder): TaskBuilder ``` Adds the specified workspace to the `Task`. ###### `workspace`Required - *Type:* cdk8s-pipelines.WorkspaceBuilder --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | logicalID | string | *No description.* | | description | string | Gets the `description` of the `Task`. | | name | string | Gets the name of the `Task` built by the `TaskBuilder`. | | parameters | cdk8s-pipelines.ParameterBuilder[] | *No description.* | | workspaces | cdk8s-pipelines.WorkspaceBuilder[] | Gets the workspaces for the `Task`. | | delegate | cdk8s-pipelines.TaskBuilder | *No description.* | --- ##### `logicalID`Required ```typescript public readonly logicalID: string; ``` - *Type:* string --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string Gets the `description` of the `Task`. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string Gets the name of the `Task` built by the `TaskBuilder`. --- ##### `parameters`Optional ```typescript public readonly parameters: ParameterBuilder[]; ``` - *Type:* cdk8s-pipelines.ParameterBuilder[] --- ##### `workspaces`Optional ```typescript public readonly workspaces: WorkspaceBuilder[]; ``` - *Type:* cdk8s-pipelines.WorkspaceBuilder[] Gets the workspaces for the `Task`. --- ##### `delegate`Required ```typescript public readonly delegate: TaskBuilder; ``` - *Type:* cdk8s-pipelines.TaskBuilder --- ### IbmPak03 #### Initializers ```typescript import { IbmPak03 } from 'cdk8s-pipelines-lib' new IbmPak03(scope: Construct, id: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | buildTask | Builds the `Task`. | | withAnnotation | Adds an annotation to the `Task` `metadata` with the provided key and value. | | withDescription | Sets the `description` of the `Task` being built. | | withLabel | Adds a label to the `Task` with the provided label key and value. | | withName | Sets the name of the `Task` being built. | | withResult | Allows you to add an result to the Task. | | withStep | Adds the given `step` (`TaskStepBuilder`) to the `Task`. | | withStringParam | Adds a parameter of type string to the `Task`. | | withWorkspace | Adds the specified workspace to the `Task`. | --- ##### `buildTask` ```typescript public buildTask(): void ``` Builds the `Task`. ##### `withAnnotation` ```typescript public withAnnotation(key: string, value: string): TaskBuilder ``` Adds an annotation to the `Task` `metadata` with the provided key and value. > [https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) ###### `key`Required - *Type:* string The annotation's key. --- ###### `value`Required - *Type:* string The annotation's value. --- ##### `withDescription` ```typescript public withDescription(description: string): TaskBuilder ``` Sets the `description` of the `Task` being built. ###### `description`Required - *Type:* string --- ##### `withLabel` ```typescript public withLabel(key: string, value: string): TaskBuilder ``` Adds a label to the `Task` with the provided label key and value. > [https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) ###### `key`Required - *Type:* string --- ###### `value`Required - *Type:* string --- ##### `withName` ```typescript public withName(name: string): TaskBuilder ``` Sets the name of the `Task` being built. ###### `name`Required - *Type:* string --- ##### `withResult` ```typescript public withResult(name: string, description: string): TaskBuilder ``` Allows you to add an result to the Task. > [https://tekton.dev/docs/pipelines/tasks/#emitting-results](https://tekton.dev/docs/pipelines/tasks/#emitting-results) ###### `name`Required - *Type:* string The name of the result. --- ###### `description`Required - *Type:* string The result's description. --- ##### `withStep` ```typescript public withStep(step: TaskStepBuilder): TaskBuilder ``` Adds the given `step` (`TaskStepBuilder`) to the `Task`. ###### `step`Required - *Type:* cdk8s-pipelines.TaskStepBuilder --- ##### `withStringParam` ```typescript public withStringParam(param: ParameterBuilder): TaskBuilder ``` Adds a parameter of type string to the `Task`. ###### `param`Required - *Type:* cdk8s-pipelines.ParameterBuilder --- ##### `withWorkspace` ```typescript public withWorkspace(workspace: WorkspaceBuilder): TaskBuilder ``` Adds the specified workspace to the `Task`. ###### `workspace`Required - *Type:* cdk8s-pipelines.WorkspaceBuilder --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | logicalID | string | *No description.* | | description | string | Gets the `description` of the `Task`. | | name | string | Gets the name of the `Task` built by the `TaskBuilder`. | | parameters | cdk8s-pipelines.ParameterBuilder[] | *No description.* | | workspaces | cdk8s-pipelines.WorkspaceBuilder[] | Gets the workspaces for the `Task`. | | delegate | cdk8s-pipelines.TaskBuilder | *No description.* | --- ##### `logicalID`Required ```typescript public readonly logicalID: string; ``` - *Type:* string --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string Gets the `description` of the `Task`. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string Gets the name of the `Task` built by the `TaskBuilder`. --- ##### `parameters`Optional ```typescript public readonly parameters: ParameterBuilder[]; ``` - *Type:* cdk8s-pipelines.ParameterBuilder[] --- ##### `workspaces`Optional ```typescript public readonly workspaces: WorkspaceBuilder[]; ``` - *Type:* cdk8s-pipelines.WorkspaceBuilder[] Gets the workspaces for the `Task`. --- ##### `delegate`Required ```typescript public readonly delegate: TaskBuilder; ``` - *Type:* cdk8s-pipelines.TaskBuilder --- ### IbmPakApplyCatalogSource01 #### Initializers ```typescript import { IbmPakApplyCatalogSource01 } from 'cdk8s-pipelines-lib' new IbmPakApplyCatalogSource01(scope: Construct, id: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | buildTask | Builds the `Task`. | | withAnnotation | Adds an annotation to the `Task` `metadata` with the provided key and value. | | withDescription | Sets the `description` of the `Task` being built. | | withLabel | Adds a label to the `Task` with the provided label key and value. | | withName | Sets the name of the `Task` being built. | | withResult | Allows you to add an result to the Task. | | withStep | Adds the given `step` (`TaskStepBuilder`) to the `Task`. | | withStringParam | Adds a parameter of type string to the `Task`. | | withWorkspace | Adds the specified workspace to the `Task`. | --- ##### `buildTask` ```typescript public buildTask(): void ``` Builds the `Task`. ##### `withAnnotation` ```typescript public withAnnotation(key: string, value: string): TaskBuilder ``` Adds an annotation to the `Task` `metadata` with the provided key and value. > [https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) ###### `key`Required - *Type:* string The annotation's key. --- ###### `value`Required - *Type:* string The annotation's value. --- ##### `withDescription` ```typescript public withDescription(description: string): TaskBuilder ``` Sets the `description` of the `Task` being built. ###### `description`Required - *Type:* string --- ##### `withLabel` ```typescript public withLabel(key: string, value: string): TaskBuilder ``` Adds a label to the `Task` with the provided label key and value. > [https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) ###### `key`Required - *Type:* string --- ###### `value`Required - *Type:* string --- ##### `withName` ```typescript public withName(name: string): TaskBuilder ``` Sets the name of the `Task` being built. ###### `name`Required - *Type:* string --- ##### `withResult` ```typescript public withResult(name: string, description: string): TaskBuilder ``` Allows you to add an result to the Task. > [https://tekton.dev/docs/pipelines/tasks/#emitting-results](https://tekton.dev/docs/pipelines/tasks/#emitting-results) ###### `name`Required - *Type:* string The name of the result. --- ###### `description`Required - *Type:* string The result's description. --- ##### `withStep` ```typescript public withStep(step: TaskStepBuilder): TaskBuilder ``` Adds the given `step` (`TaskStepBuilder`) to the `Task`. ###### `step`Required - *Type:* cdk8s-pipelines.TaskStepBuilder --- ##### `withStringParam` ```typescript public withStringParam(param: ParameterBuilder): TaskBuilder ``` Adds a parameter of type string to the `Task`. ###### `param`Required - *Type:* cdk8s-pipelines.ParameterBuilder --- ##### `withWorkspace` ```typescript public withWorkspace(workspace: WorkspaceBuilder): TaskBuilder ``` Adds the specified workspace to the `Task`. ###### `workspace`Required - *Type:* cdk8s-pipelines.WorkspaceBuilder --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | logicalID | string | *No description.* | | description | string | Gets the `description` of the `Task`. | | name | string | Gets the name of the `Task` built by the `TaskBuilder`. | | parameters | cdk8s-pipelines.ParameterBuilder[] | *No description.* | | workspaces | cdk8s-pipelines.WorkspaceBuilder[] | Gets the workspaces for the `Task`. | | delegate | cdk8s-pipelines.TaskBuilder | *No description.* | --- ##### `logicalID`Required ```typescript public readonly logicalID: string; ``` - *Type:* string --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string Gets the `description` of the `Task`. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string Gets the name of the `Task` built by the `TaskBuilder`. --- ##### `parameters`Optional ```typescript public readonly parameters: ParameterBuilder[]; ``` - *Type:* cdk8s-pipelines.ParameterBuilder[] --- ##### `workspaces`Optional ```typescript public readonly workspaces: WorkspaceBuilder[]; ``` - *Type:* cdk8s-pipelines.WorkspaceBuilder[] Gets the workspaces for the `Task`. --- ##### `delegate`Required ```typescript public readonly delegate: TaskBuilder; ``` - *Type:* cdk8s-pipelines.TaskBuilder --- ### IbmPakInstallOperator01 #### Initializers ```typescript import { IbmPakInstallOperator01 } from 'cdk8s-pipelines-lib' new IbmPakInstallOperator01(scope: Construct, id: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | buildTask | Builds the `Task`. | | withAnnotation | Adds an annotation to the `Task` `metadata` with the provided key and value. | | withDescription | Sets the `description` of the `Task` being built. | | withLabel | Adds a label to the `Task` with the provided label key and value. | | withName | Sets the name of the `Task` being built. | | withResult | Allows you to add an result to the Task. | | withStep | Adds the given `step` (`TaskStepBuilder`) to the `Task`. | | withStringParam | Adds a parameter of type string to the `Task`. | | withWorkspace | Adds the specified workspace to the `Task`. | --- ##### `buildTask` ```typescript public buildTask(): void ``` Builds the `Task`. ##### `withAnnotation` ```typescript public withAnnotation(key: string, value: string): TaskBuilder ``` Adds an annotation to the `Task` `metadata` with the provided key and value. > [https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) ###### `key`Required - *Type:* string The annotation's key. --- ###### `value`Required - *Type:* string The annotation's value. --- ##### `withDescription` ```typescript public withDescription(description: string): TaskBuilder ``` Sets the `description` of the `Task` being built. ###### `description`Required - *Type:* string --- ##### `withLabel` ```typescript public withLabel(key: string, value: string): TaskBuilder ``` Adds a label to the `Task` with the provided label key and value. > [https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) ###### `key`Required - *Type:* string --- ###### `value`Required - *Type:* string --- ##### `withName` ```typescript public withName(name: string): TaskBuilder ``` Sets the name of the `Task` being built. ###### `name`Required - *Type:* string --- ##### `withResult` ```typescript public withResult(name: string, description: string): TaskBuilder ``` Allows you to add an result to the Task. > [https://tekton.dev/docs/pipelines/tasks/#emitting-results](https://tekton.dev/docs/pipelines/tasks/#emitting-results) ###### `name`Required - *Type:* string The name of the result. --- ###### `description`Required - *Type:* string The result's description. --- ##### `withStep` ```typescript public withStep(step: TaskStepBuilder): TaskBuilder ``` Adds the given `step` (`TaskStepBuilder`) to the `Task`. ###### `step`Required - *Type:* cdk8s-pipelines.TaskStepBuilder --- ##### `withStringParam` ```typescript public withStringParam(param: ParameterBuilder): TaskBuilder ``` Adds a parameter of type string to the `Task`. ###### `param`Required - *Type:* cdk8s-pipelines.ParameterBuilder --- ##### `withWorkspace` ```typescript public withWorkspace(workspace: WorkspaceBuilder): TaskBuilder ``` Adds the specified workspace to the `Task`. ###### `workspace`Required - *Type:* cdk8s-pipelines.WorkspaceBuilder --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | logicalID | string | *No description.* | | description | string | Gets the `description` of the `Task`. | | name | string | Gets the name of the `Task` built by the `TaskBuilder`. | | parameters | cdk8s-pipelines.ParameterBuilder[] | *No description.* | | workspaces | cdk8s-pipelines.WorkspaceBuilder[] | Gets the workspaces for the `Task`. | | delegate | cdk8s-pipelines.TaskBuilder | *No description.* | --- ##### `logicalID`Required ```typescript public readonly logicalID: string; ``` - *Type:* string --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string Gets the `description` of the `Task`. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string Gets the name of the `Task` built by the `TaskBuilder`. --- ##### `parameters`Optional ```typescript public readonly parameters: ParameterBuilder[]; ``` - *Type:* cdk8s-pipelines.ParameterBuilder[] --- ##### `workspaces`Optional ```typescript public readonly workspaces: WorkspaceBuilder[]; ``` - *Type:* cdk8s-pipelines.WorkspaceBuilder[] Gets the workspaces for the `Task`. --- ##### `delegate`Required ```typescript public readonly delegate: TaskBuilder; ``` - *Type:* cdk8s-pipelines.TaskBuilder --- ### InstallFromIBMOperatorPipeline A basic pipeline that starts with a subscription to the IBM operator catalog. The following steps are included in this pipeline, so you do not need to add them. The pipeline: 1. Creates the specified namespace. 1. Registers the IBM operator. 1. Creates an OperatorGroup. 1. Subscribes to the given `name` and `channel` #### Initializers ```typescript import { InstallFromIBMOperatorPipeline } from 'cdk8s-pipelines-lib' new InstallFromIBMOperatorPipeline(scope: Construct, id: string, ns: string, subscription: string, channel: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | The parent [Construct](https://cdk8s.io/docs/latest/basics/constructs/). | | id | string | The `id` of the construct. | | ns | string | The namespace to create and to use for subscribing to the product and channel. | | subscription | string | The name of the subscription. | | channel | string | The name of the channel (e.g., `v3.3`, `stable`). | --- ##### `scope`Required - *Type:* constructs.Construct The parent [Construct](https://cdk8s.io/docs/latest/basics/constructs/). --- ##### `id`Required - *Type:* string The `id` of the construct. Must be unique for each one in a chart. --- ##### `ns`Required - *Type:* string The namespace to create and to use for subscribing to the product and channel. --- ##### `subscription`Required - *Type:* string The name of the subscription. For example, for IBM Event Streams is it `ibm-eventstreams`. For Red Hat Serverless, it is `serverless-operator`. --- ##### `channel`Required - *Type:* string The name of the channel (e.g., `v3.3`, `stable`). --- #### Methods | **Name** | **Description** | | --- | --- | | buildPipeline | Builds the actual [Pipeline](https://tekton.dev/docs/getting-started/pipelines/) from the settings configured using the fluid syntax. | | withDescription | Provides the name for the pipeline task and will be rendered as the `name` property. | | withName | Provides the name for the pipeline task and will be rendered as the `name` property. | | withTask | *No description.* | --- ##### `buildPipeline` ```typescript public buildPipeline(opts?: BuilderOptions): void ``` Builds the actual [Pipeline](https://tekton.dev/docs/getting-started/pipelines/) from the settings configured using the fluid syntax. ###### `opts`Optional - *Type:* cdk8s-pipelines.BuilderOptions --- ##### `withDescription` ```typescript public withDescription(description: string): PipelineBuilder ``` Provides the name for the pipeline task and will be rendered as the `name` property. ###### `description`Required - *Type:* string --- ##### `withName` ```typescript public withName(name: string): PipelineBuilder ``` Provides the name for the pipeline task and will be rendered as the `name` property. ###### `name`Required - *Type:* string --- ##### `withTask` ```typescript public withTask(taskB: TaskBuilder): PipelineBuilder ``` ###### `taskB`Required - *Type:* cdk8s-pipelines.TaskBuilder --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | Gets the name of the pipeline. | | params | cdk8s-pipelines.PipelineParam[] | Returns the array of `PipelineParam` objects that represent the parameters configured for the `Pipeline`. | | workspaces | cdk8s-pipelines.PipelineWorkspace[] | Returns the array of `PipelineWorkspace` objects that represent the workspaces configured for the `Pipeline`. | --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* string Gets the name of the pipeline. --- ##### `params`Required ```typescript public readonly params: PipelineParam[]; ``` - *Type:* cdk8s-pipelines.PipelineParam[] Returns the array of `PipelineParam` objects that represent the parameters configured for the `Pipeline`. Note this is an "expensive" get because it loops through the tasks in the pipeline and checks for duplicates in the pipeline parameters for each task parameter found. You should avoid calling this in a loop--instead, declare a local variable before the loop and reference that instead. --- ##### `workspaces`Required ```typescript public readonly workspaces: PipelineWorkspace[]; ``` - *Type:* cdk8s-pipelines.PipelineWorkspace[] Returns the array of `PipelineWorkspace` objects that represent the workspaces configured for the `Pipeline`. This is an "expensive" get because it loops through the workspaces in the pipeline and checks for duplicates in the pipeline workspaces for each task workspace found. You should avoid calling this in a loop--instead, declare a local variable before the loop and reference that instead. --- ### KustomizeCli01 #### Initializers ```typescript import { KustomizeCli01 } from 'cdk8s-pipelines-lib' new KustomizeCli01(scope: Construct, id: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | buildTask | Builds the `Task`. | | withAnnotation | Adds an annotation to the `Task` `metadata` with the provided key and value. | | withDescription | Sets the `description` of the `Task` being built. | | withLabel | Adds a label to the `Task` with the provided label key and value. | | withName | Sets the name of the `Task` being built. | | withResult | Allows you to add an result to the Task. | | withStep | Adds the given `step` (`TaskStepBuilder`) to the `Task`. | | withStringParam | Adds a parameter of type string to the `Task`. | | withWorkspace | Adds the specified workspace to the `Task`. | --- ##### `buildTask` ```typescript public buildTask(): void ``` Builds the `Task`. ##### `withAnnotation` ```typescript public withAnnotation(key: string, value: string): TaskBuilder ``` Adds an annotation to the `Task` `metadata` with the provided key and value. > [https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) ###### `key`Required - *Type:* string The annotation's key. --- ###### `value`Required - *Type:* string The annotation's value. --- ##### `withDescription` ```typescript public withDescription(description: string): TaskBuilder ``` Sets the `description` of the `Task` being built. ###### `description`Required - *Type:* string --- ##### `withLabel` ```typescript public withLabel(key: string, value: string): TaskBuilder ``` Adds a label to the `Task` with the provided label key and value. > [https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) ###### `key`Required - *Type:* string --- ###### `value`Required - *Type:* string --- ##### `withName` ```typescript public withName(name: string): TaskBuilder ``` Sets the name of the `Task` being built. ###### `name`Required - *Type:* string --- ##### `withResult` ```typescript public withResult(name: string, description: string): TaskBuilder ``` Allows you to add an result to the Task. > [https://tekton.dev/docs/pipelines/tasks/#emitting-results](https://tekton.dev/docs/pipelines/tasks/#emitting-results) ###### `name`Required - *Type:* string The name of the result. --- ###### `description`Required - *Type:* string The result's description. --- ##### `withStep` ```typescript public withStep(step: TaskStepBuilder): TaskBuilder ``` Adds the given `step` (`TaskStepBuilder`) to the `Task`. ###### `step`Required - *Type:* cdk8s-pipelines.TaskStepBuilder --- ##### `withStringParam` ```typescript public withStringParam(param: ParameterBuilder): TaskBuilder ``` Adds a parameter of type string to the `Task`. ###### `param`Required - *Type:* cdk8s-pipelines.ParameterBuilder --- ##### `withWorkspace` ```typescript public withWorkspace(workspace: WorkspaceBuilder): TaskBuilder ``` Adds the specified workspace to the `Task`. ###### `workspace`Required - *Type:* cdk8s-pipelines.WorkspaceBuilder --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | logicalID | string | *No description.* | | description | string | Gets the `description` of the `Task`. | | name | string | Gets the name of the `Task` built by the `TaskBuilder`. | | parameters | cdk8s-pipelines.ParameterBuilder[] | *No description.* | | workspaces | cdk8s-pipelines.WorkspaceBuilder[] | Gets the workspaces for the `Task`. | | delegate | cdk8s-pipelines.TaskBuilder | *No description.* | --- ##### `logicalID`Required ```typescript public readonly logicalID: string; ``` - *Type:* string --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string Gets the `description` of the `Task`. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string Gets the name of the `Task` built by the `TaskBuilder`. --- ##### `parameters`Optional ```typescript public readonly parameters: ParameterBuilder[]; ``` - *Type:* cdk8s-pipelines.ParameterBuilder[] --- ##### `workspaces`Optional ```typescript public readonly workspaces: WorkspaceBuilder[]; ``` - *Type:* cdk8s-pipelines.WorkspaceBuilder[] Gets the workspaces for the `Task`. --- ##### `delegate`Required ```typescript public readonly delegate: TaskBuilder; ``` - *Type:* cdk8s-pipelines.TaskBuilder --- ### OpenshiftClient02 #### Initializers ```typescript import { OpenshiftClient02 } from 'cdk8s-pipelines-lib' new OpenshiftClient02(scope: Construct, id: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | buildTask | Builds the `Task`. | | withAnnotation | Adds an annotation to the `Task` `metadata` with the provided key and value. | | withDescription | Sets the `description` of the `Task` being built. | | withLabel | Adds a label to the `Task` with the provided label key and value. | | withName | Sets the name of the `Task` being built. | | withResult | Allows you to add an result to the Task. | | withStep | Adds the given `step` (`TaskStepBuilder`) to the `Task`. | | withStringParam | Adds a parameter of type string to the `Task`. | | withWorkspace | Adds the specified workspace to the `Task`. | --- ##### `buildTask` ```typescript public buildTask(): void ``` Builds the `Task`. ##### `withAnnotation` ```typescript public withAnnotation(key: string, value: string): TaskBuilder ``` Adds an annotation to the `Task` `metadata` with the provided key and value. > [https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) ###### `key`Required - *Type:* string The annotation's key. --- ###### `value`Required - *Type:* string The annotation's value. --- ##### `withDescription` ```typescript public withDescription(description: string): TaskBuilder ``` Sets the `description` of the `Task` being built. ###### `description`Required - *Type:* string --- ##### `withLabel` ```typescript public withLabel(key: string, value: string): TaskBuilder ``` Adds a label to the `Task` with the provided label key and value. > [https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) ###### `key`Required - *Type:* string --- ###### `value`Required - *Type:* string --- ##### `withName` ```typescript public withName(name: string): TaskBuilder ``` Sets the name of the `Task` being built. ###### `name`Required - *Type:* string --- ##### `withResult` ```typescript public withResult(name: string, description: string): TaskBuilder ``` Allows you to add an result to the Task. > [https://tekton.dev/docs/pipelines/tasks/#emitting-results](https://tekton.dev/docs/pipelines/tasks/#emitting-results) ###### `name`Required - *Type:* string The name of the result. --- ###### `description`Required - *Type:* string The result's description. --- ##### `withStep` ```typescript public withStep(step: TaskStepBuilder): TaskBuilder ``` Adds the given `step` (`TaskStepBuilder`) to the `Task`. ###### `step`Required - *Type:* cdk8s-pipelines.TaskStepBuilder --- ##### `withStringParam` ```typescript public withStringParam(param: ParameterBuilder): TaskBuilder ``` Adds a parameter of type string to the `Task`. ###### `param`Required - *Type:* cdk8s-pipelines.ParameterBuilder --- ##### `withWorkspace` ```typescript public withWorkspace(workspace: WorkspaceBuilder): TaskBuilder ``` Adds the specified workspace to the `Task`. ###### `workspace`Required - *Type:* cdk8s-pipelines.WorkspaceBuilder --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | logicalID | string | *No description.* | | description | string | Gets the `description` of the `Task`. | | name | string | Gets the name of the `Task` built by the `TaskBuilder`. | | parameters | cdk8s-pipelines.ParameterBuilder[] | *No description.* | | workspaces | cdk8s-pipelines.WorkspaceBuilder[] | Gets the workspaces for the `Task`. | | delegate | cdk8s-pipelines.TaskBuilder | *No description.* | --- ##### `logicalID`Required ```typescript public readonly logicalID: string; ``` - *Type:* string --- ##### `description`Optional ```typescript public readonly description: string; ``` - *Type:* string Gets the `description` of the `Task`. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* string Gets the name of the `Task` built by the `TaskBuilder`. --- ##### `parameters`Optional ```typescript public readonly parameters: ParameterBuilder[]; ``` - *Type:* cdk8s-pipelines.ParameterBuilder[] --- ##### `workspaces`Optional ```typescript public readonly workspaces: WorkspaceBuilder[]; ``` - *Type:* cdk8s-pipelines.WorkspaceBuilder[] Gets the workspaces for the `Task`. --- ##### `delegate`Required ```typescript public readonly delegate: TaskBuilder; ``` - *Type:* cdk8s-pipelines.TaskBuilder ---