feat(operator build): allow disable / force / onlyonrelease for operator config (#912)

This closes #699.

Author: buehler

docs/docs/operator/build-customization.mdx

@@ -41,15 +41,42 @@ You can customize the build process by setting the following MSBuild properties
 </PropertyGroup>
 ```
 
-### Disabling Automatic Generation
+### Disabling or Forcing Automatic Generation
 
-To disable automatic resource generation during build:
+The `GenerateOperatorResources` property controls when Kubernetes resources are generated during the build:
+
+- **`<GenerateOperatorResources>false</GenerateOperatorResources>`**: Disables automatic resource generation for all build configurations.
+- **`<GenerateOperatorResources>true</GenerateOperatorResources>`**: Forces resource generation for all build configurations (including Debug and Release).
+- **Unset or empty**: Resources are generated **only** for `Release` builds (default behavior).
+
+You can use this property in your project file as follows:
 
 ```xml
 <PropertyGroup>
-    <!-- Disable automatic generation -->
+    <!-- Disable automatic generation completely -->
     <GenerateOperatorResources>false</GenerateOperatorResources>
 </PropertyGroup>
+
+<PropertyGroup>
+    <!-- Force automatic generation for all builds -->
+    <GenerateOperatorResources>true</GenerateOperatorResources>
+</PropertyGroup>
+
+<PropertyGroup>
+    <!-- Only generate in Release (default if not set) -->
+    <!-- <GenerateOperatorResources></GenerateOperatorResources> -->
+</PropertyGroup>
+```
+
+#### Conditional Generation Example
+
+You can also conditionally enable or disable generation based on the build configuration:
+
+```xml
+<PropertyGroup>
+    <!-- Disable automatic generation in Debug mode -->
+    <GenerateOperatorResources Condition="'$(Configuration)' == 'Debug'">false</GenerateOperatorResources>
+</PropertyGroup>
 ```
 
 ## Build Process Details
@@ -168,3 +195,33 @@ dotnet tool install KubeOps.Cli
    - Verify the output directory exists
    - Check for permission issues
    - Ensure the path is valid for your OS
+
+## Using with the CRD Installer for Local Development
+
+For local development, you may want to not automatically generate resources in Debug mode and have them installed in your cluster. You can combine `GenerateOperatorResources` with the [CRD Installer utility](./utilities) for this purpose.
+
+For example, in your `Program.cs`:
+
+```csharp
+builder.Services
+    .AddKubernetesOperator()
+#if DEBUG
+    .AddCrdInstaller(c =>
+    {
+        c.OverwriteExisting = true;
+        c.DeleteOnShutdown = true;
+    })
+#endif
+    .RegisterComponents();
+```
+
+And in your project file:
+
+```xml
+<PropertyGroup>
+    <!-- Use the default behavior which does not generate resources in Debug mode -->
+    <GenerateOperatorResources></GenerateOperatorResources>
+</PropertyGroup>
+```
+
+This setup ensures that resources are always generated and installed automatically during development, but you can disable or restrict this behavior for production builds as needed.

examples/Operator/Operator.csproj

@@ -17,7 +17,7 @@
     </ItemGroup>
 
 <!--    <PropertyGroup>-->
-<!--        <KubeOpsCli>dotnet run &#45;&#45;project ../../src/KubeOps.Cli/ &#45;&#45; </KubeOpsCli>-->
+<!--        <KubeOpsCli>dotnet run &#45;&#45;project ../../src/KubeOps.Cli/KubeOps.Cli.csproj &#45;&#45;framework net9.0 &#45;&#45; </KubeOpsCli>-->
 <!--    </PropertyGroup>-->
 <!--    <Import Project="..\..\src\KubeOps.Operator\Build\KubeOps.Operator.targets" />-->
 

src/KubeOps.Operator/Build/KubeOps.Operator.targets

@@ -4,6 +4,7 @@
             <OperatorName Condition="'$(OperatorName)' == ''">$(AssemblyName.ToLowerInvariant())</OperatorName>
             <KubeOpsCli Condition="'$(KubeOpsCli)' == ''">dotnet kubeops</KubeOpsCli>
             <KubeOpsConfigOut Condition="'$(KubeOpsConfigOut)' == ''">$(MSBuildProjectDirectory)\config</KubeOpsConfigOut>
+            <GenerateOperatorResources Condition="'$(GenerateOperatorResources)' == '' And '$(Configuration)' == 'Release'">true</GenerateOperatorResources>
         </PropertyGroup>
     </Target>
 
@@ -45,8 +46,10 @@
         </Exec>
         <Message Importance="high" Condition="$(CliInstalled) == 1"
                  Text="KubeOps CLI is not installed as tool, cannot generate stuff for projects. Please install it with 'dotnet tool install KubeOps.Cli' to use automatic build generation." />
+        <Message Importance="high" Condition="'$(GenerateOperatorResources)' != 'true'"
+                 Text="Property 'GenerateOperatorResources' property did not evaluate to 'true'. Do not generate operator configs." />
         <CallTarget ContinueOnError="true"
                     Targets="GenerateKustomizationConfig"
-                    Condition="$(CliInstalled) == 0" />
+                    Condition="$(CliInstalled) == 0 And '$(GenerateOperatorResources)' == 'true'" />
     </Target>
-</Project>
+</Project>