docs: add COSI resource operations in API usage examples#2808
Open
utkuozdemir wants to merge 1 commit intosiderolabs:mainfrom
Open
docs: add COSI resource operations in API usage examples#2808utkuozdemir wants to merge 1 commit intosiderolabs:mainfrom
utkuozdemir wants to merge 1 commit intosiderolabs:mainfrom
Conversation
Show how COSI resources should be created, updated and destroyed. Closes siderolabs#2804. Signed-off-by: Utku Ozdemir <utku.ozdemir@siderolabs.com>
Unix4ever
reviewed
May 7, 2026
| st := c.Omni().State() | ||
|
|
||
| // List all machine statuses. | ||
| machines, err := safe.StateList[*omni.MachineStatus](ctx, st, omni.NewMachineStatus("").Metadata()) |
Member
There was a problem hiding this comment.
As we touch this code we can update it with newer versions of the method:
Suggested change
| machines, err := safe.StateList[*omni.MachineStatus](ctx, st, omni.NewMachineStatus("").Metadata()) | |
| machines, err := safe.ReaderListAll[*omni.MachineStatus](ctx, st) |
Unix4ever
approved these changes
May 7, 2026
There was a problem hiding this comment.
Pull request overview
This PR updates the Go client usage example to better document how Omni uses COSI for resource management, and adds an end-to-end example of creating, updating, and destroying a user-managed COSI resource (MachineClass).
Changes:
- Improves wording/structure of the existing Omni/Talos API usage example.
- Adds a COSI state resource lifecycle example (create/update/teardown+destroy) using
MachineClass. - Minor naming cleanups (
client→c,template→tmpl) for readability.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+43
to
46
| // Create a new client. | ||
| c, err := client.New("https://<account>.omni.siderolabs.io:443", client.WithServiceAccount( | ||
| "base64encodedkey", // From the generated service account. | ||
| )) |
| // Talking to Omni specific APIs: getting talosconfig. | ||
| _, err = client.Management().Talosconfig(ctx) | ||
| // Get the talosconfig for the cluster. | ||
| _, err = c.Management().Talosconfig(ctx) |
| machineClass.Metadata().Labels().Set("my-label", "my-value") | ||
|
|
||
| machineClass.TypedSpec().Value.MatchLabels = []string{ | ||
| "omni.sidero.dev/arch = amd64, omni.sidero.dev/cpus > 2", // amd64 machines with more than 2 CPUs |
Member
Author
There was a problem hiding this comment.
good one. this means probably the label in https://github.com/siderolabs/docs/blob/main/public/omni/omni-cluster-setup/create-a-machine-class.mdx is also incorrect.
Comment on lines
51
to
54
| defer func() { | ||
| if e := client.Close(); e != nil { | ||
| if e := c.Close(); e != nil { | ||
| log.Printf("failed to close client %s", e) | ||
| } |
Comment on lines
+146
to
+148
| if err = st.Create(ctx, machineClass); err != nil { | ||
| log.Panicf("failed to create machine class %s", err) | ||
| } |
Comment on lines
+156
to
+158
| if err != nil { | ||
| log.Panicf("failed to update machine class %s", err) | ||
| } |
Comment on lines
+170
to
+172
| if err = st.TeardownAndDestroy(ctx, machineClass.Metadata()); err != nil { | ||
| log.Panicf("failed to destroy machine class %s", err) | ||
| } |
smira
reviewed
May 8, 2026
|
|
||
| // Setup versions information. You can embed that into `go build` too. | ||
| // Setup version information. You can embed this into the binary via `go build -ldflags`. | ||
| version.Name = "omni" |
Member
There was a problem hiding this comment.
don't we generate version via abbrev_tag?
smira
approved these changes
May 8, 2026
Member
smira
left a comment
smira
left a comment
There was a problem hiding this comment.
I would probably add some Watch example (or WatchKind)? with proper context cancelation, etc.?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Show how COSI resources should be created, updated and destroyed.
Closes #2804.