Documentation
¶
Overview ¶
+kubebuilder:validation:Optional +groupName=config.openshift.io Package v1alpha1 is the v1alpha1 version of the API.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( GroupName = "config.openshift.io" GroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1alpha1"} // Install is a function which adds this version to a scheme Install = schemeBuilder.AddToScheme // SchemeGroupVersion generated code relies on this name // Deprecated SchemeGroupVersion = GroupVersion // AddToScheme exists solely to keep the old generators creating valid code // DEPRECATED AddToScheme = schemeBuilder.AddToScheme )
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource generated code relies on this being here, but it logically belongs to the group DEPRECATED
Types ¶
type DataPolicy ¶
type DataPolicy string
dataPolicy declares valid data policy types +kubebuilder:validation:Enum="";None;ObfuscateNetworking
const ( // No data obfuscation NoPolicy DataPolicy = "None" // IP addresses and cluster domain name are obfuscated ObfuscateNetworking DataPolicy = "ObfuscateNetworking" )
type GatherConfig ¶
type GatherConfig struct {
// dataPolicy allows user to enable additional global obfuscation of the IP addresses and base domain
// in the Insights archive data. Valid values are "None" and "ObfuscateNetworking".
// When set to None the data is not obfuscated.
// When set to ObfuscateNetworking the IP addresses and the cluster domain name are obfuscated.
// When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time.
// The current default is None.
// +optional
DataPolicy DataPolicy `json:"dataPolicy,omitempty"`
// disabledGatherers is a list of gatherers to be excluded from the gathering. All the gatherers can be disabled by providing "all" value.
// If all the gatherers are disabled, the Insights operator does not gather any data.
// The particular gatherers IDs can be found at https://github.com/openshift/insights-operator/blob/master/docs/gathered-data.md.
// Run the following command to get the names of last active gatherers:
// "oc get insightsoperators.operator.openshift.io cluster -o json | jq '.status.gatherStatus.gatherers[].name'"
// An example of disabling gatherers looks like this: `disabledGatherers: ["clusterconfig/machine_configs", "workloads/workload_info"]`
// +optional
DisabledGatherers []string `json:"disabledGatherers"`
}
gatherConfig provides data gathering configuration options.
func (*GatherConfig) DeepCopy ¶
func (in *GatherConfig) DeepCopy() *GatherConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GatherConfig.
func (*GatherConfig) DeepCopyInto ¶
func (in *GatherConfig) DeepCopyInto(out *GatherConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (GatherConfig) SwaggerDoc ¶
func (GatherConfig) SwaggerDoc() map[string]string
type InsightsDataGather ¶
type InsightsDataGather struct {
metav1.TypeMeta `json:",inline"`
// metadata is the standard object's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
metav1.ObjectMeta `json:"metadata,omitempty"`
// spec holds user settable values for configuration
// +kubebuilder:validation:Required
Spec InsightsDataGatherSpec `json:"spec"`
// status holds observed values from the cluster. They may not be overridden.
// +optional
Status InsightsDataGatherStatus `json:"status"`
}
+genclient +genclient:nonNamespaced +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
InsightsDataGather provides data gather configuration options for the the Insights Operator.
Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support. +openshift:compatibility-gen:level=4
func (*InsightsDataGather) DeepCopy ¶
func (in *InsightsDataGather) DeepCopy() *InsightsDataGather
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new InsightsDataGather.
func (*InsightsDataGather) DeepCopyInto ¶
func (in *InsightsDataGather) DeepCopyInto(out *InsightsDataGather)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*InsightsDataGather) DeepCopyObject ¶
func (in *InsightsDataGather) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (InsightsDataGather) SwaggerDoc ¶
func (InsightsDataGather) SwaggerDoc() map[string]string
type InsightsDataGatherList ¶
type InsightsDataGatherList struct {
metav1.TypeMeta `json:",inline"`
// metadata is the standard list's metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
metav1.ListMeta `json:"metadata"`
Items []InsightsDataGather `json:"items"`
}
InsightsDataGatherList is a collection of items
Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support. +openshift:compatibility-gen:level=4
func (*InsightsDataGatherList) DeepCopy ¶
func (in *InsightsDataGatherList) DeepCopy() *InsightsDataGatherList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new InsightsDataGatherList.
func (*InsightsDataGatherList) DeepCopyInto ¶
func (in *InsightsDataGatherList) DeepCopyInto(out *InsightsDataGatherList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*InsightsDataGatherList) DeepCopyObject ¶
func (in *InsightsDataGatherList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (InsightsDataGatherList) SwaggerDoc ¶
func (InsightsDataGatherList) SwaggerDoc() map[string]string
type InsightsDataGatherSpec ¶
type InsightsDataGatherSpec struct {
// gatherConfig spec attribute includes all the configuration options related to
// gathering of the Insights data and its uploading to the ingress.
// +optional
GatherConfig GatherConfig `json:"gatherConfig,omitempty"`
}
func (*InsightsDataGatherSpec) DeepCopy ¶
func (in *InsightsDataGatherSpec) DeepCopy() *InsightsDataGatherSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new InsightsDataGatherSpec.
func (*InsightsDataGatherSpec) DeepCopyInto ¶
func (in *InsightsDataGatherSpec) DeepCopyInto(out *InsightsDataGatherSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (InsightsDataGatherSpec) SwaggerDoc ¶
func (InsightsDataGatherSpec) SwaggerDoc() map[string]string
type InsightsDataGatherStatus ¶
type InsightsDataGatherStatus struct {
}
func (*InsightsDataGatherStatus) DeepCopy ¶
func (in *InsightsDataGatherStatus) DeepCopy() *InsightsDataGatherStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new InsightsDataGatherStatus.
func (*InsightsDataGatherStatus) DeepCopyInto ¶
func (in *InsightsDataGatherStatus) DeepCopyInto(out *InsightsDataGatherStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.