Documentation
¶
Overview ¶
Copyright 2022 Ondat.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Copyright 2022 Ondat.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Package v1 contains API Schema definitions for the config.storageos.com v1 API group +kubebuilder:object:generate=true +groupName=config.storageos.com
Copyright 2022 Ondat.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Index ¶
Constants ¶
const ( // MetricsExporterConfigFileName is a mandatory key in the data field of the // ConfigMap/storage-metrics-exporter. The associated value must be a valid MetricsExporterConfig // serialized as YAML. MetricsExporterConfigFileName = "config.yaml" )
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "config.storageos.com", Version: "v1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion} // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
This section is empty.
Types ¶
type MetricsExporterCollector ¶ added in v0.1.7
type MetricsExporterCollector string
MetricsExporterCollector is the name of a metrics collector in the metrics-exporter. +kubebuilder:validation:Enum=diskstats;filesystem
const ( MetricsExporterCollectorDiskStats MetricsExporterCollector = "diskstats" MetricsExporterCollectorFileSystem MetricsExporterCollector = "filesystem" )
All known metrics-exporter collectors are listed here.
type MetricsExporterConfig ¶
type MetricsExporterConfig struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
MetricsExporterConfigSpec `json:",inline"`
}
MetricsExporterConfig is the Schema for the metricsexporterconfigs API
func (*MetricsExporterConfig) DeepCopy ¶
func (in *MetricsExporterConfig) DeepCopy() *MetricsExporterConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetricsExporterConfig.
func (*MetricsExporterConfig) DeepCopyInto ¶
func (in *MetricsExporterConfig) DeepCopyInto(out *MetricsExporterConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MetricsExporterConfig) DeepCopyObject ¶
func (in *MetricsExporterConfig) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*MetricsExporterConfig) Default ¶ added in v0.1.7
func (c *MetricsExporterConfig) Default() *MetricsExporterConfig
type MetricsExporterConfigSpec ¶ added in v0.1.7
type MetricsExporterConfigSpec struct {
// Verbosity of log messages. Accepts go.uber.org/zap log levels.
// +kubebuilder:default:info
// +kubebuilder:validation:Enum=debug;info;warn;error;dpanic;panic;fatal
LogLevel string `json:"logLevel,omitempty"`
// Timeout in seconds to serve metrics.
// +kubebuilder:default:10
// +kubebuilder:validation:Minimum=1
Timeout int `json:"timeout,omitempty"`
// DisabledCollectors is a list of collectors that shall be disabled. By default, all are enabled.
DisabledCollectors []MetricsExporterCollector `json:"disabledCollectors,omitempty"`
}
MetricsExporterConfigSpec represents the configuration options for the metrics-exporter. These fields shall be inlined in the StorageOSCluster.Spec.Metrics.
func (*MetricsExporterConfigSpec) DeepCopy ¶ added in v0.1.7
func (in *MetricsExporterConfigSpec) DeepCopy() *MetricsExporterConfigSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetricsExporterConfigSpec.
func (*MetricsExporterConfigSpec) DeepCopyInto ¶ added in v0.1.7
func (in *MetricsExporterConfigSpec) DeepCopyInto(out *MetricsExporterConfigSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
Source Files