KubernetesCRDModelGen 1.5.0

KubernetesCRDModelGen

What is this?

This project contains components which allow generation of C# Classes/Assemblies from Kubernetes Custom Resource Definitions.

• KubernetesCRDModelGen
  • Custom Resource Definition to C# Class/Assembly Generator
• KubernetesCRDModelGen.SourceGenerator
  • Yaml to C# Source Generator
• KubernetesCRDModelGen.Tool
  • Yaml to C# Class Generator
• KubernetesCRDModelGen.Sync
  • Synchronizes Custom Resource Definitions from numerous sources

How to use

• Programmatically

  var crd = KubernetesYaml.LoadAllFromString(yaml);
  var generator = new Generator();
  var code = generator.GenerateCode(crd);
  var result = generator.GenerateAssembly(crd);
  using var unloadHandle = result.UnloadHandle;
  
  if (!result.Success)
  {
      foreach (var diagnostic in result.Diagnostics)
      {
          Console.WriteLine($"{diagnostic.Severity}: {diagnostic.Id}: {diagnostic.Message}");
      }
  }
  else
  {
      var assembly = result.Assembly;
      var xml = result.XmlDocumentation;
  }
  

• CLI
  • Install .Net Tool
    • dotnet tool install --global KubernetesCRDModelGen.Tool
  • Run
    • KubernetesCRDModelGen --FolderPath /path/to/yamls --Namespace Namespace

How to use the Source Generator

Create a C# Class Library Project and add some CRD yaml files to the project. Update the .csproj with the following settings. The Models will be generated in the "KubernetesCRDModelGen.Models.{CRD Group Name}" namespace.

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <TargetFrameworks>net10.0</TargetFrameworks>
    <ImplicitUsings>enable</ImplicitUsings>
    <Nullable>enable</Nullable>
    <LangVersion>latest</LangVersion>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="KubernetesClient" Version="19.0.2" />
    <PackageReference Include="KubernetesCRDModelGen.SourceGenerator" Version="2.*" />
  </ItemGroup>

  
  <ItemGroup>
    <AdditionalFiles Include="*.yaml" />
  </ItemGroup>

  
  <ItemGroup>
    
    <CRDYamlSourceUrls>https://app1.com/crd.yaml,https://app2.com/crd.yaml</CRDYamlSourceUrls>

    
    <CRDYamlSourceUrls>https://app1.com/crd.yaml</CRDYamlSourceUrls>
    <CRDYamlSourceUrls>$(CRDYamlSourceUrls),https://app2.com/crd.yaml</CRDYamlSourceUrls>
  </ItemGroup>

</Project>

Published Packages

We publish the following premade packages

Type Mappings