README
¶
Kubernetes Template Project
The Kubernetes Template Project is a template for starting new projects in the GitHub organizations owned by Kubernetes. All Kubernetes projects, at minimum, must have the following files:
- a
README.mdoutlining the project goals, sponsoring sig, and community contact information - an
OWNERSwith the project leads listed as approvers (docs onOWNERSfiles) - a
CONTRIBUTING.mdoutlining how to contribute to the project - an unmodified copy of
code-of-conduct.mdfrom this repo, which outlines community behavior and the consequences of breaking the code - a
LICENSEwhich must be Apache 2.0 for code projects, or Creative Commons 4.0 for documentation repositories, without any custom content - a
SECURITY_CONTACTSwith the contact points for the Product Security Team to reach out to for triaging and handling of incoming issues. They must agree to abide by the Embargo Policy and will be removed and replaced if they violate that agreement.
Community, discussion, contribution, and support
Learn how to engage with the Kubernetes community on the community page.
You can reach the maintainers of this project at:
Code of conduct
Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
test-app
Module
|
|
|
pkg
|
|
|
api
Package api defines the APIs.
|
Package api defines the APIs. |
|
api/collectorcontrollerv1alpha1
Package collectorcontrollerv1alpha1 defines the MetricsPrometheusCollector API.
|
Package collectorcontrollerv1alpha1 defines the MetricsPrometheusCollector API. |
|
api/quotamanagementv1alpha1
Package v1beta1 contains API Schema definitions for the usagemetricscollector.sigs.k8s.io API group +kubebuilder:object:generate=true +groupName=quotamanagement.usagemetricscollector.sigs.k8s.io +versionName=v1alpha1
|
Package v1beta1 contains API Schema definitions for the usagemetricscollector.sigs.k8s.io API group +kubebuilder:object:generate=true +groupName=quotamanagement.usagemetricscollector.sigs.k8s.io +versionName=v1alpha1 |
|
api/samplerserverv1alpha1
Package samplerserverv1alpha1 defines the MetricsNodeSampler API.
|
Package samplerserverv1alpha1 defines the MetricsNodeSampler API. |
|
collector
Package collector implements the metrics-prometheus-collector which exports metrics to prometheus when scraped.
|
Package collector implements the metrics-prometheus-collector which exports metrics to prometheus when scraped. |
|
log
Package log contains the shared logger used by the project
|
Package log contains the shared logger used by the project |
|
sampler
Package sampler implements metrics-node-sampler which samples local utilization metrics from the node it is running on and serves aggregated values from a grpc API.
|
Package sampler implements metrics-node-sampler which samples local utilization metrics from the node it is running on and serves aggregated values from a grpc API. |
|
sampler/api
Package api is a reverse proxy.
|
Package api is a reverse proxy. |
|
scheme
Package scheme provides a shared scheme for Kubernetes types
|
Package scheme provides a shared scheme for Kubernetes types |
|
testutil
Package testutil provides utilities for writing functional tests
|
Package testutil provides utilities for writing functional tests |
|
version
Package version exports the build version for a component
|
Package version exports the build version for a component |
|
watchconfig
Package watchconfig watches for config file changes
|
Package watchconfig watches for config file changes |
|
testutil
module
|
|
|
tools
module
|
Click to show internal directories.
Click to hide internal directories.