Bug 1302782

Summary:	Adjust CRUSH Tunables section needs "sudo"
Product:	[Red Hat Storage] Red Hat Ceph Storage	Reporter:	Ken Dreyer (Red Hat) <kdreyer>
Component:	Documentation	Assignee:	John Wilkins <jowilkin>
Status:	CLOSED CURRENTRELEASE	QA Contact:	Ramakrishnan Periyasamy <rperiyas>
Severity:	unspecified	Docs Contact:
Priority:	unspecified
Version:	1.3.2	CC:	asriram, flucifre, hnallurv, jowilkin, kdreyer, ngoswami
Target Milestone:	rc
Target Release:	1.3.3
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	Bug Fix
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2016-09-30 17:21:53 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:

Description Ken Dreyer (Red Hat) 2016-01-28 15:42:25 UTC

Description of problem:
The "Adjust CRUSH Tunables" section of quick-ceph-deploy.adoc has the following command:

  ceph osd crush tunables optimal

This command requires the cephx admin keyring. If that keyring was set up by ceph-deploy (as our docs describe with "ceph-deploy admin <calamarinode>), then the "ceph" command will not work if it's run by an unprivileged user on the Calamari admin node. The user must run all cephx-authenticated ceph commands with "sudo".

Version-Release number of selected component (if applicable):
Latest quick-ceph-deploy.adoc for both RHEL and Ubuntu.


Steps to Reproduce:
1. Set up a cluster, following the documentation.
2. As described in the installation guide, run `ceph-deploy admin <calamarinode>` to install the admin keyring to the calamari admin node.
3. Run `ceph osd crush tunables optimal` as described in the guide.


Actual results:
Permission error

Expected results:
The command successfully sets crush tunables

Additional info:
Maybe we want to add "sudo" into the "Storage Strategies" document as well? https://access.redhat.com/documentation/en/red-hat-ceph-storage/1.3/storage-strategies/chapter-9-crush-tunables What do you think?

Comment 2 John Wilkins 2016-02-09 20:48:11 UTC

Added "as root" commentary to make it consistent with platform docs.

See https://gitlab.cee.redhat.com/red-hat-ceph-storage-documentation/doc-Red_Hat_Ceph_Storage_1.3-Installation_Guide_for_Red_Hat_Enterprise_Linux/commit/de7a1ceb734ade628a9864b9ff46a3a136b8bedb

Comment 3 Ramakrishnan Periyasamy 2016-09-06 11:55:50 UTC

Please provide stage area link to verify this bug. Gitlab access not available.

Comment 4 John Wilkins 2016-09-14 15:46:03 UTC

https://access.qa.redhat.com/documentation/en/red-hat-ceph-storage/1.3/single/installation-guide-for-red-hat-enterprise-linux/#adjust_crush_tunables

Comment 5 Ramakrishnan Periyasamy 2016-09-15 10:58:16 UTC

As per the bug "ceph osd crush tunables optimal" command need to be run as "root" user or the command should be prefixed with "sudo".

In Document "2.10. Adjust CRUSH Tunables" Section is not updated accordingly.

Suggesting to add "sudo" prefix to the command (sudo ceph osd crush tunables optimal) or add a note saying that "run this command as root user".

Comment 6 Federico Lucifredi 2016-09-15 12:23:13 UTC

You can say that the command needs to be executed with root privilege and leave it to the admin to know to use sudo on Ubuntu.

Comment 7 John Wilkins 2016-09-19 18:49:43 UTC

Added "as root" phraseology per Federico: 

https://access.qa.redhat.com/documentation/en/red-hat-ceph-storage/1.3/single/installation-guide-for-red-hat-enterprise-linux/#adjust_crush_tunables

https://access.qa.redhat.com/documentation/en/red-hat-ceph-storage/1.3/single/installation-guide-for-ubuntu/#adjust_crush_tunables

Comment 8 Ramakrishnan Periyasamy 2016-09-20 05:09:26 UTC

Verified the document for ubuntu and RHEL.