feat: kube-rbac-proxy sidecar container for eval-hub #716
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,15 +14,27 @@ const ( | |
|
|
||
| // Container configuration | ||
| containerName = "evalhub" | ||
| // evalHubAppPort is where eval-hub binds TLS (loopback only); kube-rbac-proxy listens on servicePort. | ||
| evalHubAppPort = 8444 | ||
| // evalHubHealthPath is forwarded by kube-rbac-proxy; use --ignore-paths so kubelet probes skip authn/z. | ||
| evalHubHealthPath = "/api/v1/health" | ||
|
|
||
| // Service configuration (public HTTPS targets kube-rbac-proxy on this port) | ||
| serviceName = "evalhub" | ||
| servicePort = 8443 | ||
|
|
||
| // kube-rbac-proxy sidecar | ||
| kubeRBACProxyContainerName = "kube-rbac-proxy" | ||
| kubeRBACProxyConfigMountPath = "/etc/kube-rbac-proxy/auth.yaml" | ||
| evalHubAuthConfigMapKey = "auth.yaml" | ||
| kubeRBACProxyUpstreamCAMountPath = "/etc/kube-rbac-proxy/upstream-ca" | ||
| kubeRBACProxyHealthPort = 9443 | ||
|
|
||
| // Configuration constants | ||
| configMapName = "trustyai-service-operator-config" | ||
| configMapEvalHubImageKey = "evalHubImage" | ||
| configMapKubeRBACProxyImageKey = "kube-rbac-proxy" | ||
| defaultKubeRBACProxyImage = "quay.io/openshift/origin-kube-rbac-proxy:4.19" | ||
|
Contributor
Author
There was a problem hiding this comment. This is the fallback if a version is not provided through the operator configmap. Since we do not own kube-rbac-proxy repo, it is better to stick to a default image that we know works well rather than use ":latest"? Btw, this version 4.19 does not have our changes with endpoint-specific SARs - it needs to be added to the configmap and here in code as default once we have an image. |
||
|
|
||
| // TLS configuration (OpenShift service serving certificates) | ||
| tlsSecretMountPath = "/etc/tls/private" | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,6 +9,7 @@ import ( | |
| appsv1 "k8s.io/api/apps/v1" | ||
| corev1 "k8s.io/api/core/v1" | ||
| "k8s.io/apimachinery/pkg/api/errors" | ||
| "k8s.io/apimachinery/pkg/api/resource" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "k8s.io/apimachinery/pkg/util/intstr" | ||
| "sigs.k8s.io/controller-runtime/pkg/client" | ||
|
|
@@ -74,17 +75,22 @@ func (r *EvalHubReconciler) buildDeploymentSpec(ctx context.Context, instance *e | |
| evalHubImage = defaultEvalHubImage | ||
| } | ||
|
|
||
| kubeRBACProxyImage, err := r.getKubeRBACProxyImage(ctx) | ||
| if err != nil { | ||
| log.FromContext(ctx).Error(err, "Error getting kube-rbac-proxy image from ConfigMap. Using the default image value of "+defaultKubeRBACProxyImage) | ||
| kubeRBACProxyImage = defaultKubeRBACProxyImage | ||
| } | ||
|
|
||
| // Build default environment variables | ||
| // EvalHub listens on loopback only; kube-rbac-proxy terminates TLS on servicePort and enforces SAR (auth.yaml). | ||
| defaultEnvVars := []corev1.EnvVar{ | ||
| { | ||
| Name: "API_HOST", | ||
| Value: "127.0.0.1", | ||
| }, | ||
| { | ||
| Name: "PORT", | ||
| Value: fmt.Sprintf("%d", evalHubAppPort), | ||
| }, | ||
| { | ||
| Name: "TLS_CERT_FILE", | ||
|
|
@@ -116,7 +122,7 @@ func (r *EvalHubReconciler) buildDeploymentSpec(ctx context.Context, instance *e | |
| }, | ||
| { | ||
| Name: "SERVICE_URL", | ||
| Value: fmt.Sprintf("https://%s.%s.svc.cluster.local:%d", instance.Name, instance.Namespace, servicePort), | ||
| }, | ||
| { | ||
| Name: "EVALHUB_INSTANCE_NAME", | ||
|
|
@@ -191,40 +197,103 @@ func (r *EvalHubReconciler) buildDeploymentSpec(ctx context.Context, instance *e | |
| ImagePullPolicy: corev1.PullAlways, | ||
| Ports: []corev1.ContainerPort{ | ||
| { | ||
| Name: "evalhub", | ||
| ContainerPort: evalHubAppPort, | ||
| Protocol: corev1.ProtocolTCP, | ||
| }, | ||
| }, | ||
| Env: env, | ||
| Resources: defaultResourceRequirements, | ||
| SecurityContext: defaultSecurityContext, | ||
| VolumeMounts: volumeMounts, | ||
| // Liveness/readiness run on kube-rbac-proxy (same URL path as clients) with --ignore-paths on evalHubHealthPath. | ||
| } | ||
|
|
||
| upstreamURL := fmt.Sprintf("http://127.0.0.1:%d/", evalHubAppPort) | ||
| upstreamCAPath := kubeRBACProxyUpstreamCAMountPath + "/" + serviceCACertFile | ||
|
|
||
| kubeRBACProxyContainer := corev1.Container{ | ||
| Name: kubeRBACProxyContainerName, | ||
| Image: kubeRBACProxyImage, | ||
| ImagePullPolicy: corev1.PullIfNotPresent, | ||
| Args: []string{ | ||
| "--secure-listen-address=0.0.0.0:" + fmt.Sprintf("%d", servicePort), | ||
| "--upstream=" + upstreamURL, | ||
|
Member
There was a problem hiding this comment. @nbs-rh do we need these ( |
||
| "--upstream-ca-file=" + upstreamCAPath, | ||
| "--config-file=" + kubeRBACProxyConfigMountPath, | ||
| "--tls-cert-file=" + tlsSecretMountPath + "/" + tlsCertFile, | ||
| "--tls-private-key-file=" + tlsSecretMountPath + "/" + tlsKeyFile, | ||
| "--proxy-endpoints-port=" + fmt.Sprintf("%d", kubeRBACProxyHealthPort), | ||
| "--ignore-paths=" + evalHubHealthPath, | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
| "--auth-header-fields-enabled", | ||
| "--auth-header-user-field-name=X-User", | ||
| "--v=0", | ||
| }, | ||
| Ports: []corev1.ContainerPort{ | ||
| { | ||
| Name: "https", | ||
| ContainerPort: servicePort, | ||
| Protocol: corev1.ProtocolTCP, | ||
| }, | ||
| { | ||
| Name: "proxy-healthz", | ||
| ContainerPort: kubeRBACProxyHealthPort, | ||
| Protocol: corev1.ProtocolTCP, | ||
| }, | ||
| }, | ||
| Resources: corev1.ResourceRequirements{ | ||
| Requests: corev1.ResourceList{ | ||
| corev1.ResourceCPU: resource.MustParse("50m"), | ||
| corev1.ResourceMemory: resource.MustParse("32Mi"), | ||
| }, | ||
| Limits: corev1.ResourceList{ | ||
| corev1.ResourceCPU: resource.MustParse("100m"), | ||
|
Collaborator
There was a problem hiding this comment. @nbs-rh is it to be expected that these are hard-coded here? |
||
| corev1.ResourceMemory: resource.MustParse("64Mi"), | ||
| }, | ||
| }, | ||
| SecurityContext: defaultSecurityContext, | ||
| VolumeMounts: []corev1.VolumeMount{ | ||
| { | ||
| Name: "evalhub-config", | ||
| MountPath: kubeRBACProxyConfigMountPath, | ||
| SubPath: evalHubAuthConfigMapKey, | ||
| ReadOnly: true, | ||
| }, | ||
| { | ||
| Name: instance.Name + "-tls", | ||
| MountPath: tlsSecretMountPath, | ||
| ReadOnly: true, | ||
| }, | ||
| { | ||
| Name: serviceCAVolumeName, | ||
| MountPath: kubeRBACProxyUpstreamCAMountPath, | ||
| ReadOnly: true, | ||
| }, | ||
| }, | ||
| ReadinessProbe: &corev1.Probe{ | ||
| ProbeHandler: corev1.ProbeHandler{ | ||
| HTTPGet: &corev1.HTTPGetAction{ | ||
| Path: evalHubHealthPath, | ||
| Port: intstr.FromInt(servicePort), | ||
| Scheme: corev1.URISchemeHTTPS, | ||
| }, | ||
| }, | ||
| InitialDelaySeconds: 10, | ||
| PeriodSeconds: 5, | ||
| TimeoutSeconds: 5, | ||
| FailureThreshold: 3, | ||
| }, | ||
| LivenessProbe: &corev1.Probe{ | ||
| ProbeHandler: corev1.ProbeHandler{ | ||
| HTTPGet: &corev1.HTTPGetAction{ | ||
| Path: evalHubHealthPath, | ||
| Port: intstr.FromInt(servicePort), | ||
| Scheme: corev1.URISchemeHTTPS, | ||
| }, | ||
| }, | ||
| InitialDelaySeconds: 30, | ||
| PeriodSeconds: 10, | ||
| TimeoutSeconds: 5, | ||
| FailureThreshold: 3, | ||
| }, | ||
| } | ||
|
|
@@ -309,14 +378,14 @@ func (r *EvalHubReconciler) buildDeploymentSpec(ctx context.Context, instance *e | |
| }, | ||
| }) | ||
| } | ||
| // Pod template with EvalHub + kube-rbac-proxy and required volumes | ||
| podTemplate := corev1.PodTemplateSpec{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Labels: labels, | ||
| }, | ||
| Spec: corev1.PodSpec{ | ||
| ServiceAccountName: generateServiceAccountName(instance), | ||
| Containers: []corev1.Container{container, kubeRBACProxyContainer}, | ||
| SecurityContext: defaultPodSecurityContext, | ||
| RestartPolicy: corev1.RestartPolicyAlways, | ||
| Volumes: volumes, | ||
|
|
@@ -347,6 +416,15 @@ func (r *EvalHubReconciler) buildDeploymentSpec(ctx context.Context, instance *e | |
| }, nil | ||
| } | ||
|
|
||
| // getKubeRBACProxyImage retrieves the kube-rbac-proxy image from the operator ConfigMap. | ||
| func (r *EvalHubReconciler) getKubeRBACProxyImage(ctx context.Context) (string, error) { | ||
| namespace := r.Namespace | ||
| if namespace == "" { | ||
| namespace = "trustyai-service-operator-system" | ||
| } | ||
| return utils.GetImageFromConfigMapWithFallback(ctx, r.Client, configMapKubeRBACProxyImageKey, configMapName, namespace, defaultKubeRBACProxyImage) | ||
| } | ||
|
|
||
| // getEvalHubImage retrieves the EvalHub image from ConfigMap with fallback to default | ||
| func (r *EvalHubReconciler) getEvalHubImage(ctx context.Context) (string, error) { | ||
| // Get the namespace where the operator is deployed (where the ConfigMap should be) | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.