Extend kubernetes interrelation variables in nginx.tmpl #2486

dmgtn · 2018-05-09T22:19:59Z

This PR improves variables, that allows associate (in logs and in lua) nginx servers and locations with related kubernetes resources:

According to TCP/IP (and common sense), $service_name is not enough to uniquely identify "service", we need $service_port for that.
When you define rules in ingress resource, you use path. So it would be very useful to be able to use the same path in logs (and in lua).

k8s-ci-robot · 2018-05-09T22:20:03Z

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.

If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
If you signed the CLA as a corporation, please sign in with your organization's credentials at https://identity.linuxfoundation.org/projects/cncf to be authorized.
If you have done the above and are still having issues with the CLA being reported as unsigned, please email the CNCF helpdesk: helpdesk@rt.linuxfoundation.org

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

aledbf · 2018-05-10T16:28:34Z

@distol please sign the CLA

antoineco · 2018-05-11T09:09:59Z

rootfs/etc/nginx/template/nginx.tmpl

@@ -834,6 +836,7 @@ stream {
            set $namespace      "{{ $ing.Namespace }}";
            set $ingress_name   "{{ $ing.Rule }}";
            set $service_name   "{{ $ing.Service }}";
+            set $service_port   "{{ if $location.Port }}{{ $location.Port }}{{ end }}";


The conditional is not necessary here.

antoineco · 2018-05-11T09:11:26Z

rootfs/etc/nginx/template/nginx.tmpl

@@ -829,6 +829,12 @@ stream {
        {{ end }}

        location {{ $path }} {
+            {{ $ing := (getIngressInformation $location.Ingress $location.Path) }}
+            {{/* $ing.Metadata contains the Ingress metadata */}}


Outdated comment ($ing.Metadata is not referenced).

antoineco · 2018-05-11T09:13:34Z

rootfs/etc/nginx/template/nginx.tmpl

+            set $namespace      "{{ $ing.Namespace }}";
+            set $ingress_name   "{{ $ing.Rule }}";
+            set $service_name   "{{ $ing.Service }}";
+            set $service_port   "{{ if $location.Port }}{{ $location.Port }}{{ end }}";


The conditional is not necessary here.

antoineco · 2018-05-11T09:28:05Z

Oh, you also have to run make code-generator by the way :) It creates a gzipped bytes array of the nginx.tmpl file which gets unpacked in memory during tests, so it has to remain up-to-date with the actual template.

antoineco · 2018-05-11T11:08:11Z

/lgtm

aledbf · 2018-05-11T11:09:07Z

@distol please squash the commits and we are ready to merge

dmgtn · 2018-05-11T11:12:57Z

@aledbf, commits are already squashed. I've made 3 small independent changes, so there are 3 commits, one for each change with its own comment.

aledbf · 2018-06-05T19:15:21Z

@distol friendly ping. Please rebase and squash

ElvinEfendi · 2018-06-06T01:29:02Z

rootfs/etc/nginx/template/nginx.tmpl

+            set $ingress_name   "{{ $ing.Rule }}";
+            set $service_name   "{{ $ing.Service }}";
+            set $service_port   "{{ $location.Port }}";
+            set $location_path  "{{ $location.Path }}";


Could you describe a use case for this? Are $request or $request_uri not enough to identify which path got hit?

Hi! Ingress Controller lives between three worlds:

HTTP world — $scheme, $host, $request_uri

Nginx world — vhost ($server_name) and location ($location_path)

Kubernetes world — namespace ($namespace), ingress ($ingress_name), and service ($service_name, $service_port).

So, depending on the task, we should be able to easily identify request in any of the "coordinate systems".

To make it more clear, that you could use $namespace, $ingress_name and $service_name variables anywhere in location (especialy in lua), move their definition to the very begining of the location.

According to TCP/IP (and common sense), $service_name is not enough to uniquely identify service, we need $service_port for that.

When you define rules in ingress resource, you use path. So it would be very useful to be able to use the same path in logs.

dmgtn · 2018-06-07T10:47:06Z

@distol friendly ping. Please rebase and squash

@aledbf, I've already written, that commits have been squashed from the very beginning. I've made 3 small independent changes, and to my sense, it should be 3 commits, one for each change with its own comment. And same time it looks not reasonable to make three pull requests because changes are too small.

Please have a look at commit log and if after that you will not change your mind — no problem, I'll squash these three changes to one commit.

P.S. Rebased to the master and removed bindata.

aledbf · 2018-06-08T21:41:45Z

/lgtm
/approve

aledbf · 2018-06-08T21:41:51Z

@distol thanks!

k8s-ci-robot · 2018-06-08T21:41:52Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: aledbf, antoineco, distol

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [aledbf]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

aledbf · 2018-06-08T21:42:33Z

@distol next time, please squash the commits

k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 9, 2018

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels May 10, 2018

antoineco suggested changes May 11, 2018

View reviewed changes

antoineco reviewed May 11, 2018

View reviewed changes

k8s-ci-robot assigned antoineco May 11, 2018

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 11, 2018

ElvinEfendi reviewed Jun 6, 2018

View reviewed changes

Dmitry Stolyarov added 3 commits June 7, 2018 13:43

Move vars to the very beginning of the location

eafb189

To make it more clear, that you could use $namespace, $ingress_name and $service_name variables anywhere in location (especialy in lua), move their definition to the very begining of the location.

Add $service_port variable

59aac73

According to TCP/IP (and common sense), $service_name is not enough to uniquely identify service, we need $service_port for that.

Add $location_path variable

02ff824

When you define rules in ingress resource, you use path. So it would be very useful to be able to use the same path in logs.

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 7, 2018

k8s-ci-robot assigned aledbf Jun 8, 2018

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 8, 2018

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 8, 2018

k8s-ci-robot merged commit fc96d5c into kubernetes:master Jun 8, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Extend kubernetes interrelation variables in nginx.tmpl #2486

Extend kubernetes interrelation variables in nginx.tmpl #2486

dmgtn commented May 9, 2018

k8s-ci-robot commented May 9, 2018

aledbf commented May 10, 2018

antoineco May 11, 2018

antoineco May 11, 2018

dmgtn May 11, 2018

antoineco May 11, 2018

dmgtn May 11, 2018

antoineco commented May 11, 2018 •

edited

Loading

antoineco commented May 11, 2018

aledbf commented May 11, 2018

dmgtn commented May 11, 2018

aledbf commented Jun 5, 2018

ElvinEfendi Jun 6, 2018

dmgtn Jun 7, 2018

dmgtn commented Jun 7, 2018

aledbf commented Jun 8, 2018

aledbf commented Jun 8, 2018

k8s-ci-robot commented Jun 8, 2018

aledbf commented Jun 8, 2018

Extend kubernetes interrelation variables in nginx.tmpl #2486

Extend kubernetes interrelation variables in nginx.tmpl #2486

Conversation

dmgtn commented May 9, 2018

k8s-ci-robot commented May 9, 2018

aledbf commented May 10, 2018

antoineco May 11, 2018

Choose a reason for hiding this comment

antoineco May 11, 2018

Choose a reason for hiding this comment

dmgtn May 11, 2018

Choose a reason for hiding this comment

antoineco May 11, 2018

Choose a reason for hiding this comment

dmgtn May 11, 2018

Choose a reason for hiding this comment

antoineco commented May 11, 2018 • edited Loading

antoineco commented May 11, 2018

aledbf commented May 11, 2018

dmgtn commented May 11, 2018

aledbf commented Jun 5, 2018

ElvinEfendi Jun 6, 2018

Choose a reason for hiding this comment

dmgtn Jun 7, 2018

Choose a reason for hiding this comment

dmgtn commented Jun 7, 2018

aledbf commented Jun 8, 2018

aledbf commented Jun 8, 2018

k8s-ci-robot commented Jun 8, 2018

aledbf commented Jun 8, 2018

antoineco commented May 11, 2018 •

edited

Loading