Add support for Ironic baremetal API

There is currently no support for Ironic baremetal API in gophercloud. I'm working on it, and will have a PR open shortly for Nodes to get some early feedback, and will then continue on to the rest of the resources.

Categorized by the groupings under https://developer.openstack.org/api-ref/baremetal/

API

~~API Versions~~ Baremetal API: Return versions supported by the API #1577

Clients

~~Keystone~~ Baremetal v1 API: Nodes #1431
~~Noauth~~ Baremetal API: noauth support #1449
~~HTTP~~ Basic Support http_basic auth_strategy for Ironic Inspector #1986 (inspector) and Support http_basic auth_strategy for Ironic #1983 ironic)

Nodes

Basic CRUD

~~Nodes: List~~ Baremetal v1 API: Nodes #1431
~~Nodes: Get~~ Baremetal v1 API: Nodes #1431
~~Nodes: Create~~ Baremetal v1 API: Nodes #1431
~~Nodes: Update~~ Baremetal v1 API: Nodes #1431
~~Nodes: Delete~~ Baremetal v1 API: Nodes #1431

Node Management

~~Nodes: Validation~~ Baremetal V1 API: Node management #1450
~~Nodes: Boot Devices~~ Baremetal V1 API: Node management #1450
~~Nodes: Non-masking interrupts~~ Baremetal V1 API: Node management #1450
~~Nodes: Provision State~~ Baremetal API v1: Node provision state #1452
~~Nodes: Maintenance~~ baremetal: add API to set maintenance and maintenance reason #2384
~~Nodes: Power State~~ Baremetal API v1: Node Power State #1479
~~Nodes: RAID Config~~ Baremetal API V1: Support set RAID config #1559
Nodes: Console

Node Vendor Passthru

Node Vendor Passthru: List
Node Vendor Passthru: Call

Node Traits

Virtual Interfaces

~~VIF: List for a Node~~ Added support for VIF's in Baremetal #3311
~~VIF: Attach to a Node~~ Added support for VIF's in Baremetal #3311
~~VIF: Detach from a Node~~ Added support for VIF's in Baremetal #3311

Portgroups

~~Portgroups: List~~ Added support for baremetal portgroups #3290
~~Portgroups: Get~~ Added support for baremetal portgroups #3290
~~Portgroups: Create~~ Added support for baremetal portgroups #3290
~~Portgroups: Update~~ Added support for baremetal portgroups #3290
~~Portgroups: Delete~~ Added support for baremetal portgroups #3290

Ports

~~Ports: List~~ Baremetal V1 API Ports #1453
~~Ports: Get~~ Baremetal V1 API Ports #1453
~~Ports: Create~~ Baremetal V1 API Ports #1453
~~Ports: Update~~ Baremetal V1 API Ports #1453
~~Ports: Delete~~ Baremetal V1 API Ports #1453

Volumes

Volume Connector

Volume Targets

Drivers

~~Drivers: List Baremetal V1 API Drivers #1461~~
~~Drivers: Get Baremetal V1 API Drivers #1461~~
~~Drivers: Show Properties~~ Baremetal V1 API Drivers #1461
~~Drivers: Show disk properties~~ Baremetal V1 API Drivers #1461

Drivers vendor passthru

Drivers vendor passthru: List
Drivers vendor passthru: Call

Conductors

~~Conductors: List~~ Add conductor API to Baremetal V1 #2722
~~Conductor: Get~~ Add conductor API to Baremetal V1 #2722

Allocation

~~Allocation: Create~~ Baremetal API V1: Allocations #1528
~~Allocation: List~~ Baremetal API V1: Allocations #1528
~~Allocation: Get~~ Baremetal API V1: Allocations #1528
~~Allocation: Delete~~ Baremetal API V1: Allocations #1528

Allocation: Node

Node Allocation: Get
Node Allocation: Delete

Chassis

One minor note: The chassis functionality in the OpenStack Baremetal API is essentially unused and could likely be disregarded.

Good job!! I love u guys. haha.
Thanks!

Would be nice to throw the newly introduced Conductors and Allocations on the list. On the other hand, as Julia mentioned, Chassis are pretty useless.

@dtantsur

Thanks @dtantsur, updated the list to include those. Is Chassis worth including at all for anyone or should I just remove it entirely from the list?

I would make it absolutely lowest priority. Literally the last thing to get done (and only for completeness).

@stbenjam

@stbenjam One thing I just noticed is that Ports created_at and updated_at are set to string. They should be time.Time:

https://github.com/gophercloud/gophercloud/blob/master/openstack/baremetal/v1/ports/results.go#L61-L66

If you run into JSON decoding issues with the time, then you'll need to implement a custom UnmarshalJSON method. This is quite common because the suite of OpenStack projects use so many different time formats. For example:

gophercloud/openstack/blockstorage/v3/volumes/results.go

Line 13 in 19abc56

AttachedAt time.Time `json:"-"`

gophercloud/openstack/blockstorage/v3/volumes/results.go

Lines 23 to 38 in 19abc56

    
           func (r *Attachment) UnmarshalJSON(b []byte) error { 
        
           	type tmp Attachment 
        
           	var s struct { 
        
           		tmp 
        
           		AttachedAt gophercloud.JSONRFC3339MilliNoZ `json:"attached_at"` 
        
           	} 
        
           	err := json.Unmarshal(b, &s) 
        
           	if err != nil { 
        
           		return err 
        
           	} 
        
           	*r = Attachment(s.tmp) 
        
           	r.AttachedAt = time.Time(s.AttachedAt) 
        
           	return err 
        
           }

gophercloud/openstack/blockstorage/v3/volumes/results.go

Line 27 in 19abc56

AttachedAt gophercloud.JSONRFC3339MilliNoZ `json:"attached_at"`

gophercloud/results.go

Lines 296 to 312 in cbd1d4b

    
           type JSONRFC3339MilliNoZ time.Time 
        
           func (jt *JSONRFC3339MilliNoZ) UnmarshalJSON(data []byte) error { 
        
           	var s string 
        
           	if err := json.Unmarshal(data, &s); err != nil { 
        
           		return err 
        
           	} 
        
           	if s == "" { 
        
           		return nil 
        
           	} 
        
           	t, err := time.Parse(RFC3339MilliNoZ, s) 
        
           	if err != nil { 
        
           		return err 
        
           	} 
        
           	*jt = JSONRFC3339MilliNoZ(t) 
        
           	return nil 
        
           }

results.go already has a wide array of time formats. It's doubtful you'll need to define a new one.

Let me know if you need any help with this.

@iurygregory

@iurygregory ^ FYI, if you have time to look

@stbenjam

@stbenjam going to look

@jtopjian

@jtopjian according to the Ironic API docs they we handle as string see https://developer.openstack.org/api-ref/baremetal/?expanded=#ports-ports (Create Port Response, List Detailed Ports Response, Show Port Details Response, Update a Port Response)

So its still necessary to change?

I think so. You’ll still interact with the API using strings but it should be marshalled/unmarshalled as a native time type in go.

@stbenjam

@stbenjam is correct. API references and JSON samples will always have dates as strings because JSON doesn't have a native "date" type. Converting them to a real date-type in Go will allow code to use date-specific methods/actions.

There are lots examples throughout Gophercloud on how to handle this (just search for UnmarshalJSON), but please let me know if you need help - I don't mean for this to cause a large amount of time.

@iurygregory

@iurygregory would you be able to check the TODO items in the bug description and see what's actually left to do (and maybe prioritize it?).

Thanks

@EmilienM

@EmilienM @iurygregory is on PTO this month, so I wouldn't expect a reply before sometime in January.

(...) so I wouldn't expect a reply before sometime in January.

Thanks. This is not urgent at all! Trying to make sure we keep this issue updated and at some point we close it.

Maintenance API: #2384

Hey Folks,

I recently(ish) contributed #3228, and am now looking to contribute more to baremetal. I will read everything up to now and make my own judgement on what to tackle next, but if anyone has features they are interested in being covered first, let me know.

There are also some updates to this list. If I can be given permissions to edit the above post I am happy to do all those updates.
#2722 (Conductors is completed)

Portgroups seems like a good start from there?

Cheers :)

@Sharpz7

@Sharpz7 thanks! It's worth checking which features of the list above are actually implemented or not: I think it's outdated. Of all items marked as not done, I think the port groups and the VIF API are the most important, followed by vendor passthru (but I'm quite sure we already have at least some passthru support) and the rest of the allocation API.

Conductors API seems to have been implemented by #2722 (but please double-check it for completeness).

@dtantsur

@dtantsur you responded too quickly! I was just editing my comment since spotting the conductors change. Thank you though, I agree with you and I think that priority list is good :)

FYI, I've updated the list with completed work. Let me know if I missed anything.

I don't think there is much left now. Maybe volumes?

@Sharpz7

@Sharpz7 do we have runbooks?

@dtantsur

@dtantsur no I do not think so, I will add that to do. @mandre would you be against me creating a new issue so I can take ownership of maintaining the EPIC?

Okay... I think this issue is nearly entirely covered.

Navigation Menu

Repository navigation

Add support for Ironic baremetal API #1429

API

Clients

Nodes

Basic CRUD

Node Management

Node Vendor Passthru

Node Traits

Virtual Interfaces

Portgroups

Ports

Volumes

Volume Connector

Volume Targets

Drivers

Drivers vendor passthru

Conductors

Allocation

Allocation: Node

Chassis

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

	func (r *Attachment) UnmarshalJSON(b []byte) error {
	type tmp Attachment
	var s struct {
	tmp
	AttachedAt gophercloud.JSONRFC3339MilliNoZ `json:"attached_at"`
	}
	err := json.Unmarshal(b, &s)
	if err != nil {
	return err
	}
	*r = Attachment(s.tmp)

	r.AttachedAt = time.Time(s.AttachedAt)

	return err
	}

	type JSONRFC3339MilliNoZ time.Time

	func (jt *JSONRFC3339MilliNoZ) UnmarshalJSON(data []byte) error {
	var s string
	if err := json.Unmarshal(data, &s); err != nil {
	return err
	}
	if s == "" {
	return nil
	}
	t, err := time.Parse(RFC3339MilliNoZ, s)
	if err != nil {
	return err
	}
	*jt = JSONRFC3339MilliNoZ(t)
	return nil
	}

Add support for Ironic baremetal API #1429

Description

API

Clients

Nodes

Basic CRUD

Node Management

Node Vendor Passthru

Node Traits

Virtual Interfaces

Portgroups

Ports

Volumes

Volume Connector

Volume Targets

Drivers

Drivers vendor passthru

Conductors

Allocation

Allocation: Node

Chassis

Activity

juliakreger commented on Feb 15, 2019

joy717 commented on Feb 25, 2019

dtantsur commented on Feb 25, 2019

stbenjam commented on Feb 26, 2019

dtantsur commented on Feb 28, 2019

jtopjian commented on Mar 12, 2019

stbenjam commented on Mar 13, 2019

iurygregory commented on Mar 13, 2019

iurygregory commented on Mar 13, 2019

stbenjam commented on Mar 13, 2019

jtopjian commented on Mar 13, 2019

EmilienM commented on Dec 15, 2021

juliakreger commented on Dec 15, 2021

EmilienM commented on Dec 15, 2021

dtantsur commented on Apr 20, 2022

Sharpz7 commented on Dec 31, 2024

dtantsur commented on Dec 31, 2024

Sharpz7 commented on Dec 31, 2024

mandre commented on Mar 20, 2025

Sharpz7 commented on Jun 1, 2026

dtantsur commented on Jun 1, 2026

Sharpz7 commented on Jun 1, 2026

Sharpz7 commented on Aug 11, 2026

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions