Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow TLS to Goldmane #3807

Merged
merged 3 commits into from
Mar 8, 2025
Merged

Allow TLS to Goldmane #3807

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
afae299
Allow TLS for Goldmane API
caseydavenport Mar 7, 2025
14dba95
include trusted bundle in volume mounts
caseydavenport Mar 7, 2025
39ea34d
Fix ut
caseydavenport Mar 7, 2025
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
26 changes: 25 additions & 1 deletion pkg/controller/whisker/controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,9 @@ import (
"github.com/tigera/operator/pkg/controller/utils"
"github.com/tigera/operator/pkg/controller/utils/imageset"
"github.com/tigera/operator/pkg/ctrlruntime"
"github.com/tigera/operator/pkg/dns"
"github.com/tigera/operator/pkg/render"
rcertificatemanagement "github.com/tigera/operator/pkg/render/certificatemanagement"
"github.com/tigera/operator/pkg/render/monitor"
"github.com/tigera/operator/pkg/render/whisker"
"github.com/tigera/operator/pkg/tls/certificatemanagement"
Expand Down Expand Up @@ -199,6 +201,27 @@ func (r *Reconciler) Reconcile(ctx context.Context, request reconcile.Request) (
return reconcile.Result{}, err
}

// Goldmane needs a server certificate for it's gRPC API.
// TODO: Add this to the trusted bundle. This isn't stritctly needed, since the bundle already includes the operator CA that
// signed this certificate. But in order to support custom user-supplied certificates, we will need to do this.
goldmaneCertificateNames := dns.GetServiceDNSNames(whisker.GoldmaneServiceName, whisker.WhiskerNamespace, r.clusterDomain)
goldmaneCertificateNames = append(goldmaneCertificateNames, "localhost", "127.0.0.1")
keyPair, err := certificateManager.GetOrCreateKeyPair(r.cli, whisker.GoldmaneServerSecret, common.OperatorNamespace(), goldmaneCertificateNames)
if err != nil {
r.status.SetDegraded(operatorv1.ResourceCreateError, "Error creating TLS certificate", err, log)
return reconcile.Result{}, err
}
certComponent := rcertificatemanagement.CertificateManagement(&rcertificatemanagement.Config{
Namespace: whisker.WhiskerNamespace,
TruthNamespace: common.OperatorNamespace(),
ServiceAccounts: []string{whisker.WhiskerServiceAccountName},
KeyPairOptions: []rcertificatemanagement.KeyPairOption{
rcertificatemanagement.NewKeyPairOption(keyPair, true, true),
},
// TrustedBundle is managed by the core controller.
TrustedBundle: nil,
})

trustedCertBundle, err := certificateManager.LoadTrustedBundle(ctx, r.cli, whisker.WhiskerNamespace)
if err != nil {
r.status.SetDegraded(operatorv1.ResourceReadError, "Error loading trusted cert bundle", err, reqLogger)
Expand All @@ -213,9 +236,10 @@ func (r *Reconciler) Reconcile(ctx context.Context, request reconcile.Request) (
TunnelSecret: tunnelSecret,
TrustedCertBundle: trustedCertBundle,
ManagementClusterConnection: managementClusterConnection,
GoldmaneServerKeyPair: keyPair,
}

components := []render.Component{whisker.Whisker(cfg)}
components := []render.Component{certComponent, whisker.Whisker(cfg)}
if err = imageset.ApplyImageSet(ctx, r.cli, variant, components...); err != nil {
r.status.SetDegraded(operatorv1.ResourceUpdateError, "Error with images from ImageSet", err, reqLogger)
return reconcile.Result{}, err
Expand Down
35 changes: 30 additions & 5 deletions pkg/render/whisker/component.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ const (
WhiskerServiceAccountName = WhiskerName
WhiskerDeploymentName = WhiskerName
WhiskerRoleName = WhiskerName
GoldmaneServerSecret = "goldmane-server-secret"
GoldmaneServiceName = "goldmane"

GuardianContainerName = "guardian"
GoldmaneContainerName = "goldmane"
Expand All @@ -64,6 +66,7 @@ type Configuration struct {
TunnelSecret *corev1.Secret
TrustedCertBundle certificatemanagement.TrustedBundleRO
ManagementClusterConnection *operatorv1.ManagementClusterConnection
GoldmaneServerKeyPair certificatemanagement.KeyPairInterface
}

type Component struct {
Expand Down Expand Up @@ -185,25 +188,43 @@ func (c *Component) whiskerBackendContainer() corev1.Container {
{Name: "GOLDMANE_HOST", Value: "localhost:7443"},
},
SecurityContext: securitycontext.NewNonRootContext(),
VolumeMounts: c.cfg.TrustedCertBundle.VolumeMounts(rmeta.OSTypeLinux),
}
}

func (c *Component) goldmaneContainer() corev1.Container {
var volumeMounts []corev1.VolumeMount

env := []corev1.EnvVar{
{Name: "LOG_LEVEL", Value: "INFO"},
{Name: "PORT", Value: "7443"},
}
var volumeMounts []corev1.VolumeMount

if c.cfg.GoldmaneServerKeyPair != nil {
env = append(env, corev1.EnvVar{
Name: "SERVER_KEY_PATH",
Value: c.cfg.GoldmaneServerKeyPair.VolumeMountKeyFilePath(),
})
env = append(env, corev1.EnvVar{
Name: "SERVER_CERT_PATH",
Value: c.cfg.GoldmaneServerKeyPair.VolumeMountCertificateFilePath(),
})

volumeMounts = append(volumeMounts, c.cfg.GoldmaneServerKeyPair.VolumeMount(c.SupportedOSType()))
}

if c.cfg.ManagementClusterConnection != nil {
env = append(env,
corev1.EnvVar{
Name: "PUSH_URL",
Value: "https://localhost:8080/api/v1/flows/bulk"},
Value: "https://localhost:8080/api/v1/flows/bulk",
},
corev1.EnvVar{
Name: "CA_CERT_PATH",
Value: c.cfg.TrustedCertBundle.MountPath()},
Value: c.cfg.TrustedCertBundle.MountPath(),
},
)
volumeMounts = c.cfg.TrustedCertBundle.VolumeMounts(c.SupportedOSType())
volumeMounts = append(volumeMounts, c.cfg.TrustedCertBundle.VolumeMounts(c.SupportedOSType())...)
}

return corev1.Container{
Expand All @@ -219,7 +240,7 @@ func (c *Component) goldmaneContainer() corev1.Container {
func (c *Component) goldmaneService() *corev1.Service {
return &corev1.Service{
ObjectMeta: metav1.ObjectMeta{
Name: "goldmane",
Name: GoldmaneServiceName,
Namespace: WhiskerNamespace,
},
Spec: corev1.ServiceSpec{
Expand Down Expand Up @@ -261,6 +282,10 @@ func (c *Component) deployment() *appsv1.Deployment {
ctrs := []corev1.Container{c.whiskerContainer(), c.whiskerBackendContainer(), c.goldmaneContainer()}
volumes := []corev1.Volume{c.cfg.TrustedCertBundle.Volume()}

if c.cfg.GoldmaneServerKeyPair != nil {
volumes = append(volumes, c.cfg.GoldmaneServerKeyPair.Volume())
}

if c.cfg.ManagementClusterConnection != nil {
ctrs = append(ctrs, c.guardianContainer())
volumes = append(volumes, secretVolume(c.cfg.TunnelSecret))
Expand Down
3 changes: 3 additions & 0 deletions pkg/render/whisker/component_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@ var _ = Describe("ComponentRendering", func() {
{Name: "GOLDMANE_HOST", Value: "localhost:7443"},
},
SecurityContext: securitycontext.NewNonRootContext(),
VolumeMounts: certificatemanagement.CreateTrustedBundle(nil).VolumeMounts(rmeta.OSTypeAny),
},
{
Name: whisker.GoldmaneContainerName,
Expand Down Expand Up @@ -142,6 +143,7 @@ var _ = Describe("ComponentRendering", func() {
},
},
),

Entry("Should configure guardian",
&whisker.Configuration{
Installation: &operatorv1.InstallationSpec{
Expand Down Expand Up @@ -196,6 +198,7 @@ var _ = Describe("ComponentRendering", func() {
{Name: "GOLDMANE_HOST", Value: "localhost:7443"},
},
SecurityContext: securitycontext.NewNonRootContext(),
VolumeMounts: certificatemanagement.CreateTrustedBundle(nil).VolumeMounts(rmeta.OSTypeAny),
},
{
Name: whisker.GoldmaneContainerName,
Expand Down
Loading