KubewardenPolicySDK 0.1.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package KubewardenPolicySDK --version 0.1.0                
NuGet\Install-Package KubewardenPolicySDK -Version 0.1.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="KubewardenPolicySDK" Version="0.1.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add KubewardenPolicySDK --version 0.1.0                
#r "nuget: KubewardenPolicySDK, 0.1.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install KubewardenPolicySDK as a Cake Addin
#addin nuget:?package=KubewardenPolicySDK&version=0.1.0

// Install KubewardenPolicySDK as a Cake Tool
#tool nuget:?package=KubewardenPolicySDK&version=0.1.0                

Kubewarden .NET Policy SDK

⚠️ Warning: experimental ⚠️

This code leverages dot-net-wasi-sdk, which is currently marked as experimental.

It also requires usage of .NET 7, which is currently in preview.

This library provides a SDK that can be used to write Kubewarden Policies using the C# programming language.

This is a first iteration of the SDK, it can be used to create both validating and mutating policies.

However, the following host capabilities are not exposed yet:

Requirements

The code requires .NET 7, which is currently (as of July 2022) in preview mode. Executing dotnet --version should return 7.0.100-preview.4 or later.

Policy quickstart

Start by creating a Console application:

dotnet new console -o MyFirstKubewardenPolicy
cd MyFirstKubewardenPolicy
dotnet add package Wasi.Sdk --prerelease
dotnet add package Kubewarden.Sdk

Edit the Program.cs file and replace its contents to match the following ones:

using WapcGuest;
using KubewardenPolicySDK;

namespace Policy;

public class IngressPolicy
{
  public static void Main()
  {
    var wapc = new Wapc();
    wapc.RegisterFunction("protocol_version", Kubewarden.ProtocolVersionGuest);
    wapc.RegisterFunction("validate", Validate);
    wapc.RegisterFunction("validate_settings", SettingsValidate);
  }

  static byte[] Validate(byte[] payload)
  {
    return Kubewarden.AcceptRequest();
  }

  static byte[] SettingsValidate(byte[] payload)
  {
    return Kubewarden.AcceptSettings();
  }
}

Finally, build the policy in this way:

dotnet build

This will produce a .wasm file under the bin/Debug directory. The policy can now be run using kwctl.

For a more complex example, checkout the examples directory.

Contribute

The author of this code is not a .NET expert, patches are welcome to improve the code quality and to make it more idiomatic.

Product Compatible and additional computed target framework versions.
.NET net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • net7.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.1.2 354 12/6/2022
0.1.1 413 7/4/2022
0.1.0 390 7/4/2022