KubernetesCRDModelGen.Tool 1.0.0-alpha.579

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 fac = new LoggerFactory();
  var generator = new Generator(fac);
  var code = generator.GenerateCode(crd);
  var assembly = generator.GenerateAssembly(crd)
  

• CLI
  • Install .Net Tool
    • dotnet tool install --global KubernetesCRDModelGen.Tool --prerelease
  • 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>net8.0</TargetFrameworks>
    <ImplicitUsings>enable</ImplicitUsings>
    <Nullable>enable</Nullable>
    <LangVersion>latest</LangVersion>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="KubernetesClient" Version="17.0.4" />
    <PackageReference Include="KubernetesCRDModelGen.SourceGenerator" Version="1.0.0-0" OutputItemType="Analyzer" ReferenceOutputAssembly="false" PrivateAssets="all" />
    <AdditionalFiles Include="*.yaml" />
  </ItemGroup>

</Project>

Published Packages

We publish the following premade packages

Type Mappings