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

Jump to bottom

Adds log level settings #388

Merged
merged 13 commits into from
Oct 7, 2024
Merged

Adds log level settings #388

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
0a8c342
Adds log level settings
alexandrealvino Jul 9, 2024
b4890b8
Fix lint
alexandrealvino Jul 9, 2024
a586b09
Fix lint
alexandrealvino Jul 10, 2024
97319a5
Adds warn and error levels
alexandrealvino Jul 11, 2024
7d020fd
Update configuration doc
alexandrealvino Jul 12, 2024
f30969b
Update configuration doc
alexandrealvino Jul 12, 2024
4819828
Merge branch 'main' into log-level
alexandrealvino Jul 17, 2024
1a0e1b0
Merge branch 'main' into log-level
alexandrealvino Oct 2, 2024
5bdf68b
Merge branch 'main' into log-level
alexandrealvino Oct 7, 2024
e456a48
Merge branch 'main' into log-level
alexandrealvino Oct 7, 2024
1171268
Create helper function to get log level and improve documentation
alexandrealvino Oct 7, 2024
c4d6af3
Add loglevel config in demo files
alexandrealvino Oct 7, 2024
0cbdc94
Merge branch 'main' into log-level
azdagron Oct 7, 2024
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
3 changes: 3 additions & 0 deletions api/v1alpha1/controllermanagerconfig_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,9 @@ type ControllerManagerConfig struct {

// SPIREServerSocketPath is the path to the SPIRE Server API socket
SPIREServerSocketPath string `json:"spireServerSocketPath"`

// LogLevel is the log level for the controller manager
LogLevel string `json:"logLevel"`
}

// ControllerManagerConfigurationSpec defines the desired state of GenericControllerManagerConfiguration.
Expand Down
40 changes: 31 additions & 9 deletions cmd/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ import (
_ "k8s.io/client-go/plugin/pkg/client/auth"
"k8s.io/client-go/rest"

"go.uber.org/zap/zapcore"
"k8s.io/apimachinery/pkg/runtime"
utilruntime "k8s.io/apimachinery/pkg/util/runtime"
clientgoscheme "k8s.io/client-go/kubernetes/scheme"
Expand Down Expand Up @@ -111,16 +112,8 @@ func parseConfig() (Config, error) {
"Command-line flags override configuration from this file.")
flag.StringVar(&spireAPISocketFlag, "spire-api-socket", "", "The path to the SPIRE API socket (deprecated; use the config file)")
flag.BoolVar(&expandEnvFlag, "expand-env", false, "Expand environment variables in SPIRE Controller Manager config file")

// Parse log flags
opts := zap.Options{
Development: true,
}
opts.BindFlags(flag.CommandLine)
flag.Parse()

ctrl.SetLogger(zap.New(zap.UseFlagOptions(&opts)))

// Set default values
retval.ctrlConfig = spirev1alpha1.ControllerManagerConfig{
IgnoreNamespaces: []string{"kube-system", "kube-public", "spire-system"},
Expand All @@ -134,7 +127,6 @@ func parseConfig() (Config, error) {
if err := spirev1alpha1.LoadOptionsFromFile(configFileFlag, scheme, &retval.options, &retval.ctrlConfig, expandEnvFlag); err != nil {
return retval, fmt.Errorf("unable to load the config file: %w", err)
}

for _, ignoredNamespace := range retval.ctrlConfig.IgnoreNamespaces {
regex, err := regexp.Compile(ignoredNamespace)
if err != nil {
Expand All @@ -144,6 +136,21 @@ func parseConfig() (Config, error) {
retval.ignoreNamespacesRegex = append(retval.ignoreNamespacesRegex, regex)
}
}

// Parse log flags
logLevel, err := getLogLevel(retval.ctrlConfig.LogLevel)
if err != nil {
return retval, fmt.Errorf("unable to parse log level: %w", err)
}
opts := zap.Options{
Level: logLevel,
Development: true,
}
opts.BindFlags(flag.CommandLine)

ctrl.SetLogger(zap.New(zap.UseFlagOptions(&opts)))
ctrl.Log.V(0).Info("Logger configured", "level", opts.Level)

// Determine the SPIRE Server socket path
switch {
case retval.ctrlConfig.SPIREServerSocketPath == "" && spireAPISocketFlag == "":
Expand Down Expand Up @@ -471,3 +478,18 @@ func parseClusterDomainCNAME(cname string) (string, error) {

return clusterDomain, nil
}

func getLogLevel(logLevel string) (zapcore.Level, error) {
switch strings.ToLower(logLevel) {
case "debug":
return zapcore.DebugLevel, nil
case "warn":
return zapcore.WarnLevel, nil
case "error":
return zapcore.ErrorLevel, nil
case "info":
return zapcore.InfoLevel, nil
default:
return zapcore.InfoLevel, fmt.Errorf("invalid log level: %s", logLevel)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
return zapcore.InfoLevel, fmt.Errorf("invalid log level: %s", logLevel)
return zapcore.InfoLevel, fmt.Errorf("invalid log level: %q", logLevel)

}
}
1 change: 1 addition & 0 deletions demo/config/cluster1/spire/spire-controller-manager-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ leaderElection:
resourceName: 98c9c988.spiffe.io
resourceNamespace: spire-system
clusterName: cluster1
logLevel: info
trustDomain: cluster1.demo
ignoreNamespaces:
- kube-system
Expand Down
1 change: 1 addition & 0 deletions demo/config/cluster2/spire/spire-controller-manager-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ leaderElection:
resourceName: 98c9c988.spiffe.io
resourceNamespace: spire-system
clusterName: cluster2
logLevel: info
trustDomain: cluster2.demo
ignoreNamespaces:
- kube-system
Expand Down
21 changes: 12 additions & 9 deletions docs/spire-controller-manager-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,17 @@

The SPIRE Controller Manager configuration is defined [here](../api/v1alpha1/controllermanagerconfig_types.go).

Beyond the standard [controller manager configuration](https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/config/v1alpha1#ControllerConfigurationSpec), the following fields are defined:
Beyond the
standard [controller manager configuration](https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/config/v1alpha1#ControllerConfigurationSpec),
the following fields are defined:

| Field | Required | Default | Description |
| ------------------------------------ | -------- | ------------------------------------------------ | ------------------------------------------------------------------ |
| `clusterName` | REQUIRED | | The name of the cluster |
| `trustDomain` | REQUIRED | | The trust domain name for the cluster |
| `clusterDomain` | OPTIONAL | | The domain of the cluster, ie `cluster.local`. If not specified will attempt to auto detect. |
| `ignoreNamespaces` | OPTIONAL | `["kube-system", "kube-public", "spire-system"]` | Namespaces that the controllers should ignore |
| `validatingWebhookConfigurationName` | OPTIONAL | `spire-controller-manager-webhook` | The name of the validating admission controller webhook to manage |
| Field | Required | Default | Description |
|--------------------------------------|----------|--------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `clusterName` | REQUIRED | | The name of the cluster |
| `trustDomain` | REQUIRED | | The trust domain name for the cluster |
| `clusterDomain` | OPTIONAL | | The domain of the cluster, ie `cluster.local`. If not specified will attempt to auto detect. |
| `ignoreNamespaces` | OPTIONAL | `["kube-system", "kube-public", "spire-system"]` | Namespaces that the controllers should ignore |
| `validatingWebhookConfigurationName` | OPTIONAL | `spire-controller-manager-webhook` | The name of the validating admission controller webhook to manage |
| `gcInterval` | OPTIONAL | `10s` | How often the SPIRE state is reconciled when the controller is otherwise idle. This impacts how quickly SPIRE state will converge after CRDs are removed or SPIRE state is mutated underneath the controller. |
| `spireServerSocketPath` | OPTIONAL | `/spire-server/api.sock` | The path the the SPIRE Server API socket |
| `spireServerSocketPath` | OPTIONAL | `/spire-server/api.sock` | The path the the SPIRE Server API socket |
| `logLevel` | OPTIONAL | `info` | The log level for the controller manager. Supported values are `info`, `error`, `warn` and `debug`. |