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

feat(api)!: initial integration of registry1 api flavor #920

Merged
merged 49 commits into from
Sep 3, 2024

Conversation

justinthelaw
Copy link
Contributor

@justinthelaw justinthelaw commented Aug 16, 2024

OVERVIEW

Adds the Registry1 flavor of the LeapfrogAI API to the developer workflow and increases Helm chart and Dockerfile standard (foreshadowing upcoming Helm and Dockerfile linting PR).

Once all other registry1 flavored images are published to IronBank, the e2e-registry1-weekly.yaml will need to have access to a uds-bundle.yaml that points to packages created using the registry1.dso.mil container registry. For now, as each component comes online, we can use the yq commands to temporarily modify each one within the workflow:

uds zarf tools yq -i '.packages[1] |= del(.repository)' uds-bundles/latest/cpu/uds-bundle.yaml
uds zarf tools yq -i '.packages[1] |= .ref = "registry1"' uds-bundles/latest/cpu/uds-bundle.yaml
uds zarf tools yq -i '.packages[1] |= .path = "../../../packages/api"' uds-bundles/latest/cpu/uds-bundle.yaml
uds zarf tools yq -i '.metadata.version = "registry1"' uds-bundles/latest/cpu/uds-bundle.yaml

BREAKING CHANGES

  • LeapfrogAI API internal cluster service subdomain, and zarf-connect name, is now leapfrogai-api instead of api, following the convention of using the Helm chart name for template helpers
  • LeapfrogAI API Zarf package now uses Zarf package template variable IMAGE_VERSION instead of LEAPFROGAI_IMAGE_VERSION, to align the build process with all other components/packages

CHANGES

  • Adds FLAVOR flag to the Makefile, defaulting to upstream
  • Adds registry1 Zarf package flavoring for the API
  • Refactors manifest structure to align with UDS Common and Core best practices
  • Slight optimizations to the LeapfrogAI API Dockerfile
  • Implements and uses helper functions for Helm chart templating
  • Adds documentation to mention and use the Registry1 flavor
  • Adds weekly test for registry1 flavored API (to be refactored later on)
  • Fixes UDS setup action usage and version, v0.14.0

@justinthelaw justinthelaw added dependencies Pull requests that update a dependency file api labels Aug 16, 2024
@justinthelaw justinthelaw linked an issue Aug 16, 2024 that may be closed by this pull request
Copy link

netlify bot commented Aug 16, 2024

Deploy Preview for leapfrogai-docs canceled.

Name Link
🔨 Latest commit 8a41f46
🔍 Latest deploy log https://app.netlify.com/sites/leapfrogai-docs/deploys/66d76f9217bc7c00083a4a24

@justinthelaw justinthelaw added the blocked 🛑 Something needs to happen before this issues is worked label Aug 16, 2024
@justinthelaw
Copy link
Contributor Author

Depends on documentation updates from #902, and then one more update on top of that documentation.

@justinthelaw justinthelaw marked this pull request as ready for review August 16, 2024 19:48
@justinthelaw justinthelaw requested a review from a team as a code owner August 16, 2024 19:48
@justinthelaw justinthelaw added the needs-docs PR Label - Docs required prior to merge label Aug 16, 2024
@justinthelaw justinthelaw marked this pull request as draft August 16, 2024 20:31
@justinthelaw justinthelaw marked this pull request as ready for review August 16, 2024 21:04
@justinthelaw justinthelaw removed the blocked 🛑 Something needs to happen before this issues is worked label Aug 20, 2024
@justinthelaw justinthelaw added needs-tests PR Label - New tests are required prior to merge and removed needs-docs PR Label - Docs required prior to merge labels Aug 20, 2024
@justinthelaw justinthelaw removed the needs-tests PR Label - New tests are required prior to merge label Aug 20, 2024
gphorvath
gphorvath previously approved these changes Sep 3, 2024
@justinthelaw
Copy link
Contributor Author

Pending @YrrepNoj approval too! Thanks @gphorvath and @CollectiveUnicorn

gphorvath
gphorvath previously approved these changes Sep 3, 2024
Copy link
Member

@YrrepNoj YrrepNoj left a comment

Choose a reason for hiding this comment

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

One small change request and one pondering on if we should consider this PR a 'breaking' change.

packages/api/chart/values.yaml Outdated Show resolved Hide resolved
packages/api/zarf.yaml Show resolved Hide resolved
@justinthelaw justinthelaw changed the title feat(api): initial integration of registry1 api flavor feat(api)!: initial integration of registry1 api flavor Sep 3, 2024
Copy link
Member

@YrrepNoj YrrepNoj left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks for the updates.

@justinthelaw justinthelaw merged commit a8e93fb into main Sep 3, 2024
31 checks passed
@justinthelaw justinthelaw deleted the 730-feat-leapfrogai-api-registry1-flavor branch September 3, 2024 20:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

feat: leapfrogai api registry1 flavor
4 participants