Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions CommunityToolkit.Aspire.sln
Original file line number Diff line number Diff line change
Expand Up @@ -365,6 +365,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CommunityToolkit.Aspire.Hos
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CommunityToolkit.Aspire.Hosting.Dapr", "src\CommunityToolkit.Aspire.Hosting.Dapr\CommunityToolkit.Aspire.Hosting.Dapr.csproj", "{27144ED2-9F74-4A86-AABA-38CD061D8984}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CommunityToolkit.Aspire.Hosting.Zitadel", "src\CommunityToolkit.Aspire.Hosting.Zitadel\CommunityToolkit.Aspire.Hosting.Zitadel.csproj", "{35C570A9-8109-4DE0-8F67-B665DF56BE2B}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Expand Down Expand Up @@ -955,6 +957,10 @@ Global
{27144ED2-9F74-4A86-AABA-38CD061D8984}.Debug|Any CPU.Build.0 = Debug|Any CPU
{27144ED2-9F74-4A86-AABA-38CD061D8984}.Release|Any CPU.ActiveCfg = Release|Any CPU
{27144ED2-9F74-4A86-AABA-38CD061D8984}.Release|Any CPU.Build.0 = Release|Any CPU
{35C570A9-8109-4DE0-8F67-B665DF56BE2B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{35C570A9-8109-4DE0-8F67-B665DF56BE2B}.Debug|Any CPU.Build.0 = Debug|Any CPU
{35C570A9-8109-4DE0-8F67-B665DF56BE2B}.Release|Any CPU.ActiveCfg = Release|Any CPU
{35C570A9-8109-4DE0-8F67-B665DF56BE2B}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
Expand Down Expand Up @@ -1138,6 +1144,7 @@ Global
{72652F7E-CFC0-4E3D-AD96-74C206A110BA} = {41ACF613-EE5A-5900-F4D1-9FB713A32BE8}
{92D490BC-B953-45DC-8F9D-A992B2AEF96A} = {41ACF613-EE5A-5900-F4D1-9FB713A32BE8}
{27144ED2-9F74-4A86-AABA-38CD061D8984} = {41ACF613-EE5A-5900-F4D1-9FB713A32BE8}
{35C570A9-8109-4DE0-8F67-B665DF56BE2B} = {414151D4-7009-4E78-A5C6-D99EBD1E67D1}
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {08B1D4B8-D2C5-4A64-BB8B-E1A2B29525F0}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<AdditionalPackageTags>Zitadel</AdditionalPackageTags>
<Description>Provides Zitadel IDP integration for Aspire.</Description>
</PropertyGroup>

<ItemGroup>
<PackageReference Include="Aspire.Hosting" />
</ItemGroup>

</Project>
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
namespace CommunityToolkit.Aspire.Hosting.Zitadel;

/// <summary>
/// Contains strings which describes the Zitadel container registry.
/// </summary>
internal static class ZitadelContainerImageTags
{
/// <summary>
/// ghcr.io
/// </summary>
public const string Registry = "ghcr.io";

/// <summary>
/// zitadel/zitadel
/// </summary>
public const string Image = "zitadel/zitadel";

/// <summary>
/// latest
/// </summary>
public const string Tag = "latest";
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does it ship specific version numbers? If so, can we pin it so that we ensure consistent behaviour over time.

Copy link
Author

@TheBrambleShark TheBrambleShark Mar 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It appears they have a mix of actual version numbers and generated ids. The generated ids appear to be builds for specific PRs/branches so I think we can ignore those.

How should we handle pinning these? Are you thinking a static class with const strings or an enum? Or do you mean just ship it with an explicit version as the tag rather than latest?

Edit: Here is the current latest version (not counting the hash value tags) https://github.com/zitadel/zitadel/pkgs/container/zitadel/376730503?tag=v2.66.14

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should align with the release that is published as latest - https://github.com/zitadel/zitadel/releases

Currently, that is v2.71.4

}
38 changes: 38 additions & 0 deletions src/CommunityToolkit.Aspire.Hosting.Zitadel/ZitadelResource.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using Aspire.Hosting;
using Aspire.Hosting.ApplicationModel;
using System.Security.Cryptography.Xml;

namespace CommunityToolkit.Aspire.Hosting.Zitadel;

/// <summary>
/// A resource that represents a Zitadel resource.
/// <param name="name">The name of the resource.</param>
/// <param name="admin">A parameter that contains the Zitadel admin, or <see langword="null"/> to use a default value.</param>
/// <param name="adminPassword">A parameter that contains the Zitadel admin password.</param>
/// </summary>
public sealed class ZitadelResource(string name, ParameterResource? admin, ParameterResource adminPassword)
: ContainerResource(name), IResourceWithServiceDiscovery
{
private const string DefaultAdmin = "zitadel-admin";

/// <summary>
/// Gets the parameter that contains the Zitadel admin username.
/// </summary>
public ParameterResource? AdminUserNameParameter { get; } = admin;

/// <summary>
/// Gets the parameter that contains the Zitadel admin username.
/// </summary>
internal ReferenceExpression AdminReference
=> AdminUserNameParameter is not null
? ReferenceExpression.Create($"{AdminUserNameParameter}")
: ReferenceExpression.Create($"{DefaultAdmin}");

/// <summary>
/// Gets the parameter that contains the Zitadel admin password.
/// </summary>
public ParameterResource AdminPasswordParameter { get; } = adminPassword ?? throw new ArgumentNullException(nameof(adminPassword));
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using Aspire.Hosting;
using Aspire.Hosting.ApplicationModel;

namespace CommunityToolkit.Aspire.Hosting.Zitadel;

/// <summary>
/// Provides extension methods for adding Zitadel resources to an <see cref="IDistributedApplicationBuilder"/>.
/// </summary>
public static class ZitadelResourceBuilderExtensions
{
private const string AdminEnvVarName = "ZITADEL_DEFAULTINSTANCE_ORG_HUMAN_USERNAME";
private const string AdminEnvVarPassword = "ZITADEL_DEFAULTINSTANCE_ORG_HUMAN_PASSWORD";

private const int DefaultcontainerPort = 8080; // ZITADEL_PORT
private const string ManagementEndpointName = "management";

/// <summary>
/// Adds a Zitadel container to the application model.
/// </summary>
/// <param name="builder">The <see cref="IDistributedApplicationBuilder"/>.</param>
/// <param name="name">The name of the resource. </param>
/// <param name="port">The host port that the underlying container is bound to when running locally.</param>
/// <param name="adminUsername">The parameter used as the admin for the Zitadel resource. If <see langword="null"/> a default value will be used.</param>
/// <param name="adminPassword">The parameter used as the admin password for the Zitadel resource. If <see langword="null"/> a default password will be used.</param>
/// <returns>A reference to the <see cref="IResourceBuilder{T}"/>.</returns>
public static IResourceBuilder<ZitadelResource> AddZitadel
(
this IDistributedApplicationBuilder builder,
string name,
int? port = null,
IResourceBuilder<ParameterResource>? adminUsername = null,
IResourceBuilder<ParameterResource>? adminPassword = null
)
{
ArgumentNullException.ThrowIfNull(builder);
ArgumentException.ThrowIfNullOrEmpty(name);

var passwordParameter = adminPassword?.Resource ??
ParameterResourceBuilderExtensions.CreateDefaultPasswordParameter(builder, $"{name}-password");

var resource = new ZitadelResource(name, adminUsername?.Resource, passwordParameter);

// TODO: Add health check
var zitadel = builder
.AddResource(resource)
.WithImage(ZitadelContainerImageTags.Image)
.WithImageRegistry(ZitadelContainerImageTags.Registry)
.WithImageTag(ZitadelContainerImageTags.Tag)
.WithHttpEndpoint(port: port, targetPort: DefaultcontainerPort)
.WithEnvironment(context =>
{
context.EnvironmentVariables[AdminEnvVarName] = resource.AdminReference;
context.EnvironmentVariables[AdminEnvVarPassword] = resource.AdminPasswordParameter;
// TODO: Implement Postgres/Cockroach DB integration. See https://zitadel.com/docs/self-hosting/deploy/compose
});

return zitadel;
}
}