docs: explicitly document MemorystoreInstance as Valkey resource#6806
docs: explicitly document MemorystoreInstance as Valkey resource#6806codebot-robot wants to merge 6 commits intoGoogleCloudPlatform:masterfrom
Conversation
The MemorystoreInstance CRD models the memorystore.googleapis.com Instance resource, which provides Memorystore for Valkey. This commit updates the godoc, CRD description, and sample to explicitly mention Valkey to help users discover this feature. Fixes GoogleCloudPlatform#5718
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
I have updated the PR to explicitly mention Memorystore for Valkey in the Spec and Status descriptions, and added a clarifying comment in the controller to improve discoverability. Everything has been regenerated and verified. |
| // +kubebuilder:printcolumn:name="Status Age",JSONPath=".status.conditions[?(@.type=='Ready')].lastTransitionTime",type="date",description="The last transition time for the value in 'Status'" | ||
|
|
||
| // MemorystoreInstance is the Schema for the MemorystoreInstance API | ||
| // MemorystoreInstance is the Schema for the MemorystoreInstance API. This resource manages Memorystore for Valkey instances. |
There was a problem hiding this comment.
Consider adding a link to the official Memorystore for Valkey documentation here to help users easily access the upstream resource details.
| var MemorystoreInstanceGVK = GroupVersion.WithKind("MemorystoreInstance") | ||
|
|
||
| // MemorystoreInstanceSpec defines the desired state of MemorystoreInstance | ||
| // MemorystoreInstanceSpec defines the desired state of a Memorystore for Valkey instance |
There was a problem hiding this comment.
To avoid any ambiguity, consider explicitly stating that this resource does not manage Redis instances (which are handled by RedisInstance).
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| # This sample creates a Memorystore for Valkey instance. |
There was a problem hiding this comment.
Consider updating the metadata.name to valkey-sample or memorystore-valkey-sample to make the resource type explicit in the sample's metadata as well.
| } | ||
|
|
||
| // NewInstanceModel returns a directbase.Model for the MemorystoreInstance resource, | ||
| // which manages Memorystore for Valkey instances. |
There was a problem hiding this comment.
Ensure that this comment update is reflected in any generated developer documentation for the controller, if applicable.
codebot-robot
left a comment
codebot-robot
left a comment
There was a problem hiding this comment.
I have addressed the review feedback:
- Added a link to the official Memorystore for Valkey documentation in the MemorystoreInstance godoc.
- Explicitly stated that MemorystoreInstance does not manage Redis instances (handled by RedisInstance).
- Updated the sample metadata name to 'memorystore-valkey-sample'.
- Verified that the controller comments already mention Valkey.
Everything has been regenerated and verified.
codebot-robot
left a comment
codebot-robot
left a comment
There was a problem hiding this comment.
I have addressed the remaining review feedback:
- Regenerated the resource reference documentation to ensure the sample name and Spec description updates are reflected in the generated markdown.
- Verified that the controller comments already mention Valkey and are consistent with the other documentation.
Everything has been updated, regenerated, and pushed.
--- INVESTIGATION REPORT ---
|
2 participants
The MemorystoreInstance CRD models the
memorystore.googleapis.comInstance resource, which provides Memorystore for Valkey.This PR updates the godoc, CRD description, and sample to explicitly mention Valkey to help users discover this feature.
This PR was generated by the gemini-3.1-pro-preview model.
Fixes #5718