1# Copyright 2020 Google LLC
2#
3# Licensed under the Apache License, Version 2.0 (the "License");
4# you may not use this file except in compliance with the License.
5# You may obtain a copy of the License at
6#
7# http://www.apache.org/licenses/LICENSE-2.0
8#
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS,
11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
14
15apiVersion: apiextensions.k8s.io/v1
16kind: CustomResourceDefinition
17metadata:
18 annotations:
19 cnrm.cloud.google.com/version: 1.106.0
20 creationTimestamp: null
21 labels:
22 cnrm.cloud.google.com/managed-by-kcc: "true"
23 cnrm.cloud.google.com/stability-level: alpha
24 cnrm.cloud.google.com/system: "true"
25 cnrm.cloud.google.com/tf2crd: "true"
26 name: vertexaiindexes.vertexai.cnrm.cloud.google.com
27spec:
28 group: vertexai.cnrm.cloud.google.com
29 names:
30 categories:
31 - gcp
32 kind: VertexAIIndex
33 plural: vertexaiindexes
34 shortNames:
35 - gcpvertexaiindex
36 - gcpvertexaiindexes
37 singular: vertexaiindex
38 scope: Namespaced
39 versions:
40 - additionalPrinterColumns:
41 - jsonPath: .metadata.creationTimestamp
42 name: Age
43 type: date
44 - description: When 'True', the most recent reconcile of the resource succeeded
45 jsonPath: .status.conditions[?(@.type=='Ready')].status
46 name: Ready
47 type: string
48 - description: The reason for the value in 'Ready'
49 jsonPath: .status.conditions[?(@.type=='Ready')].reason
50 name: Status
51 type: string
52 - description: The last transition time for the value in 'Status'
53 jsonPath: .status.conditions[?(@.type=='Ready')].lastTransitionTime
54 name: Status Age
55 type: date
56 name: v1alpha1
57 schema:
58 openAPIV3Schema:
59 properties:
60 apiVersion:
61 description: 'apiVersion defines the versioned schema of this representation
62 of an object. Servers should convert recognized schemas to the latest
63 internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources'
64 type: string
65 kind:
66 description: 'kind is a string value representing the REST resource this
67 object represents. Servers may infer this from the endpoint the client
68 submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds'
69 type: string
70 metadata:
71 type: object
72 spec:
73 properties:
74 description:
75 description: The description of the Index.
76 type: string
77 displayName:
78 description: The display name of the Index. The name can be up to
79 128 characters long and can consist of any UTF-8 characters.
80 type: string
81 indexUpdateMethod:
82 description: |-
83 Immutable. The update method to use with this Index. The value must be the followings. If not set, BATCH_UPDATE will be used by default.
84 * BATCH_UPDATE: user can call indexes.patch with files on Cloud Storage of datapoints to update.
85 * STREAM_UPDATE: user can call indexes.upsertDatapoints/DeleteDatapoints to update the Index and the updates will be applied in corresponding DeployedIndexes in nearly real-time.
86 type: string
87 metadata:
88 description: An additional information about the Index.
89 properties:
90 config:
91 description: Immutable. The configuration of the Matching Engine
92 Index.
93 properties:
94 algorithmConfig:
95 description: The configuration with regard to the algorithms
96 used for efficient search.
97 properties:
98 bruteForceConfig:
99 description: |-
100 Configuration options for using brute force search, which simply implements the
101 standard linear search in the database for each query.
102 type: object
103 x-kubernetes-preserve-unknown-fields: true
104 treeAhConfig:
105 description: |-
106 Configuration options for using the tree-AH algorithm (Shallow tree + Asymmetric Hashing).
107 Please refer to this paper for more details: https://arxiv.org/abs/1908.10396.
108 properties:
109 leafNodeEmbeddingCount:
110 description: Number of embeddings on each leaf node.
111 The default value is 1000 if not set.
112 type: integer
113 leafNodesToSearchPercent:
114 description: |-
115 The default percentage of leaf nodes that any query may be searched. Must be in
116 range 1-100, inclusive. The default value is 10 (means 10%) if not set.
117 type: integer
118 type: object
119 type: object
120 approximateNeighborsCount:
121 description: |-
122 The default number of neighbors to find via approximate search before exact reordering is
123 performed. Exact reordering is a procedure where results returned by an
124 approximate search algorithm are reordered via a more expensive distance computation.
125 Required if tree-AH algorithm is used.
126 type: integer
127 dimensions:
128 description: The number of dimensions of the input vectors.
129 type: integer
130 distanceMeasureType:
131 description: |-
132 The distance measure used in nearest neighbor search. The value must be one of the followings:
133 * SQUARED_L2_DISTANCE: Euclidean (L_2) Distance
134 * L1_DISTANCE: Manhattan (L_1) Distance
135 * COSINE_DISTANCE: Cosine Distance. Defined as 1 - cosine similarity.
136 * DOT_PRODUCT_DISTANCE: Dot Product Distance. Defined as a negative of the dot product.
137 type: string
138 featureNormType:
139 description: |-
140 Type of normalization to be carried out on each vector. The value must be one of the followings:
141 * UNIT_L2_NORM: Unit L2 normalization type
142 * NONE: No normalization type is specified.
143 type: string
144 required:
145 - dimensions
146 type: object
147 contentsDeltaUri:
148 description: |-
149 Allows inserting, updating or deleting the contents of the Matching Engine Index.
150 The string must be a valid Cloud Storage directory path. If this
151 field is set when calling IndexService.UpdateIndex, then no other
152 Index field can be also updated as part of the same call.
153 The expected structure and format of the files this URI points to is
154 described at https://cloud.google.com/vertex-ai/docs/matching-engine/using-matching-engine#input-data-format.
155 type: string
156 isCompleteOverwrite:
157 description: |-
158 If this field is set together with contentsDeltaUri when calling IndexService.UpdateIndex,
159 then existing content of the Index will be replaced by the data from the contentsDeltaUri.
160 type: boolean
161 type: object
162 projectRef:
163 description: The project that this resource belongs to.
164 oneOf:
165 - not:
166 required:
167 - external
168 required:
169 - name
170 - not:
171 anyOf:
172 - required:
173 - name
174 - required:
175 - namespace
176 required:
177 - external
178 properties:
179 external:
180 description: 'Allowed value: The `name` field of a `Project` resource.'
181 type: string
182 name:
183 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
184 type: string
185 namespace:
186 description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
187 type: string
188 type: object
189 region:
190 description: Immutable. The region of the index. eg us-central1.
191 type: string
192 resourceID:
193 description: Immutable. Optional. The service-generated name of the
194 resource. Used for acquisition only. Leave unset to create a new
195 resource.
196 type: string
197 required:
198 - displayName
199 - projectRef
200 - region
201 type: object
202 status:
203 properties:
204 conditions:
205 description: Conditions represent the latest available observation
206 of the resource's current state.
207 items:
208 properties:
209 lastTransitionTime:
210 description: Last time the condition transitioned from one status
211 to another.
212 type: string
213 message:
214 description: Human-readable message indicating details about
215 last transition.
216 type: string
217 reason:
218 description: Unique, one-word, CamelCase reason for the condition's
219 last transition.
220 type: string
221 status:
222 description: Status is the status of the condition. Can be True,
223 False, Unknown.
224 type: string
225 type:
226 description: Type is the type of the condition.
227 type: string
228 type: object
229 type: array
230 createTime:
231 description: The timestamp of when the Index was created in RFC3339
232 UTC "Zulu" format, with nanosecond resolution and up to nine fractional
233 digits.
234 type: string
235 deployedIndexes:
236 description: The pointers to DeployedIndexes created from this Index.
237 An Index can be only deleted if all its DeployedIndexes had been
238 undeployed first.
239 items:
240 properties:
241 deployedIndexId:
242 description: The ID of the DeployedIndex in the above IndexEndpoint.
243 type: string
244 indexEndpoint:
245 description: A resource name of the IndexEndpoint.
246 type: string
247 type: object
248 type: array
249 etag:
250 description: Used to perform consistent read-modify-write updates.
251 type: string
252 indexStats:
253 description: Stats of the index resource.
254 items:
255 properties:
256 shardsCount:
257 description: The number of shards in the Index.
258 type: integer
259 vectorsCount:
260 description: The number of vectors in the Index.
261 type: string
262 type: object
263 type: array
264 metadataSchemaUri:
265 description: Points to a YAML file stored on Google Cloud Storage
266 describing additional information about the Index, that is specific
267 to it. Unset if the Index does not have any additional information.
268 type: string
269 name:
270 description: The resource name of the Index.
271 type: string
272 observedGeneration:
273 description: ObservedGeneration is the generation of the resource
274 that was most recently observed by the Config Connector controller.
275 If this is equal to metadata.generation, then that means that the
276 current reported status reflects the most recent desired state of
277 the resource.
278 type: integer
279 updateTime:
280 description: The timestamp of when the Index was last updated in RFC3339
281 UTC "Zulu" format, with nanosecond resolution and up to nine fractional
282 digits.
283 type: string
284 type: object
285 required:
286 - spec
287 type: object
288 served: true
289 storage: true
290 subresources:
291 status: {}
292status:
293 acceptedNames:
294 kind: ""
295 plural: ""
296 conditions: []
297 storedVersions: []
View as plain text