summaryrefslogtreecommitdiffstats
path: root/README.md (follow)
Commit message (Collapse)AuthorAgeFilesLines
* doc: README.md - improve "Tshooting" and "Tips & Tricks"Zac Dover14 days1-24/+30
| | | | | | | | | | | | | | | | | | Improve the formatting and English language in the sections "Troubleshooting" and "Tips and Tricks", and move those sections to a place where they don't interrupt the flow of the vstart cluster installation instructions. Some of the strings in "Tips and Tricks" are not yet unambiguous sentences that will make sense to the uninitiated, but this PR represents a step in that direction. This PR is part of a series of PRs meant to preserve the integrity of the README.md file after some recent additions that break the flow of the document. This PR follows https://github.com/ceph/ceph/pull/61226 and https://github.com/ceph/ceph/pull/61221. Signed-off-by: Zac Dover <zac.dover@proton.me>
* doc: README.md - format "Troubleshooting"Zac Dover2025-01-031-9/+8
| | | | | | | | | | | | | Format "Troubleshooting" into its own section so that it doesn't confuse readers of the vstart installation procedure. This PR is part of a series of PRs meant to preserve the integrity of the README.md file after some recent additions that break the flow of the document. This PR follows https://github.com/ceph/ceph/pull/61221. Signed-off-by: Zac Dover <zac.dover@proton.me>
* doc: README.md - format "Tips and Tricks"Zac Dover2025-01-031-12/+9
| | | | | | | Format "Tips and Tricks" into its own section so that it doesn't confuse readers of the vstart installation procedure. Signed-off-by: Zac Dover <zac.dover@proton.me>
* doc: README.md - format admonitionZac Dover2024-12-291-1/+1
| | | | | | | Format an admonition correctly. This commit is a prelude to a cleanup of a recent addition to README.md. Signed-off-by: Zac Dover <zac.dover@proton.me>
* doc: Update vstart section in readme.mdShrish00982024-12-231-0/+31
| | | | | | Add guidance about vstart clusters to README.md. Signed-off-by: Shrish Mishra <shrish409@gmail.com>
* README: add OpenSSF Best Practices BadgeErnesto Puerta2024-09-301-0/+1
| | | | | | | | | | This effort was started long time ago by Mike Perez.[1] I now completed the remaining steps to achieve the Passing level of the OpenSSF Best Practices Badge.[2] It should be used as an opportunity to implement best practices in the Ceph community. For example, the Passing level was achieved without meeting the optional compliance with Dynamic Analysis or Security Scanning. [1] https://www.bestpractices.dev/en/projects/2220 [2] https://www.bestpractices.dev/en/criteria/0 Signed-off-by: Ernesto Puerta <37327689+epuertat@users.noreply.github.com>
* doc/README.md: create selectable commandsZac Dover2024-09-141-4/+4
| | | | | | | | | An indentation of five spaces relative to the previous line creates a command that is copyable with a single mouse click. This commit adds those copyabale commands to the procedure in the section "Building Ceph". Signed-off-by: Zac Dover <zac.dover@proton.me>
* doc/README.md: improve formattingZac Dover2024-09-111-5/+6
| | | | | | | Improve the formatting in the section "Building Ceph" in the file README.md. Signed-off-by: Zac Dover <zac.dover@proton.me>
* doc/README.md: improve formattingZac Dover2024-09-091-8/+8
| | | | | | | Improve the formatting of the section "Building Ceph" in the file README.md. Signed-off-by: Zac Dover <zac.dover@proton.me>
* doc/README.md: edit "Build Prerequisites"Zac Dover2024-09-061-6/+8
| | | | | | | Make the sentences in the "Build Prerequisites" section of README.md more direct. Signed-off-by: Zac Dover <zac.dover@proton.me>
* doc/README.md - add "tip" alert stylingZac Dover2024-08-081-13/+14
| | | | | | | | Add "tip" alert styling (what in Docbook XML is called "an admonition") to information about Ninja in an ordered list (which is what markdown has here instead of procedures). Signed-off-by: Zac Dover <zac.dover@proton.me>
* doc/README.md - allocate information correctlyZac Dover2024-08-071-19/+22
| | | | | | | | | Add information in the "Building Ceph" procedure to the steps where it belongs. Add information about "do_cmake.sh" to the step about "do_cmake.sh". Add information about Ninja to the step about Ninja. Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com> Signed-off-by: Zac Dover <zac.dover@proton.me>
* doc/README.md - add ordered listZac Dover2024-08-051-5/+12
| | | | | | Add ordered-list formatting to the "Building Ceph" section of README.md. Signed-off-by: Zac Dover <zac.dover@proton.me>
* doc: add status badge for backport creationPatrick Donnelly2024-05-141-0/+3
| | | | Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
* cmake: add --progress flag to git submodule update commandsRishabh Dave2023-10-311-1/+1
| | | | | | | | | Ceph has lots of submodules that needs to be cloned before building binaries from the repository. Seeing the progress when these submodules are being cloned is useful, especially when developers/users have a network issue or a slow network. Signed-off-by: Rishabh Dave <ridave@redhat.com>
* doc: update test cluster commands in README.mdZac Dover2023-09-081-1/+1
| | | | | | | The "rbd" pool has not been created by default since Luminous. This commit removes a command that assumed the existence of the "rbd" pool. Signed-off-by: Zac Dover <zac.dover@proton.me>
* doc/README.md - improve "Running a test cluster"Zac Dover2023-09-011-5/+6
| | | | | | | Improve the English in the section "Running a test cluster in the ceph/README.md file. Signed-off-by: Zac Dover <zac.dover@proton.me>
* doc/README.md - improve "CMake Options"Zac Dover2023-08-211-16/+27
| | | | | | | | Add subheadings to the "CMake Options" section of ceph/README.md. Remove modal verbs when appropriate and make sentences tidier. Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com> Signed-off-by: Zac Dover <zac.dover@proton.me>
* doc/README.md - edit "Building Ceph"Zac Dover2023-08-201-19/+27
| | | | | | | Improve the "Building Ceph" section of ceph/README.md. Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com> Signed-off-by: Zac Dover <zac.dover@proton.me>
* doc: edit README.md - contributing codeZac Dover2023-08-171-12/+14
| | | | | | Edit the "Contributing Code" section of the "ceph/README.md" file. Signed-off-by: Zac Dover <zac.dover@proton.me>
* doc: improve submodule update command - README.mdZac Dover2023-08-151-3/+4
| | | | | | | | | Improve the portion of README.md that directs the reader to update the submodules. Previously, the text assumed that the reader knew that they should cd into the ceph directory. Now the text is explicit about the necessity of this action. Signed-off-by: Zac Dover <zac.dover@proton.me>
* doc: update README.md install procedureZac Dover2023-07-271-0/+6
| | | | | | | | | Add instructions directing the reader to install the "python3-routes" package. This package is required in order to launch the dashboard after the installation procedure has completed, but is not yet included in the install-deps.sh script. Signed-off-by: Zac Dover <zac.dover@proton.me>
* doc: update README.mdZac Dover2023-07-251-18/+27
| | | | | | Correct and improve ceph/README.md. Signed-off-by: Zac Dover <zac.dover@proton.me>
* doc: remove leveldb support from docluo rixin2023-05-041-2/+1
| | | | Signed-off-by: luo rixin <luorixin@huawei.com>
* Update README.mdSHANKAR2023-01-291-1/+1
| | | Signed-off-by: SHANKAR <98207888+evershalik@users.noreply.github.com>
* README.md: HTTP => HTTPSKai2022-07-031-1/+1
| | | | | | Switching the link http://ceph.com/ from HTTP to HTTPS, so https://ceph.com/, to skip the redirect when opening it. (http://ceph.com/ is being redirected to https://ceph.com/) Signed-off-by: Kai Hollberg <kai.hollberg@googlemail.com>
* README: document cmake options for system packagesCasey Bodley2022-03-311-0/+8
| | | | Signed-off-by: Casey Bodley <cbodley@redhat.com>
* README.md: Update README.md to add link to tracker.ceph.comJohn Bent2022-01-051-0/+3
| | | | | | | I searched the existing documentation for a link to the tracker and had a hard time finding it. Other folks like myself might like it so prominently displayed. Added a link to https://tracker.ceph.com/projects/ceph as https://tracker.ceph.com/ is basically blank and not totally intuitive how to get to issues. Signed-off-by: John Bent <john.bent@seagate.com>
* README.md: recommend -Og instead of -O0Kefu Chai2021-07-201-1/+1
| | | | | | | | | | | | | | | | | per https://gcc.gnu.org/onlinedocs/gcc/Optimize-Options.html > -Og > Optimize debugging experience. -Og should be the optimization level of > choice for the standard edit-compile-debug cycle, offering a reasonable > level of optimization while maintaining fast compilation and a good > debugging experience. It is a better choice than -O0 for producing > debuggable code because some compiler passes that collect debug > information are disabled at -O0. so instead of using -O0, for better developer experience, -Og is recommended. Signed-off-by: Kefu Chai <kchai@redhat.com>
* README.md: fix couple minor syntax issuesSrishti Guleria2021-07-081-7/+7
| | | | Signed-off-by: Srishti Guleria <guleriasrishti01@gmail.com>
* README.md: remove extra 'the' and format para related to ninjaVarsha Rao2021-03-261-6/+6
| | | | Signed-off-by: Varsha Rao <varao@redhat.com>
* README.md: correct notes on `-j` optionKefu Chai2021-03-121-4/+5
| | | | Signed-off-by: Kefu Chai <kchai@redhat.com>
* README.md: replace "make" by "ninja"Rishabh Dave2021-03-121-11/+11
| | | | | | Update README.md since ninja is the default generator now. Signed-off-by: Rishabh Dave <ridave@redhat.com>
* cmake: do not check OFED_PREFIX anymoreKefu Chai2020-08-011-2/+2
| | | | | | | | | | OFED_PREFIX was added to compile with xio messenger for supporting RDMA using the Accelio and/or MLNX_OFED package. but xio messenger was removed in in cc9a9142fd41ee5c98792c6f6d2e5504 let remove the leftover in CMakeLists Signed-off-by: Kefu Chai <kchai@redhat.com>
* README.md: remove stale cmake prerequisiteKefu Chai2020-01-211-2/+0
| | | | | | | | | it's stale. as we now require 3.10 after dropping the support of xenial. and it's incomplete, we have a ton of build dependencies apart from cmake. Signed-off-by: Kefu Chai <kchai@redhat.com>
* do_cmake.sh: Add CEPH_GIT_DIRMatthew Oliver2019-11-041-4/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | This patch adds a new env variables that users can set to define the location of the checked out ceph git repo. The documentation mentions having to go edit the script directly to point to the ceph git directory if the build dir isn't in the top directory of the checked out git repo. This patch changes the '..' into an env variable, CEPH_GIT_DIR, that defaults to '..'. To make it easy to script and change. This allows someone to do things like: export CEPH_GIT_DIR=~/git/ceph ./do_cmake.sh or CEPH_GIT_DIR=~/git/ceph ./do_cmake.sh Which is much better then editing the script directly. The README.md has been modified to mention this variable and also includes a drive by to mention `make -j` for new contributors to build ceph quicker. Signed-off-by: Matthew Oliver <moliver@suse.com>
* relicense LGPL-2.1 code as LGPL-2.1 or LGPL-3.0Sage Weil2019-04-221-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | The primary motivation to relicense is a desire to integrate with projects that are licensed under the Apache License version 2.0. Although opinions vary, there are some who argue the the LGPL-2.1 and Apache-2.0 licenses are not fully compatible. We would like to avoid the ambiguity and potential for controversy. Projects we would like to consume that are Apache-2.0 licensed include Seastar, OpenSSL (which is in the process of relicensing to Apache-2.0), and Swagger (swagger.io). Note that some of these are dynamically linked or consumed via a high-level language and may or may not require a change to LGPL-3.0, but providing the option for LGPL-3.0 certainly avoids any uncertainty. A few other source files are already incorporated into Ceph that claim an Apache-2.0 license: src/common/deleter.h src/common/sstring.h src/include/cpp-btree The Ceph developers would further like to provide a license option that is more modern than the current LGPL-2.1. LGPL-3.0 includes updated, clarified language around several issues and is widely considered more modern, superior license. Signed-off-by: Sage Weil <sage@redhat.com>
* README.md: Add note about default do_cmake.sh debug builds.Mark Nelson2018-12-121-0/+5
| | | | Signed-off-by: Mark Nelson <mnelson@redhat.com>
* README.md: bump up required cmake to 3.5.1Kefu Chai2018-10-091-1/+1
| | | | | | we started to use cmake 3.5.1 back in 34f1ee78 Signed-off-by: Kefu Chai <kchai@redhat.com>
* legal: remove doc license ambiguityNathan Cutler2018-03-131-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | The license applicable to the files under doc/ was originally declared (in the top-level file COPYING) to be "Creative Commons Attribution-ShareAlike (CC BY-SA)" by ed0653b493a3f919a3abc37a0aa9b5aa29ae0b0e This license declaration omitted a version number. Some time later ef7418421b3748c712019c8aedd02b8005c1e1ea was merged, mentioning CC-BY-SA-1.0 as one of the Ceph source code licenses. Although the purpose of that commit was only to summarize the canonical license information from COPYING, it unintentionally became the only place in the source code where the doc license version was specified. In March 2018, the Debian project warned that CC-BY-SA-1.0 does not meet its criteria for inclusion in the "free" section of the Debian distribution. (For that, at least version 3.0 must be used.) This new commit removes the doc license ambiguity by setting it to CC-BY-SA-3.0 in all places where the license is mentioned. The exact spelling of the license name is taken from https://spdx.org/licenses/ Fixes: http://tracker.ceph.com/issues/23336 Signed-off-by: Nathan Cutler <ncutler@suse.com>
* doc/README: mention about ARGS in do_cmakeAbhishek Lekshmanan2018-01-101-1/+5
| | | | | | Add an example on how to use ARGS to override cmake builds Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
* doc: make the commands in README.md properly alignedYao Zongyou2017-10-311-11/+11
| | | | | | | | The commands in README.md are aligned using one tab or eight spaces, the github markdown engine not handle this properly, so using one tab universely. Signed-off-by: Yao Zongyou <yaozongyou@vip.qq.com>
* README.md: bump up cmake to 2.8.12Yan Jun2017-10-171-1/+1
| | | | Signed-off-by: Yan Jun <yan.jun8@zte.com.cn>
* README: Improve vstart.sh usageFabian Vogt2017-09-111-1/+1
| | | | | | | Using long options where possible to make it easier to understand directly and adding bluestore by default as it is the default storage backend. Signed-off-by: Fabian Vogt <fvogt@suse.com>
* README: quote file names with "`"Kefu Chai2017-07-271-5/+5
| | | | Signed-off-by: Kefu Chai <kchai@redhat.com>
* Merge pull request #14555 from yaozongyou/fix-readme-notconsistentKefu Chai2017-04-181-1/+1
|\ | | | | | | | | README.md: fix build instructions inconsistent. Reviewed-by: Kefu Chai <kchai@redhat.com>
| * Fix build instructions inconsistent.Yao Zongyou2017-04-141-1/+1
| | | | | | | | Signed-off-by: Yao Zongyou <yaozongyou@vip.qq.com>
* | README.md: use github heading syntax to mark the headingsKefu Chai2017-04-171-25/+12
|/ | | | Signed-off-by: Kefu Chai <kchai@redhat.com>
* README: hint at where to look to diagnose test failuresDan Mick2016-11-101-0/+2
| | | | Signed-off-by: Dan Mick <dan.mick@redhat.com>
* README.md: replace package build instructions with tarball instructionsSage Weil2016-08-231-10/+8
| | | | Signed-off-by: Sage Weil <sage@redhat.com>
generated by cgit v1.2.3 (git 2.39.1) at 2025-01-18 11:47:25 +0100