Coverage remained the same at 79.83% when pulling 04a5ac4 on dtantsur:deploy-steps into fec2b51 on gophercloud:master.

Build succeeded.

• gophercloud-unittest : SUCCESS in 4m 54s
• gophercloud-acceptance-test : SUCCESS in 2h 37m 24s
• gophercloud-acceptance-test-ironic : SUCCESS in 52m 38s

@dtantsur I took a stab at doing the code hunting requirement and came up with:

• https://github.com/openstack/ironic/blob/766d8f11b4101570829788ed11b2ab3fef85e3f8/ironic/conductor/steps.py#L234
• https://github.com/openstack/ironic/blob/766d8f11b4101570829788ed11b2ab3fef85e3f8/ironic/conductor/steps.py#L264
• https://github.com/openstack/ironic/blob/766d8f11b4101570829788ed11b2ab3fef85e3f8/ironic/conductor/steps.py#L600
• https://github.com/openstack/ironic/blob/766d8f11b4101570829788ed11b2ab3fef85e3f8/ironic/conductor/steps.py#L538-L554

If this is correct, please let me know if this is ready for review.

HI @jtopjian! Yeah, you're on the right track. This feature was added in https://opendev.org/openstack/ironic/commit/3138acc836c933aa179b9a92c14a226a8b903fe5, its API part starts in https://opendev.org/openstack/ironic/src/commit/6ae5bc4642c4619946a48512501b4ae37246f7ff/ironic/api/controllers/v1/node.py#L850 and progresses further ending up in the code you've found. Note that there is a related concept of deploy templates which makes code hunting somewhere more complicated. This change does not implement deploy templates, only the smaller API addition from the above mentioned commit.

Tested with the following code:

    client.Microversion = "1.69"

    updates := nodes.UpdateOpts {
        nodes.UpdateOperation {
            Op: nodes.AddOp,
            Path: "/instance_info/image_source",
            Value: "file:///httpboot/centos8.qcow2",
        },
    }

    _, err = nodes.Update(client, "testvm1", updates).Extract()
    if err != nil {
        panic(fmt.Sprintf("Cannot update: %s", err))
    }

    files := []struct {
        Path string `json:"path"`
        Content string `json:"content"`
    } {
        {
            Path: "/etc/motd",
            Content: "SGVsbG8gSXJvbmljIFdvcmxkIQo=",
        },
    }

    opts := nodes.ProvisionStateOpts {
        Target: nodes.TargetActive,
        DeploySteps: []nodes.DeployStep {
            nodes.DeployStep {
                Step: "inject_files",
                Interface: "deploy",
                Priority: 50,
                Args: map[string]interface{}{
                    "files": files,
                },
            },
        },
    }

    err = nodes.ChangeProvisionState(client, "testvm1", opts).ExtractErr()
    if err != nil {
        panic(fmt.Sprintf("Cannot provision: %s", err))
    }

(Note that I'm using a deploy step that has not merged yet)

@dtantsur Thanks! Those links helped. Notably:

https://opendev.org/openstack/ironic/src/commit/3138acc836c933aa179b9a92c14a226a8b903fe5/ironic/api/controllers/v1/utils.py#L125-L141

which defines the data model being added in this PR. I just needed to see something that showed the fields of the DeployStep struct are defined somewhere and DeployStep shouldn't be a generic map[string]interface.

It looks like the Interface field is an enum, with values defined here (sorry for linking to GitHub, I wasn't getting any results when using the "search" function in opendev).

If you wanted, you could create a custom string type called DeployStepInterface (or something similar). It would then look like:

type DeployStepInterface string

const (
  InterfaceDeploy DeployStepInterface = "deploy"
  ...
)

type DeployStep struct {
  Interface DeployStepInterface `json:"interface" required:"true"`
  ... 
}

    ....

    opts := nodes.ProvisionStateOpts {
        Target: nodes.TargetActive,
        DeploySteps: []nodes.DeployStep {
            nodes.DeployStep {
                Step: "inject_files",
                Interface: nodes.InterfaceDeploy,
                Priority: 50,
                Args: map[string]interface{}{
                    "files": files,
                },
            },
        },
    }

This is up to you, though. There are areas in Gophercloud that implement this and other areas that use a generic "string". If you prefer to use a string, let me know and I'll go ahead and merge this PR as-is.

It looks like the Interface field is an enum, with values defined here

Good call, I completely forgot that we limit the interfaces supported for deploy steps (I also forgot why we do that, but that's a different conversation). Will change.

@jtopjian updated and applied the same change to clean steps.

Build succeeded.

• gophercloud-unittest : SUCCESS in 4m 48s
• gophercloud-acceptance-test : SUCCESS in 2h 40m 24s
• gophercloud-acceptance-test-ironic : SUCCESS in 51m 19s