README
¶
Knative Common Packages
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.
Directories
¶
| Path | Synopsis |
|---|---|
|
+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 |
|
istio/authentication/v1alpha1
Api versions allow the api contract for a resource to be changed while keeping backward compatibility by support multiple concurrent versions of the same resource +k8s:deepcopy-gen=package +groupName=authentication.istio.io
|
Api versions allow the api contract for a resource to be changed while keeping backward compatibility by support multiple concurrent versions of the same resource +k8s:deepcopy-gen=package +groupName=authentication.istio.io |
|
istio/v1alpha3
+k8s:deepcopy-gen=package +groupName=networking.istio.io
|
+k8s:deepcopy-gen=package +groupName=networking.istio.io |
|
v1alpha1
+k8s:deepcopy-gen=package
|
+k8s:deepcopy-gen=package |
|
Package changeset provides Knative utilities for fetching GitHub Commit ID from kodata directory.
|
Package changeset provides Knative utilities for fetching GitHub Commit ID from kodata directory. |
|
client
|
|
|
clientset/versioned
This package has the automatically generated clientset.
|
This package has the automatically generated clientset. |
|
clientset/versioned/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
clientset/versioned/typed/authentication/v1alpha1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
clientset/versioned/typed/authentication/v1alpha1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
clientset/versioned/typed/istio/v1alpha3
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
clientset/versioned/typed/istio/v1alpha3/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
Package cloudevents implements utilities for handling CloudEvents.
|
Package cloudevents implements utilities for handling CloudEvents. |
|
codegen
|
|
|
Package configmap exists to facilitate consuming Kubernetes ConfigMap resources in various ways, including: - Watching them for changes over time, and - Loading them from a VolumeMount.
|
Package configmap exists to facilitate consuming Kubernetes ConfigMap resources in various ways, including: - Watching them for changes over time, and - Loading them from a VolumeMount. |
|
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 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. |
|
Package metrics provides Knative utilities for exporting metrics to Stackdriver backend or Prometheus backend based on config-observability settings.
|
Package metrics provides Knative utilities for exporting metrics to Stackdriver backend or Prometheus backend based on config-observability settings. |
|
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. |
|
Package ptr holds utilities for taking pointer references to values.
|
Package ptr holds utilities for taking pointer references to values. |
|
reconciler
|
|
|
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. |
|
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 This package exposes following methods: CheckPortAvailability(port int) error Checks if the given port is available GetPods(kubeClientset *kubernetes.Clientset, app string) (*v1.PodList, error) Gets the list of pods that satisfy the lable selector app=<app> Cleanup(pid int) error Kill the current port forwarding process running in the background PortForward(logf logging.FormatLogger, podList *v1.PodList, localPort, remotePort int) (int, error) Create a background process that will port forward the first pod from the local to remote port It returns the process id for the background process created.
|
Package monitoring provides common methods for all the monitoring components used in the tests This package exposes following methods: CheckPortAvailability(port int) error Checks if the given port is available GetPods(kubeClientset *kubernetes.Clientset, app string) (*v1.PodList, error) Gets the list of pods that satisfy the lable selector app=<app> Cleanup(pid int) error Kill the current port forwarding process running in the background PortForward(logf logging.FormatLogger, podList *v1.PodList, localPort, remotePort int) (int, error) Create a background process that will port forward the first pod from the local to remote port It returns the process id for the background process created. |
|
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 |
|
testutils
|
|
|
clustermanager
Package clustermanager provides support for managing clusters for e2e tests, responsible for creating/deleting cluster, and cluster life cycle management if running in Prow usage example: func acquireCluster() { clusterOps := GKEClient{}.Setup(2, "n1-standard-8", "us-east1", "a", "myproject") // Cast to GKEOperation GKEOps := clusterOps.(GKECluster) if err = GKEOps.Acquire(); err != nil { log.Fatalf("Failed acquire cluster: '%v'", err) } log.Printf("GKE project is: %s", GKEOps.Project) log.Printf("GKE cluster is: %v", GKEOps.Cluster) }
|
Package clustermanager provides support for managing clusters for e2e tests, responsible for creating/deleting cluster, and cluster life cycle management if running in Prow usage example: func acquireCluster() { clusterOps := GKEClient{}.Setup(2, "n1-standard-8", "us-east1", "a", "myproject") // Cast to GKEOperation GKEOps := clusterOps.(GKECluster) if err = GKEOps.Acquire(); err != nil { log.Fatalf("Failed acquire cluster: '%v'", err) } log.Printf("GKE project is: %s", GKEOps.Project) log.Printf("GKE cluster is: %v", GKEOps.Cluster) } |
|
third_party
|
|
|
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. |
Click to show internal directories.
Click to hide internal directories.