README
¶
component-base
Purpose
Implement KEP 32: https://github.com/kubernetes/enhancements/blob/master/keps/sig-cluster-lifecycle/wgs/783-component-base/README.md
The proposal is essentially about refactoring the Kubernetes core package structure in a way that all core components may share common code around:
- ComponentConfig implementation
- flag and command handling
- HTTPS serving
- delegated authn/z
- logging.
Compatibility
There are NO compatibility guarantees for this repository, yet. It is in direct support of Kubernetes, so branches will track Kubernetes and be compatible with that repo. As we more cleanly separate the layers, we will review the compatibility guarantee. We have a goal to make this easier to use in the future.
Where does it come from?
This repository is synced from https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/component-base.
Code changes are made in that location, merged into k8s.io/kubernetes and later synced here.
Things you should NOT do
- Directly modify any files in this repo. Those are driven from
k8s.io/kubernetes/staging/src/k8s.io/component-base. - Expect compatibility. This repo is changing quickly in direct support of Kubernetes.
OWNERS
WG Component Standard is working on this refactoring process, which is happening incrementally, starting in the v1.14 cycle. SIG API Machinery and SIG Cluster Lifecycle owns the code.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package configz serves ComponentConfig objects from running components.
|
Package configz serves ComponentConfig objects from running components. |
|
Package logs contains support for logging options, flags and setup.
|
Package logs contains support for logging options, flags and setup. |
|
api/v1
The LoggingAlphaOptions and LoggingBetaOptions feature gates control whether these unstable features can get enabled.
|
The LoggingAlphaOptions and LoggingBetaOptions feature gates control whether these unstable features can get enabled. |
|
datapol
Package datapol contains functions to determine if objects contain sensitive data to e.g.
|
Package datapol contains functions to determine if objects contain sensitive data to e.g. |
|
example
Package example shows how a library uses contextual logging.
|
Package example shows how a library uses contextual logging. |
|
example/cmd
command
|
|
|
example/k8s2slog
command
|
|
|
example/slog2k8s
command
slog2k8s demonstrates how an application using log/slog for logging can include Kubernetes packages.
|
slog2k8s demonstrates how an application using log/slog for logging can include Kubernetes packages. |
|
example/stdlib
command
|
|
|
internal/setverbositylevel
Package setverbositylevel stores callbacks that will be invoked by logs.GlogLevel.
|
Package setverbositylevel stores callbacks that will be invoked by logs.GlogLevel. |
|
kube-log-runner
command
|
|
|
testinit
Package testinit adds logging flags to a Ginkgo or Go test program during initialization, something that the logs package itself no longer does.
|
Package testinit adds logging flags to a Ginkgo or Go test program during initialization, something that the logs package itself no longer does. |
|
verflag
Package verflag defines utility functions to handle command line flags related to version of Kubernetes.
|
Package verflag defines utility functions to handle command line flags related to version of Kubernetes. |
|
zpages
|
|
|
features
Package features contains a separate feature set specifically designed for managing zpages related features.
|
Package features contains a separate feature set specifically designed for managing zpages related features. |