Skip to content

Latest commit

 

History

History
73 lines (51 loc) · 1.81 KB

README.md

File metadata and controls

73 lines (51 loc) · 1.81 KB
Raw

KubeOps Dotnet New Templates

To use the operator SDK as easy as possible, this Nuget Package contains dotnet new templates. These templates enable developers to create Kubernetes operators with the simple dotnet new command in C# or F#.

Installation

To install the template package, use the dotnet cli (or you may use the exact version as provided in the link above):

dotnet new --install KubeOps.Templates::*

As soon as the templates are installed, you may use them with:

dotnet new operator
#or
dotnet new operator-empty

Note that several of the templates are available in multiple languages of the .NET framework (i.e. C# and F#) and you may switch the language with the -lang flag of dotnet new.

Templates

Empty Operator

Available Languages: C#, F#

Type: Generate a project

Templatename: operator-empty

Example installation: dotnet new operator-empty -n MyOperator

Description: This template contains the well known Program.cs and Startup.cs files of any other ASP.NET project and configures the startup file to use KubeObs. No additional code is provided.

Demo Operator

Available Languages: C#, F#

Type: Generate a project

Templatename: operator

Example installation: dotnet new operator -n MyOperator

Description: This template contains the well known Program.cs and Startup.cs files of any other ASP.NET project and configures the startup file to use KubeObs. In addition to the empty operator, an example file for each "concept" is provided. You'll find an example implementation of:

  • A resource controller
  • A custom entity (that generates a CRD)
  • A finalizer
  • A validation webhook
  • A mutation webhook

This template is meant to show all possible elements of KubeOps in one go.