pepr 0.1.31 → 0.1.33

package/README.md

@@ -18,6 +18,8 @@ Capabilities are logical groupings of actions, which are the atomic units of cha
 
 Imagine Pepr as a smart home system where different devices communicate with each other. Pepr provides instructions, simplifying the management of the smart home. The project enables both expert and novice capability authors to improve management and interactions within the Kubernetes environment, making its features accessible to everyone.
 
+https://user-images.githubusercontent.com/882485/230895880-c5623077-f811-4870-bb9f-9bb8e5edc118.mp4
+
 ## Concepts
 
 ### Module
@@ -26,7 +28,7 @@ A module is the top-level collection of capabilities. It is a single, complete T
 
 ### Capability
 
-A capability is set of related CapabilityActions that work together to achieve a specific transformation or operation on Kubernetes resources. Capabilities are user-defined and can include one or more CapabilityActions. They are defined within a Pepr module and can be used in both MutatingWebhookConfigurations and ValidatingWebhookConfigurations. A Capability can have a specific scope, such as mutating or validating, and can be reused in multiple Pepr modules.
+A capability is set of related CapabilityActions that work together to achieve a specific transformation or operation on Kubernetes resources. Capabilities are user-defined and can include one or more CapabilityActions. They are defined within a Pepr module and can be used in both MutatingWebhookConfigurations and ValidatingWebhookConfigurations. A Capability can have a specific scope, such as mutating or validating, and can be reused in multiple Pepr modules. 
 
 ### CapabilityAction
 
@@ -36,26 +38,22 @@ For example, a CapabilityAction could be responsible for adding a specific label
 
 ## Example
 
-Define a new capability:
-
-```
-pepr new hello-world -d demo
-```
+Define a new capability can be done via [VSCode Snippet](https://code.visualstudio.com/docs/editor/userdefinedsnippets): create a file `capabilities/your-capability-name.ts` and then type `create` in the file, a suggestion should prompt you to generate the content from there.
 
-This will create a new directory tree called `demo/hello-world` with the following structure:
+https://user-images.githubusercontent.com/882485/230897379-0bb57dff-9832-479f-8733-79e103703135.mp4
 
-### demo/hello-world/index.ts
+Alternatively, you can use the `pepr new <capability-name>` command to this:
 
-```typescript
-import "./test-mutations";
+```
+pepr new hello-world
 ```
 
-### demo/hello-world/index.ts
+This will create a new file called `capabilities/hello-world.ts` with the following contents:
 
 ```typescript
 import { Capability, a } from "pepr";
 
-const { When } = new Capability({
+export const HelloWorld = new Capability({
   // The unique name of the capability
   name: "hello-world",
   // A short description of the capability
@@ -63,6 +61,9 @@ const { When } = new Capability({
   // Limit what namespaces the capability can be used in (optional)
   namespaces: [],
 });
+
+// Use the 'When' function to create a new Capability Action
+const { When } = HelloWorld;
 ```
 
 Next, we need to define some actions to perform when specific Kubernetes resources are created, updated or deleted in the cluster. Pepr provides a set of actions that can be used to react to Kubernetes resources, such as `a.Pod`, `a.Deployment`, `a.CronJob`, etc. These actions can be chained together to create complex conditions, such as `a.Pod.IsCreated().InNamespace("default")` or `a.Deployment.IsUpdated().WithLabel("changeme=true")`. Below is an example of a capability that reacts to the creation of a Deployment resource:

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "pepr",
-    "version": "0.1.31",
+    "version": "0.1.33",
     "description": "Kubernetes application engine",
     "author": "Defense Unicorns",
     "homepage": "https://github.com/defenseunicorns/pepr",
@@ -32,7 +32,7 @@
         "prettier": "npx prettier src --check",
         "prettier:fix": "npm run prettier -- --write",
         "prepublishOnly": "rm -fr dist/* && npm run lint:fix && npm run prettier:fix && npm run test && npm run build",
-        "e2e-dev-setup": "k3d cluster delete pepr-dev && k3d cluster create pepr-dev",
+        "e2e-dev-setup": "k3d cluster delete pepr-dev && k3d cluster create pepr-dev --k3s-arg '--debug@server:0'",
         "e2e-dev": "npm run build && docker buildx build --tag pepr:dev . && k3d image import pepr:dev -c pepr-dev && node dist/pepr-cli.js deploy -f -i pepr:dev"
     },
     "dependencies": {

package/dist/src/cli/init/templates.js

@@ -24,7 +24,7 @@ new PeprModule(cfg, [
   HelloPepr,
 
   // Your additional capabilities go here
-]);    
+]);
 `,
     };
 }
@@ -134,8 +134,8 @@ Module Root
 `,
 };
 exports.samplesYaml = {
-    path: "samples.yaml",
-    data: (0, client_node_1.dumpYaml)([
+    path: "hello-pepr.samples.yaml",
+    data: [
         {
             apiVersion: "v1",
             kind: "Namespace",
@@ -179,7 +179,9 @@ exports.samplesYaml = {
                 key: "ex-3-val",
             },
         },
-    ]),
+    ]
+        .map(r => (0, client_node_1.dumpYaml)(r, { noRefs: true }))
+        .join("---\n"),
 };
 exports.helloPeprTS = {
     path: "hello-pepr.ts",
@@ -188,7 +190,7 @@ exports.helloPeprTS = {
 /**
  *  The HelloPepr is an example capability to demonstrate some general concepts of Pepr.
  *  To test this capability you can run \`pepr dev\` and then run the following command:
- *  \`kubectl apply -f capabilities/hello-pepr/samples.yaml\`
+ *  \`kubectl apply -f capabilities/hello-pepr.samples.yaml\`
  */ 
 export const HelloPepr = new Capability({
   name: "hello-pepr",

package/dist/src/lib/controller.js

@@ -53,17 +53,13 @@ class Controller {
                 const gvk = req.body?.request?.kind || { group: "", version: "", kind: "" };
                 console.log(`Mutate request: ${gvk.group}/${gvk.version}/${gvk.kind}`);
                 name && console.log(`                ${namespace}/${name}\n`);
-                // @todo: make this actually do something
                 const response = (0, processor_1.processor)(this.config, this.capabilities, req.body.request);
                 console.debug(response);
                 // Send a no prob bob response
                 res.send({
                     apiVersion: "admission.k8s.io/v1",
                     kind: "AdmissionReview",
-                    response: {
-                        uid: req.body.request.uid,
-                        allowed: true,
-                    },
+                    response,
                 });
             }
             catch (err) {

package/dist/src/lib/processor.js

@@ -14,7 +14,6 @@ function processor(config, capabilities, req) {
     const wrapped = new request_1.RequestWrapper(req);
     const response = {
         uid: req.uid,
-        patchType: "JSONPatch",
         warnings: [],
         allowed: false,
     };
@@ -61,7 +60,10 @@ function processor(config, capabilities, req) {
     const patches = (0, fast_json_patch_1.compare)(req.object, wrapped.Raw);
     // Only add the patch if there are patches to apply
     if (patches.length > 0) {
-        response.patch = JSON.stringify(patches);
+        response.patchType = "JSONPatch";
+        // Webhook must be base64-encoded
+        // https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/#response
+        response.patch = Buffer.from(JSON.stringify(patches)).toString("base64");
     }
     // Remove the warnings array if it's empty
     if (response.warnings.length < 1) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pepr",
-  "version": "0.1.31",
+  "version": "0.1.33",
   "description": "Kubernetes application engine",
   "author": "Defense Unicorns",
   "homepage": "https://github.com/defenseunicorns/pepr",
@@ -32,7 +32,7 @@
     "prettier": "npx prettier src --check",
     "prettier:fix": "npm run prettier -- --write",
     "prepublishOnly": "rm -fr dist/* && npm run lint:fix && npm run prettier:fix && npm run test && npm run build",
-    "e2e-dev-setup": "k3d cluster delete pepr-dev && k3d cluster create pepr-dev",
+    "e2e-dev-setup": "k3d cluster delete pepr-dev && k3d cluster create pepr-dev --k3s-arg '--debug@server:0'",
     "e2e-dev": "npm run build && docker buildx build --tag pepr:dev . && k3d image import pepr:dev -c pepr-dev && node dist/pepr-cli.js deploy -f -i pepr:dev"
   },
   "dependencies": {

package/cli.ts

@@ -1,3 +0,0 @@
-#!/usr/bin/env node
-
-import "./src/cli";