-
Notifications
You must be signed in to change notification settings - Fork 23
Update CloudKitty docs to use OpenSearch #1832
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @assumptionsandg, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request updates the CloudKitty documentation to reflect the use of OpenSearch as the preferred storage backend. This change addresses a compatibility issue where the Elasticsearch backend is no longer compatible with OpenSearch as of a specific version, which was causing API errors. The documentation now guides users to configure CloudKitty with OpenSearch directly.
Highlights
- Documentation Update: Updated
doc/source/configuration/cloudkitty.rst
to change the recommended storage backend for CloudKitty from Elasticsearch to OpenSearch. - Backend Configuration: Modified the
cloudkitty_storage_backend
configuration example in the documentation fromelasticsearch
toopensearch
. - Compatibility Note Removal: Removed the note regarding a patched CloudKitty fork that allowed Elasticsearch V2 storage backend to work with OpenSearch, as OpenSearch is now the directly recommended backend.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command>
or @gemini-code-assist <command>
. Below is a summary of the supported commands.
Feature | Command | Description |
---|---|---|
Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/
folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request updates the CloudKitty documentation to use OpenSearch as the storage backend, which is necessary due to compatibility issues with the Elasticsearch backend. The changes correctly reflect this update by removing outdated information and modifying the configuration example. I have one minor suggestion to improve the consistency of the documentation.
cc7745c
to
330e860
Compare
The ElasticSearch backend is no longer compatible with OpenSearch as of 2025.1 Epoxy and results in an API error:
2025-08-12 13:45:32.187 37 ERROR cloudkitty cloudkitty.storage.v2.elasticsearch.exceptions.InvalidStatusCode: Expected 200 status code, got 400: {"error":"no handler found for uri [/cloudkitty/_mapping/_doc] and method [PUT]"}. Query was {"dynamic_templates": [{"strings_as_keywords": {"match_mapping_type": "string", "mapping": {"type": "keyword"}}}], "dynamic": false, "properties": {"start": {"type": "date"}, "end": {"type": "date"}, "type": {"type": "keyword"}, "unit": {"type": "keyword"}, "qty": {"type": "double"}, "price": {"type": "double"}, "groupby": {"dynamic": true, "type": "object"}, "metadata": {"dynamic": true, "type": "object"}}}