Feature/upgrade fabrica 4 4 by alexlovelltroy · Pull Request #13 · OpenCHAMI/boot-service

alexlovelltroy · 2026-05-11T13:04:05Z

Description

This pull request introduces several enhancements to the OpenAPI specification generation, adds support for PATCH and status subresource operations for key resources, and improves the code generation workflow. The most important changes are summarized below.

OpenAPI Spec Generation Enhancements

Added PATCH and status subresource operations for BMC, BootConfiguration, and Node resources, including new endpoints for partial updates and status-only updates. This brings the API closer to Kubernetes-style resource management and improves client flexibility. [1] [2] [3] [4] [5] [6]
Introduced a reusable patchRequestBody helper function to standardize PATCH request body schemas across resources.
Registered new OpenAPI schemas for status subresources (BMCStatus, BootConfigurationStatus, NodeStatus) to support the new status endpoints. [1] [2] [3]
Added a /health endpoint to the OpenAPI spec for basic service health checks.

Build and Code Generation Workflow

Updated the code generation workflow: replaced the manual git diff check with a make generate-check target for improved reliability and maintainability in .github/workflows/codegen-check.yaml.
Enhanced the Makefile to support a --force flag for local fabrica usage, ensuring consistent code generation behavior in local and CI environments. [1] [2]

Dependency Updates

Updated go.mod to use Go version 1.26.3 and upgraded github.com/openchami/fabrica to v0.4.4 for improved features and compatibility.

Checklist

My code follows the style guidelines of this project
I have added/updated comments where needed
I have added tests that prove my fix is effective or my feature works
I have run make test (or equivalent) locally and all tests pass
DCO Sign-off: All commits are signed off (git commit -s) with my real name and email
REUSE Compliance:
- Each new/modified source file has SPDX copyright and license headers
- Any non-commentable files include a <filename>.license sidecar
- All referenced licenses are present in the LICENSES/ directory

Type of Change

Bug fix
New feature
Breaking change
Documentation update

For more info, see Contributing Guidelines.

…ecks Signed-off-by: Alex Lovell-Troy <alex@lovelltroy.org>

…ation, and Node resources Signed-off-by: Alex Lovell-Troy <alex@lovelltroy.org>

Addresses Issue Building local docker containers with make docker-build is broken Fixes #8 Signed-off-by: Alex Lovell-Troy <alex@lovelltroy.org>

…on logic for BMC, BootConfiguration, and Node handlers Signed-off-by: Alex Lovell-Troy <alex@lovelltroy.org>

…n and /docs endpoints Signed-off-by: Alex Lovell-Troy <alex@lovelltroy.org>

… health command Signed-off-by: Alex Lovell-Troy <alex@lovelltroy.org>

…pecification Signed-off-by: Alex Lovell-Troy <alex@lovelltroy.org>

- Revised the PROFILES.md documentation to clarify boot profile behaviors, including the distinction between requested profiles and the default profile. - Updated examples for creating boot configurations and outlined the selection algorithm for boot scripts. - Incremented the version of the 'fabrica' dependency from v0.4.4 to v0.4.5 in go.mod and updated the corresponding entries in go.sum. Signed-off-by: Alex Lovell-Troy <alovelltroy@lanl.gov>

Copilot

Pull request overview

Upgrades the Fabrica-generated Boot Service surfaces and supporting workflows/docs, adding Kubernetes-style PATCH and /status subresource operations, plus documenting and exposing service endpoints like /health, /openapi.json, and /docs.

Changes:

Regenerates server/client/OpenAPI outputs to add PATCH and {uid}/status operations for BMC, BootConfiguration, and Node, plus OpenAPI entries for /health, /openapi.json, and /docs.
Updates build/codegen workflow (make generate-check, Makefile local Fabrica support, Docker build args).
Refreshes repository docs/config examples and adds an initial CHANGELOG.md.

Reviewed changes

Copilot reviewed 12 out of 20 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
README.md	Updates repo overview, runtime behavior notes, and developer workflow docs.
pkg/client/client_generated.go	Adds client health support and regenerates client outputs.
Makefile	Adds Docker Go version derivation, local Fabrica `--force`, and improves docker-build args.
go.mod	Bumps Go version and upgrades Fabrica dependency.
go.sum	Updates dependency checksums for the Fabrica upgrade.
docs/PROFILES.md	Rewrites profile docs to reflect current controller vs legacy endpoint behavior.
docs/CONFIGURATION.md	Aligns configuration docs with keys actually consumed by `cmd/server/main.go`.
docs/AUTHENTICATION.md	Clarifies package-level auth vs current server runtime auth wiring.
docs/AUTHENTICATION_TESTING.md	Updates auth testing docs to match current `pkg/auth` test helpers and scope.
docs/API.md	Adds concise API surface reference (public/modern/legacy/client).
config.example.yaml	Aligns example config to runtime-parsed keys and current behavior notes.
cmd/server/openapi_generated.go	Extends generated OpenAPI spec with PATCH/status operations and service endpoints.
cmd/server/node_handlers_generated.go	Regenerates Node handlers with PATCH/status and validation hooks.
cmd/server/bootconfiguration_handlers_generated.go	Regenerates BootConfiguration handlers with PATCH/status and validation hooks.
cmd/server/bmc_handlers_generated.go	Regenerates BMC handlers with PATCH/status and validation hooks.
cmd/client/main.go	Adds `client health` command and regenerates CLI.
CHANGELOG.md	Introduces changelog with unreleased changes summary.
.github/workflows/golangci-lint.yaml	Minor whitespace cleanup.
.github/workflows/codegen-check.yaml	Switches codegen drift verification to `make generate-check`.
.github/copilot-instructions.md	Updates contributor instructions to match current runtime/codegen behavior.

Files not reviewed (6)

cmd/client/main.go: Language not supported
cmd/server/bmc_handlers_generated.go: Language not supported
cmd/server/bootconfiguration_handlers_generated.go: Language not supported
cmd/server/node_handlers_generated.go: Language not supported
cmd/server/openapi_generated.go: Language not supported
pkg/client/client_generated.go: Language not supported

synackd · 2026-05-13T15:25:08Z

+	patchSchema := &openapi3.SchemaRef{Value: openapi3.NewObjectSchema()}
+	return &openapi3.RequestBodyRef{
+		Value: &openapi3.RequestBody{
+			Required: true,
+			Content: openapi3.Content{
+				"application/merge-patch+json": &openapi3.MediaType{Schema: patchSchema},
+				"application/json-patch+json":  &openapi3.MediaType{Schema: patchSchema},
+				"application/shorthand-patch":  &openapi3.MediaType{Schema: patchSchema},
+				"application/json":             &openapi3.MediaType{Schema: patchSchema},


This looks like something that needs to be addressed in Fabrica. Shall we open an issue?

synackd

Initial review. My comments are mainly focused on documentation since that is what changed the most.

Not in the scope of this PR, but I noticed that the term "HSM" is being used instead of "SMD". Is this what we're using across services?

…TICATION and PROFILES guides Signed-off-by: Alex Lovell-Troy <alovelltroy@lanl.gov>

Signed-off-by: Alex Lovell-Troy <alovelltroy@lanl.gov>

synackd

LGTM. There's one Copilot review comment that remains open, but seems to be a Fabrica issue.

alexlovelltroy and others added 8 commits May 11, 2026 07:44

chore: update Fabrica version to v0.4.4 and modify code generation ch…

f4b5c51

…ecks Signed-off-by: Alex Lovell-Troy <alex@lovelltroy.org>

feat: add /health endpoint and patch operations for BMC, BootConfigur…

7cd06e4

…ation, and Node resources Signed-off-by: Alex Lovell-Troy <alex@lovelltroy.org>

feat: enhance Docker build process with dynamic build arguments

1aa5a55

Addresses Issue Building local docker containers with make docker-build is broken Fixes #8 Signed-off-by: Alex Lovell-Troy <alex@lovelltroy.org>

feat: update generated code to Fabrica v0.4.4 and add custom validati…

fedac2b

…on logic for BMC, BootConfiguration, and Node handlers Signed-off-by: Alex Lovell-Troy <alex@lovelltroy.org>

feat: update OpenAPI specification generation to include /openapi.jso…

5933841

…n and /docs endpoints Signed-off-by: Alex Lovell-Troy <alex@lovelltroy.org>

feat: update generated code header to include Fabrica version and add…

7957be2

… health command Signed-off-by: Alex Lovell-Troy <alex@lovelltroy.org>

feat: update health endpoint response schema and example in OpenAPI s…

8b23c05

…pecification Signed-off-by: Alex Lovell-Troy <alex@lovelltroy.org>

alexlovelltroy requested review from Copilot, synackd and travisbcotton May 12, 2026 21:58

Copilot started reviewing on behalf of alexlovelltroy May 12, 2026 21:59 View session

Copilot AI reviewed May 12, 2026

View reviewed changes

synackd requested changes May 12, 2026

View reviewed changes

alexlovelltroy added 2 commits May 13, 2026 06:32

feat: update configuration documentation and examples, enhance AUTHEN…

14ad8a2

…TICATION and PROFILES guides Signed-off-by: Alex Lovell-Troy <alovelltroy@lanl.gov>

Regenerated all files with fabrica 0.4.5

10a0a0c

Signed-off-by: Alex Lovell-Troy <alovelltroy@lanl.gov>

synackd approved these changes May 13, 2026

View reviewed changes

alexlovelltroy merged commit 3a65e32 into main May 13, 2026
6 checks passed

synackd deleted the feature/upgrade-fabrica-4-4 branch May 14, 2026 15:04

synackd mentioned this pull request May 14, 2026

[Feature]: Add health/version endpoints #5

Closed

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/upgrade fabrica 4 4#13

Feature/upgrade fabrica 4 4#13
alexlovelltroy merged 10 commits into
mainfrom
feature/upgrade-fabrica-4-4

alexlovelltroy commented May 11, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

synackd May 13, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

synackd left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

synackd left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

alexlovelltroy commented May 11, 2026

Description

OpenAPI Spec Generation Enhancements

Build and Code Generation Workflow

Dependency Updates

Checklist

Type of Change

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

synackd May 13, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

synackd left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

synackd left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants