Xena Series Release Notes

3.0.0

New Features

  • The openstack resource provider allocation unset command now supports --resource-class option, which accepts string of a resource class. This will remove allocations for the given resource class from all the providers. If --provider option is also specified, allocations to remove will be limited to the given resource class of the given resource provider.

    example1:

    # remove VGPU allocation from provider P for this consumer.
    allocation unset <consumer_uuid> --provider P --resource-class VGPU
    

    example2:

    # remove VGPU allocations from all providers for this consumer.
    allocation unset <consumer_uuid> --resource-class VGPU
    
  • The openstack allocation candidate list and the openstack resource provider list command now supports --member-of option, which accepts comma-separated UUIDs of the resource provider aggregates. If this is specified, the returned resource providers must be associated with at least one of the aggregates identified by uuid. This option can be repeated to add(restrict) the condition with --os-placement-api-version 1.24 or greater.

  • The openstack allocation candidate list command now supports --group and --group-policy option. The --group option accepts an integer to group granular requests. If specified, following given options of resources, required/forbidden traits, and aggregates are associated to that group and will be satisfied by the same resource provider in the response. --group can be repeated to get candidates from multiple resource providers in a same resource provider tree. If multiple groups are supplied, the separate groups may or may not be satisfied by the same provider. If you want the groups to be satisfied by different resource providers, set --group_policy to isolate. For example:

    openstack allocation candidate list \
        --group 1 --resource VCPU=3 --required HW_CPU_X86_SSE \
        --group 2 --resource VCPU=4 \
        --group_policy isolate
    

    This option is available with --os-placement-api-version 1.25 or greater, but to have placement server be aware of nested providers, use --os-placement-api-version 1.29 or greater.

    See the REST API Version History for more details.

  • The openstack resource provider inventory list and openstack resource provider inventory show commands now include a used column providing summary usage information for the specified resource(s).

Deprecation Notes

  • The --aggregate-uuid option has been deprecated for the openstack allocation candidate list and the openstack resource provider list commands. Please use --member-of option instead.

2.0.0

Upgrade Notes

  • Python 2.7 support has been dropped. The minimum version of Python now supported is Python 3.6.

1.8.0

New Features

  • A new openstack resource provider allocation unset command has been added which allows removing allocations against specific resource providers for the given consumer. This can be useful when a consumer has allocations against more than one resource provider and openstack resource provider allocation delete is undesirable as it removes all allocations for the consumer. The new unset command requires --os-placement-api-version 1.12 or greater.

  • The openstack resource provider allocation set command now supports --os-placement-api-version 1.28 where a consumer generation is used which facilitates safe concurrent modification of an allocation.

1.7.0

New Features

  • A new --aggregate option has been added to the resource provider inventory set command which can set resource provider inventory for all resource providers that are members of the specified aggregate. For example, VCPU, MEMORY_MB, and/or DISK_GB allocation ratios can be managed in aggregate to resolve bug 1804125.

  • A new --amend option has been added to the resource provider inventory set command which can update resource provider inventory without requiring the user to pass a full replacement for inventory.

  • A new --dry-run option has been added to the resource provider inventory set command which gives the ability to preview changes to inventory without effecting them.

1.6.0

New Features

  • Support is added for the 1.19 placement API microversion by adding the --generation option to the openstack resource provider aggregate set command.

  • The openstack allocation candidate list command now supports microversion 1.21. An --aggregate-uuid option is added which limits the list of results to include only those resource providers that are in at least one of the aggregates.

    See the command documentation for more details.

  • The 1.22 microversion of placement adds support for excluding resource providers and allocation candidates with specified traits. A forbidden trait may be specified with --forbidden option.

1.5.0

New Features

  • Support is added for the 1.18 placement API microversion by adding the --required option to the openstack resource provider list command.

1.3.0

New Features

  • The openstack allocation candidate list command is available starting from microversion 1.10.

    See the command documentation for allocation candidate list for more details.

  • Support is added for the 1.14 placement API microversion by adding the root_provider_uuid and parent_provider_uuid to the output of resource provider list/show/create/set commands. Also resource provider create/set commands now have a new option --parent-provider <UUID>. And resource provider list has a new option --in-tree <UUID>.

  • Support is added for the 1.16 placement API microversion by adding the --limit option to the openstack allocation candidate list command.

  • Support is added for the 1.17 placement API microversion by adding the --required option to the openstack allocation candidate list command.

  • The openstack resource provider allocation set command now supports microversion 1.8. Specifically from 1.8 it is necessary to specify --user-id and --project-id arguments when setting allocations.

    The openstack resource usage show command is available starting from microversion 1.9. It is possible to show usages for a project and user.

    See the command documentation for allocation set and resource usage show for more details.

1.2.0

New Features

  • The openstack resource provider inventory delete command now supports microversion 1.5. Specifically it is possible to delete all inventories of the specified resource provider.

    See the command documentation for more details.

  • The following list of trait related commands was added for microversion 1.6:

    • openstack trait list

    • openstack trait show

    • openstack trait create

    • openstack trait delete

    • openstack resource provider trait list

    • openstack resource provider trait set

    • openstack resource provider trait delete

    See the command documentation for more details.

  • The openstack resource class set {name} command has been added which requires --os-placement-api-version 1.7. This command is similar to openstack resource class create except it is idempotent if the resource class already exists.

    See the command documentation for more details.

Upgrade Notes

  • The resource_class positional argument in command

    openstack resource provider inventory delete was replaced with the --resource-class optional argument. The --resource-class option is still required if using --os-placement-api-version less than 1.5.

1.1.0

New Features

  • The openstack resource provider list command now supports microversion 1.3 and 1.4. Specifically two new options are added to the command:

    • --aggregate-uuid: List resource providers which are members of at least one of the specified resource provider aggregates.

    • --resource: List resource providers which have the capacity to serve allocation requests for the given amount of specified resource class.

    See the command documentation for more details.

1.0.0

Prelude

This is the first major release for the osc-placement plugin and includes a minimal set of command line support for the Placement API.

New Features

  • The set of new commands in this release includes:

    $ openstack resource -h
    Command "resource" matches:
      resource class create
      resource class delete
      resource class list
      resource class show
      resource provider aggregate list
      resource provider aggregate set
      resource provider allocation delete
      resource provider allocation set
      resource provider allocation show
      resource provider create
      resource provider delete
      resource provider inventory class set
      resource provider inventory delete
      resource provider inventory list
      resource provider inventory set
      resource provider inventory show
      resource provider list
      resource provider set
      resource provider show
      resource provider usage show
    

    See the Usage documentation for more details and examples.