This update adds a new sysinv unauthenticated 'region_id' api that
return region_name
curl http://pxecontroller:6385/v1/isystems/region_id
System inventory will return a dictionary containing the
region_name
{
"region_name": "<system.region_name>"
}
Test Plan:
PASS: Verify success path handling
PASS: Verify multiple dictionary keys
Story: 2011100
Task: 49864
Change-Id: Iaeb77fdd90e5eb06cf9fc9d7da994dd22bfbee14
Signed-off-by: rummadis <ramu.ummadishetty@windriver.com>
This commit corrects a error in the API reference introduced in:
Ie78121d0c21d2c6033c8b5d4919e251fc4d98050.
This commit also improves the error handling to return understandable
error message, avoids print exception if the cert missed in the
file system.
Reduces the info logs from utils to prevent the dc audit dump too many
logs into the sysiv.log.
Test plan:
Passed - deploy an AIOSX, check the cert id by:
system kube-rootca-get-cert-id.
Passed - manually remove the kube-rootca cert and key from the system,
check the output of "system kube-rootca-get-cert-id", verified
the error message w/o exceptions.
Passed - verify the dc audit doesn't dump logs about the cert id in
sysinv.log.
Story: 2010852
Task: 49091
Signed-off-by: Yuxing Jiang <Yuxing.Jiang@windriver.com>
Change-Id: I47f1a9ca617bf0daf9c25e7b4552e52d3e9d1811
The DC Kubernetes root CA audit was based on the cert expiration alarm.
We would like to switch to cert comparison to ensure the Kubernetes
root CA certs. For this purpose, this commit creates a new sub API to
get Kubernetes root CA ID from local.
Test plan:
1. Passed - Create ISO and deploy AIOSX and distributed cloud.
2. Passed - Run "system --debug kube-rootca-get-cert-id", have the
expected response, and the cert ID was printed.
Story: 2010852
Task: 49091
Signed-off-by: Yuxing Jiang <Yuxing.Jiang@windriver.com>
Change-Id: Ie78121d0c21d2c6033c8b5d4919e251fc4d98050
This adds the CLI command 'system kube-config-kubelet'. This invokes
puppet runtime manifests to reconfigure kubelet-config ConfigMap
with new parameters, and to upgrade kubernetes nodes with new
parameters, and restart kubelet. This gives the ability to update
kubelet parameters with a software patch.
The specific kubelet-config parameters are provided within the puppet
manifests and its supporting parameters script. The specific settings
values and engineering are described in the puppet component.
Identical settings are also configured at install time in
ansible-playbooks.
TESTING:
PASS - manually fill /var/lib/docker to exceed imageGC and
verify GC operates
PASS - AIO-DX fresh install gets updated kubelet config
PASS - AIO-DX apply/remove designer patch with updated kubelet config
PASS - 'system kube-config-kubelet' updates K8S nodes kubelet config
PASS - AIO-DX reinstall controller-1 has updated kubelet config
PASS - AIO-DX install new worker node gets updated kubelet config
PASS - build and view REST documentation
Partial-Bug: 1977754
Depends-On: https://review.opendev.org/c/starlingx/stx-puppet/+/844298
Depends-On: https://review.opendev.org/c/starlingx/ansible-playbooks/+/844305
Signed-off-by: Jim Gauld <james.gauld@windriver.com>
Change-Id: Iad32a724d3f681bc9854fa663299f8539f70fd2a
This change updates the documentation of REST API available for PTP
configuration with the latest changes that support multi-instances of
PTP services.
Test Plan:
N/A
Task: 44781
Story: 2009248
Signed-off-by: Douglas Henrique Koerich <douglashenrique.koerich@windriver.com>
Change-Id: Ifa5fe47fea9fb6ec9ebe0148a8ca5960d905a896
Currently the k8s rootca update complete and abort will be rejected
if system has alarms that are not ignored internally. "-f" option
can be used to suppress none mgmt_affecting alarms, but mgmt_affecting
alarms will still prevent complete and abort.
Blocking complete and abort by alarms is not really neccessary since
it won't help user to solve the alarms anyway, and at the same time
causes confusion to the end users.
This update remove alarm checking (and the -force option) from REST
API and system CLI.
Test Plan:
PASS: rootca update complete while system has alarm
PASS: rootca update abort at host-update trust-both-cas while system
has alarms
PASS: rootca update abort at host-update update-certs while system
has alarms
PASS: rootca update abort at host-update trust-new-ca while system
has alarms
PASS: rootca update abort at pods-update trust-both-cas while system
has alarms
Closes-Bug: 1949238
Signed-off-by: Andy Ning <andy.ning@windriver.com>
Change-Id: I82b922f39d185990704c591f02781d581822b162
Currently, there are two kinds of functional images: user and bmc.
However there is no attribute to distinguish between the two kinds.
If an user image is already applied, applying bmc image would delete
the state of the applied user image.
A new parameter is added to specify a functional BMC image.
The state of last updated user image and BMC image are to be kept.
The order in which the two kinds of BMC images is applied determine
which one is to be kept.
If a BMC image with retimer is applied before a BMC image without
retimer, the states of both images must be kept.
If a BMC image without retimer is applied before a BMC image with
retimer, the state of the BMC image without retimer can be deleted.
Tox unit tests are added for the various scenarios.
Closes-Bug: 1951602
Change-Id: Ifdcbc09d9f14270a57ecc307fbea7517b048351b
Signed-off-by: Teresa Ho <teresa.ho@windriver.com>
The Host Hardware Profiles for creating re-usable configuration
templates for hosts are no longer maintained or supported and should be
removed from code. Including : CPU, Interface, Storage and Memory
profiles.
profile categories:
* cpu
* memory
* storage
* interfaces
topics:
* remove objects
* update models
* update documentation
* remove import/export profile apis
* remove and update unit tests
* new version script for migration upgrade
Test Plan / Failure Path:
PASS: Verify profile feature is removed on system upgrade
without existing previous profiles.
PASS: Verify profile feature is removed on system upgrade
with existing previous profiles.
PASS: Verify profile feature is removed on fresh install.
Regression:
PASS: Verify that the Horizon GUI remains navigable.
PASS: Verify non-affected system commands remains listed.
Story: 2009163
Task: 43159
Signed-off-by: Pablo Bovina <pablo.bovina@windriver.com>
Depends-On: https://review.opendev.org/c/starlingx/config/+/806800
Change-Id: Id828365920ce179e347acf0de5d3ed6af09efcbd
This commit provides the retimer version of the FPGA device in
the host device query output.
Tests:
Verified that retimer version is displayed when FPGA device exists.
Story: 2008972
Task: 43610
Change-Id: Ic16eab80146cf9ddd2237e2c51097fe014e2be88
Signed-off-by: Teresa Ho <teresa.ho@windriver.com>
the API document.
When I was using the /v1/ipvs POST API,
I found that the request parameter idisk_uuid was wrong.
Through analysis of the code,
I found that this parameter should be disk_or_part_uuid.
Closes-Bug: #1899227
Change-Id: I8c8539a1ba27f135ca8c57dffb227f7b518f6b4d
Signed-off-by: YuehuiLei<leiyuehui@inspur.com>
The update provides the support of updating BMC and retimer firmware
for the N3000 device.
Story: 2008965
Task: 42953
Change-Id: Id745bd642d906c917e50d54b02d5923ca6d277a7
Signed-off-by: Teresa Ho <teresa.ho@windriver.com>
This update is to allow the option primary_reselect configurable for
aggregated ethernet interface. The option is to prevent reverting
between the primary slave and other slaves.
Story: 2008706
Task: 42057
Change-Id: Icacc0bd2d5e42bf2e5db1505fd676c628dbe3ed1
Signed-off-by: Teresa Ho <teresa.ho@windriver.com>
New fields was created for the system object.
Changes was made to include GEO location attributes (latitude,
longitude) to the system object and adding a way to retrieve and
modify those attributes using the API and CLI.
Updates on: DB system model; DB migration; System object fields;
API fields; CLI fields; API documentation.
Story: 2008570
Task: 41721
Signed-off-by: Daniel Pinto Barros <DanielPinto.Barros@windriver.com>
Change-Id: I86f124c44d80896427e3ac1bc799fe34588ae942
API Reference documentation for the Kubernetes Cluster
API for cluster access information.
Story: 2008630
Task: 41914
Signed-off-by: Matt Peters <matt.peters@windriver.com>
Change-Id: Id0942dafeb2273e271d145f20517d16b1f409560
An error occurred while using the API interface
(/v1/devices/{device_id}) in the API documentation.
After analysis code, I found that the API interface should be
/v1/pci_devices/{device_id}, and the URL of "Modifies a
specific PCI device" also has this problem, so I also update
this part of the API document.
Closes-Bug:#1907074
Signed-off-by: XinxinShen<shenxinxin@inspur.com>
Change-Id: I636b830f34f9a74e0173d4a53224ec3f0249bba2
An error occurred when using the Ceph Storage Functions part
of the API documentation (POST /v1/ihosts/{host_id}/istors).
After analyzing the code, I found that the URLs set
in the code are /v1/istors.
This is inconsistent with the API documentation,
so update the partitions
section of the API documentation.
And I found that the request parameters are mandatory
rather than optional.
Closes-Bug: #1897252
Change-Id: I672735a9d1fa30894dfc0a9b2c12888a1e6b6271
Signed-off-by: YuehuiLei<leiyuehui@inspur.com>
An error occurred when using the partitions part
of the API documentation
(POST /v1/ihosts/{host_id}/partitions). After analyzing the
code, I found that the URLs set in the code are /v1/partitions.
This is inconsistent with the API documentation,
so update the partitions section of the API documentation.
Closes-Bug: #1897231
Change-Id: I9fc61b86bdfc4cb12acfd4f4cd8ecf8853ab338e
Signed-off-by: YuehuiLei<leiyuehui@inspur.com>
When I was using the /v1/ilvgs POST API, I found that
the request parameters are mandatory rather than optional.
Closes-Bug: #1897866
Change-Id: Iffb01013b16e62e1f3d3deb08f2b75132d62fde7
Signed-off-by: YuehuiLei<leiyuehui@inspur.com>
An error occurred when using the API interface
(/v1/ihosts/{host_id}/iinterfaces) in the API document. After analyzing
the code, I found that the API interface should be /v1/iinterfaces, so
update this partition section of the API documentation.
Closes-Bug:#1901833
Change-Id: Ifdef1895c2bba07843e9234b78107cf45524993e
Signed-off-by: XinxinShen<shenxinxin@inspur.com>
When I use the storage tiers POST API,
I found that the optional parameters described
in the document are wrong.
Closes-Bug: 1899133
Change-Id: Ie39c808bca30a441a7d0c072442dfd825ec8e90b
Signed-off-by: YuehuiLei<leiyuehui@inspur.com>
An error occurred when using the Ceph Monitors
of the API documentation
(DELETE /v1/ceph_mon/{ceph_mon_id}). After analyzing the
code, I found that the URLs set in the code are
/v1/ceph_mon/{host_uuid}.
This is inconsistent with the API documentation,
so update the partitions section of the API documentation.
code:https://github.com/starlingx/config/blob/
99616a7f72125c6fd5c86e5dd90af3d87ef3902c/sysinv/
cgts-client/cgts-client/cgtsclient/v1/ceph_mon.py#L55
Closes-Bug: #1899550
Change-Id: Ie1cc900a20d37246afeed740c9f67d5be405bae7
Signed-off-by: YuehuiLei<leiyuehui@inspur.com>
When I use /v1/storage_external/{storage_external_id},
I found that DELETE is not displayed in the document.
After analyzing "config\api-ref\source\api-ref-sysinv-v1-config.rst",
Lowercase delete should be DELETE, otherwise it cannot be displayed.
Closes-Bug: #1899445
Change-Id: Id79cfd5ae9ac0d7f5d234a7e6add46ca7f100e27
Signed-off-by: YuehuiLei<leiyuehui@inspur.com>
When I used the /v1/storage_file interface to
create a file storage backend, I found that
the request parameters backend and services
are mandatory and not optional.
Closes-Bug: #1899402
Change-Id: I9e78dc3f2623521185b7c6605015490ff0e09098
Signed-off-by: YuehuiLei<leiyuehui@inspur.com>
An error occurred when using the API interface
(/v1/itrapdest/{trapdest_id}) in the API document. After analyzing
the code, I found that the API interface should be /v1/itrapdest
/{ip_address}, so update this partition section of the API
documentation.
Closes-Bug:#1898961
Change-Id: Icd9e1d351050063e63aeb1edda1b8b4ee97218b5
Signed-off-by: Xinxin Shen<shenxinxin@inspur.com>
An error occurred while using the API interface
(/v1/storage_backend/usage) in the API documentation.
After analysis, I found that the submission
https://review.opendev.org/#/c/650619/ deleted the URL,
so the URL does not exist in the code, so please update
the API part of the document.
Closes-Bug:#1899138
Change-Id: I557d72507d367c7611102290b4d92419c1f5e9fb
Signed-off-by: XinxinShen<shenxinxin@inspur.com>
Update API reference doc to include new certificate_renew API.
Story: 2007347
Task: 40848
Change-Id: I314d95cb233eba6dc694c716b65be2167da094f0
Signed-off-by: Bin Qian <bin.qian@windriver.com>
An error occurred when using the URL interface of Infrastructure
Subnet. After analysis, it is found that the URL does not exist
in the starlingx/config code. See
https://review.opendev.org/#/c/656571/ for details. Therefore,
the Infrastructure Subnet part of the API documentation needs
to be deleted.
Change-Id: Icae1617c4b9c16592cfbd54f46391b9f70de5a19
Closes-Bug: #1888188
Signed-off-by: Xinxin Shen <shenxinxin@inspur.com>
An error occurred when using the profile part of the API documentation
(/v1/iprofiles and /v1/iprofiles/{profile_id}). After analyzing the code,
I found that the URLs set in the code are /v1/profile and
/v1/iprofile/{profile_id}. This is inconsistent with the API documentation,
so update the profile section of the API documentation.
Closes-Bug: #1887209
Change-Id: Id1222178ad0364ff712121566481448e873c5245
Signed-off-by: Xinxin Shen <shenxinxin@inspur.com>
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems
Update Sphinx version as well.
Disable openstackdocs_auto_name to use 'project' variable as name.
Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.
openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.
See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
Change-Id: I952b87de1d14b9c83dd0d7df8ab5d2ed0b30c555
This update adds cli and restapi to support FPGA device
programming.
CLI commands:
system device-image-apply
system device-image-create
system device-image-delete
system device-image-list
system device-image-remove
system device-image-show
system device-image-state-list
system device-label-list
system host-device-image-update
system host-device-image-update-abort
system host-device-label-assign
system host-device-label-list
system host-device-label-remove
Story: 2006740
Task: 39498
Change-Id: I556c2e7a51b3931b5a66ab27b67f51e3a8aebd9f
Signed-off-by: Teresa Ho <teresa.ho@windriver.com>
This update enhanced sysinv certificate install API to be able to
install multiple CA certs from a file. The returns from the API call
indicates the certs actually installed in the call (ie, excluding these
that are already in the system). This is neccessary especially for DC to
support multiple CA certs synchronization.
This update also added sysinv certficate uninstall API. The API is to
be used to remove a particular CA certficate from the system, identified
by its uuid. The API returns a json body with information about the
certificate that has been removed. This is required by DC sysinv api
proxy for certificate deletion synchronization, since DC tracks subcloud
certificates resource by signature while the uninstall API request
contains only uuid.
The uninstall API only supports ssl_ca certificate.
cgtsclient and system CLI are also updated to align with the updated
and new APIs. User can use "system certificate-install ..." to install
one or multiple CA certificates, and "system certificate-uninstall ..."
to remove a particular CA certificate from the system.
When multiple CA certificates are installed in the system,
"system certificate-list" will display each of the individual
certificates.
THe sysinv certificate configuration API reference is updated with the
new uninstall API. Unit tests are added for CA certificate install and
delete APIs.
Change-Id: I7dba11e56792b7d198403c436c37f71d7b7193c9
Depends-On: https://review.opendev.org/#/c/711633/
Closes-Bug: 1861438
Closes-Bug: 1860995
Signed-off-by: Andy Ning <andy.ning@windriver.com>
Add the PTP apply function to the API ref and the unit tests.
Story: 2006759
Task: 38848
Change-Id: Iae3cc9e90b653fd92a83a0d9a216d87016cf4c6c
Signed-off-by: David Sullivan <david.sullivan@windriver.com>
Test cases added for API endpoints used by:
1. host-fs-list
2. host-fs-modify
3. host-fs-show
This commit also fixes the issue of Host FS disk space calculations
yielding different values in Python 2 and Python 3.
Change-Id: I50a1ca43c43c3bba30730c616b3788664920d0c9
Story: 2007082
Task: 38013
Partial-Bug: 1862668
Signed-off-by: Jessica Castelino <jessica.castelino@windriver.com>
- Use updated project name in titles/text
- Correct text for link to Storyboard (docs)
- Correct capitalization in section headings
- Correct formatting for section headings
- Update project name in link to release notes, api-ref
- Update project name in config for docs/releasenotes/api-ref
Story:2007193
Task:38336
Change-Id: Ia01582558ab27accb68ccdf00d492f5e79689f04
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
The NTP/PTP selection will now be done per host. NTP will the default
selection.
This commit;
-Removes the enabled flag NTP and PTP API. Updates the CLI commands
and the database.
-Adds the parameter clock_synchronization to the host API. Valid
values are ‘ntp’ and ‘ptp’. Updates the host CLI commands and the
database.
-Updates puppet to set NTP/PTP per host .
-Updates the RestAPI documentation.
Story: 2006499
Task: 36464
Change-Id: I37bbb30a014301f8786cb02e35f0a1bd39d2f4aa
Signed-off-by: Kristine Bujold <kristine.bujold@windriver.com>
rummadis