Refactoring (#27)

Author: pmdevers

.github/workflows/build-publish.yml

@@ -1,10 +1,13 @@
 name: Build
 on: 
   push:
+    branches:
+      - main
+    tags:
+    - 'v*'
   pull_request:
-  release:
-    types:
-      - published
+    branches:
+      - main
 env:
   GITHUB_FEED: https://nuget.pkg.github.com/pmdevers/index.json
   GITHUB_USER: pmdevers
@@ -15,20 +18,27 @@ jobs:
   build:
     name: Build
     runs-on: ubuntu-latest
+    permissions:
+      packages: write
+      contents: write
     steps:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
+
       - name: Setup dotnet
         uses: actions/setup-dotnet@v4
         with:
           dotnet-version: '8.x.x'
+
       - name: Build
         run: dotnet build -c Release
+
       - name: Test
         run: dotnet test -c Release
+
       - name: DotNet Pack
-        if: github.event_name == 'release'
+        if: startsWith(github.ref, 'refs/tags/')
         run: |
           arrTag=(${GITHUB_REF//\// })
           VERSION="${arrTag[2]}"
@@ -38,13 +48,33 @@ jobs:
           dotnet pack -v normal --no-restore -p:PackageVersion=$VERSION --configuration Release --output packages
    
       - name: Upload Artifact
-        if: github.event_name == 'release'
+        if: startsWith(github.ref, 'refs/tags/')
         uses: actions/upload-artifact@v4
         with:
           name: nupkg
           path: packages/*.nupkg
-          
+        
+      - name: Create release notes
+        uses: johnyherangi/create-release-notes@main
+        if: startsWith(github.ref, 'refs/tags/')
+        id: create-release-notes
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Create Release
+        if: startsWith(github.ref, 'refs/tags/')
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: Release ${{ github.ref }}
+          body: ${{ steps.create-release-notes.outputs.release-notes }}
+          draft: false
+          prerelease: false 
+
       - name: DotNet NuGet Push  
-        if: github.event_name == 'release'
+        if: startsWith(github.ref, 'refs/tags/')
         run: dotnet nuget push "packages/*.nupkg" --source https://api.nuget.org/v3/index.json --api-key ${{ secrets.NUGET_KEY }} --skip-duplicate --no-symbols    
-    
+

examples/SimpleOperator/Program.cs

@@ -5,7 +5,8 @@
 
 
 var builder = OperatorHost.CreateOperatorApplicationBuilder(args)
-    .WithName("simple-operator");
+    .WithName("simple-operator")
+    .WithNamespace("simple-ops-system");
 
 builder.AddController<TestItemController>()
     .WithFinalizer("testitem.local.finalizer"); 

examples/SimpleOperator/Projects/ProjectController.cs

@@ -1,8 +1,9 @@
 using K8sOperator.NET;
+using K8sOperator.NET.Metadata;
 
 namespace SimpleOperator.Projects;
 
-
+[Namespace("default")]
 public class ProjectController(ILoggerFactory logger) : Controller<Project>
 {
     private readonly ILogger _logger = logger.CreateLogger<ProjectController>();

examples/SimpleOperator/Projects/TestItem.cs

@@ -1,5 +1,4 @@
 using k8s.Models;
-using K8sOperator.NET.Metadata;
 using K8sOperator.NET.Models;
 using static SimpleOperator.Projects.TestItem;
 
@@ -10,7 +9,6 @@ public class TestItem : CustomResource<TestItemSpec, TestItemStatus>
 {
     public class TestItemSpec
     {
-        public EntityScope Scope { get; set; }
         public string? String { get; set; }
     }
 

examples/SimpleOperator/install.yaml

@@ -9,7 +9,7 @@ spec:
     listKind: TestItemList
     plural: testitems
     singular: testitem
-  scope: Namespaced
+  scope: Cluster
   versions:
   - name: v1alpha1
     schema:
@@ -21,16 +21,9 @@ spec:
           spec:
             nullable: false
             properties:
-              scope:
-                enum:
-                - Namespaced
-                - Cluster
-                type: string
               string:
                 nullable: false
                 type: string
-            required:
-            - scope
             type: object
         type: object
     served: true
@@ -139,6 +132,7 @@ metadata:
   labels:
     operator-deployment: simple-operator
   name: simple-operator-deployment
+  namespace: simple-ops-system
 spec:
   replicas: 1
   revisionHistoryLimit: 0

src/K8sOperator.NET.Generators/Builders/CustomResourceDefinitionBuilderExtensions.cs

@@ -11,7 +11,7 @@ namespace K8sOperator.NET.Generators.Builders;
 /// <summary>
 /// Provides extension methods for building Kubernetes CustomResourceDefinitions.
 /// </summary>
-public static class CustomResourceDefinitionBuilderExtensions
+public static partial class CustomResourceDefinitionBuilderExtensions
 {
 
     /// <summary>

src/K8sOperator.NET.Generators/Builders/EntityScope.cs

@@ -0,0 +1,18 @@
+namespace K8sOperator.NET.Generators.Builders;
+
+
+/// <summary>
+/// 
+/// </summary>
+public enum EntityScope
+{
+    /// <summary>
+    /// The entity is scoped to a specific namespace.
+    /// </summary>
+    Namespaced = 0,
+
+    /// <summary>
+    /// The entity is scoped to the entire cluster.
+    /// </summary>
+    Cluster = 1
+}

src/K8sOperator.NET.Generators/Builders/KubernetesObjectBuilderExtentions.cs

@@ -25,6 +25,23 @@ public static IKubernetesObjectBuilder<T> WithName<T>(this IKubernetesObjectBuil
         return builder;
     }
 
+    /// <summary>
+    /// Sets the namespace of the kubernetes object
+    /// </summary>
+    /// <typeparam name="T">The type of the Kubernetes object.</typeparam>
+    /// <param name="builder">The builder instance.</param>
+    /// <param name="ns">The namespace to assign to the Kubernetes object.</param>
+    /// <returns>The configured builder.</returns>
+    public static IKubernetesObjectBuilder<T> WithNamespace<T>(this IKubernetesObjectBuilder<T> builder, string? ns)
+        where T : IMetadata<V1ObjectMeta> 
+    {
+        builder.Add(x => 
+        {
+            x.Metadata.SetNamespace(ns);
+        });
+        return builder;
+    }
+
     /// <summary>
     /// Adds a label to the Kubernetes object.
     /// </summary>

src/K8sOperator.NET.Generators/Install.cs

@@ -49,10 +49,11 @@ private async Task Write(IKubernetesObject obj)
     private static V1CustomResourceDefinition CreateCustomResourceDefinition(IEventWatcher item)
     {
         var group = item.Metadata.OfType<KubernetesEntityAttribute>().First();
-        var scope = item.Metadata.OfType<IEntityScopeMetadata>().First();
+        var scope = item.Metadata.OfType<INamespaceMetadata>().FirstOrDefault();
 
         var crdBuilder = new CustomResourceDefinitionBuilder();
-        crdBuilder.WithName($"{group.PluralName}.{group.Group}")
+        crdBuilder
+          .WithName($"{group.PluralName}.{group.Group}")
           .WithSpec()
               .WithGroup(group.Group)
               .WithNames(
@@ -61,7 +62,7 @@ private static V1CustomResourceDefinition CreateCustomResourceDefinition(IEventW
                  plural: group.PluralName,
                  singular: group.Kind.ToLower()
               )
-              .WithScope(scope.Scope)
+              .WithScope(scope == null ? EntityScope.Cluster : EntityScope.Namespaced)
               .WithVersion(
                     group.ApiVersion,
                     schema =>
@@ -76,12 +77,15 @@ private static V1CustomResourceDefinition CreateCustomResourceDefinition(IEventW
 
     private static V1Deployment CreateDeployment(IReadOnlyList<object> metadata)
     {
-        var name = metadata.TryGetValue<IOperatorNameMetadata, string>(x => x.Name)!;
+        var name = metadata.TryGetValue<IOperatorNameMetadata, string>(x => x.OperatorName)!;
         var image = metadata.TryGetValue<IImageMetadata, string>(x => x.GetImage())!;
+        var ns = metadata.TryGetValue<INamespaceMetadata, string>(x => x.Namespace);
 
         var deployment = DeploymentBuilder.Create();
 
-        deployment.WithName($"{name}-deployment")
+        deployment
+            .WithName($"{name}-deployment")
+            .WithNamespace(ns)
             .WithLabel("operator-deployment", name)
             .WithSpec()
                 .WithReplicas(1)
@@ -134,7 +138,7 @@ private static V1Deployment CreateDeployment(IReadOnlyList<object> metadata)
 
     private static V1ClusterRoleBinding CreateClusterRoleBinding(IReadOnlyList<object> metadata)
     {
-        var name = metadata.TryGetValue<IOperatorNameMetadata, string>(x => x.Name);
+        var name = metadata.TryGetValue<IOperatorNameMetadata, string>(x => x.OperatorName);
 
         var clusterrolebinding = new ClusterRoleBindingBuilder()
             .WithName($"{name}-role-binding")
@@ -146,7 +150,7 @@ private static V1ClusterRoleBinding CreateClusterRoleBinding(IReadOnlyList<objec
 
     private static V1ClusterRole CreateClusterRole(IReadOnlyList<object> metadata, IEnumerable<IEventWatcher> watchers)
     {
-        var name = metadata.TryGetValue<IOperatorNameMetadata, string>(x => x.Name);
+        var name = metadata.TryGetValue<IOperatorNameMetadata, string>(x => x.OperatorName);
 
         var clusterrole = new ClusterRoleBuilder()
                     .WithName($"{name}-role");

src/K8sOperator.NET/Builder/ControllerBuilder.cs

@@ -25,13 +25,10 @@ internal class ControllerBuilder(IServiceProvider serviceProvider, Type controll
     public IController Build()
     {
         var controller = (IController)ActivatorUtilities.CreateInstance(_serviceProvider, _controllerType);
-        var attribute = controller.ResourceType.GetCustomAttribute<KubernetesEntityAttribute>();
-
-        if (attribute is not null)
-        {
-            Metadata.Add(attribute);
-        }
+        Metadata.AddRange(_controllerType.GetCustomAttributes());
 
+        var attributes = controller.ResourceType.GetCustomAttributes();
+        Metadata.AddRange(attributes);
         return controller;
     }
 }