Enabling Basic Ceph Support in openATTIC¶
openATTIC depends on Ceph’s librados Python bindings for performing many Ceph management and monitoring tasks, e.g. the management of Ceph Pools or RADOS block devices.
Ceph support in openATTIC is currently developed against Ceph 12.1.0 aka “Luminous”. Older Ceph versions may not work as expected. If your Linux distribution ships an older version of Ceph (as most currently do), please either use the upstream Ceph package repositories or find an alternative package repository for your distribution that provides a version of Ceph that meets the requirements. Note that this applies to both the version of the Ceph tools installed on the openATTIC node as well as the version running on your Ceph cluster.
To set up openATTIC with Ceph you first have to copy the Ceph administrator keyring and configuration from your Ceph admin node to your local openATTIC system.
From your Ceph admin node, you can perform this step by using
(assuming that you can perform SSH logins from the admin node into the
# ceph-deploy admin openattic.yourdomain.com
On the openATTIC node, you should then have the following files:
Please ensure that these files are actually readable by the openATTIC system user
openattic by default). This could be done by making them readable by the
openattic user group:
# chgrp openattic /etc/ceph/ceph.conf /etc/ceph/ceph.client.admin.keyring # chmod g+r /etc/ceph/ceph.conf /etc/ceph/ceph.client.admin.keyring
Alternatively, you can copy these files manually.
openATTIC partially supports managing multiple Ceph clusters, provided they have
different names and FSIDs. You can add another cluster by copying the
cluster’s admin keyring and configuration into
/etc/ceph using a different
cluster name, e.g.
development instead of the default name
It is also possible to configure a Ceph cluster’s configuration and keyring file
in the settings file
CEPH_CLUSTERS is a string setting containing paths to
Multiple clusters can be added by seperating them with a
; sign like so:
For each Ceph cluster, one can set the path to the keyring file by adding
CEPH_KEYRING_ appended by the uppercase cluster fsid as follows:
It is also possible to define a specific user name for each cluster, by adding
CEPH_KEYRING_USER_ appended by the uppercase cluster fsid, like so:
The last step is to recreate your openATTIC configuration:
# oaconfig install
DeepSea integration in openATTIC¶
DeepSea is a Ceph installation and management framework developed by SUSE which is based on the Salt Open automation and orchestration software. It highly automates the deployment, configuration and management of an entire Ceph cluster and all of its components.
Some openATTIC features like iSCSI target and Ceph object gateway (RGW) management depend on communicating with DeepSea via the Salt REST API.
To enable the REST API of DeepSea you would have to issue the following command on the Salt master node:
salt-call state.apply ceph.salt-api
By default, openATTIC assumes that Salt master hostname is
salt, API port is
and API username is
admin. If you need to change any of this default values, you
should configure it in either
/etc/default/openattic for Debian-based
distributions or in
/etc/sysconfig/openattic for RedHat-based distributions
as well as SUSE Linux.
Available settings are:
SALT_API_HOST="salt" SALT_API_PORT="8000" SALT_API_USERNAME="admin" SALT_API_PASSWORD="admin"
Do not use spaces before or after the equal signs
Ceph Object Gateway management features¶
If you want to enable the Ceph Object Gateway management features, and you are using
DeepSea, you just have to guarantee that the Salt REST API is correctly
configured (see DeepSea integration in openATTIC). In case you are not using DeepSea,
you have to configure the Rados Gateway manually by editing either
/etc/default/openattic for Debian-based distributions or
/etc/sysconfig/openattic for RedHat-based distributions as well as SUSE
This is an example for the manually configured Rados Gateway credentials:
RGW_API_HOST="ceph-1" RGW_API_PORT=80 RGW_API_SCHEME="http" RGW_API_ACCESS_KEY="VFEG733GBY0DJCIV6NK0" RGW_API_SECRET_KEY="lJzPbZYZTv8FzmJS5eiiZPHxlT2LMGOMW8ZAeOAq"
If your Rados Gateway admin resource isn’t configured to use the default
admin (e.g. http://host:80/admin), you will need to also set the
RGW_API_ADMIN_RESOURCE option appropriately.
You can obtain these credentials by issuing the
radosgw-admin command like
radosgw-admin user info --uid=admin
openATTIC Base Configuration¶
After all the required packages have been installed, you need to perform the
actual openATTIC configuration, by running
# oaconfig install
oaconfig install will start and enable a number of services, initialize
the openATTIC database and scan the system for.
Changing the Default User Password¶
oaconfig creates a local adminstrative user account
openattic, with the same password.
As a security precaution, we strongly recommend to change this password immediately:
# oaconfig changepassword openattic Changing password for user 'openattic' Password: <enter password> Password (again): <re-enter password> Password changed successfully for user 'openattic'
Now, your openATTIC storage system can be managed via the user interface.
See Getting started for instructions on how to access the web user interface.
If you don’t want to manage your users locally, consult the chapter Configuring Authentication and Single Sign-On for alternative methods for authentication and authorization.