README
¶
Knative Common Packages
"The kitchen sink" by Alan Cleaver is licensed under CC BY 2.0
Knative pkg provides a place for sharing common Knative packages across the
Knative repos.
To learn more about Knative, please visit our Knative docs repository.
If you are interested in contributing, see CONTRIBUTING.md and DEVELOPMENT.md. For a list of help wanted issues across Knative, take a look at CLOTRIBUTOR.
Directories
¶
| Path | Synopsis |
|---|---|
|
apiextensions
|
|
|
+k8s:deepcopy-gen=package
|
+k8s:deepcopy-gen=package |
|
duck
Package duck defines logic for defining and consuming "duck typed" Kubernetes resources.
|
Package duck defines logic for defining and consuming "duck typed" Kubernetes resources. |
|
duck/v1
+k8s:deepcopy-gen=package +groupName=duck.knative.dev
|
+k8s:deepcopy-gen=package +groupName=duck.knative.dev |
|
duck/v1alpha1
+k8s:deepcopy-gen=package +groupName=duck.knative.dev
|
+k8s:deepcopy-gen=package +groupName=duck.knative.dev |
|
duck/v1beta1
+k8s:deepcopy-gen=package +groupName=duck.knative.dev
|
+k8s:deepcopy-gen=package +groupName=duck.knative.dev |
|
test/example/v1alpha1
+k8s:deepcopy-gen=package +groupName=example.knative.dev
|
+k8s:deepcopy-gen=package +groupName=example.knative.dev |
|
test/pub/v1alpha1
+k8s:deepcopy-gen=package +groupName=pub.knative.dev
|
+k8s:deepcopy-gen=package +groupName=pub.knative.dev |
|
Package changeset returns version control info that was embedded in the golang binary
|
Package changeset returns version control info that was embedded in the golang binary |
|
client
|
|
|
codegen
|
|
|
Package configmap exists to facilitate consuming Kubernetes ConfigMap resources in various ways, including:
|
Package configmap exists to facilitate consuming Kubernetes ConfigMap resources in various ways, including: |
|
Package depcheck defines a test utility for ensuring certain packages don't take on heavy dependencies.
|
Package depcheck defines a test utility for ensuring certain packages don't take on heavy dependencies. |
|
Package hash contains various Knative specific hashing utilities.
|
Package hash contains various Knative specific hashing utilities. |
|
Package injection defines the mechanisms through which clients, informers and shared informer factories are injected into a shared controller binary implementation.
|
Package injection defines the mechanisms through which clients, informers and shared informer factories are injected into a shared controller binary implementation. |
|
Package kflag contains a variety of non-standard command-line flag types
|
Package kflag contains a variety of non-standard command-line flag types |
|
Package kmeta provides Knative utilities for operating on Kubernetes resources' ObjectMeta.
|
Package kmeta provides Knative utilities for operating on Kubernetes resources' ObjectMeta. |
|
Package kmp wraps github.com/google/go-cmp with custom Comparers for frequently used kubernetes resources that have unexported fields.
|
Package kmp wraps github.com/google/go-cmp with custom Comparers for frequently used kubernetes resources that have unexported fields. |
|
Simple abstraction for storing state on a k8s ConfigMap.
|
Simple abstraction for storing state on a k8s ConfigMap. |
|
LeaderElection provides an interface for controllers implementing using controller injection: https://github.com/knative/pkg/blob/main/injection/README.md
|
LeaderElection provides an interface for controllers implementing using controller injection: https://github.com/knative/pkg/blob/main/injection/README.md |
|
chaosduck
The chaosduck binary is an e2e testing tool for leader election, which loads the leader election configuration within the system namespace and periodically kills one of the leader pods for each HA component.
|
The chaosduck binary is an e2e testing tool for leader election, which loads the leader election configuration within the system namespace and periodically kills one of the leader pods for each HA component. |
|
Package metrics provides Knative utilities for exporting metrics to OpenCensus/OTel or Prometheus backend based on config-observability settings.
|
Package metrics provides Knative utilities for exporting metrics to OpenCensus/OTel or Prometheus backend based on config-observability settings. |
|
metricstest
Package metricstest simplifies some of the common boilerplate around testing metrics exports.
|
Package metricstest simplifies some of the common boilerplate around testing metrics exports. |
|
Package network holds the typed objects that define the schemas for configuring the knative networking layer.
|
Package network holds the typed objects that define the schemas for configuring the knative networking layer. |
|
handlers
Package handlers holds useful HTTP handler implementations.
|
Package handlers holds useful HTTP handler implementations. |
|
metrics/metricstest
Package metricstest provides test helpers to assert OTel metrics are recorded properly.
|
Package metricstest provides test helpers to assert OTel metrics are recorded properly. |
|
runtime
Package runtime provides configuration to publish Go runtime statistics and HTTP helpers to expose Go runtime profiling data
|
Package runtime provides configuration to publish Go runtime statistics and HTTP helpers to expose Go runtime profiling data |
|
Package ptr holds utilities for taking pointer references to values.
|
Package ptr holds utilities for taking pointer references to values. |
|
testing
Package testing includes utilities for testing controllers.
|
Package testing includes utilities for testing controllers. |
|
Package resolver implements resolvers for resolving k8s references and URIs.
|
Package resolver implements resolvers for resolving k8s references and URIs. |
|
Package source holds utilities for Source developers.
|
Package source holds utilities for Source developers. |
|
logstream
Package logstream lets end-to-end tests incorporate controller logs into the error output of tests.
|
Package logstream lets end-to-end tests incorporate controller logs into the error output of tests. |
|
monitoring
Package monitoring provides common methods for all the monitoring components used in the tests
|
Package monitoring provides common methods for all the monitoring components used in the tests |
|
zipkin
Package zipkin adds Zipkin tracing support that can be used in conjunction with SpoofingClient to log zipkin traces for requests that have encountered server errors i.e HTTP request that have HTTP status between 500 to 600.
|
Package zipkin adds Zipkin tracing support that can be used in conjunction with SpoofingClient to log zipkin traces for requests that have encountered server errors i.e HTTP request that have HTTP status between 500 to 600. |
|
+k8s:deepcopy-gen=package +groupName=pkg.knative.dev
|
+k8s:deepcopy-gen=package +groupName=pkg.knative.dev |
|
duck
+k8s:deepcopy-gen=package +groupName=duck.knative.dev
|
+k8s:deepcopy-gen=package +groupName=duck.knative.dev |
|
config
Package config holds the typed objects that define the schemas for assorted ConfigMap objects on which the Revision controller depends.
|
Package config holds the typed objects that define the schemas for assorted ConfigMap objects on which the Revision controller depends. |
|
Package tracker defines a utility to enable Reconcilers to trigger reconciliations when objects that are cross-referenced change, so that the level-based reconciliation can react to the change.
|
Package tracker defines a utility to enable Reconcilers to trigger reconciliations when objects that are cross-referenced change, so that the level-based reconciliation can react to the change. |
|
psbinding
Package psbinding provides facilities to make authoring Bindings that work with "Pod Spec"-able subjects easier.
|
Package psbinding provides facilities to make authoring Bindings that work with "Pod Spec"-able subjects easier. |
Click to show internal directories.
Click to hide internal directories.