Help us shape the future of Go! Take the 2026 Go Developer Survey

search

package
v1.17.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 10, 2026 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package search is the internal version of the API. +k8s:deepcopy-gen=package +groupName=search.karmada.io

Index

Constants

View Source
const GroupName = "search.karmada.io"

GroupName specifies the group name used to register the objects.

Variables

View Source
var (
	// SchemeBuilder is the scheme builder with scheme init functions to run for this API package
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	// AddToScheme is a common registration function for mapping packaged scoped group & version keys to a scheme
	AddToScheme = SchemeBuilder.AddToScheme
)
View Source
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}

SchemeGroupVersion is group version used to register these objects

Functions

func Kind

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns a Group qualified GroupKind

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type BackendStoreConfig

type BackendStoreConfig struct {
	// OpenSearch is a community-driven, open source search and analytics suite.
	// Refer to website(https://opensearch.org/) for more details about OpenSearch.
	// +optional
	OpenSearch *OpenSearchConfig `json:"openSearch,omitempty"`
}

BackendStoreConfig specifies backend store.

func (*BackendStoreConfig) DeepCopy

func (in *BackendStoreConfig) DeepCopy() *BackendStoreConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackendStoreConfig.

func (*BackendStoreConfig) DeepCopyInto

func (in *BackendStoreConfig) DeepCopyInto(out *BackendStoreConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type OpenSearchConfig

type OpenSearchConfig struct {
	// Addresses is a list of node endpoint(e.g. 'https://localhost:9200') to use.
	// For the 'node' concept, please refer to:
	// https://opensearch.org/docs/latest/opensearch/index/#clusters-and-nodes
	// +required
	Addresses []string `json:"addresses"`

	// SecretRef represents the secret contains mandatory credentials to access the server.
	// The secret should hold credentials as follows:
	// - secret.data.userName
	// - secret.data.password
	// +required
	SecretRef clusterv1alpha1.LocalSecretReference `json:"secretRef"`
}

OpenSearchConfig holds the necessary configuration for client to access and config an OpenSearch server.

func (*OpenSearchConfig) DeepCopy

func (in *OpenSearchConfig) DeepCopy() *OpenSearchConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OpenSearchConfig.

func (*OpenSearchConfig) DeepCopyInto

func (in *OpenSearchConfig) DeepCopyInto(out *OpenSearchConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Proxying added in v1.3.0

type Proxying struct {
	metav1.TypeMeta
}

Proxying define a flag for resource proxying that do not have actual resources.

func (*Proxying) DeepCopy added in v1.3.0

func (in *Proxying) DeepCopy() *Proxying

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Proxying.

func (*Proxying) DeepCopyInto added in v1.3.0

func (in *Proxying) DeepCopyInto(out *Proxying)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Proxying) DeepCopyObject added in v1.3.0

func (in *Proxying) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ResourceRegistry

type ResourceRegistry struct {
	metav1.TypeMeta
	metav1.ObjectMeta

	// Spec represents the desired behavior of ResourceRegistry.
	Spec ResourceRegistrySpec

	// Status represents the status of ResourceRegistry.
	// +optional
	Status ResourceRegistryStatus
}

ResourceRegistry defines a list of member cluster to be cached.

func (*ResourceRegistry) DeepCopy

func (in *ResourceRegistry) DeepCopy() *ResourceRegistry

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceRegistry.

func (*ResourceRegistry) DeepCopyInto

func (in *ResourceRegistry) DeepCopyInto(out *ResourceRegistry)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ResourceRegistry) DeepCopyObject

func (in *ResourceRegistry) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ResourceRegistryList

type ResourceRegistryList struct {
	metav1.TypeMeta
	metav1.ListMeta

	// Items holds a list of ResourceRegistry.
	Items []ResourceRegistry
}

ResourceRegistryList if a collection of ResourceRegistry.

func (*ResourceRegistryList) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceRegistryList.

func (*ResourceRegistryList) DeepCopyInto

func (in *ResourceRegistryList) DeepCopyInto(out *ResourceRegistryList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ResourceRegistryList) DeepCopyObject

func (in *ResourceRegistryList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ResourceRegistrySpec

type ResourceRegistrySpec struct {
	// TargetCluster specifies the clusters where the cache system collect resource from.
	// +required
	TargetCluster policyv1alpha1.ClusterAffinity `json:"targetCluster"`

	// ResourceSelectors specifies the resources type that should be cached by cache system.
	// +required
	ResourceSelectors []ResourceSelector `json:"resourceSelectors"`

	// BackendStore specifies the location where to store the cached items.
	// +optional
	BackendStore *BackendStoreConfig `json:"backendStore,omitempty"`
}

ResourceRegistrySpec defines the desired state of ResourceRegistry.

func (*ResourceRegistrySpec) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceRegistrySpec.

func (*ResourceRegistrySpec) DeepCopyInto

func (in *ResourceRegistrySpec) DeepCopyInto(out *ResourceRegistrySpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ResourceRegistryStatus

type ResourceRegistryStatus struct {
	// Conditions contain the different condition statuses.
	// +optional
	Conditions []metav1.Condition
}

ResourceRegistryStatus defines the observed state of ResourceRegistry

func (*ResourceRegistryStatus) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceRegistryStatus.

func (*ResourceRegistryStatus) DeepCopyInto

func (in *ResourceRegistryStatus) DeepCopyInto(out *ResourceRegistryStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ResourceSelector

type ResourceSelector struct {
	// APIVersion represents the API version of the target resources.
	// +required
	APIVersion string

	// Kind represents the kind of the target resources.
	// +required
	Kind string `json:"kind"`

	// Namespace of the target resource.
	// Default is empty, which means all namespaces.
	// +optional
	Namespace string
}

ResourceSelector specifies the resources type and its scope.

func (*ResourceSelector) DeepCopy

func (in *ResourceSelector) DeepCopy() *ResourceSelector

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ResourceSelector.

func (*ResourceSelector) DeepCopyInto

func (in *ResourceSelector) DeepCopyInto(out *ResourceSelector)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Search struct {
	metav1.TypeMeta
}

Search define a flag for resource search that do not have actual resources.

func (*Search) DeepCopy

func (in *Search) DeepCopy() *Search

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Search.

func (*Search) DeepCopyInto

func (in *Search) DeepCopyInto(out *Search)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Search) DeepCopyObject

func (in *Search) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

Directories

Path Synopsis
Package v1alpha1 is the v1alpha1 version of the API.
Package v1alpha1 is the v1alpha1 version of the API.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL