Arkanis.Aspire.Hosting.Extensions.Kubernetes.ExternalSecrets 1.0.0-dev.22

This is a prerelease version of Arkanis.Aspire.Hosting.Extensions.Kubernetes.ExternalSecrets.
dotnet add package Arkanis.Aspire.Hosting.Extensions.Kubernetes.ExternalSecrets --version 1.0.0-dev.22
                    
NuGet\Install-Package Arkanis.Aspire.Hosting.Extensions.Kubernetes.ExternalSecrets -Version 1.0.0-dev.22
                    
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="Arkanis.Aspire.Hosting.Extensions.Kubernetes.ExternalSecrets" Version="1.0.0-dev.22" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Arkanis.Aspire.Hosting.Extensions.Kubernetes.ExternalSecrets" Version="1.0.0-dev.22" />
                    
Directory.Packages.props
<PackageReference Include="Arkanis.Aspire.Hosting.Extensions.Kubernetes.ExternalSecrets" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Arkanis.Aspire.Hosting.Extensions.Kubernetes.ExternalSecrets --version 1.0.0-dev.22
                    
#r "nuget: Arkanis.Aspire.Hosting.Extensions.Kubernetes.ExternalSecrets, 1.0.0-dev.22"
                    
#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.
#:package Arkanis.Aspire.Hosting.Extensions.Kubernetes.ExternalSecrets@1.0.0-dev.22
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Arkanis.Aspire.Hosting.Extensions.Kubernetes.ExternalSecrets&version=1.0.0-dev.22&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=Arkanis.Aspire.Hosting.Extensions.Kubernetes.ExternalSecrets&version=1.0.0-dev.22&prerelease
                    
Install as a Cake Tool

Arkanis.Aspire.Hosting.Extensions.Kubernetes.ExternalSecrets

NuGet License

.NET Aspire hosting extensions for publishing External Secrets Operator manifests from AppHost configuration. This package adds Kubernetes environment helpers, ExternalSecret builders, and 1Password External Secrets remote-reference mapping.

Installation

dotnet add package Arkanis.Aspire.Hosting.Extensions.Kubernetes.ExternalSecrets

Quick Start

using Aspire.Hosting;
using Aspire.Hosting.Extensions.Kubernetes.ExternalSecrets;
using Aspire.Hosting.Extensions.Kubernetes.ExternalSecrets.OnePassword;

var builder = DistributedApplication.CreateBuilder(args);

var apiKey = builder.AddParameter("ApiKey", secret: true);
var api = builder.AddProject<Projects.Api>("api");
var kubernetes = builder.AddKubernetesEnvironment("kubernetes");

api.WithKubernetesExternalSecret("api-secrets", secret => secret
    .MapOnePasswordParameter("ApiKey", apiKey, builder.Configuration)
    .InKubernetesEnvironment(kubernetes));

builder.Build().Run();

WithKubernetesExternalSecret(...) emits the explicit ExternalSecret manifest during Kubernetes publish. It does not require a separate environment-level WithExternalSecrets(...) call.

Configure environment defaults when multiple resource-local ExternalSecrets should share a store reference or refresh interval.

kubernetes.WithExternalSecrets(ExternalSecretsOptions.FromConfiguration(builder.Configuration));

You can also configure those defaults in code.

kubernetes.WithExternalSecrets(secrets => secrets
    .WithSecretStore(ExternalSecretStoreOptions.ClusterSecretStore("shared-store"))
    .WithRefreshInterval("30m"));

api.WithKubernetesExternalSecret("api-secrets", secret => secret
    .MapRemoteSecret("ApiKey", apiKey, remoteKey: "Shared/API", remoteProperty: "credential")
    .InKubernetesEnvironment(kubernetes));

builder.Build().Run();

Source ownership and generated passwords

New AppHosts should keep parameters source-agnostic and let the Kubernetes environment select their publish-time source. WithExternalSecrets(...) automatically infers ownership from normal typed Aspire environment values whenever their selected source is owned outside Helm/Aspire. This includes direct parameter values, URI expressions, and connection strings such as a Redis reference. The publisher centrally allocates each Kubernetes Secret target after it resolves source ownership.

WithKubernetesExternalSecretProjection(...) is an escape hatch for custom transformations or values whose typed provenance cannot be represented safely. It is not needed for normal WithReference(...) usage.

using Arkanis.Aspire.Hosting.Extensions.Kubernetes.ExternalSecrets.SecretSources;

var redisPassword = builder.AddParameter("redis-password", secret: true);

kubernetes.WithExternalSecrets(secrets => secrets
    .WithParameterSource(redisPassword, source => source
        .UsePasswordGenerator(password => password
            .WithLength(32)
            .WithDigits(4)
            .WithSymbols(4)
            .CreatedOnce())));

var redis = builder.AddRedis("redis", password: redisPassword);
api.WithReference(redis, "Redis");

Configuration can select a source per environment, with ParameterSources keyed by parameter name or explicit configuration key. At publish time, a matching configuration entry overrides the code-first source default for that parameter. The static configuration example intentionally contains the rendered 1Password prefix; C# code should use OnePasswordSecretReference.Prefix.

Kubernetes:
  Secrets:
    ParameterSources:
      redis-password:
        kind: PasswordGenerator
        password:
          length: 32
          digits: 4
          symbols: 4
          rotation: CreatedOnce
      api-client-secret:
        kind: ExternalProvider
        provider:
          reference: op://Shared/Api/client-secret
      imported-token:
        kind: ExistingSecret
        existingSecret:
          name: platform-token
          key: token

One generated parameter produces one Password generator invocation and one shared materialized target for all of its consumers. The generated Password resource emits every direct logical key that its workloads consume, then ESO target templates derive URIs and connection strings from that one value. Generated target values use Helm raw-string actions so ESO template expressions survive chart rendering for controller-side evaluation. CreatedOnce uses ESO's immutable orphan target policy for stable infrastructure credentials. Choose Periodic or OnChange only when every consumer and the backing system support coordinated credential rotation. Derived values are valid only when all their secret dependencies have the same ownership target; incompatible dependencies fail before Helm runs. An unrepresentable typed expression fails with ESO2007, and incompatible definitions for one shared target key fail with ESO2008. The publisher writes non-secret secret-ownership.json and secret-ownership.md artifacts beside chart output. They list resource identities, keys, source kinds, owners, targets, and dependencies, but deliberately exclude concrete values and provider references. Shared Password generator and materializer manifests are written under templates/generated-secrets so their chart location does not depend on the first consuming workload.

WithKubernetesExternalSecret(string, ...) remains available for existing AppHosts but is obsolete because an explicit target name bypasses central ownership allocation.

Automatically inferred and explicit projected bindings both rewrite generated Kubernetes workload application and init-container Secret selectors, including whole-Secret envFrom imports. The typed Aspire Kubernetes publisher currently emits Deployment and StatefulSet workloads. The rendered-chart rewriter also recognizes standard DaemonSet, ReplicaSet, Job, and CronJob pod-template paths. Docker Compose and other non-Kubernetes publish targets are unchanged because they do not emit ESO resources or Kubernetes Secret selectors.

Secret Reload Restarts

WithKubernetesExternalSecret(...) rewrites matching generated environment variables to read from the ExternalSecret target Secret. When it emits those secretKeyRef entries, the generated workload metadata receives reloader.stakater.com/auto: "true" so Stakater Reloader can roll the workload after the referenced Secret changes.

api.WithKubernetesExternalSecret("api-secrets", secret =>
    secret.MapOnePasswordParameter(
        "ApiKey",
        apiKey,
        builder.Configuration));

api.WithoutSecretReloadRestart();

Use WithoutSecretReloadRestart() only for workloads that must not restart automatically after a referenced Kubernetes Secret rotates.

Scope

This package emits External Secrets Operator resource intent during Aspire publish. It does not install External Secrets Operator, create a cluster secret store, or grant live-cluster access.

Dependency

This package references Arkanis.Aspire.Hosting.Extensions.Kubernetes.

Repository

Source, issues, and release workflow details are available at https://github.com/ArkanisCorporation/Aspire.Hosting.Extensions.Kubernetes.

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

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Arkanis.Aspire.Hosting.Extensions.Kubernetes.ExternalSecrets:

Package Downloads
Arkanis.Aspire.Hosting.Extensions.Kubernetes.CloudNativePostgres

Reusable Aspire hosting extensions for publishing CloudNativePG database resources and credentials ExternalSecrets.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.0-dev.22 386 9/27/2026
1.0.0-dev.21 78 9/27/2026
1.0.0-dev.20 165 9/18/2026
1.0.0-dev.19 101 9/17/2026
1.0.0-dev.18 177 9/11/2026
1.0.0-dev.17 349 8/8/2026
1.0.0-dev.16 101 8/7/2026
1.0.0-dev.15 94 8/7/2026
1.0.0-dev.14 108 8/6/2026
1.0.0-dev.13 93 8/6/2026
1.0.0-dev.12 103 8/6/2026
1.0.0-dev.11 96 8/6/2026
1.0.0-dev.10 101 8/5/2026
1.0.0-dev.9 135 8/1/2026
1.0.0-dev.8 98 8/1/2026
1.0.0-dev.7 250 7/5/2026
1.0.0-dev.6 107 7/5/2026
1.0.0-dev.5 117 7/4/2026
1.0.0-dev.4 107 7/3/2026
1.0.0-dev.3 102 7/2/2026
Loading failed