fix: readme and namings (#45)

operator-framework · Nov 22, 2022 · 78830b3 · 78830b3
1 parent a219106
commit 78830b3
Show file tree

Hide file tree

Showing 8 changed files with 70 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -3,19 +3,61 @@
 Framework and tooling to support
 implementing [admission controllers](https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/)
 and [conversion hooks](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definition-versioning/#webhook-conversion)
-for Kubernetes in Java. Supports both **quarkus** and **spring boot**. Both Sync and Async programing model.
+for Kubernetes in Java. Supports both **quarkus** and **spring boot**. Both **sync** and **async** programing model.
 
 ## Sample Usage
 
 ### Admission Controllers
 
 Defining a mutation or validation controller is simple as:
 
-https://github.com/java-operator-sdk/kubernetes-webhooks-framework/blob/0946595d941b789caef6a69b34c2e5be8c6b59cf/samples/quarkus/src/main/java/io/javaoperatorsdk/admissioncontroller/sample/quarkus/AdmissionControllerConfig.java#L31-L68
+```java
 
-What can be then simple used in an endpoint:
+  @Singleton
+  @Named(MUTATING_CONTROLLER)
+  public AdmissionController<Pod> mutatingController() {
+    return new AdmissionController<>((resource, operation) -> {
+      if (resource.getMetadata().getLabels() == null) {
+        resource.getMetadata().setLabels(new HashMap<>());
+      }
+      resource.getMetadata().getLabels().putIfAbsent(APP_NAME_LABEL_KEY, "mutation-test");
+      return resource;
+    });
+  }
+
+  @Singleton
+  @Named(VALIDATING_CONTROLLER)
+  public AdmissionController<Pod> validatingController() {
+    return new AdmissionController<>((resource, operation) -> {
+      if (resource.getMetadata().getLabels() == null
+              || resource.getMetadata().getLabels().get(APP_NAME_LABEL_KEY) == null) {
+        throw new NotAllowedException("Missing label: " + APP_NAME_LABEL_KEY);
+      }
+    });
+  }
+
+```
+
+What can be simply used in an endpoint:
+
+```java
+  @POST
+  @Path(MUTATE_PATH)
+  @Consumes(MediaType.APPLICATION_JSON)
+  @Produces(MediaType.APPLICATION_JSON)
+  public AdmissionReview mutate(AdmissionReview admissionReview) {
+    return mutationController.handle(admissionReview);
+  }
+
+  @POST
+  @Path(VALIDATE_PATH)
+  @Consumes(MediaType.APPLICATION_JSON)
+  @Produces(MediaType.APPLICATION_JSON)
+  public AdmissionReview validate(AdmissionReview admissionReview) {
+    return validationController.handle(admissionReview);
+  }
+```
 
-https://github.com/java-operator-sdk/kubernetes-webhooks-framework/blob/0946595d941b789caef6a69b34c2e5be8c6b59cf/samples/quarkus/src/main/java/io/javaoperatorsdk/admissioncontroller/sample/quarkus/AdmissionEndpoint.java#L57-L89
 
 See samples also for details.
 
@@ -29,8 +71,22 @@ To create the controller
 register [mappers](https://github.com/java-operator-sdk/kubernetes-webhooks-framework/blob/main/core/src/main/java/io/javaoperatorsdk/webhook/conversion/Mapper.java)
 :
 
-https://github.com/java-operator-sdk/kubernetes-webhooks-framework/blob/2a2bce54b49ea3398bef95a9102ee8645e11cf87/samples/quarkus/src/main/java/io/javaoperatorsdk/webhook/admission/sample/quarkus/conversion/ConversionControllerConfig.java#L15-L29
+```java
+  @Singleton
+  public ConversionController conversionController() {
+    var controller = new ConversionController();
+    controller.registerMapper(new V1Mapper());
+    controller.registerMapper(new V2Mapper());
+    return controller;
+  }
+```
 
 and use the controllers in the endpoint:
 
-https://github.com/java-operator-sdk/kubernetes-webhooks-framework/blob/2a2bce54b49ea3398bef95a9102ee8645e11cf87/samples/spring-boot/src/main/java/io/javaoperatorsdk/webhook/sample/springboot/conversion/ConversionEndpoint.java#L29-L40
+```java
+  @PostMapping(CONVERSION_PATH)
+  @ResponseBody
+  public ConversionReview convert(@RequestBody ConversionReview conversionReview) {
+    return conversionController.handle(conversionReview);
+  }
+```
diff --git a/core/pom.xml b/core/pom.xml
@@ -10,7 +10,7 @@
   </parent>
 
   <artifactId>kubernetes-webhooks-framework-core</artifactId>
-  <name>Admission Controller Framework - Core</name>
+  <name>Kubernetes Webhooks Framework - Core</name>
   <packaging>jar</packaging>
 
   <build>

diff --git a/pom.xml b/pom.xml
@@ -6,7 +6,7 @@
     <groupId>io.javaoperatorsdk</groupId>
     <artifactId>kubernetes-webhooks-framework</artifactId>
     <version>0.2.1-SNAPSHOT</version>
-    <name>Kubernetes Webhooks Framework for Java</name>
+    <name>Kubernetes Webhooks Framework</name>
     <description>Framework to Implement Admission Controllers and Conversion Hooks in Java</description>
     <packaging>pom</packaging>
     <url>https://github.com/java-operator-sdk/kubernetes-webhooks-framework</url>

diff --git a/samples/commons/pom.xml b/samples/commons/pom.xml
@@ -10,7 +10,7 @@
 
 	<groupId>io.javaoperatorsdk.admissioncontroller.sample</groupId>
 	<artifactId>sample-commons</artifactId>
-	<name>Admission Controller Framework - Samples - Commons</name>
+	<name>Kubernetes Webhooks Framework - Samples - Commons</name>
 
 	<properties>
 		<java.version>11</java.version>

diff --git a/...commons/src/main/java/io/javaoperatorsdk/webhook/sample/commons/AdmissionControllers.java b/...commons/src/main/java/io/javaoperatorsdk/webhook/sample/commons/AdmissionControllers.java
@@ -21,7 +21,6 @@ public static AdmissionController<Pod> mutatingController() {
       if (resource.getMetadata().getLabels() == null) {
         resource.getMetadata().setLabels(new HashMap<>());
       }
-
       resource.getMetadata().getLabels().putIfAbsent(APP_NAME_LABEL_KEY, "mutation-test");
       return resource;
     });

diff --git a/samples/pom.xml b/samples/pom.xml
@@ -9,7 +9,7 @@
   </parent>
   <artifactId>kubernetes-webhooks-framework-samples</artifactId>
   <packaging>pom</packaging>
-  <name>Admission Controller Framework - Samples</name>
+  <name>Kubernetes Webhooks Framework - Samples</name>
   <modules>
     <module>commons</module>
     <module>spring-boot</module>

diff --git a/samples/quarkus/pom.xml b/samples/quarkus/pom.xml
@@ -7,9 +7,9 @@
     <artifactId>kubernetes-webhooks-framework-samples</artifactId>
     <version>0.2.1-SNAPSHOT</version>
   </parent>
-  <groupId>io.javaoperatorsdk.admissioncontroller.sample</groupId>
+  <groupId>io.javaoperatorsdk.webhook.sample</groupId>
   <artifactId>quarkus-sample</artifactId>
-  <name>Admission Controller Framework - Samples - Quarkus</name>
+  <name>Kubernetes Webhooks Framework - Samples - Quarkus</name>
   <properties>
     <compiler-plugin.version>3.8.1</compiler-plugin.version>
     <maven.compiler.release>11</maven.compiler.release>

diff --git a/samples/spring-boot/pom.xml b/samples/spring-boot/pom.xml
@@ -8,10 +8,10 @@
 		<version>0.2.1-SNAPSHOT</version>
 	</parent>
 
-	<groupId>io.javaoperatorsdk.admissioncontroller.sample</groupId>
+	<groupId>io.javaoperatorsdk.webhook.sample</groupId>
 	<artifactId>spring-boot-sample</artifactId>
 	<version>0.2.1-SNAPSHOT</version>
-	<name>Admission Controller Framework - Samples - Spring Boot</name>
+	<name>Kubernetes Webhooks Framework - Samples - Spring Boot</name>
 
 	<properties>
 		<java.version>11</java.version>