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

docs: note on adding services to Bento #300

Merged
merged 7 commits into from
Jan 14, 2025
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: adding services - bentoctl notes
  • Loading branch information
davidlougheed committed Jan 9, 2025
commit cd169563eeedd1e2b1e0bec4ecdd8385e4adbb7c
18 changes: 14 additions & 4 deletions docs/adding-services.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,20 @@ externally accessible.

### Required `bentoctl` changes

TODO

* If new certificates are needed, add new entries to the `init_self_signed_certs` function (for development purposes)
in `py_bentoctl/other_helpers.py`.
Inside the `py_bentoctl` Python module:

* If the service is locked behind a feature flag, add the feature (as an `BentoOptionalFeature` instance) to
`config.py`, modeling it after other definitions.
* Add the service image environment variables to the `service_image_vars` variable in `services.py`.
* If the service is not a Bento service (or does not have the `bento` user in the Docker image), add the service to the
`BENTO_USER_EXCLUDED_SERVICES` variable.
* In `other_helpers.py`:
* If the service has a data directory that needs to be initialized, add an entry to the `data_dir_vars` variable
in the `init_dirs(...)` function containing the name of the environment variable which points to the data volume
directory.
* Add any entry with the name of the environment variable storing the name of the Docker network to the `networks`
variable in the `init_docker(...)` function.
* If new certificates are needed, add new entries to the `init_self_signed_certs` function (for development purposes).

### Documentation changes

Expand Down