Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add performance considerations chapter #1597

Open
wants to merge 31 commits into
base: master
Choose a base branch
from

Conversation

pstorz
Copy link
Member

@pstorz pstorz commented Nov 14, 2023

Thank you for contributing to the Bareos Project!

Please check

  • Short description and the purpose of this PR is present above this paragraph
  • Your name is present in the AUTHORS file (optional)

If you have any questions or problems, please give a comment in the PR.

Helpful documentation and best practices

Checklist for the reviewer of the PR (will be processed by the Bareos team)

Make sure you check/merge the PR using devtools/pr-tool to have some simple automated checks run and a proper changelog record added.

General
  • Is the PR title usable as CHANGELOG entry?
  • Purpose of the PR is understood
  • Commit descriptions are understandable and well formatted
  • Check backport line
  • Required backport PRs have been created
Source code quality
  • Source code changes are understandable
  • Variable and function names are meaningful
  • Code comments are correct (logically and spelling)
  • Required documentation changes are present and part of the PR
Tests
  • Decision taken that a test is required (if not, then remove this paragraph)
  • The choice of the type of test (unit test or systemtest) is reasonable
  • Testname matches exactly what is being tested
  • On a fail, output of the test leads quickly to the origin of the fault

@pstorz pstorz added the documentation This PR changes only documentation label Nov 14, 2023
@pstorz pstorz force-pushed the dev/pstorz/master/docs-performance-compression branch from 354294e to 0da5167 Compare November 14, 2023 14:04
- xfs on ssd partition
* - **Storage Filesystem**
- tmpfs 10G ramdisk

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be nice to have the output of openssl testing test.

openssl speed md5 sha1 sha256 sha512
version: 3.1.4

options: bn(64,64)
compiler: gcc -fPIC -pthread -m64 -Wa,--noexecstack -Wall -O3 -O2 -Wall -U_FORTIFY_SOURCE -fstack-protector-strong -funwind-tables -fasynchronous-unwind-tables -fstack-clash-protection -Werror=return-type -flto=auto -g -Wa,--noexecstack -fno-common -Wall -DOPENSSL_USE_NODELETE -DL_ENDIAN -DOPENSSL_PIC -DOPENSSL_BUILDING_OPENSSL -DZLIB -DNDEBUG -D_FORTIFY_SOURCE=3 -DTERMIO -DPURIFY -D_GNU_SOURCE -DOPENSSL_NO_BUF_FREELISTS -DSYSTEM_CIPHERS_FILE="/etc/crypto-policies/back-ends/openssl.config"
CPUINFO: OPENSSL_ia32cap=0x7ffaf3ffffebffff:0x29c67af
The 'numbers' are in 1000s of bytes per second processed.
type             16 bytes     64 bytes    256 bytes   1024 bytes   8192 bytes  16384 bytes
md5              42047.62k   139503.13k   322998.78k   482274.30k   587265.37k   606262.61k
sha1             52591.86k   171246.51k   421058.82k   662665.56k   791098.71k   825567.91k
sha256           41911.55k   109063.49k   239631.24k   315815.59k   351338.50k   347586.56k
sha512           31209.98k   126040.62k   264445.44k   446635.35k   546570.24k   536024.41k

Copy link
Contributor

@sebsura sebsura left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Those are some great additions to the documentation. While skimming the text i noticed the following things:

Comment on lines 462 to 465

set(comp_algo "lz4hc")
set(checksum_algo "sha512")

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are those still used ?

Address = @hostname@
Password = "@fd_password@"
Fd Port = @fd_port@
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing new line ?

Comment on lines 2 to 4
# /testspace/pstorz/data_kernelsource
/testspace/pstorz/data_multimedia
# /testspace/pstorz/data_rootfs
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The default here should probably be something that always exists.

Only *LZO* and *No Compression* are regarded.


No TLS with no Encryption
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
No TLS with no Encryption
No TLS with no Compression


Speed comparison [MiB/s] when TLS is disabled and no compression is configured.

No TLS with LZO Encryption
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
No TLS with LZO Encryption
No TLS with LZO Compression

log="$restore_log-$clientoptions_filenamecompat-$filesetoptions_filenamecompat"
echo > "$log"
# clean restore dir
sudo rm -Rvf "$tmp/bareos-restores"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a very bad idea. I think the sudo is not supposed to be here ?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also there are a lot of complaints from shellcheck here.

@pstorz pstorz force-pushed the dev/pstorz/master/docs-performance-compression branch from cfe24c2 to 92e8487 Compare November 27, 2023 17:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This PR changes only documentation onhold
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants