feat(generator): add controller registrations (#623)

This generates `.AddController<T,T>` register calls
for the operator builder to enable convenient registering.

Author: buehler

examples/Operator/Controller/V1TestEntityController.cs

@@ -19,13 +19,13 @@ public V1TestEntityController(ILogger<V1TestEntityController> logger)
 
     public Task ReconcileAsync(V1TestEntity entity)
     {
-        _logger.LogInformation("Reconciling entity {EntityName}.", entity.Metadata.Name);
+        _logger.LogInformation("Reconciling entity {Entity}.", entity);
         return Task.CompletedTask;
     }
 
     public Task DeletedAsync(V1TestEntity entity)
     {
-        _logger.LogInformation("Deleting entity {EntityName}.", entity.Metadata.Name);
+        _logger.LogInformation("Deleting entity {Entity}.", entity);
         return Task.CompletedTask;
     }
 }

examples/Operator/Entities/V1TestEntity.cs

@@ -15,4 +15,6 @@ public class V1TestEntity : IKubernetesObject<V1ObjectMeta>, ISpec<V1TestEntityS
     public V1TestEntitySpec Spec { get; set; } = new();
 
     public V1TestEntityStatus Status { get; set; } = new();
+
+    public override string ToString() => $"Test Entity ({Metadata.Name}): {Spec.Username} ({Spec.Email})";
 }

examples/Operator/Entities/V1TestEntitySpec.cs

@@ -1,12 +1,8 @@
-using k8s.Models;
-
 namespace Operator.Entities;
 
 public class V1TestEntitySpec
 {
-    public string Spec { get; set; } = string.Empty;
-
     public string Username { get; set; } = string.Empty;
 
-    public IntstrIntOrString StringOrInteger { get; set; } = 42;
+    public string Email { get; set; } = string.Empty;
 }

examples/Operator/Program.cs

@@ -3,17 +3,13 @@
 using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Logging;
 
-using Operator.Controller;
-using Operator.Entities;
-
 var builder = Host.CreateApplicationBuilder(args);
 
 builder.Logging.SetMinimumLevel(LogLevel.Trace);
 
 builder.Services
     .AddKubernetesOperator()
-    .RegisterEntitiyMetadata()
-    .AddController<V1TestEntityController, V1TestEntity>();
+    .RegisterResources();
 
 using var host = builder.Build();
 await host.RunAsync();

examples/Operator/test_entity.yaml

@@ -2,3 +2,6 @@ apiVersion: testing.dev/v1
 kind: TestEntity
 metadata:
   name: my-test-entity
+spec:
+  username: my-username
+  email: [email protected]

examples/Operator/todos.txt

@@ -0,0 +1,10 @@
+todo:
+- finalizer
+- events
+- leadership election
+- requeue
+- build targets
+- other CLI commands
+- web: webhooks
+- cache?
+- try .net 8 AOT?

src/KubeOps.Abstractions/Entities/CustomKubernetesEntity.cs

@@ -1,16 +1,16 @@
-using k8s;
-using k8s.Models;
-
-namespace KubeOps.Abstractions.Entities;
-
-/// <summary>
-/// Base class for custom Kubernetes entities. The interface <see cref="IKubernetesObject{TMetadata}"/>
-/// can be used on its own, but this class provides convenience initializers.
-/// </summary>
-public abstract class CustomKubernetesEntity : KubernetesObject, IKubernetesObject<V1ObjectMeta>
-{
-    /// <summary>
-    /// The metadata of the kubernetes object.
-    /// </summary>
-    public V1ObjectMeta Metadata { get; set; } = new();
-}
+using k8s;
+using k8s.Models;
+
+namespace KubeOps.Abstractions.Entities;
+
+/// <summary>
+/// Base class for custom Kubernetes entities. The interface <see cref="IKubernetesObject{TMetadata}"/>
+/// can be used on its own, but this class provides convenience initializers.
+/// </summary>
+public abstract class CustomKubernetesEntity : KubernetesObject, IKubernetesObject<V1ObjectMeta>
+{
+    /// <summary>
+    /// The metadata of the kubernetes object.
+    /// </summary>
+    public V1ObjectMeta Metadata { get; set; } = new();
+}

src/KubeOps.Abstractions/Entities/CustomKubernetesEntity{TSpec,TStatus}.cs

@@ -1,21 +1,21 @@
-using k8s;
-
-namespace KubeOps.Abstractions.Entities;
-
-/// <summary>
-/// Defines a custom Kubernetes entity.
-/// This entity contains a spec (like <see cref="CustomKubernetesEntity{TSpec}"/>)
-/// and a status (<see cref="Status"/>) which can be updated to reflect the state
-/// of the entity.
-/// </summary>
-/// <typeparam name="TSpec">The type of the specified data.</typeparam>
-/// <typeparam name="TStatus">The type of the status data.</typeparam>
-public abstract class CustomKubernetesEntity<TSpec, TStatus> : CustomKubernetesEntity<TSpec>, IStatus<TStatus>
-    where TSpec : new()
-    where TStatus : new()
-{
-    /// <summary>
-    /// Status object for the entity.
-    /// </summary>
-    public TStatus Status { get; set; } = new();
-}
+using k8s;
+
+namespace KubeOps.Abstractions.Entities;
+
+/// <summary>
+/// Defines a custom Kubernetes entity.
+/// This entity contains a spec (like <see cref="CustomKubernetesEntity{TSpec}"/>)
+/// and a status (<see cref="Status"/>) which can be updated to reflect the state
+/// of the entity.
+/// </summary>
+/// <typeparam name="TSpec">The type of the specified data.</typeparam>
+/// <typeparam name="TStatus">The type of the status data.</typeparam>
+public abstract class CustomKubernetesEntity<TSpec, TStatus> : CustomKubernetesEntity<TSpec>, IStatus<TStatus>
+    where TSpec : new()
+    where TStatus : new()
+{
+    /// <summary>
+    /// Status object for the entity.
+    /// </summary>
+    public TStatus Status { get; set; } = new();
+}

src/KubeOps.Abstractions/Entities/CustomKubernetesEntity{TSpec}.cs

@@ -1,17 +1,17 @@
-using k8s;
-
-namespace KubeOps.Abstractions.Entities;
-
-/// <summary>
-/// Defines a custom kubernetes entity which can be used in finalizers and controllers.
-/// This entity contains a <see cref="Spec"/>, which means in contains specified data.
-/// </summary>
-/// <typeparam name="TSpec">The type of the specified data.</typeparam>
-public abstract class CustomKubernetesEntity<TSpec> : CustomKubernetesEntity, ISpec<TSpec>
-    where TSpec : new()
-{
-    /// <summary>
-    /// Specification of the kubernetes object.
-    /// </summary>
-    public TSpec Spec { get; set; } = new();
-}
+using k8s;
+
+namespace KubeOps.Abstractions.Entities;
+
+/// <summary>
+/// Defines a custom kubernetes entity which can be used in finalizers and controllers.
+/// This entity contains a <see cref="Spec"/>, which means in contains specified data.
+/// </summary>
+/// <typeparam name="TSpec">The type of the specified data.</typeparam>
+public abstract class CustomKubernetesEntity<TSpec> : CustomKubernetesEntity, ISpec<TSpec>
+    where TSpec : new()
+{
+    /// <summary>
+    /// Specification of the kubernetes object.
+    /// </summary>
+    public TSpec Spec { get; set; } = new();
+}

src/KubeOps.Abstractions/Entities/EntityList.cs

@@ -1,22 +1,22 @@
-using k8s;
-using k8s.Models;
-
-namespace KubeOps.Abstractions.Entities;
-
-/// <summary>
-/// Type for a list of entities.
-/// </summary>
-/// <typeparam name="T">Type for the list entries.</typeparam>
-public class EntityList<T> : KubernetesObject
-    where T : IKubernetesObject
-{
-    /// <summary>
-    /// Official list metadata object of kubernetes.
-    /// </summary>
-    public V1ListMeta Metadata { get; set; } = new();
-
-    /// <summary>
-    /// The list of items.
-    /// </summary>
-    public IList<T> Items { get; set; } = new List<T>();
-}
+using k8s;
+using k8s.Models;
+
+namespace KubeOps.Abstractions.Entities;
+
+/// <summary>
+/// Type for a list of entities.
+/// </summary>
+/// <typeparam name="T">Type for the list entries.</typeparam>
+public class EntityList<T> : KubernetesObject
+    where T : IKubernetesObject
+{
+    /// <summary>
+    /// Official list metadata object of kubernetes.
+    /// </summary>
+    public V1ListMeta Metadata { get; set; } = new();
+
+    /// <summary>
+    /// The list of items.
+    /// </summary>
+    public IList<T> Items { get; set; } = new List<T>();
+}