cdk8s-jenkins 0.0.1 → 0.0.4

package/.gitattributes

@@ -4,6 +4,7 @@
 /.eslintrc.json linguist-generated
 /.gitattributes linguist-generated
 /.github/pull_request_template.md linguist-generated
+/.github/workflows/auto-approve.yml linguist-generated
 /.github/workflows/build.yml linguist-generated
 /.github/workflows/pull-request-lint.yml linguist-generated
 /.github/workflows/release.yml linguist-generated

package/.jsii

@@ -67,7 +67,7 @@
     "stability": "stable"
   },
   "homepage": "https://github.com/cdk8s-team/cdk8s-jenkins",
-  "jsiiVersion": "1.59.0 (build eb02c92)",
+  "jsiiVersion": "1.62.0 (build 293ac17)",
   "keywords": [
     "cdk"
   ],
@@ -82,7 +82,7 @@
   },
   "name": "cdk8s-jenkins",
   "readme": {
-    "markdown": "# This library is currently under development. Stay tuned!"
+    "markdown": "# cdk8s-jenkins\n`cdk8s-jenkins` is a library that lets you easily define a manifest for deploying a Jenkins instance to your Kubernetes cluster.\n\n## Prerequisites\nThis library uses a Custom Resource Definition provided by jenkins, and thus requires both the CRD and the operator to be installed on the cluster.\nYou can set this up by,\n1. Apply the Custom Resource Definition(CRD) for jenkins on your Kubernetes cluster.\n```\nkubectl apply -f https://raw.githubusercontent.com/jenkinsci/kubernetes-operator/master/config/crd/bases/jenkins.io_jenkins.yaml\n```\n2. Install the Jenkins Operator on your Kubernetes cluster.\n```\nkubectl apply -f https://raw.githubusercontent.com/jenkinsci/kubernetes-operator/master/deploy/all-in-one-v1alpha2.yaml\n```\n\n> For more information regarding applying jenkins crd and installing jenkins operator, please refer [jenkins official documentaion](https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/installing-the-operator/).\n\n## Usage\nThe library provides a high level `Jenkins` construct to provision a Jenkins instance.\nYou can just instantiate the Jenkins instance and that would add a Jenkins resource to the kubernetes manifest.\n\nThe library provide a set of defaults, so provisioning a basic Jenkins instance requires no configuration:\n\n```ts\nimport { Jenkins } from 'cdk8s-jenkins';\n\n// inside your chart:\nconst jenkins = new Jenkins(this, 'my-jenkins');\n```\n\nThe library also enables configuring the following parmeters for the Jenkins instance:\n### metadata\n```ts\nconst jenkins = new Jenkins(this, 'my-jenkins', {\n  metadata: {\n    namespace: 'jenkins-namespace',\n    labels: { customApp: 'my-jenkins' },\n  },\n});\n```\n### disableCsrfProtection\nThis allows you to toggle CSRF Protection for Jenkins.\n```ts\nconst jenkins = new Jenkins(this, 'my-jenkins', {\n  disableCsrfProtection: true,\n});\n```\n### basePlugins\nThese are the plugins required by the jenkins operator.\n```ts\nconst jenkins = new Jenkins(this, 'my-jenkins', {\n  basePlugins: [{\n    name: 'configuration-as-code',\n    version: '1.55',\n    }],\n});\n\n```\n\nYou can also utilize `addBasePlugins` function to add base plugins to jenkins configuration after initialization.\n```ts\nconst jenkins = new Jenkins(this, 'my-jenkins');\njenkins.addBasePlugins([{\n  name: 'workflow-api',\n  version: '2.76',\n}]);\n```\n\n### plugins\nThese are the plugins that you can add to your jenkins instance.\n```ts\nconst jenkins = new Jenkins(this, 'my-jenkins', {\n  plugins: [{\n    name: 'simple-theme-plugin',\n    version: '0.7',\n    }],\n});\n```\nYou can also utilize `addPlugins` function to add plugins to jenkins configuration after initialization.\n```ts\nconst jenkins = new Jenkins(this, 'my-jenkins');\njenkins.addPlugins([{\n  name: 'simple-theme-plugin',\n  version: '0.7',\n}]);\n```\n\n### seedJobs\nYou can define list of jenkins seed job configurations here. For more info you can take look at [jenkins documentation](https://jenkinsci.github.io/kubernetes-operator/docs/getting-started/latest/configuring-seed-jobs-and-pipelines/).\n\n```ts\nconst jenkins = new Jenkins(this, 'my-jenkins', {\n  seedJobs: [{\n    id: 'jenkins-operator',\n    targets: 'cicd/jobs/*.jenkins',\n    description: 'Jenkins Operator repository',\n    repositoryBranch: 'master',\n    repositoryUrl: 'https://github.com/jenkinsci/kubernetes-operator.git',\n    }],\n});\n```\nYou can also utilize `addSeedJobs` function to add seed jobs to jenkins configuration after initialization.\n```ts\nconst jenkins = new Jenkins(this, 'my-jenkins');\njenkins.addSeedJobs([{\n  id: 'jenkins-operator',\n  targets: 'cicd/jobs/*.jenkins',\n  description: 'Jenkins Operator repository',\n  repositoryBranch: 'master',\n  repositoryUrl: 'https://github.com/jenkinsci/kubernetes-operator.git',\n}]);\n```\n\n## Using escape hatches\n\nYou can utilize escape hatches to make changes to the configurations that are not yet exposed by the library.\n\nFor instance, if you would like to update the version of a base plugin:\n\n```ts\nconst jenkins = new Jenkins(this, 'my-jenkins');\nconst jenkinsApiObject = ApiObject.of(jenkins);\njenkinsApiObject.addJsonPatch(JsonPatch.replace('/spec/master/basePlugins/1', {\n  name: 'workflow-job',\n  version: '3.00',\n}));\n```\n\nFor more information regarding escape hatches, take a look at [cdk8s documentation](https://cdk8s.io/docs/latest/concepts/escape-hatches/).\n\n## Security\n\nSee [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more\ninformation.\n\n## License\n\nThis project is licensed under the Apache-2.0 License.\n"
   },
   "repository": {
     "type": "git",
@@ -110,43 +110,419 @@
     }
   },
   "types": {
-    "cdk8s-jenkins.Hello": {
+    "cdk8s-jenkins.Jenkins": {
       "assembly": "cdk8s-jenkins",
+      "base": "constructs.Construct",
       "docs": {
-        "stability": "stable"
+        "stability": "stable",
+        "summary": "A jenkins instance."
       },
-      "fqn": "cdk8s-jenkins.Hello",
+      "fqn": "cdk8s-jenkins.Jenkins",
       "initializer": {
         "docs": {
           "stability": "stable"
-        }
+        },
+        "locationInModule": {
+          "filename": "src/jenkins.ts",
+          "line": 118
+        },
+        "parameters": [
+          {
+            "name": "scope",
+            "type": {
+              "fqn": "constructs.Construct"
+            }
+          },
+          {
+            "name": "id",
+            "type": {
+              "primitive": "string"
+            }
+          },
+          {
+            "name": "props",
+            "optional": true,
+            "type": {
+              "fqn": "cdk8s-jenkins.JenkinsProps"
+            }
+          }
+        ]
       },
       "kind": "class",
       "locationInModule": {
-        "filename": "src/index.ts",
-        "line": 1
+        "filename": "src/jenkins.ts",
+        "line": 113
       },
       "methods": [
         {
           "docs": {
-            "stability": "stable"
+            "stability": "stable",
+            "summary": "Add base plugins to jenkins instance."
           },
           "locationInModule": {
-            "filename": "src/index.ts",
-            "line": 2
+            "filename": "src/jenkins.ts",
+            "line": 211
           },
-          "name": "sayHello",
-          "returns": {
-            "type": {
-              "primitive": "string"
+          "name": "addBasePlugins",
+          "parameters": [
+            {
+              "docs": {
+                "summary": "List of base plugins."
+              },
+              "name": "basePlugins",
+              "type": {
+                "fqn": "cdk8s-jenkins.Plugin"
+              },
+              "variadic": true
+            }
+          ],
+          "variadic": true
+        },
+        {
+          "docs": {
+            "stability": "stable",
+            "summary": "Add custom plugins to jenkins instance."
+          },
+          "locationInModule": {
+            "filename": "src/jenkins.ts",
+            "line": 221
+          },
+          "name": "addPlugins",
+          "parameters": [
+            {
+              "docs": {
+                "summary": "List of custom plugins."
+              },
+              "name": "plugins",
+              "type": {
+                "fqn": "cdk8s-jenkins.Plugin"
+              },
+              "variadic": true
+            }
+          ],
+          "variadic": true
+        },
+        {
+          "docs": {
+            "stability": "stable",
+            "summary": "Add seed jobs to jenkins instance."
+          },
+          "locationInModule": {
+            "filename": "src/jenkins.ts",
+            "line": 229
+          },
+          "name": "addSeedJobs",
+          "parameters": [
+            {
+              "docs": {
+                "summary": "List of seed jobs."
+              },
+              "name": "seedJobs",
+              "type": {
+                "fqn": "cdk8s-jenkins.SeedJob"
+              },
+              "variadic": true
+            }
+          ],
+          "variadic": true
+        }
+      ],
+      "name": "Jenkins",
+      "symbolId": "src/jenkins:Jenkins"
+    },
+    "cdk8s-jenkins.JenkinsProps": {
+      "assembly": "cdk8s-jenkins",
+      "datatype": true,
+      "docs": {
+        "stability": "stable",
+        "summary": "Props for `Jenkins`."
+      },
+      "fqn": "cdk8s-jenkins.JenkinsProps",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/jenkins.ts",
+        "line": 60
+      },
+      "name": "JenkinsProps",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- Default base plugins:\n\n      { name: 'kubernetes', version: '1.31.3' },\n      { name: 'workflow-job', version: '1145.v7f2433caa07f' },\n      { name: 'workflow-aggregator', version: '2.6' },\n      { name: 'git', version: '4.10.3' },\n      { name: 'job-dsl', version: '1.78.1' },\n      { name: 'configuration-as-code', version: '1414.v878271fc496f' },\n      { name: 'kubernetes-credentials-provider', version: '0.20' }",
+            "stability": "stable",
+            "summary": "List of plugins required by Jenkins operator."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/jenkins.ts",
+            "line": 94
+          },
+          "name": "basePlugins",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "fqn": "cdk8s-jenkins.Plugin"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- false",
+            "stability": "stable",
+            "summary": "Toggle for CSRF Protection on Jenkins resource."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/jenkins.ts",
+            "line": 80
+          },
+          "name": "disableCsrfProtection",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": ": Default metadata values:\n {\n     name: An app-unique name generated by the chart,\n     annotations: No annotations,\n     labels: { app: 'jenkins' },\n     namespace: default,\n     finalizers: No finalizers,\n     ownerReferences: Automatically set by Kubernetes\n }",
+            "stability": "stable",
+            "summary": "Metadata associated with Jenkins resource."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/jenkins.ts",
+            "line": 74
+          },
+          "name": "metadata",
+          "optional": true,
+          "type": {
+            "fqn": "cdk8s.ApiObjectMetadata"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- []",
+            "stability": "stable",
+            "summary": "List of custom plugins applied to Jenkins resource."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/jenkins.ts",
+            "line": 100
+          },
+          "name": "plugins",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "fqn": "cdk8s-jenkins.Plugin"
+              },
+              "kind": "array"
             }
           }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- No seed jobs",
+            "remarks": "For more information about seed jobs, please take a look at { @link https://github.com/jenkinsci/job-dsl-plugin/wiki/Tutorial---Using-the-Jenkins-Job-DSL Jenkins Seed Jobs Documentation }.",
+            "stability": "stable",
+            "summary": "List of seed job configuration for Jenkins resource."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/jenkins.ts",
+            "line": 107
+          },
+          "name": "seedJobs",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "fqn": "cdk8s-jenkins.SeedJob"
+              },
+              "kind": "array"
+            }
+          }
+        }
+      ],
+      "symbolId": "src/jenkins:JenkinsProps"
+    },
+    "cdk8s-jenkins.Plugin": {
+      "assembly": "cdk8s-jenkins",
+      "datatype": true,
+      "docs": {
+        "stability": "stable",
+        "summary": "Jenkins plugin."
+      },
+      "fqn": "cdk8s-jenkins.Plugin",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/jenkins.ts",
+        "line": 8
+      },
+      "name": "Plugin",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "The name of Jenkins plugin."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/jenkins.ts",
+            "line": 19
+          },
+          "name": "name",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "The version of Jenkins plugin."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/jenkins.ts",
+            "line": 24
+          },
+          "name": "version",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- Plugins are downloaded from Jenkins Update Centers.",
+            "see": "https://github.com/jenkinsci/kubernetes-operator/blob/master/pkg/configuration/base/resources/scripts_configmap.go#L121-L124",
+            "stability": "stable",
+            "summary": "The url from where plugin has to be downloaded."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/jenkins.ts",
+            "line": 14
+          },
+          "name": "downloadUrl",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/jenkins:Plugin"
+    },
+    "cdk8s-jenkins.SeedJob": {
+      "assembly": "cdk8s-jenkins",
+      "datatype": true,
+      "docs": {
+        "stability": "stable",
+        "summary": "Jenkins seed job."
+      },
+      "fqn": "cdk8s-jenkins.SeedJob",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/jenkins.ts",
+        "line": 30
+      },
+      "name": "SeedJob",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "The description of the seed job."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/jenkins.ts",
+            "line": 39
+          },
+          "name": "description",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "The unique name for the seed job."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/jenkins.ts",
+            "line": 34
+          },
+          "name": "id",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "The repository branch where seed job definitions are present."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/jenkins.ts",
+            "line": 44
+          },
+          "name": "repositoryBranch",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "Supports SSH and HTTPS.",
+            "stability": "stable",
+            "summary": "The repository access URL."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/jenkins.ts",
+            "line": 49
+          },
+          "name": "repositoryUrl",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "The repository path where seed job definitions are present."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/jenkins.ts",
+            "line": 54
+          },
+          "name": "targets",
+          "type": {
+            "primitive": "string"
+          }
         }
       ],
-      "name": "Hello",
-      "symbolId": "src/index:Hello"
+      "symbolId": "src/jenkins:SeedJob"
     }
   },
-  "version": "0.0.1",
-  "fingerprint": "TNmaCkrTSAtanW25anZNtB/kqGJMQwKnO+1vMxdyv8U="
-}
+  "version": "0.0.4",
+  "fingerprint": "yxyer1B8f3oH/s2yxlO8jA65lB7LAX7FVGRuGaZqvK0="
+}