feat(operator): add build targets extension for automatic resource ge…

…neration

BREAKING CHANGE: The targets file contains
other properties than before. Refer to the
documentation for explicit details.

.config/dotnet-tools.json

@@ -4,9 +4,7 @@
   "tools": {
     "docfx": {
       "version": "2.71.0",
-      "commands": [
-        "docfx"
-      ]
+      "commands": ["docfx"]
     }
   }
 }

examples/.gitignore

@@ -0,0 +1,2 @@
+config/
+Dockerfile

examples/Operator/Controller/V1SecondEntityController.cs

@@ -23,8 +23,9 @@ public V1SecondEntityController(
         _logger = logger;
     }
 
-    public async Task ReconcileAsync(V1SecondEntity entity)
+    public Task ReconcileAsync(V1SecondEntity entity)
     {
         _logger.LogInformation("Reconciling entity {Entity}.", entity);
+        return Task.CompletedTask;
     }
 }

examples/Operator/todos.txt

@@ -1,6 +1,4 @@
 todo:
-- other CLI commands
-- build targets
 - error handling
 - web: webhooks
 - docs

src/KubeOps.Cli/Arguments.cs

@@ -41,4 +41,8 @@ var slnFile
         "namespace",
         () => "default",
         "The Kubernetes namespace that the operator will be run.");
+
+    public static readonly Argument<string> OperatorName = new(
+        "name",
+        "Name of the operator.");
 }

src/KubeOps.Cli/Commands/Generator/CrdGenerator.cs

@@ -16,16 +16,14 @@ public static Command Command
     {
         get
         {
-            var cmd = new Command("crd", "Generates CRDs for Kubernetes based on a solution or project.")
+            var cmd = new Command("crds", "Generates CRDs for Kubernetes based on a solution or project.")
             {
                 Options.OutputFormat,
                 Options.OutputPath,
                 Options.SolutionProjectRegex,
                 Options.TargetFramework,
                 Arguments.SolutionOrProjectFile,
             };
-            cmd.AddAlias("crds");
-            cmd.AddAlias("c");
             cmd.SetHandler(ctx => Handler(AnsiConsole.Console, ctx));
 
             return cmd;

src/KubeOps.Cli/Commands/Generator/Generator.cs → src/KubeOps.Cli/Commands/Generator/Generate.cs

@@ -3,17 +3,18 @@
 
 namespace KubeOps.Cli.Commands.Generator;
 
-internal static class Generator
+internal static class Generate
 {
     public static Command Command
     {
         get
         {
-            var cmd = new Command("generator", "Generates elements related to an operator.")
+            var cmd = new Command("generate", "Generates elements related to an operator.")
             {
                 CertificateGenerator.Command,
                 CrdGenerator.Command,
                 DockerGenerator.Command,
+                InstallerGenerator.Command,
                 OperatorGenerator.Command,
                 RbacGenerator.Command,
             };

src/KubeOps.Cli/Commands/Generator/InstallerGenerator.cs

@@ -0,0 +1,68 @@
+using System.CommandLine;
+using System.CommandLine.Invocation;
+
+using k8s;
+using k8s.Models;
+
+using KubeOps.Abstractions.Kustomize;
+using KubeOps.Cli.Output;
+
+using Spectre.Console;
+
+namespace KubeOps.Cli.Commands.Generator;
+
+internal static class InstallerGenerator
+{
+    public static Command Command
+    {
+        get
+        {
+            var cmd = new Command("installer", "Generates Kustomization YAML to install the entire operator.")
+            {
+                Options.OutputPath, Options.OutputFormat, Arguments.OperatorName,
+            };
+            cmd.SetHandler(ctx => Handler(AnsiConsole.Console, ctx));
+
+            return cmd;
+        }
+    }
+
+    internal static async Task Handler(IAnsiConsole console, InvocationContext ctx)
+    {
+        var outPath = ctx.ParseResult.GetValueForOption(Options.OutputPath);
+        var format = ctx.ParseResult.GetValueForOption(Options.OutputFormat);
+        var name = ctx.ParseResult.GetValueForArgument(Arguments.OperatorName);
+
+        var result = new ResultOutput(console, format);
+        console.WriteLine("Generate operator installer.");
+
+        result.Add(
+            $"namespace.{format.ToString().ToLowerInvariant()}",
+            new V1Namespace(metadata: new(name: "system")).Initialize());
+        result.Add(
+            $"kustomization.{format.ToString().ToLowerInvariant()}",
+            new KustomizationConfig
+            {
+                NamePrefix = $"{name}-",
+                Namespace = $"{name}-system",
+                CommonLabels = new Dictionary<string, string> { { "operator", name }, },
+                Resources = new List<string>
+                {
+                    $"./namespace.{format.ToString().ToLowerInvariant()}", "./rbac", "./operator", "./crds",
+                },
+                Images = new List<KustomizationImage>
+                {
+                    new() { Name = "operator", NewName = "accessible-docker-image", NewTag = "latest", },
+                },
+            });
+
+        if (outPath is not null)
+        {
+            await result.Write(outPath);
+        }
+        else
+        {
+            result.Write();
+        }
+    }
+}

src/KubeOps.Cli/Commands/Generator/RbacGenerator.cs

@@ -28,7 +28,6 @@ public static Command Command
                 Options.TargetFramework,
                 Arguments.SolutionOrProjectFile,
             };
-            cmd.AddAlias("r");
             cmd.SetHandler(ctx => Handler(AnsiConsole.Console, ctx));
 
             return cmd;

src/KubeOps.Cli/Program.cs

@@ -13,7 +13,7 @@
 return await new CommandLineBuilder(new RootCommand(
         "CLI for KubeOps. Commandline tool to help with management tasks such as generating or installing CRDs.")
     {
-        Generator.Command, Version.Command, Install.Command, Uninstall.Command,
+        Generate.Command, Version.Command, Install.Command, Uninstall.Command,
     })
     .UseDefaults()
     .UseParseErrorReporting(ExitCodes.UsageError)

src/KubeOps.Cli/Properties/launchSettings.json

@@ -4,7 +4,7 @@
     "CLI Generate RBAC": {
       "commandName": "Project",
       "workingDirectory": "$(ProjectDir)",
-      "commandLineArgs": "gen rbac ../../examples/Operator/Operator.csproj"
+      "commandLineArgs": "g rbac ../../examples/Operator/Operator.csproj"
     },
     "CLI Generate Cert": {
       "commandName": "Project",
@@ -14,7 +14,7 @@
     "CLI Generate CRDs": {
       "commandName": "Project",
       "workingDirectory": "$(ProjectDir)",
-      "commandLineArgs": "g c ../../examples/Operator/Operator.csproj"
+      "commandLineArgs": "g crds ../../examples/Operator/Operator.csproj"
     },
     "CLI Generate Operator": {
       "commandName": "Project",
@@ -26,6 +26,11 @@
       "workingDirectory": "$(ProjectDir)",
       "commandLineArgs": "g docker"
     },
+    "CLI Generate Installer": {
+      "commandName": "Project",
+      "workingDirectory": "$(ProjectDir)",
+      "commandLineArgs": "g installer demo-operator"
+    },
     "CLI Install": {
       "commandName": "Project",
       "workingDirectory": "$(ProjectDir)",