8000 Feature/flag include year (#2884) · nginx/kubernetes-ingress@06ec33b · GitHub
[go: up one dir, main page]
Skip to content

Commit 06ec33b

Browse files
shaun-nxhaywoodsh“shaun-nx”
authored
Feature/flag include year (#2884)
* replace glog with forked version to include years * replace glog with forked version to include years * Add flag to include year in log header * Add cmd flag to include year in log header * Fix linter * Remove white space * Add `-include-year` flag to OSS ingress deployment and daemon-set configurations * Add section for `controller.includeYear` to helm installation docs * Update nginxinc/glog to v1.1.2 Co-authored-by: Haywood Shannon <5781935+haywoodsh@users.noreply.github.com> Co-authored-by: “shaun-nx” <“s.odonovan@f5.com”>
1 parent 99fba9e commit 06ec33b

File tree

12 files changed

+29
-3
lines changed

12 files changed

+29
-3
lines changed

‎cmd/nginx-ingress/flags.go‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import (
66
"net"
77
"os"
88
"regexp"
9+
"strconv"
910
"strings"
1011

1112
"github.com/golang/glog"
@@ -174,6 +175,9 @@ var (
174175
enableExternalDNS = flag.Bool("enable-external-dns", false,
175176
"Enable external-dns controller for VirtualServer resources. Requires -enable-custom-resources")
176177

178+
includeYearInLogs = flag.Bool("include-year", false,
179+
"Option to include the year in the log header")
180+
177181
startupCheckFn func() error
178182
)
179183

@@ -261,6 +265,11 @@ func initialChecks() {
261265
glog.Fatalf("Error setting logtostderr to true: %v", err)
262266
}
263267

268+
err = flag.Lookup("include_year").Value.Set(strconv.FormatBool(*includeYearInLogs))
269+
if err != nil {
270+
glog.Fatalf("Error setting include_year flag: %v", err)
271+
}
272+
264273
if startupCheckFn != nil {
265274
err := startupCheckFn()
266275
if err != nil {

‎deployments/daemon-set/nginx-ingress.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ spec:
6464
args:
6565
- -nginx-configmaps=$(POD_NAMESPACE)/nginx-config
6666
- -default-server-tls-secret=$(POD_NAMESPACE)/default-server-secret
67+
#- -include-year
6768
#- -v=3 # Enables extensive logging. Useful for troubleshooting.
6869
#- -report-ingress-status
6970
#- -external-service=nginx-ingress

‎deployments/daemon-set/nginx-plus-ingress.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ spec:
6565
- -nginx-plus
6666
- -nginx-configmaps=$(POD_NAMESPACE)/nginx-config
6767
- -default-server-tls-secret=$(POD_NAMESPACE)/default-server-secret
68+
#- -include-year
6869
#- -enable-app-protect
6970
#- -enable-app-protect-dos
7071
#- -v=3 # Enables extensive logging. Useful for troubleshooting.

‎deployments/deployment/nginx-ingress.yaml‎

Lines changed: 1 addition & 0 deletions

‎deployments/deployment/nginx-plus-ingress.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ spec:
6464
args:
6565
- -nginx-configmaps=$(POD_NAMESPACE)/nginx-config
6666
- -default-server-tls-secret=$(POD_NAMESPACE)/default-server-secret
67+
#- -include-year
6768
#- -enable-cert-manager
6869
#- -enable-external-dns
6970
#- -v=3 # Enables extensive logging. Useful for troubleshooting.
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ spec:
6565
- -nginx-plus
6666
- -nginx-configmaps=$(POD_NAMESPACE)/nginx-config
6767
- -default-server-tls-secret=$(POD_NAMESPACE)/default-server-secret
68+
#- -include-year
6869
#- -enable-cert-manager
6970
#- -enable-external-dns
7071
#- -enable-app-protect

‎deployments/helm-chart/templates/controller-daemonset.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,7 @@ spec:
185185
- -prometheus-tls-secret={{ .Values.prometheus.secret }}
186186
- -enable-custom-resources={{ .Values.controller.enableCustomResources }}
187187
- -enable-snippets={{ .Values.controller.enableSnippets }}
188+
- -include-year={{ .Values.controller.includeYear }}
188189
{{- if .Values.controller.enableCustomResources }}
189190
- -enable-tls-passthrough={{ .Values.controller.enableTLSPassthrough }}
190191
- -enable-preview-policies={{ .Values.controller.enablePreviewPolicies }}

‎deployments/helm-chart/templates/controller-deployment.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,7 @@ spec:
188188
- -prometheus-tls-secret={{ .Values.prometheus.secret }}
189189
- -enable-custom-resources={{ .Values.controller.enableCustomResources }}
190190
- -enable-snippets={{ .Values.controller.enableSnippets }}
191+
- -include-year={{ .Values.controller.includeYear }}
191192
{{- if .Values.controller.enableCustomResources }}
192193
- -enable-tls-passthrough={{ .Values.controller.enableTLSPassthrough }}
193194
- -enable-preview-policies={{ .Values.controller.enablePreviewPolicies }}

‎deployments/helm-chart/values.yaml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,9 @@ controller:
178178
## Enable OIDC policies.
179179
enableOIDC: false
180180

181+
## Include year in log header. This parameter will be removed in release 2.7 and the year will be included by default.
182+
includeYear: false
183+
181184
## Enable TLS Passthrough on port 443. Requires controller.enableCustomResources.
182185
enableTLSPassthrough: false
183186

‎docs/content/configuration/global-configuration/command-line-arguments.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,13 @@ Default `false`.
7373
&nbsp;
7474
<a name="cmdoption-enable-leader-election"></a>
7575

76+
### -inlcude-year
77+
Adds year to log headers.
78+
79+
Default `false`.
80+
81+
**NOTE**: This flag will be removed in release 2.7 and the year will be included by default.
82+
7683
### -enable-leader-election
7784

7885
Enables Leader election to avoid multiple replicas of the controller reporting the status of Ingress, VirtualServer and VirtualServerRoute resources -- only one replica will report status.

‎docs/content/installation/installation-with-helm.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,7 @@ The following tables lists the configurable parameters of the NGINX Ingress Cont
187187
|``controller.enableCustomResources`` | Enable the custom resources. | true |
188188
|``controller.enablePreviewPolicies`` | Enable preview policies. This parameter is deprecated. To enable OIDC Policies please use ``controller.enableOIDC`` instead. | false |
189189
|``controller.enableOIDC`` | Enable OIDC policies. | false |
190+
|``controller.includeYear`` | Include year in log header. This parameter will be removed in release 2.7 and the year will be included by default. | false |
190191
|``controller.enableTLSPassthrough`` | Enable TLS Passthrough on port 443. Requires ``controller.enableCustomResources``. | false |
191192
`controller.enableCertManager` | Enable x509 automated certificate management for VirtualServer resources using cert-manager (cert-manager.io). Requires `controller.enableCustomResources`. | false
192193
`controller.enableExternalDNS` | Enable integration with ExternalDNS for configuring public DNS entries for VirtualServer resources using [ExternalDNS](https://github.com/kubernetes-sigs/external-dns). Requires `controller.enableCustomResources`. | false

0 commit comments

Comments
 (0)
0