Skeleton!

Author: simone

Readme.md

@@ -1,5 +1,53 @@
-# Usefull command
+# Website operator
 
-minikube start
-docker build -t javaoperator .
-minikube image load javaoperator
+This repository contains an example schema of an operator written in .Net. You could use it in order to start develop your first Kubernetes operator!
+
+The schema contains three elements:
+- Controller (a.k.a. Reconciler)
+- Entity
+- Finalizer
+
+The **controller** is going to manage the "reconcile" step. It will watch over the observed resources and takes care of being sure that the k8s cluster state and the desired state are the same.
+
+The **entity** described the state that should be observed by the controller.
+
+The **finalizer** has the responsibility of dispose unused resources.
+
+## 💪🏻 Working software exercises
+You should start from this schema and implement the following feature:
+
+- feat n.1: Create a Pod with image nginx everytime a new custom resource of type website has been created
+- feat n.2: When a custom resource has been deleted, remove the linked resources (Pod)
+- feat n.3: When a new custom resource has been created or updated, the operator should deploy a deployment manifest and take the number of replicas from the new custom resource
+- feat n.4: When the pod starts, update the default nginx index.html and put inside a short description from the custom resource
+- feat n.5: Show time: 🎉 Create a NodePort service for that deployment and retreive the public ip address.
+
+## How to generate manifests
+
+You could use the [KubeOps.Cli](https://buehler.github.io/dotnet-operator-sdk/src/KubeOps.Cli/README.html) tool. It allows you to generate the needed files for your operator as well as managing resources in your Kubernetes cluster.
+
+    dotnet new tool-manifest
+    dotnet tool install KubeOps.Cli
+    dotnet kubeops gen op website --out ./manifests
+    //update the image in kustomization.yaml with the operator docker image you'll use
+    //set the imagePullPolicy: IfNotPresent property in the deployment
+
+## How to run in local env
+If you want to test the operator locally you could easily run it in a local minikube instance.
+
+Build operator image:
+
+    docker build -t javaoperator .
+
+Load the image in your local minikube cluster
+
+    minikube image load javaoperator
+
+Apply it:
+
+    kubectl apply -k manifests
+
+## Notes
+
+(*) Reconciles: it stands for the act of the operator to edit
+(reconcile) the status of the kubernetes cluster as we want (looking at the custom resource)

kubernetes-charts/operator-role.yaml

@@ -21,16 +21,16 @@ rules:
   verbs:
   - '*'
 - apiGroups:
-  - intre.com
+  - intre.it
   resources:
-  - sites
+  - websites
   verbs:
   - '*'
 - apiGroups:
-  - intre.com
+  - intre.it
   resources:
-  - sites/status
+  - websites/status
   verbs:
   - get
   - update
-  - patch
+  - patch

pom.xml

@@ -40,13 +40,6 @@
             <version>5.5.0</version>
         </dependency>
 
-        <dependency>
-            <groupId>io.fabric8</groupId>
-            <artifactId>crd-generator-apt</artifactId>
-            <version>6.9.2</version>
-            <scope>provided</scope>
-        </dependency>
-
         <dependency>
             <groupId>org.bouncycastle</groupId>
             <artifactId>bcprov-jdk18on</artifactId>

src/main/java/inter/com/javaoperator/controller/WebSiteReconciler.java

@@ -1,4 +1,4 @@
-package inter.com.javaoperator;
+package intre.it.javaoperator;
 
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;

src/main/java/inter/com/javaoperator/model/WebSiteSpec.java

@@ -1,6 +1,6 @@
-package inter.com.javaoperator.config;
+package intre.it.javaoperator.config;
 
-import inter.com.javaoperator.controller.WebSiteReconciler;
+import intre.it.javaoperator.controller.WebSiteReconciler;
 import io.javaoperatorsdk.operator.Operator;
 import io.javaoperatorsdk.operator.api.reconciler.Reconciler;
 import org.springframework.context.annotation.Bean;

…avaoperator/JavaoperatorApplication.java …avaoperator/JavaoperatorApplication.javasrc/main/java/inter/com/javaoperator/JavaoperatorApplication.java renamed to src/main/java/intre/it/javaoperator/JavaoperatorApplication.java src/main/java/inter/com/javaoperator/JavaoperatorApplication.java renamed to src/main/java/intre/it/javaoperator/JavaoperatorApplication.java

@@ -0,0 +1,25 @@
+package intre.it.javaoperator.controller;
+
+import intre.it.javaoperator.model.WebSite;
+import io.fabric8.kubernetes.client.KubernetesClient;
+import io.fabric8.kubernetes.client.KubernetesClientBuilder;
+import io.javaoperatorsdk.operator.api.reconciler.*;
+
+@ControllerConfiguration
+public class WebSiteReconciler implements Reconciler<WebSite>, Cleaner<WebSite> {
+    private final KubernetesClient client;
+
+    public WebSiteReconciler() {
+        this.client = new KubernetesClientBuilder().build();
+    }
+
+    @Override
+    public UpdateControl<WebSite> reconcile(WebSite WebSite, Context<WebSite> context) throws Exception {
+        return UpdateControl.patchStatus(WebSite);
+    }
+
+    @Override
+    public DeleteControl cleanup(WebSite webSite, Context<WebSite> context) {
+        return DeleteControl.defaultDelete();
+    }
+}

…nter/com/javaoperator/config/Config.java …intre/it/javaoperator/config/Config.javasrc/main/java/inter/com/javaoperator/config/Config.java renamed to src/main/java/intre/it/javaoperator/config/Config.java src/main/java/inter/com/javaoperator/config/Config.java renamed to src/main/java/intre/it/javaoperator/config/Config.java

@@ -1,11 +1,11 @@
-package inter.com.javaoperator.model;
+package intre.it.javaoperator.model;
 
 import io.fabric8.kubernetes.api.model.Namespaced;
 import io.fabric8.kubernetes.client.CustomResource;
 import io.fabric8.kubernetes.model.annotation.Group;
 import io.fabric8.kubernetes.model.annotation.Version;
 
-@Group("com.example.javaoperator")
+@Group("intre.it")
 @Version("v1")
 public class WebSite extends CustomResource<WebSiteSpec, WebSiteStatus> implements Namespaced {
 

src/main/java/intre/it/javaoperator/controller/WebSiteReconciler.java

@@ -0,0 +1,32 @@
+package intre.it.javaoperator.model;
+
+public class WebSiteSpec {
+
+    private String webSiteName;
+    private String url;
+    private String shortDescription;
+
+    public String getWebSiteName() {
+        return webSiteName;
+    }
+
+    public void setWebSiteName(String WebSite) {
+        this.webSiteName = WebSite;
+    }
+
+    public String getUrl() {
+        return url;
+    }
+
+    public void setUrl(String url) {
+        this.url = url;
+    }
+
+    public String getShortDescription() {
+        return shortDescription;
+    }
+
+    public void setShortDescription(String shortDescription) {
+        this.shortDescription = shortDescription;
+    }
+}