Skip to content

Use gateway name as Proxy fleet name for Gateway Namespace mode #6135

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

Merged
zirain merged 1 commit into from
May 26, 2025
Merged

Use gateway name as Proxy fleet name for Gateway Namespace mode #6135

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions api/v1alpha1/envoygateway_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,10 +290,10 @@ type KubernetesWatchMode struct {

const (
// KubernetesDeployModeTypeControllerNamespace indicates that the controller namespace is used for the infra proxy deployments.
KubernetesDeployModeTypeControllerNamespace = "ControllerNamespace"
KubernetesDeployModeTypeControllerNamespace KubernetesDeployModeType = "ControllerNamespace"

// KubernetesDeployModeTypeGatewayNamespace indicates that the gateway namespace is used for the infra proxy deployments.
KubernetesDeployModeTypeGatewayNamespace = "GatewayNamespace"
KubernetesDeployModeTypeGatewayNamespace KubernetesDeployModeType = "GatewayNamespace"
)

// KubernetesDeployModeType defines the type of KubernetesDeployMode
Expand Down
6 changes: 3 additions & 3 deletions internal/gatewayapi/testdata/gateway-namespace-mode-infra-httproute.out.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ infraIR:
ownerReference:
kind: Gateway
name: gateway-1
name: default/gateway-1
name: gateway-1
namespace: default
default/gateway-2:
proxy:
Expand All @@ -262,7 +262,7 @@ infraIR:
ownerReference:
kind: Gateway
name: gateway-2
name: default/gateway-2
name: gateway-2
namespace: default
test-ns/gateway-3:
proxy:
Expand All @@ -281,7 +281,7 @@ infraIR:
ownerReference:
kind: Gateway
name: gateway-3
name: test-ns/gateway-3
name: gateway-3
namespace: test-ns
xdsIR:
default/gateway-1:
Expand Down
1 change: 1 addition & 0 deletions internal/gatewayapi/translator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,6 +318,7 @@ func (t *Translator) InitIRs(gateways []*GatewayContext) (map[string]*ir.Xds, ma
gwInfraIR.Proxy.Name = irKey
gwInfraIR.Proxy.Namespace = t.ControllerNamespace
if t.GatewayNamespaceMode {
gwInfraIR.Proxy.Name = gateway.Name
gwInfraIR.Proxy.Namespace = gateway.Namespace
gwInfraIR.Proxy.GetProxyMetadata().OwnerReference = &ir.ResourceMetadata{
Kind: resource.KindGateway,
Expand Down
7 changes: 6 additions & 1 deletion internal/infrastructure/common/proxy_args.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,13 @@ func BuildProxyArgs(

logging := infra.Config.Spec.Logging

serviceCluster := infra.Name
if gatewayNamespaceMode {
Copy link
Contributor

@arkodg arkodg May 23, 2025

Choose a reason for hiding this comment

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

ha, can we decorate this with comments, mentioning that we need the IR key here to set in serviceCluster

another option is to pass the IR key into

gateway/internal/infrastructure/runner/runner.go

Line 115 in be51e5b

if err := r.mgr.CreateOrUpdateProxyInfra(ctx, val); err != nil {
and eventually pass the context here ?

Copy link
Member Author

@zirain zirain May 24, 2025

Choose a reason for hiding this comment

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

the root cause there's two type thing in this name field

  • In controller namspace mode, it's ns/name (equal to irKey)
  • In gateway namespace mode, it's just the name.

we'd better clean this in a follow up PR.

serviceCluster = fmt.Sprintf("%s/%s", infra.Namespace, infra.Name)
}

args := []string{
fmt.Sprintf("--service-cluster %s", infra.Name),
fmt.Sprintf("--service-cluster %s", serviceCluster),
fmt.Sprintf("--service-node %s", serviceNode),
fmt.Sprintf("--config-yaml %s", bootstrapConfigurations),
fmt.Sprintf("--log-level %s", logging.DefaultEnvoyProxyLoggingLevel()),
Expand Down
63 changes: 29 additions & 34 deletions internal/infrastructure/kubernetes/proxy/resource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ const (
)

// ExpectedResourceHashedName returns expected resource hashed name including up to the 48 characters of the original name.
// WARNING: DO NOT USE THIS FUNCTION IN MOST OF THE CASES. Use ResourceRender.Name() instead.
func ExpectedResourceHashedName(name string) string {
hashedName := utils.GetHashedName(name, 48)
return fmt.Sprintf("%s-%s", config.EnvoyPrefix, hashedName)
Expand Down Expand Up @@ -308,7 +309,7 @@ func expectedContainerVolumeMounts(containerSpec *egv1a1.KubernetesContainerSpec
}

// expectedVolumes returns expected proxy deployment volumes.
func expectedVolumes(name string, gatewayNamespacedMode bool, pod *egv1a1.KubernetesPodSpec, dnsDomain, controllerNamespace string) []corev1.Volume {
func (r *ResourceRender) expectedVolumes(pod *egv1a1.KubernetesPodSpec) []corev1.Volume {
var volumes []corev1.Volume
certsVolume := corev1.Volume{
Name: "certs",
Expand All @@ -320,13 +321,13 @@ func expectedVolumes(name string, gatewayNamespacedMode bool, pod *egv1a1.Kubern
},
}

if gatewayNamespacedMode {
if r.GatewayNamespaceMode {
certsVolume = corev1.Volume{
Name: "certs",
VolumeSource: corev1.VolumeSource{
ConfigMap: &corev1.ConfigMapVolumeSource{
LocalObjectReference: corev1.LocalObjectReference{
Name: ExpectedResourceHashedName(name),
Name: r.Name(),
},
Items: []corev1.KeyToPath{
{
Expand All @@ -339,7 +340,7 @@ func expectedVolumes(name string, gatewayNamespacedMode bool, pod *egv1a1.Kubern
},
},
}
saAudience := fmt.Sprintf("%s.%s.svc.%s", config.EnvoyGatewayServiceName, controllerNamespace, dnsDomain)
saAudience := fmt.Sprintf("%s.%s.svc.%s", config.EnvoyGatewayServiceName, r.ControllerNamespace(), r.DNSDomain)
saTokenProjectedVolume := corev1.Volume{
Name: "sa-token",
VolumeSource: corev1.VolumeSource{
Expand Down Expand Up @@ -367,45 +368,39 @@ func expectedVolumes(name string, gatewayNamespacedMode bool, pod *egv1a1.Kubern
VolumeSource: corev1.VolumeSource{
ConfigMap: &corev1.ConfigMapVolumeSource{
LocalObjectReference: corev1.LocalObjectReference{
Name: ExpectedResourceHashedName(name),
},
Items: []corev1.KeyToPath{
{
Key: common.SdsCAFilename,
Path: common.SdsCAFilename,
},
{
Key: common.SdsCertFilename,
Path: common.SdsCertFilename,
},
Name: r.Name(),
},
Items: sdsConfigMapItems(r.GatewayNamespaceMode),
DefaultMode: ptr.To[int32](420),
Optional: ptr.To(false),
},
},
}
if gatewayNamespacedMode {
sdsVolume = corev1.Volume{
Name: "sds",
VolumeSource: corev1.VolumeSource{
ConfigMap: &corev1.ConfigMapVolumeSource{
LocalObjectReference: corev1.LocalObjectReference{
Name: ExpectedResourceHashedName(name),
},
Items: []corev1.KeyToPath{
{
Key: common.SdsCAFilename,
Path: common.SdsCAFilename,
},
},
DefaultMode: ptr.To[int32](420),
Optional: ptr.To(false),
},

volumes = append(volumes, sdsVolume)
return resource.ExpectedVolumes(pod, volumes)
}

func sdsConfigMapItems(gatewayNamespaceMode bool) []corev1.KeyToPath {
if gatewayNamespaceMode {
return []corev1.KeyToPath{
{
Key: common.SdsCAFilename,
Path: common.SdsCAFilename,
},
}
}
volumes = append(volumes, sdsVolume)
return resource.ExpectedVolumes(pod, volumes)

return []corev1.KeyToPath{
{
Key: common.SdsCAFilename,
Path: common.SdsCAFilename,
},
{
Key: common.SdsCertFilename,
Path: common.SdsCertFilename,
},
}
}

// expectedContainerEnv returns expected proxy container envs.
Expand Down
10 changes: 7 additions & 3 deletions internal/infrastructure/kubernetes/proxy/resource_provider.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,10 @@ func NewResourceRender(ctx context.Context, kubernetesInfra KubernetesInfraProvi
}

func (r *ResourceRender) Name() string {
if r.GatewayNamespaceMode {
return r.infra.Name
}

return ExpectedResourceHashedName(r.infra.Name)
}

Expand Down Expand Up @@ -380,7 +384,7 @@ func (r *ResourceRender) Deployment() (*appsv1.Deployment, error) {
SecurityContext: deploymentConfig.Pod.SecurityContext,
Affinity: deploymentConfig.Pod.Affinity,
Tolerations: deploymentConfig.Pod.Tolerations,
Volumes: expectedVolumes(r.infra.Name, r.GatewayNamespaceMode, deploymentConfig.Pod, r.DNSDomain, r.controllerNamespace),
Volumes: r.expectedVolumes(deploymentConfig.Pod),
ImagePullSecrets: deploymentConfig.Pod.ImagePullSecrets,
NodeSelector: deploymentConfig.Pod.NodeSelector,
TopologySpreadConstraints: deploymentConfig.Pod.TopologySpreadConstraints,
Expand Down Expand Up @@ -598,15 +602,15 @@ func (r *ResourceRender) getPodSpec(
return corev1.PodSpec{
Containers: containers,
InitContainers: initContainers,
ServiceAccountName: ExpectedResourceHashedName(r.infra.Name),
ServiceAccountName: r.Name(),
TerminationGracePeriodSeconds: expectedTerminationGracePeriodSeconds(proxyConfig.Spec.Shutdown),
DNSPolicy: corev1.DNSClusterFirst,
RestartPolicy: corev1.RestartPolicyAlways,
SchedulerName: "default-scheduler",
SecurityContext: pod.SecurityContext,
Affinity: pod.Affinity,
Tolerations: pod.Tolerations,
Volumes: expectedVolumes(r.infra.Name, r.GatewayNamespaceMode, pod, r.DNSDomain, r.controllerNamespace),
Volumes: r.expectedVolumes(pod),
ImagePullSecrets: pod.ImagePullSecrets,
NodeSelector: pod.NodeSelector,
TopologySpreadConstraints: pod.TopologySpreadConstraints,
Expand Down
Loading