Skip to content
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

Documentation updates for fault domain and ADDITIONAL_ENV_FILE #1980

Merged
merged 3 commits into from
Apr 3, 2024

Conversation

gm42
Copy link
Contributor

@gm42 gm42 commented Mar 26, 2024

Description

Two changes:

  • remove non-working example about fictitious spec.zoneName
  • mention that spec.sidecarVariables must be declared in the FoundationDB k8s object

Type of change

  • Documentation

Discussion

None

Testing

None; the existing test does not cover the sidecarVariables aspect, but that's fine.

Documentation

This is a minor documentation update.

Follow-up

None needed, unless the examples need rework.

@gm42
Copy link
Contributor Author

gm42 commented Mar 26, 2024

Alternatively, I could leave the non-working example and put there a question mark ? in place of spec.zoneName

@gm42
Copy link
Contributor Author

gm42 commented Mar 26, 2024

I added another commit to document ADDITIONAL_ENV_FILE, as I thought it's useful and relevant for split images. The unified image also has a similar mechanism, so we might want to use that one when it's no more considered under development.

@gm42 gm42 changed the title Minor documentation updates for fault domain Documentation updates for fault domain and ADDITIONAL_ENV_FILE Mar 26, 2024
Copy link
Member

@brownleej brownleej left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@johscheuer johscheuer merged commit 1bf9aad into FoundationDB:main Apr 3, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants