starlingx
/
config-files
Code Issues Proposed changes

Migrate io-scheduler package to Debian 

Modified io-scheduler package to add support to Debian packaging.

PASS: built image successfully
PASS: installed image successfully (with io-scheduler)
PASS: build updated latest image (fresh env)
PASS: bootstrap and unlock successfully

Story: 2009256
Task: 45064

Signed-off-by: Thayna Santos <Thayna.EmillyCavalcanteSantos@windriver.com>
Change-Id: I4a6b93e28d07e244f484a9842edc6d02d0213529
This commit is contained in:
Thayna Santos 2022-04-19 16:36:47 -04:00 committed by Thayná Emilly Cavalcante Santos
parent e24f835db4
commit a108b646db
12 changed files with 365 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
debian_pkg_dirs
View File

@ -6,6 +6,7 @@ docker-config
filesystem-scripts
haproxy-config
initscripts-config
io-scheduler
iptables-config
lighttpd-config
lvm2-config

202
io-scheduler/debian/deb_folder/LICENSE Normal file
View File

@ -0,0 +1,202 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

5
io-scheduler/debian/deb_folder/changelog Normal file
View File

@ -0,0 +1,5 @@
io-scheduler (1.0-1) unstable; urgency=medium
* Initial release
-- Thayna Santos <Thayna.EmillyCavalcanteSantos@windriver.com> Fri, 14 Apr 15:11:30 -0300

12
io-scheduler/debian/deb_folder/control Normal file
View File

@ -0,0 +1,12 @@
Source: io-scheduler
Section: admin
Priority: optional
Maintainer: StarlingX Developers <starlingx-discuss@lists.starlingx.io>
Build-Depends: debhelper-compat (= 13)
Standards-Version: 4.5.1
Homepage: https://www.starlingx.io
Package: io-scheduler
Architecture: any
Description: StarlingX io-scheduler configuration files
StarlingX io-scheduler configuration and tuning.

27
io-scheduler/debian/deb_folder/copyright Normal file
View File

@ -0,0 +1,27 @@
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
Upstream-Name: io-scheduler
Source: https://opendev.org/starlingx/config-files
Files: *
Copyright: (c) 2013-2022 Wind River Systems, Inc
License: Apache-2
Files: debian/*
Copyright: 2022 Wind River Systems, Inc
License: Apache-2
License: Apache-2
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
.
https://www.apache.org/licenses/LICENSE-2.0
.
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
.
On Debian-based systems the full text of the Apache version 2.0 license
can be found in `/usr/share/common-licenses/Apache-2.0'.

1
io-scheduler/debian/deb_folder/io-scheduler.dirs Normal file
View File

@ -0,0 +1 @@
etc/udev/rules.d

1
io-scheduler/debian/deb_folder/io-scheduler.install Normal file
View File

@ -0,0 +1 @@
etc/udev/rules.d/60-io-scheduler.rules

8
io-scheduler/debian/deb_folder/postinst Normal file
View File

@ -0,0 +1,8 @@
#!/bin/sh
set -e
udevadm control --reload-rules
udevadm trigger --type=devices --subsystem-match=block
#DEBHELPER#

11
io-scheduler/debian/deb_folder/rules Normal file
View File

@ -0,0 +1,11 @@
#!/usr/bin/make -f
#export DH_VERBOSE = 1
ROOT := $(CURDIR)/debian/tmp
%:
dh $@
override_dh_install:
install -p -D -m 644 60-io-scheduler.rules ${ROOT}/etc/udev/rules.d/60-io-scheduler.rules
dh_install

1
io-scheduler/debian/deb_folder/source/format Normal file
View File

@ -0,0 +1 @@
3.0 (quilt)

7
io-scheduler/debian/meta_data.yaml Normal file
View File

@ -0,0 +1,7 @@
---
debname: io-scheduler
debver: 1.0-1
src_path: source-debian
revision:
dist: $STX_DIST
PKG_GITREVCOUNT: true

89
io-scheduler/source-debian/60-io-scheduler.rules Normal file
View File

@ -0,0 +1,89 @@
# This file contains the rules to customize io scheduler.
# Need nodetype environment variable
IMPORT{file}="/etc/platform/platform.conf"
# 3.10 kernel
# Heuristics:
# 'deadline' io-scheduler tuned settings
# - deadline generally recommended for databases, servers, and SSDs,
# and for more deterministic latency
# - note that read_expire is a key tuning parameter here
# - the following is recommended by DRBD user guide
# front_merges: 0 (from 1)
# read_expire: 150 (from 500)
# write_expire: 1500 (from 5000)
#
# 'cfq' io scheduler tuned settings
# - recommended for HDD, and fairness (ionice)
# - the following tuned values greatly improve parallelism,
# and performance in large storage environments
# slice_idle: 0 (from 8)
# quantum: 32 (from 8)
#
# 'noop' io scheduler for variants of HW-RAID.
# - RAID controller will do its own separate scheduling
#
# Overall:
# - Historically we choose 'deadline' for low-latency, SSDs, and local storage;
# 'cfq' for worker non-sda HDDs, 'noop' for all variants of HW-RAID.
# - We prefer to guarantee latency more than fairness for all platform services,
# especially under extreme read and write load, e.g, when creating/deleting
# multiple heat stacks, or running disk intensive operations.
# - Kubernetes etcd server has better latency with cfq as compared
# to deadline even on SSDs.
# - This setting requires re-evaluation with io-schedulers
# (i.e., mq-deadline, bfq, kyber) available in new kernels.
# 5.10 kernel
# Heuristics:
# 'none'
# - Implements a first-in first-out (FIFO) scheduling algorithm. It
# merges requests at the generic block layer through a simple last-hit cache.
# 'mq-deadline'
# - Attempts to provide a guaranteed latency for requests from the point at
# which requests reach the scheduler.
# - This scheduler is suitable for most use cases, but particularly those in
# which the write operations are mostly asynchronous.
# 'bfq'
# - Targets desktop systems and interactive tasks.
# - The bfq scheduler ensures that a single application is never using all of
# the bandwidth. In effect, the storage device is always as responsive as if
# it was idle. In its default configuration, bfq focuses on delivering the
# lowest latency rather than achieving the maximum throughput.
# - bfq is based on cfq code. It does not grant the disk to each process for
# a fixed time slice but assigns a budget measured in number of sectors to the process.
# - This scheduler is suitable while copying large files and the system does not become
# unresponsive in this case.
# 'kyber'
# - The scheduler tunes itself to achieve a latency goal by calculating the latencies
# of every I/O request submitted to the block I/O layer. You can configure the target
# latencies for read, in the case of cache-misses, and synchronous write requests.
# - This scheduler is suitable for fast devices, for example NVMe, SSD, or other low
# latency devices.
#
# Overall:
# - Traditional HDD with a SCSI interface: Use mq-deadline or bfq
# - High-performance SSD or a CPU-bound system with fast storage: Use none,
# especially when running enterprise applications. Alternatively, use kyber.
# - Desktop or interactive tasks: Use bfq.
# - Virtual guest: Use mq-deadline. With a host bus adapter (HBA) driver that
# is multi-queue capable, use none.
ACTION=="add|change", SUBSYSTEM=="block", KERNEL=="sd[a-z]", \
ATTR{queue/scheduler}="mq-deadline", \
ATTR{queue/iosched/front_merges}="0", \
ATTR{queue/iosched/read_expire}="150", \
ATTR{queue/iosched/write_expire}="1500"
ACTION=="add|change", ENV{nodetype}=="controller", SUBSYSTEM=="block", KERNEL=="sd[a-z]", \
PROGRAM="/usr/local/bin/is-rootdisk-device.sh %E{DEVNAME}", RESULT=="?*", \
ATTR{queue/scheduler}="bfq", \
ATTR{queue/iosched/strict_guarantees}="1"
# Set none io scheduler for variants of HW-RAID.
# HP ProLiant DL360p Gen8; HP ProLiant DL380p Gen8
ACTION=="add|change", SUBSYSTEM=="block", KERNEL=="sd[a-z]", ATTRS{raid_level}=="*RAID*", ATTR{queue/scheduler}="none"
# Dell Inc. PowerEdge R720
ACTION=="add|change", SUBSYSTEM=="block", KERNEL=="sd[a-z]", ATTRS{label}=="*RAID*", ATTR{queue/scheduler}="none"