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

Feature/flag include year #2884

Merged
merged 15 commits into from
Jul 27, 2022
Merged

Feature/flag include year #2884

Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
40bd214
replace glog with forked version to include years
haywoodsh Jul 21, 2022
beb9e42
replace glog with forked version to include years
haywoodsh Jul 21, 2022
8368fb7
Merge branch 'main' into feature/replace-glog-with-forked-version
shaun-nx Jul 22, 2022
284c746
Merge branch 'feature/replace-glog-with-forked-version' of github.com…
Jul 22, 2022
740dde8
Add flag to include year in log header
Jul 22, 2022
e4c81f2
Add cmd flag to include year in log header
Jul 25, 2022
e9c9c43
Merge branch 'main' into feature/flag-include-year
shaun-nx Jul 25, 2022
461933a
Fix linter
Jul 25, 2022
a0e5e1f
Merge branch 'feature/flag-include-year' of github.com:nginxinc/kuber…
Jul 25, 2022
9a5023e
Remove white space
Jul 25, 2022
565952b
Merge branch 'main' into feature/flag-include-year
shaun-nx Jul 26, 2022
185936b
Add `-include-year` flag to OSS ingress deployment and daemon-set con…
Jul 26, 2022
769d310
Add section for `controller.includeYear` to helm installation docs
Jul 26, 2022
05623c5
Merge branch 'main' into feature/flag-include-year
shaun-nx Jul 27, 2022
30fa0db
Update nginxinc/glog to v1.1.2
Jul 27, 2022
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
9 changes: 9 additions & 0 deletions cmd/nginx-ingress/flags.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (
"net"
"os"
"regexp"
"strconv"
"strings"

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

includeYearInLogs = flag.Bool("include-year", false,
"Option to include the year in the log header")

startupCheckFn func() error
)

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

err = flag.Lookup("include_year").Value.Set(strconv.FormatBool(*includeYearInLogs))
if err != nil {
glog.Fatalf("Error setting include_year flag: %v", err)
}

if startupCheckFn != nil {
err := startupCheckFn()
if err != nil {
Expand Down
1 change: 1 addition & 0 deletions deployments/daemon-set/nginx-ingress.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ spec:
args:
- -nginx-configmaps=$(POD_NAMESPACE)/nginx-config
- -default-server-tls-secret=$(POD_NAMESPACE)/default-server-secret
#- -include-year
#- -v=3 # Enables extensive logging. Useful for troubleshooting.
#- -report-ingress-status
#- -external-service=nginx-ingress
Expand Down
1 change: 1 addition & 0 deletions deployments/daemon-set/nginx-plus-ingress.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ spec:
- -nginx-plus
- -nginx-configmaps=$(POD_NAMESPACE)/nginx-config
- -default-server-tls-secret=$(POD_NAMESPACE)/default-server-secret
#- -include-year
#- -enable-app-protect
#- -enable-app-protect-dos
#- -v=3 # Enables extensive logging. Useful for troubleshooting.
Expand Down
1 change: 1 addition & 0 deletions deployments/deployment/nginx-ingress.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ spec:
args:
- -nginx-configmaps=$(POD_NAMESPACE)/nginx-config
- -default-server-tls-secret=$(POD_NAMESPACE)/default-server-secret
#- -include-year
#- -enable-cert-manager
#- -enable-external-dns
#- -v=3 # Enables extensive logging. Useful for troubleshooting.
Expand Down
1 change: 1 addition & 0 deletions deployments/deployment/nginx-plus-ingress.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ spec:
- -nginx-plus
- -nginx-configmaps=$(POD_NAMESPACE)/nginx-config
- -default-server-tls-secret=$(POD_NAMESPACE)/default-server-secret
#- -include-year
Copy link
Contributor

Choose a reason for hiding this comment

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

can specify the same in deployments/daemon-set/nginx-plus-ingress.yaml as well

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good catch. I will also add it to the OSS version of the deployments

#- -enable-cert-manager
#- -enable-external-dns
#- -enable-app-protect
Expand Down
1 change: 1 addition & 0 deletions deployments/helm-chart/templates/controller-daemonset.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,7 @@ spec:
- -prometheus-tls-secret={{ .Values.prometheus.secret }}
- -enable-custom-resources={{ .Values.controller.enableCustomResources }}
- -enable-snippets={{ .Values.controller.enableSnippets }}
- -include-year={{ .Values.controller.includeYear }}
{{- if .Values.controller.enableCustomResources }}
- -enable-tls-passthrough={{ .Values.controller.enableTLSPassthrough }}
- -enable-preview-policies={{ .Values.controller.enablePreviewPolicies }}
Expand Down
1 change: 1 addition & 0 deletions deployments/helm-chart/templates/controller-deployment.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,7 @@ spec:
- -prometheus-tls-secret={{ .Values.prometheus.secret }}
- -enable-custom-resources={{ .Values.controller.enableCustomResources }}
- -enable-snippets={{ .Values.controller.enableSnippets }}
- -include-year={{ .Values.controller.includeYear }}
{{- if .Values.controller.enableCustomResources }}
- -enable-tls-passthrough={{ .Values.controller.enableTLSPassthrough }}
- -enable-preview-policies={{ .Values.controller.enablePreviewPolicies }}
Expand Down
3 changes: 3 additions & 0 deletions deployments/helm-chart/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,9 @@ controller:
## Enable OIDC policies.
enableOIDC: false

## Include year in log header. This parameter will be removed in release 2.7 and the year will be included by default.
includeYear: false
Copy link
Contributor

Choose a reason for hiding this comment

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

a corresponding entry in https://github.com/nginxinc/kubernetes-ingress/blob/feature/flag-include-year/docs/content/installation/installation-with-helm.md as controller.includeYear

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not sure I understand this. None of the values in this file start with controller. why would the includeYear value need to start with that?

Copy link
Contributor

@vepatel vepatel Jul 26, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

it refers to https://github.com/nginxinc/kubernetes-ingress/blob/feature/flag-include-year/deployments/helm-chart/values.yaml#L1 so when you're installing using helm-chart helm install my-release --set controller.kind=daemonset --set controller.nginxplus=true --set controller.image.repository=nginx-ingress --set controller.image.tag=edge --set controller.includeYear=true ......


## Enable TLS Passthrough on port 443. Requires controller.enableCustomResources.
enableTLSPassthrough: false

Expand Down
7 changes: 7 additions & 0 deletions docs/content/configuration/global-configuration/command-line-arguments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,13 @@ Default `false`.
 
<a name="cmdoption-enable-leader-election"></a>

### -inlcude-year
Adds year to log headers.

Default `false`.

**NOTE**: This flag will be removed in release 2.7 and the year will be included by default.

### -enable-leader-election

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.
Expand Down
1 change: 1 addition & 0 deletions docs/content/installation/installation-with-helm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,7 @@ The following tables lists the configurable parameters of the NGINX Ingress Cont
|``controller.enableCustomResources`` | Enable the custom resources. | true |
|``controller.enablePreviewPolicies`` | Enable preview policies. This parameter is deprecated. To enable OIDC Policies please use ``controller.enableOIDC`` instead. | false |
|``controller.enableOIDC`` | Enable OIDC policies. | false |
|``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 |
|``controller.enableTLSPassthrough`` | Enable TLS Passthrough on port 443. Requires ``controller.enableCustomResources``. | false |
`controller.enableCertManager` | Enable x509 automated certificate management for VirtualServer resources using cert-manager (cert-manager.io). Requires `controller.enableCustomResources`. | false
`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
Expand Down