[sapi] 1.93.0 regression. Unable to update meta-data to a service instance being async provisionned

[gberche-orange]

Issue

As a cf user

• in order to attach metadata to a service instance that takes hours to create
• I need the PATCH /v3/service_instances/guid endpoint to accept update to metadata although the service instance is still in progress

This behavior regressed with capi 1.93.0

Context

This scenario also affects tooling that provision service instances and need to attach metadata to them (this issue was detected through orange-cloudfoundry/osb-cmdb#65 )

Steps to Reproduce

cf cs service async-plan myservice
guid=$(cf s myservice --guid)
CF_TRACE=true cf curl -X PATH /v3/service_instances/${guid} -d '{
    "metadata": {
      "annotations": {
        "note": "detailed information"
      },
      "labels": {
        "key": "value"
      }
    }
  }'

Expected result

HTTP/1.1 200 OK

Current result

starting with 1.93.0 (and likely related support for async brokers at https://www.pivotaltracker.com/n/projects/2105761/stories/171649250 ) this fails with

CF-AsyncServiceInstanceOperationInProgress(60016): An operation for service instance f0a8f886-76a2-49d8-80eb-5f7230e5f8fe is in progress.

Possible Fix

Allow metadata-only update to a service instance (or service binding) despite the status "in progress"

[cf-gitbot]

We have created an issue in Pivotal Tracker to manage this:

https://www.pivotaltracker.com/story/show/174775179

The labels on this github issue will be updated when the story is started.

[FelisiaM]

Hi @gberche-orange

This is raised previously here #1781
Does the proposed solution there help your usecase?

Felisia

[gberche-orange]

thanks @FelisiaM for your prompt response! Yes, embedding the metadata in the V3 service instance creation will address my use case. Sorry for creating this issue on wrong repo, and missing the existing issue on cc_ng.

[gberche-orange]

@FelisiaM what would be the CF CLI UX / workflow to attach metadata to a service instance being provisionned ?

I understand the CF7 create-service-instance does not support specifying metadata as arguments, and that rather a distinct cf7 set-label CLI command is required instead.

As a result, users won't be able to attach metadata to long async service instances until their provisionning completion.

[cf-gitbot]

We have created an issue in Pivotal Tracker to manage this:

https://www.pivotaltracker.com/story/show/174776441

The labels on this github issue will be updated when the story is started.

[gberche-orange]

@FelisiaM

In response to #1781 (comment)

We think that it might be risky to allow several operations to occur on the same SI while we are not sure that it has completed creation.

Have you considered allowing only updates of metadata while there is an operation in progress ?

What risks would there be of allowing metadata updates while an operation is in progress ?

Potential benefits of this approach:

• preserves the CF CLI UX for set-label on updating service instance
• avoid introducing breaking changes to existing CF corporate users relying on metadata endpoint that when GA a while ago https://docs.cloudfoundry.org/adminguide/metadata.html#add (close to pivotal PAS 2.5 or 2.6)

The previously suggested usage of PUT V3/service_instances/guid with service-instance and metadata is hard to apply by the community because:

• this endpoint is still marked as experimental
• feedback from usage of this endpoint by CF7 has not yet been gathered
• client SDKs are not ready, and require significant effort and time to deal with V3 style (e.g. job redirects)

[cf-gitbot]

We have created an issue in Pivotal Tracker to manage this:

https://www.pivotaltracker.com/story/show/174825693

The labels on this github issue will be updated when the story is started.

[kirederik]

Thanks @gberche-orange!

This issue is now fixed and will be included in the next capi-release. We'll close the issue once it's released

[gberche-orange]

Thanks a lot @kirederik for the prompt fix, I'll watch the capi release repo to test it.

[kirederik]

CAPI 1.99.0 is released and should contain the fix for this!

I'll close it for now but please reopen it if you find any other issues!