2023.2.Bobcat spec maintain
Change-Id: Ia8c9b0591fdd4b5eb35f65d9aae0fff46b820f10
This commit is contained in:
parent
eb76508050
commit
fd77a79610
|
@ -0,0 +1,392 @@
|
|||
..
|
||||
This work is licensed under a Creative Commons Attribution 3.0 Unported
|
||||
License.
|
||||
|
||||
http://creativecommons.org/licenses/by/3.0/legalcode
|
||||
|
||||
==========================================
|
||||
Example Spec - The title of your blueprint
|
||||
==========================================
|
||||
|
||||
Include the URL of your launchpad blueprint:
|
||||
|
||||
https://blueprints.launchpad.net/openstack-cyborg/+spec/example
|
||||
|
||||
Introduction paragraph -- why are we doing anything? A single paragraph of
|
||||
prose that operators can understand. The title and this first paragraph
|
||||
should be used as the subject line and body of the commit message
|
||||
respectively.
|
||||
|
||||
Some notes about the cyborg-spec and blueprint process:
|
||||
|
||||
* Not all blueprints need a spec. For more information see
|
||||
https://docs.openstack.org/developer/cyborg/blueprints.html#specs
|
||||
|
||||
* The aim of this document is first to define the problem we need to solve,
|
||||
and second agree the overall approach to solve that problem.
|
||||
|
||||
* This is not intended to be extensive documentation for a new feature.
|
||||
For example, there is no need to specify the exact configuration changes,
|
||||
nor the exact details of any DB model changes. But you should still define
|
||||
that such changes are required, and be clear on how that will affect
|
||||
upgrades.
|
||||
|
||||
* You should aim to get your spec approved before writing your code.
|
||||
While you are free to write prototypes and code before getting your spec
|
||||
approved, its possible that the outcome of the spec review process leads
|
||||
you towards a fundamentally different solution than you first envisaged.
|
||||
|
||||
* But, API changes are held to a much higher level of scrutiny.
|
||||
As soon as an API change merges, we must assume it could be in production
|
||||
somewhere, and as such, we then need to support that API change forever.
|
||||
To avoid getting that wrong, we do want lots of details about API changes
|
||||
upfront.
|
||||
|
||||
Some notes about using this template:
|
||||
|
||||
* Your spec should be in ReSTructured text, like this template.
|
||||
|
||||
* Please wrap text at 79 columns.
|
||||
|
||||
* The filename in the git repository should match the launchpad URL, for
|
||||
example a URL of: https://blueprints.launchpad.net/openstack-cyborg/+spec/awesome-thing
|
||||
should be named awesome-thing.rst
|
||||
|
||||
* Please do not delete any of the sections in this template. If you have
|
||||
nothing to say for a whole section, just write: None
|
||||
|
||||
* For help with syntax, see http://sphinx-doc.org/rest.html
|
||||
|
||||
* To test out your formatting, build the docs using tox and see the generated
|
||||
HTML file in doc/build/html/specs/<path_of_your_file>
|
||||
|
||||
* If you would like to provide a diagram with your spec, ascii diagrams are
|
||||
required. http://asciiflow.com/ is a very nice tool to assist with making
|
||||
ascii diagrams. The reason for this is that the tool used to review specs is
|
||||
based purely on plain text. Plain text will allow review to proceed without
|
||||
having to look at additional files which can not be viewed in gerrit. It
|
||||
will also allow inline feedback on the diagram itself.
|
||||
|
||||
* If your specification proposes any changes to the Cyborg REST API such
|
||||
as changing parameters which can be returned or accepted, or even
|
||||
the semantics of what happens when a client calls into the API, then
|
||||
you should add the APIImpact flag to the commit message. Specifications with
|
||||
the APIImpact flag can be found with the following query:
|
||||
|
||||
https://review.opendev.org/#/q/status:merged+project:openstack/cyborg+message:apiimpact,n,z
|
||||
|
||||
|
||||
Problem description
|
||||
===================
|
||||
|
||||
A detailed description of the problem. What problem is this blueprint
|
||||
addressing?
|
||||
|
||||
Use Cases
|
||||
---------
|
||||
|
||||
What use cases does this address? What impact on actors does this change have?
|
||||
Ensure you are clear about the actors in each use case: Developer, End User,
|
||||
Deployer etc.
|
||||
|
||||
Proposed change
|
||||
===============
|
||||
|
||||
Here is where you cover the change you propose to make in detail. How do you
|
||||
propose to solve this problem?
|
||||
|
||||
If this is one part of a larger effort make it clear where this piece ends. In
|
||||
other words, what's the scope of this effort?
|
||||
|
||||
At this point, if you would like to just get feedback on if the problem and
|
||||
proposed change fit in Cyborg, you can stop here and post this for review to
|
||||
get preliminary feedback. If so please say:
|
||||
Posting to get preliminary feedback on the scope of this spec.
|
||||
|
||||
Alternatives
|
||||
------------
|
||||
|
||||
What other ways could we do this thing? Why aren't we using those? This doesn't
|
||||
have to be a full literature review, but it should demonstrate that thought has
|
||||
been put into why the proposed solution is an appropriate one.
|
||||
|
||||
Data model impact
|
||||
-----------------
|
||||
|
||||
Changes which require modifications to the data model often have a wider impact
|
||||
on the system. The community often has strong opinions on how the data model
|
||||
should be evolved, from both a functional and performance perspective. It is
|
||||
therefore important to capture and gain agreement as early as possible on any
|
||||
proposed changes to the data model.
|
||||
|
||||
Questions which need to be addressed by this section include:
|
||||
|
||||
* What new data objects and/or database schema changes is this going to
|
||||
require?
|
||||
|
||||
* What database migrations will accompany this change.
|
||||
|
||||
* How will the initial set of new data objects be generated, for example if you
|
||||
need to take into account existing instances, or modify other existing data
|
||||
describe how that will work.
|
||||
|
||||
REST API impact
|
||||
---------------
|
||||
|
||||
Each API method which is either added or changed should have the following
|
||||
|
||||
* Specification for the method
|
||||
|
||||
* A description of what the method does suitable for use in
|
||||
user documentation
|
||||
|
||||
* Method type (POST/PUT/GET/DELETE)
|
||||
|
||||
* Normal http response code(s)
|
||||
|
||||
* Expected error http response code(s)
|
||||
|
||||
* A description for each possible error code should be included
|
||||
describing semantic errors which can cause it such as
|
||||
inconsistent parameters supplied to the method, or when an
|
||||
instance is not in an appropriate state for the request to
|
||||
succeed. Errors caused by syntactic problems covered by the JSON
|
||||
schema definition do not need to be included.
|
||||
|
||||
* URL for the resource
|
||||
|
||||
* URL should not include underscores, and use hyphens instead.
|
||||
|
||||
* Parameters which can be passed via the url
|
||||
|
||||
* JSON schema definition for the request body data if allowed
|
||||
|
||||
* Field names should use snake_case style, not CamelCase or MixedCase
|
||||
style.
|
||||
|
||||
* JSON schema definition for the response body data if any
|
||||
|
||||
* Field names should use snake_case style, not CamelCase or MixedCase
|
||||
style.
|
||||
|
||||
* Example use case including typical API samples for both data supplied
|
||||
by the caller and the response
|
||||
|
||||
* Discuss any policy changes, and discuss what things a deployer needs to
|
||||
think about when defining their policy.
|
||||
|
||||
Note that the schema should be defined as restrictively as
|
||||
possible. Parameters which are required should be marked as such and
|
||||
only under exceptional circumstances should additional parameters
|
||||
which are not defined in the schema be permitted (eg
|
||||
additionaProperties should be False).
|
||||
|
||||
Reuse of existing predefined parameter types such as regexps for
|
||||
passwords and user defined names is highly encouraged.
|
||||
|
||||
Security impact
|
||||
---------------
|
||||
|
||||
Describe any potential security impact on the system. Some of the items to
|
||||
consider include:
|
||||
|
||||
* Does this change touch sensitive data such as tokens, keys, or user data?
|
||||
|
||||
* Does this change alter the API in a way that may impact security, such as
|
||||
a new way to access sensitive information or a new way to login?
|
||||
|
||||
* Does this change involve cryptography or hashing?
|
||||
|
||||
* Does this change require the use of sudo or any elevated privileges?
|
||||
|
||||
* Does this change involve using or parsing user-provided data? This could
|
||||
be directly at the API level or indirectly such as changes to a cache layer.
|
||||
|
||||
* Can this change enable a resource exhaustion attack, such as allowing a
|
||||
single API interaction to consume significant server resources? Some examples
|
||||
of this include launching subprocesses for each connection, or entity
|
||||
expansion attacks in XML.
|
||||
|
||||
For more detailed guidance, please see the OpenStack Security Guidelines as
|
||||
a reference (https://wiki.openstack.org/wiki/Security/Guidelines). These
|
||||
guidelines are a work in progress and are designed to help you identify
|
||||
security best practices. For further information, feel free to reach out
|
||||
to the OpenStack Security Group at openstack-security@lists.openstack.org.
|
||||
|
||||
Notifications impact
|
||||
--------------------
|
||||
|
||||
Please specify any changes to notifications. Be that an extra notification,
|
||||
changes to an existing notification, or removing a notification.
|
||||
|
||||
Other end user impact
|
||||
---------------------
|
||||
|
||||
Aside from the API, are there other ways a user will interact with this
|
||||
feature?
|
||||
|
||||
* Does this change have an impact on python-cyborgclient? What does the user
|
||||
interface there look like?
|
||||
|
||||
Performance Impact
|
||||
------------------
|
||||
|
||||
Describe any potential performance impact on the system, for example
|
||||
how often will new code be called, and is there a major change to the calling
|
||||
pattern of existing code.
|
||||
|
||||
Examples of things to consider here include:
|
||||
|
||||
* A periodic task might look like a small addition but if it calls conductor or
|
||||
another service the load is multiplied by the number of nodes in the system.
|
||||
|
||||
* Scheduler filters get called once per host for every instance being created,
|
||||
so any latency they introduce is linear with the size of the system.
|
||||
|
||||
* A small change in a utility function or a commonly used decorator can have a
|
||||
large impacts on performance.
|
||||
|
||||
* Calls which result in a database queries (whether direct or via conductor)
|
||||
can have a profound impact on performance when called in critical sections of
|
||||
the code.
|
||||
|
||||
* Will the change include any locking, and if so what considerations are there
|
||||
on holding the lock?
|
||||
|
||||
Other deployer impact
|
||||
---------------------
|
||||
|
||||
Discuss things that will affect how you deploy and configure OpenStack
|
||||
that have not already been mentioned, such as:
|
||||
|
||||
* What config options are being added? Should they be more generic than
|
||||
proposed (for example a flag that other hypervisor drivers might want to
|
||||
implement as well)? Are the default values ones which will work well in
|
||||
real deployments?
|
||||
|
||||
* Is this a change that takes immediate effect after its merged, or is it
|
||||
something that has to be explicitly enabled?
|
||||
|
||||
* If this change is a new binary, how would it be deployed?
|
||||
|
||||
* Please state anything that those doing continuous deployment, or those
|
||||
upgrading from the previous release, need to be aware of. Also describe
|
||||
any plans to deprecate configuration values or features. For example, if we
|
||||
change the directory name that instances are stored in, how do we handle
|
||||
instance directories created before the change landed? Do we move them? Do
|
||||
we have a special case in the code? Do we assume that the operator will
|
||||
recreate all the instances in their cloud?
|
||||
|
||||
Developer impact
|
||||
----------------
|
||||
|
||||
Discuss things that will affect other developers working on OpenStack,
|
||||
such as:
|
||||
|
||||
* If the blueprint proposes a change to the driver API, discussion of how
|
||||
other hypervisors would implement the feature is required.
|
||||
|
||||
|
||||
Implementation
|
||||
==============
|
||||
|
||||
Assignee(s)
|
||||
-----------
|
||||
|
||||
Who is leading the writing of the code? Or is this a blueprint where you're
|
||||
throwing it out there to see who picks it up?
|
||||
|
||||
If more than one person is working on the implementation, please designate the
|
||||
primary author and contact.
|
||||
|
||||
Primary assignee:
|
||||
<launchpad-id or None>
|
||||
|
||||
Other contributors:
|
||||
<launchpad-id or None>
|
||||
|
||||
Work Items
|
||||
----------
|
||||
|
||||
Work items or tasks -- break the feature up into the things that need to be
|
||||
done to implement it. Those parts might end up being done by different people,
|
||||
but we're mostly trying to understand the timeline for implementation.
|
||||
|
||||
|
||||
Dependencies
|
||||
============
|
||||
|
||||
* Include specific references to specs and/or blueprints in cyborg, or in other
|
||||
projects, that this one either depends on or is related to.
|
||||
|
||||
* If this requires functionality of another project that is not currently used
|
||||
by Cyborg, document that fact.
|
||||
|
||||
* Does this feature require any new library dependencies or code otherwise not
|
||||
included in OpenStack? Or does it depend on a specific version of library?
|
||||
|
||||
|
||||
Testing
|
||||
=======
|
||||
|
||||
Please discuss the important scenarios needed to test here, as well as
|
||||
specific edge cases we should be ensuring work correctly. For each
|
||||
scenario please specify if this requires specialized hardware, a full
|
||||
OpenStack environment, or can be simulated inside the Cyborg tree.
|
||||
|
||||
Please discuss how the change will be tested. We especially want to know what
|
||||
tempest tests will be added. It is assumed that unit test coverage will be
|
||||
added so that doesn't need to be mentioned explicitly, but discussion of why
|
||||
you think unit tests are sufficient and we don't need to add more tempest
|
||||
tests would need to be included.
|
||||
|
||||
Is this untestable in gate given current limitations (specific hardware /
|
||||
software configurations available)? If so, are there mitigation plans (3rd
|
||||
party testing, gate enhancements, etc).
|
||||
|
||||
|
||||
Documentation Impact
|
||||
====================
|
||||
|
||||
Which audiences are affected most by this change, and which documentation
|
||||
titles on docs.openstack.org should be updated because of this change? Don't
|
||||
repeat details discussed above, but reference them here in the context of
|
||||
documentation for multiple audiences. For example, the Operations Guide targets
|
||||
cloud operators, and the End User Guide would need to be updated if the change
|
||||
offers a new feature available through the CLI or dashboard. If a config option
|
||||
changes or is deprecated, note here that the documentation needs to be updated
|
||||
to reflect this specification's change.
|
||||
|
||||
References
|
||||
==========
|
||||
|
||||
Please add any useful references here. You are not required to have any
|
||||
reference. Moreover, this specification should still make sense when your
|
||||
references are unavailable. Examples of what you could include are:
|
||||
|
||||
* Links to mailing list or IRC discussions
|
||||
|
||||
* Links to notes from a summit session
|
||||
|
||||
* Links to relevant research, if appropriate
|
||||
|
||||
* Related specifications as appropriate (e.g. if it's an EC2 thing, link the
|
||||
EC2 docs)
|
||||
|
||||
* Anything else you feel it is worthwhile to refer to
|
||||
|
||||
|
||||
History
|
||||
=======
|
||||
|
||||
Optional section intended to be used each time the spec is updated to describe
|
||||
new design, API or any database schema updated. Useful to let reader understand
|
||||
what's happened along the time.
|
||||
|
||||
.. list-table:: Revisions
|
||||
:header-rows: 1
|
||||
|
||||
* - Release Name
|
||||
- Description
|
||||
* - 2023.2 Bobcat
|
||||
- Introduced
|
|
@ -0,0 +1 @@
|
|||
../../2023.2-bobcat-template.rst
|
|
@ -0,0 +1,301 @@
|
|||
..
|
||||
This work is licensed under a Creative Commons Attribution 3.0 Unported
|
||||
License.
|
||||
|
||||
http://creativecommons.org/licenses/by/3.0/legalcode
|
||||
|
||||
=====================
|
||||
Support attribute API
|
||||
=====================
|
||||
|
||||
This spec adds a new group of APIs to manage the lifecycle of accelerator's
|
||||
attributes.
|
||||
|
||||
Problem description
|
||||
===================
|
||||
|
||||
Attribute is designed for describing customized information of an accelerator.
|
||||
Now they are generated by drivers, users can not add/delete/update them, it's
|
||||
not applicable to our scenarios now.
|
||||
|
||||
Use Cases
|
||||
---------
|
||||
|
||||
An admin or operator needs a group of APIs to manage his accelerator's
|
||||
attributes.
|
||||
Here are some useful scenarios:
|
||||
|
||||
* For a NIC accelerator, we need to add a phys_net attribute, it's should be
|
||||
created by deployer or other components.
|
||||
* For some Function Volatile Accelerators, we can create the Function name as
|
||||
an attribute.
|
||||
* Also for some information, such as Function_UUID is machine readable.
|
||||
|
||||
Proposed change
|
||||
===============
|
||||
None
|
||||
|
||||
Alternatives
|
||||
------------
|
||||
|
||||
None
|
||||
|
||||
Data model impact
|
||||
-----------------
|
||||
|
||||
* Add attribute object to deployable object.
|
||||
|
||||
REST API impact
|
||||
---------------
|
||||
|
||||
URL: ``/v2/deployable/{uuid}/attribute``
|
||||
|
||||
METHOD: ``GET``
|
||||
|
||||
List all attributes of specified deployable.
|
||||
|
||||
Normal response code (200) and body::
|
||||
|
||||
{
|
||||
"attributes":[{
|
||||
"key":"key1",
|
||||
"value":"value1",
|
||||
"uuid":"uuid1"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
Error response code and body:
|
||||
|
||||
* 401 (Unauthorized): Unauthorized
|
||||
|
||||
* 403 (Forbidden): RBAC check failed
|
||||
|
||||
* No response body
|
||||
|
||||
|
||||
URL: ``/v2/deployable/{uuid}/attribute/{uuid_or_key}``
|
||||
|
||||
METHOD: ``GET``
|
||||
|
||||
GET specified attribute of specified deployable.
|
||||
|
||||
Query Parameters: None
|
||||
|
||||
Normal response code (200) and body::
|
||||
|
||||
{
|
||||
"attribute":
|
||||
{
|
||||
"key":"key1",
|
||||
"value":"value1",
|
||||
"uuid":"uuid1",
|
||||
"created_at":"2020-05-28T03:03:20",
|
||||
"updated_at":"2020-05-28T03:03:20"
|
||||
}
|
||||
}
|
||||
|
||||
Error response code and body:
|
||||
|
||||
* 401 (Unauthorized): Unauthorized
|
||||
|
||||
* 403 (Forbidden): RBAC check failed
|
||||
|
||||
* 404 (NotFound): No deployable of that UUID or no attribute of that UUID
|
||||
exists
|
||||
|
||||
* No response body
|
||||
|
||||
|
||||
URL: ``/v2/deployable/{uuid}/attribute``
|
||||
|
||||
METHOD: ``POST``
|
||||
|
||||
Create one or more deployable attribute(s).
|
||||
|
||||
Request body::
|
||||
|
||||
[
|
||||
{
|
||||
"key": "key1",
|
||||
"value": "value1"
|
||||
},
|
||||
{
|
||||
"key": "key2",
|
||||
"value": "value2"
|
||||
},
|
||||
...
|
||||
]
|
||||
|
||||
Normal response code and body:
|
||||
|
||||
* 204 (No content)
|
||||
|
||||
* No response body
|
||||
|
||||
Error response code:
|
||||
|
||||
* 401 (Unauthorized): Unauthorized
|
||||
|
||||
* 403 (Forbidden): RBAC check failed
|
||||
|
||||
* 409 (Conflict): Bad input or key is not unique
|
||||
|
||||
Error response body::
|
||||
|
||||
{"error": "error-string"}
|
||||
|
||||
|
||||
URL: ``/v2/deployable/{uuid}/attribute/{uuid_or_key}``
|
||||
|
||||
METHOD: ``DELETE``
|
||||
|
||||
Delete an exist deployable attribute.
|
||||
|
||||
Query Parameters: None
|
||||
|
||||
Normal response code and body:
|
||||
|
||||
* 204 (No content)
|
||||
|
||||
* No response body
|
||||
|
||||
Error response code:
|
||||
|
||||
* 401 (Unauthorized): Unauthorized
|
||||
|
||||
* 403 (Forbidden): RBAC check failed
|
||||
|
||||
* 404 (NotFound): No deployable of that UUID or no attribute of that UUID
|
||||
exists
|
||||
|
||||
Error response body::
|
||||
|
||||
{"error": "error-string"}
|
||||
|
||||
|
||||
URL: ``/v2/deployable/{uuid}/attribute``
|
||||
|
||||
METHOD: ``DELETE``
|
||||
|
||||
Delete all attributes of a deployable.
|
||||
|
||||
Query Parameters: None
|
||||
|
||||
Normal response code and body:
|
||||
|
||||
* 204 (No content)
|
||||
|
||||
* No response body
|
||||
|
||||
Error response code:
|
||||
|
||||
* 401 (Unauthorized): Unauthorized
|
||||
|
||||
* 403 (Forbidden): RBAC check failed
|
||||
|
||||
Error response body::
|
||||
|
||||
{"error": "error-string"}
|
||||
|
||||
|
||||
URL: ``/v2/deployable/{uuid}/attribute/{uuid_or_key}``
|
||||
|
||||
METHOD: ``PUT``
|
||||
|
||||
Update an exist deployable attribute.
|
||||
|
||||
Query Parameters: None
|
||||
|
||||
Request body (Value of deployable attribute)::
|
||||
|
||||
{"value": "value1"}
|
||||
|
||||
Normal response code and body:
|
||||
|
||||
* 204 (No content)
|
||||
|
||||
* No response body
|
||||
|
||||
Error response code and body:
|
||||
|
||||
* 401 (Unauthorized): Unauthorized
|
||||
|
||||
* 403 (Forbidden): RBAC check failed
|
||||
|
||||
* 404 (NotFound): No deployable of that UUID or no attribute of that UUID
|
||||
exists
|
||||
|
||||
Error response body::
|
||||
|
||||
{"error": "error-string"}
|
||||
|
||||
Security impact
|
||||
---------------
|
||||
None
|
||||
|
||||
Notifications impact
|
||||
--------------------
|
||||
None
|
||||
|
||||
Other end user impact
|
||||
---------------------
|
||||
* Change Cyborg Attribute table.
|
||||
|
||||
|
||||
Performance Impact
|
||||
------------------
|
||||
None
|
||||
|
||||
Other deployer impact
|
||||
---------------------
|
||||
None
|
||||
|
||||
Developer impact
|
||||
----------------
|
||||
* If the user want to use these feature, they should upgrade their Cyborg
|
||||
* project to latest to support these changes.
|
||||
|
||||
Implementation
|
||||
==============
|
||||
|
||||
Assignee(s)
|
||||
-----------
|
||||
Primary assignee:
|
||||
hejunli
|
||||
|
||||
Work Items
|
||||
----------
|
||||
|
||||
* Change Cyborg REST APIs.
|
||||
* Change Cyborg Attribute table.
|
||||
* Change Cyborg deployable object.
|
||||
* Change cyborgclient to support Attribute management action.
|
||||
* Add related tests.
|
||||
|
||||
Dependencies
|
||||
============
|
||||
None
|
||||
|
||||
Testing
|
||||
=======
|
||||
Appropriate unit and functional tests should be added.
|
||||
|
||||
Documentation Impact
|
||||
====================
|
||||
* Need a documentation to record microversion history.
|
||||
* Need a documentaiton to explain api usage.
|
||||
|
||||
References
|
||||
==========
|
||||
None
|
||||
|
||||
History
|
||||
=======
|
||||
.. list-table:: Revisions
|
||||
:header-rows: 1
|
||||
|
||||
* - Release Name
|
||||
- Description
|
||||
* - Antelope
|
||||
- Introduced
|
|
@ -0,0 +1,221 @@
|
|||
..
|
||||
This work is licensed under a Creative Commons Attribution 3.0 Unported
|
||||
License.
|
||||
|
||||
http://creativecommons.org/licenses/by/3.0/legalcode
|
||||
|
||||
=============================
|
||||
Add disable/enable device API
|
||||
=============================
|
||||
|
||||
https://blueprints.launchpad.net/openstack-cyborg/+spec/disable-enable-device
|
||||
|
||||
Nowadays, Cyborg discovers the device on compute node by each driver. All
|
||||
devices matching the spec of driver are discovered and reported to the
|
||||
Placement service as an accelerator resources.
|
||||
This spec proposes a set of new APIs which allow admin users to
|
||||
disable/enable a device.
|
||||
|
||||
|
||||
Problem description
|
||||
===================
|
||||
|
||||
Cyborg maintains a configuration file to configure the enabled drivers. Once
|
||||
the driver is enabled, the agent will discover all devices whose vendor ID,
|
||||
device ID match the driver's requirement. If admin user do not want all devices
|
||||
to be used by virtual machine, there is no way to disable a device currently.
|
||||
|
||||
|
||||
Use Cases
|
||||
---------
|
||||
* Alice is an admin user, she wants some FPGAs to be reserved for its own use
|
||||
and not allow them to be allocated to a VM at the time. For example, she
|
||||
wants to program the FPGA device and use it as the OVS agent running on
|
||||
the host.
|
||||
|
||||
Proposed change
|
||||
===============
|
||||
We propose to add new API in order to enable/disable a device. If the device is
|
||||
disabled, Cyborg will report this device as a reserved resource to Placement,
|
||||
so that Nova can not schedule to this device. On the contrary, if the device is
|
||||
enabled, the device should become available and the 'reserved' field in
|
||||
Placement shoule be set to 0.
|
||||
* Since the API layer is modified, a new microversion should be introduced.
|
||||
* It also need a new field "is_maintaining" in Device object and data model to
|
||||
indicate whether the device is disbaled. If one device is disabled, the
|
||||
"is_maintaining" field should be set to "True", and if the device is enabled,
|
||||
the field should be set to "False". The default value should be "False".
|
||||
* Cyborg need call Placement API to update the "reserved" field for the
|
||||
device in this API.
|
||||
* Add "is_maintaining" field's value check during conductor's periodic report.
|
||||
|
||||
Alternatives
|
||||
------------
|
||||
None
|
||||
|
||||
Data model impact
|
||||
-----------------
|
||||
A new column `is_maintaining` should be added in Device's data model.
|
||||
|
||||
|
||||
REST API impact
|
||||
---------------
|
||||
A microversion need to be introduced since the Device API changed.
|
||||
|
||||
List Device API
|
||||
^^^^^^^^^^^^^^^
|
||||
* Return a device list
|
||||
URL: ``/devices``
|
||||
METHOD: ``GET``
|
||||
Return: 200
|
||||
|
||||
.. code-block::
|
||||
|
||||
{
|
||||
"devices": [
|
||||
{
|
||||
"uuid": "d2446439-0142-40b7-9eee-82d855f453d9",
|
||||
"type": "FPGA",
|
||||
"vendor": "0xABCD",
|
||||
"model": "miss model info",
|
||||
"std_board_info": "{"device_id": "0xabcd", "class": "Fake class"}",
|
||||
"vendor_board_info": "fake_vendor_info",
|
||||
"hostname": "devstack01",
|
||||
"links": [
|
||||
{
|
||||
"href": "http://172.23.97.140/accelerator/v2/devices/d2446439-0142-40b7-9eee-82d855f453d9",
|
||||
"rel": "self"
|
||||
}
|
||||
],
|
||||
"created_at": "2021-11-03T08:48:43+00:00",
|
||||
"updated_at": null
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
Get Device API
|
||||
^^^^^^^^^^^^^^
|
||||
* Get a device by uuid and return the details
|
||||
URL: ``/devices/{uuid}``
|
||||
METHOD: ``GET``
|
||||
Return: 200
|
||||
|
||||
.. code-block::
|
||||
|
||||
{
|
||||
"uuid": "d2446439-0142-40b7-9eee-82d855f453d9",
|
||||
"type": "FPGA",
|
||||
"vendor": "0xABCD",
|
||||
"model": "miss model info",
|
||||
"std_board_info": "{"device_id": "0xabcd", "class": "Fake class"}",
|
||||
"vendor_board_info": "fake_vendor_info",
|
||||
"hostname": "devstack01",
|
||||
"links": [
|
||||
{
|
||||
"href": "http://172.23.97.140/accelerator/v2/devices/d2446439-0142-40b7-9eee-82d855f453d9",
|
||||
"rel": "self"
|
||||
}
|
||||
],
|
||||
"created_at": "2021-11-03T08:48:43+00:00",
|
||||
"updated_at": null
|
||||
}
|
||||
|
||||
|
||||
Disable Device API
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
* Disable a device
|
||||
URL: ``/devices/disable/{device_uuid}``
|
||||
METHOD: ``POST``
|
||||
Return: 200
|
||||
Error Code: 404(the device is not found),403(the role is not admin)
|
||||
|
||||
Enable Device API
|
||||
^^^^^^^^^^^^^^^^^
|
||||
* Enable a device
|
||||
URL: ``/devices/enable/{device_uuid}``
|
||||
METHOD: ``POST``
|
||||
Return: 200
|
||||
Error Code: 404(the device is not found),403(the role is not admin)
|
||||
|
||||
Security impact
|
||||
---------------
|
||||
None
|
||||
|
||||
Notifications impact
|
||||
--------------------
|
||||
None
|
||||
|
||||
Other end user impact
|
||||
---------------------
|
||||
None
|
||||
|
||||
Performance Impact
|
||||
------------------
|
||||
None
|
||||
|
||||
Other deployer impact
|
||||
---------------------
|
||||
The deployer need update Cyborg to the microversion which supports
|
||||
disable/enable API. Otherwise the disable/enable API will be rejected.
|
||||
|
||||
Developer impact
|
||||
----------------
|
||||
None
|
||||
|
||||
|
||||
Implementation
|
||||
==============
|
||||
|
||||
Assignee(s)
|
||||
-----------
|
||||
Primary assignee:
|
||||
Xinran Wang(xin-ran.wang@intel.com)
|
||||
|
||||
Work Items
|
||||
----------
|
||||
* Add new column `is_maintaining` for device table.
|
||||
* Add disable/enable API in DeviceController.
|
||||
* Update the RP `reserved` field according to the operation. For `disable`
|
||||
oparation, the `reserved` field need be set by the same value as the
|
||||
`total` field, and for `enable` operation, the `reserved` field will be set
|
||||
to zero.
|
||||
* Update GET/LIST device API with `is_maintaining` field added in returned
|
||||
value.
|
||||
* Add disable/enable operation in cyborgclient.
|
||||
* Add unit tests.
|
||||
|
||||
Dependencies
|
||||
============
|
||||
None
|
||||
|
||||
|
||||
Testing
|
||||
=======
|
||||
Need add unit test, and tempest test if needed.
|
||||
|
||||
|
||||
Documentation Impact
|
||||
====================
|
||||
Need add related docs.
|
||||
|
||||
References
|
||||
==========
|
||||
None
|
||||
|
||||
|
||||
History
|
||||
=======
|
||||
|
||||
Optional section intended to be used each time the spec is updated to describe
|
||||
new design, API or any database schema updated. Useful to let reader understand
|
||||
what's happened along the time.
|
||||
|
||||
.. list-table:: Revisions
|
||||
:header-rows: 1
|
||||
|
||||
* - Release Name
|
||||
- Description
|
||||
* - Xena
|
||||
- Introduced
|
||||
* - Yoga
|
||||
- Reproposed
|
|
@ -0,0 +1 @@
|
|||
../../2023.2-bobcat-template.rst
|
Loading…
Reference in New Issue