Documentation ¶
Overview ¶
+groupName=app.verrazzano.io
Package v1alpha1 contains API Schema definitions for the app v1alpha1 API group +kubebuilder:object:generate=true +groupName=app.verrazzano.io
Index ¶
Constants ¶
const MetricsTemplateKind string = "MetricsTemplate"
MetricsTemplateKind identifies the Kind for the MetricsTemplate.
Variables ¶
var ( // SchemeGroupVersion is the group version used to register these objects SchemeGroupVersion = schema.GroupVersion{Group: "app.verrazzano.io", Version: "v1alpha1"} // SchemeBuilder is used to add Go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion} // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
This section is empty.
Types ¶
type MetricsBinding ¶
type MetricsBinding struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec MetricsBindingSpec `json:"spec"` }
MetricsBinding specifies the metrics binding API.
func (*MetricsBinding) DeepCopy ¶
func (in *MetricsBinding) DeepCopy() *MetricsBinding
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetricsBinding.
func (*MetricsBinding) DeepCopyInto ¶
func (in *MetricsBinding) DeepCopyInto(out *MetricsBinding)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MetricsBinding) DeepCopyObject ¶
func (in *MetricsBinding) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type MetricsBindingList ¶
type MetricsBindingList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []MetricsBinding `json:"items"` }
MetricsBindingList contains a list of metrics binding resources. +kubebuilder:object:root=true
func (*MetricsBindingList) DeepCopy ¶
func (in *MetricsBindingList) DeepCopy() *MetricsBindingList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetricsBindingList.
func (*MetricsBindingList) DeepCopyInto ¶
func (in *MetricsBindingList) DeepCopyInto(out *MetricsBindingList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MetricsBindingList) DeepCopyObject ¶
func (in *MetricsBindingList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type MetricsBindingSpec ¶
type MetricsBindingSpec struct { // Identifies a namespace and name for a metricsTemplate resource. MetricsTemplate NamespaceName `json:"metricsTemplate"` // Identifies a namespace and name for a Prometheus ConfigMap resource. // +optional PrometheusConfigMap NamespaceName `json:"prometheusConfigMap,omitempty"` // Identifies a namespace, name, and key for a secret containing the Prometheus configuration. // +optional PrometheusConfigSecret SecretKey `json:"prometheusConfigSecret,omitempty"` // Identifies the name and type for a workload. Workload Workload `json:"workload"` }
MetricsBindingSpec specifies the desired state of a metrics binding.
func (*MetricsBindingSpec) DeepCopy ¶
func (in *MetricsBindingSpec) DeepCopy() *MetricsBindingSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetricsBindingSpec.
func (*MetricsBindingSpec) DeepCopyInto ¶
func (in *MetricsBindingSpec) DeepCopyInto(out *MetricsBindingSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MetricsTemplate ¶
type MetricsTemplate struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec MetricsTemplateSpec `json:"spec"` }
MetricsTemplate specifies the metrics template API.
func (*MetricsTemplate) DeepCopy ¶
func (in *MetricsTemplate) DeepCopy() *MetricsTemplate
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetricsTemplate.
func (*MetricsTemplate) DeepCopyInto ¶
func (in *MetricsTemplate) DeepCopyInto(out *MetricsTemplate)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MetricsTemplate) DeepCopyObject ¶
func (in *MetricsTemplate) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type MetricsTemplateList ¶
type MetricsTemplateList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []MetricsTemplate `json:"items"` }
MetricsTemplateList contains a list of metrics template resources. +kubebuilder:object:root=true
func (*MetricsTemplateList) DeepCopy ¶
func (in *MetricsTemplateList) DeepCopy() *MetricsTemplateList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetricsTemplateList.
func (*MetricsTemplateList) DeepCopyInto ¶
func (in *MetricsTemplateList) DeepCopyInto(out *MetricsTemplateList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MetricsTemplateList) DeepCopyObject ¶
func (in *MetricsTemplateList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type MetricsTemplateSpec ¶
type MetricsTemplateSpec struct { // Prometheus configuration details. // +optional PrometheusConfig PrometheusConfig `json:"prometheusConfig,omitempty"` // Selector for target workloads. // +optional WorkloadSelector WorkloadSelector `json:"workloadSelector,omitempty"` }
MetricsTemplateSpec specifies the desired state of a metrics template.
func (*MetricsTemplateSpec) DeepCopy ¶
func (in *MetricsTemplateSpec) DeepCopy() *MetricsTemplateSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetricsTemplateSpec.
func (*MetricsTemplateSpec) DeepCopyInto ¶
func (in *MetricsTemplateSpec) DeepCopyInto(out *MetricsTemplateSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type NamespaceName ¶
type NamespaceName struct { // Name of the resource. Name string `json:"name"` // Namespace of the resource. Namespace string `json:"namespace"` }
NamespaceName identifies a namespace and name pair for a resource.
func (*NamespaceName) DeepCopy ¶
func (in *NamespaceName) DeepCopy() *NamespaceName
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NamespaceName.
func (*NamespaceName) DeepCopyInto ¶
func (in *NamespaceName) DeepCopyInto(out *NamespaceName)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PrometheusConfig ¶
type PrometheusConfig struct { // Scrape configuration template to be added to the Prometheus configuration. ScrapeConfigTemplate string `json:"scrapeConfigTemplate"` // Identity of the ConfigMap to be updated with the scrape configuration specified in `scrapeConfigTemplate`. TargetConfigMap TargetConfigMap `json:"targetConfigMap"` }
PrometheusConfig refers to the templated metrics scraping configuration.
func (*PrometheusConfig) DeepCopy ¶
func (in *PrometheusConfig) DeepCopy() *PrometheusConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PrometheusConfig.
func (*PrometheusConfig) DeepCopyInto ¶
func (in *PrometheusConfig) DeepCopyInto(out *PrometheusConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SecretKey ¶ added in v1.4.0
type SecretKey struct { // Name of the secret. Name string `json:"name"` // Namespace of the secret. Namespace string `json:"namespace"` // Key in the secret whose value this object represents. Key string `json:"key"` }
SecretKey identifies a value in a Kubernetes secret by its namespace, name, and key.
func (*SecretKey) DeepCopy ¶ added in v1.4.0
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SecretKey.
func (*SecretKey) DeepCopyInto ¶ added in v1.4.0
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TargetConfigMap ¶
type TargetConfigMap struct { // Name of the ConfigMap to be updated with the scrape target configuration. Name string `json:"name"` // Namespace of the ConfigMap to be updated with the scrape target configuration. Namespace string `json:"namespace"` }
TargetConfigMap contains metadata about the Prometheus ConfigMap.
func (*TargetConfigMap) DeepCopy ¶
func (in *TargetConfigMap) DeepCopy() *TargetConfigMap
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TargetConfigMap.
func (*TargetConfigMap) DeepCopyInto ¶
func (in *TargetConfigMap) DeepCopyInto(out *TargetConfigMap)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Workload ¶
type Workload struct { // Name of the resource. Name string `json:"name"` // TypeMeta of the resource. TypeMeta metav1.TypeMeta `json:"typeMeta"` }
Workload identifies the name and type of workload.
func (*Workload) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Workload.
func (*Workload) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type WorkloadSelector ¶
type WorkloadSelector struct { // Scopes the template to given API Groups. // +optional APIGroups []string `json:"apiGroups,omitempty"` // Scopes the template to given API Versions. // +optional APIVersions []string `json:"apiVersions,omitempty"` // Scopes the template to a namespace. // +optional NamespaceSelector metav1.LabelSelector `json:"namespaceSelector,omitempty"` // Scopes the template to a specifically-labelled object instance. // +optional ObjectSelector metav1.LabelSelector `json:"objectSelector,omitempty"` // Scopes the template to given API Resources. // +optional Resources []string `json:"resources,omitempty"` }
WorkloadSelector identifies the workloads to which a template applies.
func (*WorkloadSelector) DeepCopy ¶
func (in *WorkloadSelector) DeepCopy() *WorkloadSelector
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WorkloadSelector.
func (*WorkloadSelector) DeepCopyInto ¶
func (in *WorkloadSelector) DeepCopyInto(out *WorkloadSelector)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.