-
Notifications
You must be signed in to change notification settings - Fork 1
Update values.yaml to include comment about CAS db name #421
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
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: Eric Hofesmann <ehofesmann@gmail.com>
Important Review skippedReview was skipped due to path filters ⛔ Files ignored due to path filters (1)
CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including You can disable this status message by setting the ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
Intentionally redundant, yes. I don't expect anyone that is new to FiftyOne to read through a thousand of lines of this values.yaml or the table of hundreds of env vars without their eyes glazing over And since this is a variable that is more likely to need to be changed compared to many of the others, it makes sense to me to call it out here |
# Set the name of the Mongo database for CAS if not using the default `cas` | ||
# CAS_DATABASE_NAME: your-cas-name |
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.
This file is a quickstart (simple example) values file. This is already documented in the "real" values file helm/fiftyone-teams-app/values.yaml that also gets added to the helm/fiftyone-teams-app/README.md.
Yep. It's confusing.
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.
Def confusing, but still is adding this an issue?
We have similar callouts in that example as well:
fiftyone-teams-app-deploy/helm/values.yaml
Line 104 in 40accf0
# env: |
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.
It becomes a maintenance question. Which things are deemed important enough to make it to the example? It is likely already very out of date.
Please target to |
@ehofesmann retarget to v2.11.0, get review, and merge asap if you want this in v2.11.0 documentation |
Rationale
A customer didn't know that CAS had a separate DB or how to configure that name, this adds comment to values.yaml at at least call it out in one additional location
Checklist
This brings us closer to docker compose parity which calls it out in the .env:
fiftyone-teams-app-deploy/docker/internal-auth/env.template
Line 64 in 17c1182
Testing