Skip to content

Commit 93daa40

Browse files
committed
change log level naming to align with Kubernetes API conventions
1 parent 9f8dbdf commit 93daa40

9 files changed

Lines changed: 32 additions & 32 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,9 @@ spec:
4343
spec:
4444
# Optional: Number of replicas (default: 2)
4545
replicas: 2
46-
# Optional: Log level (default: INFO)
47-
# Valid values: DEBUG, INFO, WARN, ERROR, FATAL, PANIC
48-
logLevel: INFO
46+
# Optional: Log level (default: Info)
47+
# Valid values: Debug, Info, Warn, Error, Fatal, Panic
48+
logLevel: Info
4949
# Optional: Ingress provider type (default: KubernetesIngress)
5050
# Valid values:
5151
# - KubernetesIngress: Standard Kubernetes Ingress provider (ingress class: "traefik")
@@ -62,7 +62,7 @@ spec:
6262
| Field | Type | Default | Description |
6363
|-------|------|---------|-------------|
6464
| `spec.replicas` | int32 | `2` | Number of Traefik replicas |
65-
| `spec.logLevel` | string | `INFO` | Traefik log level: `DEBUG`, `INFO`, `WARN`, `ERROR`, `FATAL`, `PANIC` |
65+
| `spec.logLevel` | string | `Info` | Traefik log level: `Debug`, `Info`, `Warn`, `Error`, `Fatal`, `Panic` |
6666
| `spec.ingressProvider` | string | `KubernetesIngress` | Kubernetes Ingress provider type: `KubernetesIngress` or `KubernetesIngressNGINX` |
6767
| `spec.dashboard` | bool | `false` | Enable the Traefik API and dashboard (not recommended for production) |
6868

docs/api-reference/traefik.extensions.gardener.cloud.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ _Appears in:_
4444
| --- | --- | --- | --- |
4545
| `replicas` _integer_ | Replicas is the number of Traefik replicas to deploy.<br />Defaults to 2 if not specified. | | |
4646
| `ingressProvider` _[IngressProviderType](#ingressprovidertype)_ | IngressProvider specifies which Kubernetes Ingress provider to use.<br />Valid values are:<br />- "KubernetesIngress" (default): Standard Kubernetes Ingress provider<br />- "KubernetesIngressNGINX": NGINX-compatible provider with support for NGINX annotations<br />Use KubernetesIngressNGINX when migrating from NGINX Ingress Controller to maintain<br />compatibility with existing NGINX-specific annotations. | | |
47-
| `logLevel` _string_ | LogLevel sets the Traefik log level.<br />Valid values are: DEBUG, INFO, WARN, ERROR, FATAL, PANIC<br />Defaults to "INFO" if not specified. | | |
47+
| `logLevel` _string_ | LogLevel sets the Traefik log level.<br />Valid values are: Debug, Info, Warn, Error, Fatal, Panic<br />Defaults to "Info" if not specified. | | |
4848
| `dashboard` _boolean_ | Dashboard enables the Traefik dashboard.<br />The dashboard is exposed on port 9000 and accessible via port-forwarding.<br />Enabling the API and the dashboard in production is not recommended, because it will expose all<br />configuration elements, including sensitive data, for which access should be reserved to administrators.<br />Defaults to false if not specified. | | |
4949

5050

examples/shoot.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ spec:
2121
# Optional: Number of Traefik replicas
2222
replicas: 2
2323

24-
# Optional: Log level (default: "INFO")
25-
# Valid values: DEBUG, INFO, WARN, ERROR, FATAL, PANIC
26-
# logLevel: INFO
24+
# Optional: Log level (default: "Info")
25+
# Valid values: Debug, Info, Warn, Error, Fatal, Panic
26+
# logLevel: Info
2727

2828
# Optional: Ingress provider type (default: "KubernetesIngress")
2929
# Valid values:

pkg/actuator/actuator.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ func (a *Actuator) Reconcile(ctx context.Context, logger logr.Logger, ex *extens
214214
}
215215
if cfg.Spec.LogLevel != "" {
216216
if _, ok := traefik.ValidLogLevels[cfg.Spec.LogLevel]; !ok {
217-
return fmt.Errorf("invalid traefik log level %q: must be one of DEBUG, INFO, WARN, ERROR, FATAL, PANIC", cfg.Spec.LogLevel)
217+
return fmt.Errorf("invalid traefik log level %q: must be one of Debug, Info, Warn, Error, Fatal, Panic", cfg.Spec.LogLevel)
218218
}
219219
traefikConfig.LogLevel = cfg.Spec.LogLevel
220220
}

pkg/apis/config/types.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ type TraefikConfigSpec struct {
3636
IngressProvider IngressProviderType `json:"ingressProvider,omitempty"`
3737

3838
// LogLevel sets the Traefik log level.
39-
// Valid values are: DEBUG, INFO, WARN, ERROR, FATAL, PANIC
40-
// Defaults to "INFO" if not specified.
39+
// Valid values are: Debug, Info, Warn, Error, Fatal, Panic
40+
// Defaults to "Info" if not specified.
4141
LogLevel string `json:"logLevel,omitempty"`
4242

4343
// Dashboard enables the Traefik dashboard.

pkg/apis/config/v1alpha1/types.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ type TraefikConfigSpec struct {
3636
IngressProvider IngressProviderType `json:"ingressProvider,omitempty"`
3737

3838
// LogLevel sets the Traefik log level.
39-
// Valid values are: DEBUG, INFO, WARN, ERROR, FATAL, PANIC
40-
// Defaults to "INFO" if not specified.
39+
// Valid values are: Debug, Info, Warn, Error, Fatal, Panic
40+
// Defaults to "Info" if not specified.
4141
LogLevel string `json:"logLevel,omitempty"`
4242

4343
// Dashboard enables the Traefik dashboard.

pkg/traefik/constants.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ const (
2727

2828
// ValidLogLevels contains the set of log levels supported by Traefik.
2929
var ValidLogLevels = map[string]struct{}{
30-
"DEBUG": {},
31-
"INFO": {},
32-
"WARN": {},
33-
"ERROR": {},
34-
"FATAL": {},
35-
"PANIC": {},
30+
"Debug": {},
31+
"Info": {},
32+
"Warn": {},
33+
"Error": {},
34+
"Fatal": {},
35+
"Panic": {},
3636
}

pkg/traefik/deployer.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ func DefaultConfig() Config {
9999
return Config{
100100
Replicas: 2,
101101
IngressProvider: config.IngressProviderKubernetesIngress,
102-
LogLevel: "INFO",
102+
LogLevel: "Info",
103103
}
104104
}
105105

pkg/traefik/deployer_test.go

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -219,24 +219,24 @@ func TestDeployment_LogLevel(t *testing.T) {
219219
expectedArg string
220220
}{
221221
{
222-
name: "INFO log level",
223-
logLevel: "INFO",
224-
expectedArg: "--log.level=INFO",
222+
name: "Info log level",
223+
logLevel: "Info",
224+
expectedArg: "--log.level=Info",
225225
},
226226
{
227-
name: "DEBUG log level",
228-
logLevel: "DEBUG",
229-
expectedArg: "--log.level=DEBUG",
227+
name: "Debug log level",
228+
logLevel: "Debug",
229+
expectedArg: "--log.level=Debug",
230230
},
231231
{
232-
name: "WARN log level",
233-
logLevel: "WARN",
234-
expectedArg: "--log.level=WARN",
232+
name: "Warn log level",
233+
logLevel: "Warn",
234+
expectedArg: "--log.level=Warn",
235235
},
236236
{
237-
name: "ERROR log level",
238-
logLevel: "ERROR",
239-
expectedArg: "--log.level=ERROR",
237+
name: "Error log level",
238+
logLevel: "Error",
239+
expectedArg: "--log.level=Error",
240240
},
241241
}
242242

0 commit comments

Comments
 (0)