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

Add container orchestrator environment variable #43

Merged
merged 2 commits into from
Sep 27, 2024

Conversation

bd-g
Copy link
Collaborator

@bd-g bd-g commented Sep 27, 2024

Proposed changes

Add an environment variable to container launch templates to enable more detailed support for self-hosted deployments.

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update or tests (if none of the other choices apply)

Checklist

  • I have read the CONTRIBUTING doc
  • I have tested my changes in my local self-hosted environment
  • I have added necessary documentation (if appropriate)

@bd-g bd-g requested a review from a team as a code owner September 27, 2024 16:29
@bd-g bd-g force-pushed the brent-george/container-orchestrator-id branch from ea97f10 to 7c8691b Compare September 27, 2024 16:31
@bd-g bd-g changed the title add container orchestrator environment variable Add container orchestrator environment variable Sep 27, 2024
@@ -9,6 +9,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
### Added

- Automatic model management on AWS now supports model removal. See the `engine.modelManager.models.remove` section in the `values.yaml` file for details.
- Container orchestrator environment variable added to improve support.
Copy link
Contributor

Choose a reason for hiding this comment

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

Worth calling out the 3 supported values, since it's a small finite set and we could potentially add/change it in the future?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

It's not necessarily intended to be change or configured - I don't think it needs to be called out.

Also, the cardinality will increase, as the Helm value will change for each version (but the prefix will stay the same).

@@ -14,6 +14,7 @@ services:
# Make sure you `export` your self-hosted API key secret in your local environment
environment:
DEEPGRAM_API_KEY: "${DEEPGRAM_API_KEY}"
DEEPGRAM_DEPLOYMENT_ORCHESTRATOR: "docker-compose"
Copy link
Contributor

Choose a reason for hiding this comment

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

Any way to make this a static variable or enum of some type, or is hard-coding the same string multiple times the best option on these?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I wasn't previously aware, which is why there is duplication in other places, but your question prompted me to go looking, and I found Docker Compose extension fields. Let me see if they're also compatible with Podman.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The Compose protocol is fairly limited. I was able to reduce the duplication of the API key and the common orchestrator variable. I tried to do the same for the release tag on each image, but I can edit only a subsection of a field.

It's also not supported by podman-compose right now, so can only use this for the Docker Compose templates.

@bd-g bd-g merged commit fde5906 into main Sep 27, 2024
1 check passed
@bd-g bd-g deleted the brent-george/container-orchestrator-id branch September 27, 2024 19:16
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.

2 participants