ceph
/
ceph-ansible
mirror of https://github.com/ceph/ceph-ansible.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Cleanup readme files in roles directories 

The contents of the README files are no longer up to date.
Documentation for all roles is located below the docs directory.
pull/2062/head
Christian Berendt 2017-10-17 10:44:58 +02:00
parent ddb878d938
commit 4c380c9ef8
17 changed files with 35 additions and 750 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
roles/ceph-agent/README.md
View File

@ -1,41 +1,3 @@
# Ansible role: Ceph Storage Agent # Ansible role: ceph-agent
This role bootstraps the Ceph Storage Agent. Documentation is available at http://docs.ceph.com/ceph-ansible/.
# Requirements
Nothing, it runs out of the box.
# Role variables
Have a look at: `defaults/main.yml`.
## Mandatory variables
None.
# Dependencies
None.
# Example Playbook
```
- hosts: servers
remote_user: ubuntu
roles:
- { role: leseb.ceph-agent }
```
# Contribution
**THIS REPOSITORY DOES NOT ACCEPT PULL REQUESTS**
**PULL REQUESTS MUST GO THROUGH [CEPH-ANSIBLE](https://github.com/ceph/ceph-ansible)**
# License
Apache
# Author Information
This role was created by Alfredo Deza.

42
roles/ceph-client/README.md
View File

@ -1,41 +1,3 @@
# Ansible role: Ceph Client # Ansible role: ceph-client
This role bootstraps all the necessary bits to run a Ceph client. Documentation is available at http://docs.ceph.com/ceph-ansible/.
# Requirements
Nothing, it runs out of the box.
# Role variables
Have a look at: `defaults/main.yml`.
## Mandatory variables
None.
# Dependencies
The role `ceph.ceph-common` must be installed.
# Example Playbook
```
- hosts: servers
remote_user: ubuntu
roles:
- { role: ceph.ceph-client }
```
# Contribution
**THIS REPOSITORY DOES NOT ACCEPT PULL REQUESTS**
**PULL REQUESTS MUST GO THROUGH [CEPH-ANSIBLE](https://github.com/ceph/ceph-ansible)**
# License
Apache
# Author Information
This role was created by [Sébastien Han](http://sebastien-han.fr/).

45
roles/ceph-common-coreos/README.md
View File

@ -1,44 +1,3 @@
# Ansible role: Ceph Storage Agent # Ansible role: ceph-common
This role installs python and pip on CoreOS. Documentation is available at http://docs.ceph.com/ceph-ansible/.
# Requirements
This role has to be run without gathering facts and with sudo attribute.
# Role variables
Have a look at: `defaults/main.yml`.
## Mandatory variables
None.
# Dependencies
New CoreOS releases support pypy in version 2.4 and above. Unfortunately CoreOS stable channel
has to be used with pypy in version 2.4 and below due to some dependency issues.
# Example Playbook
```
- hosts: servers
remote_user: core
become: True
gather_facts: false
roles:
- { role: ceph-common-coreos }
```
# Contribution
**THIS REPOSITORY DOES NOT ACCEPT PULL REQUESTS**
**PULL REQUESTS MUST GO THROUGH [CEPH-ANSIBLE](https://github.com/ceph/ceph-ansible)**
# License
Apache
# Author Information
This role was created by Piotr Prokop.

79
roles/ceph-common/README.md
View File

@ -1,78 +1,3 @@
# Ansible role: Ceph Common # Ansible role: ceph-common
This role does several things prior to bootstrapping your Ceph cluster: Documentation is available at http://docs.ceph.com/ceph-ansible/.
* Checks the system and validates that Ceph can be installed
* Tunes the operating system if the node is an OSD server
* Installs Ceph
* Generates `ceph.conf`
# Requirements
Move the `plugins/actions/config_template.py` file to your top level playbook directory.
Edit your `ansible.cfg` like so:
action_plugins = plugins/actions
Depending on how you are managing your playbook, the path might be different so edit the file accordingly if necessary.
# Role variables
Have a look at `defaults/main.yml`.
## Mandatory variables
* Install source, choose one of these:
* `ceph_stable`
* `ceph_dev`
* `ceph_rhcs`
* `ceph_custom`
* `journal_size`
* `monitor_interface`
* `public_network`
* `cluster_network`
## Handlers
* update apt cache
* restart ceph-mon
* restart ceph-osd
* restart ceph-mds
* restart ceph-rgw
* restart ceph-restapi
# Dependencies
None
# Example Playbook
```
- hosts: servers
remote_user: ubuntu
roles:
- { role: leseb.ceph-common }
```
# Misc
This role is a **mandatory** dependency for the following roles:
* ceph-mon
* ceph-osd
* ceph-mds
* ceph-rgw
* ceph-restapi
# Contribution
**THIS REPOSITORY DOES NOT ACCEPT PULL REQUESTS**.
**PULL REQUESTS MUST GO THROUGH [CEPH-ANSIBLE](https://github.com/ceph/ceph-ansible)**.
# License
Apache
# Author Information
This role was created by [Sébastien Han](http://sebastien-han.fr/).

45
roles/ceph-config/README.md
View File

@ -1,44 +1,3 @@
# Ansible role: Ceph config # Ansible role: ceph-config
This role does several things: Documentation is available at http://docs.ceph.com/ceph-ansible/.
* Create the cluster fsid
* Generate the `ceph.conf` file
# Requirements
Nothing, it runs out of the box.
# Role variables
Have a look at `defaults/main.yml`.
## Mandatory variables
None.
# Dependencies
None
# Example Playbook
```
- hosts: servers
remote_user: ubuntu
roles:
- { role: ceph.ceph-config }
```
# Contribution
**THIS REPOSITORY DOES NOT ACCEPT PULL REQUESTS**.
**PULL REQUESTS MUST GO THROUGH [CEPH-ANSIBLE](https://github.com/ceph/ceph-ansible)**.
# License
Apache
# Author Information
This role was created by Guillaume Abrioux.

3
roles/ceph-defaults/README.md 100644
View File

@ -0,0 +1,3 @@
# Ansible role: ceph-defaults
Documentation is available at http://docs.ceph.com/ceph-ansible/.

53
roles/ceph-docker-common/README.md
View File

@ -1,52 +1,3 @@
# Ansible role: Ceph Docker Common # Ansible role: ceph-docker
This role contains variables and tasks common to Documentation is available at http://docs.ceph.com/ceph-ansible/.
all containerized deployments.
# Requirements
Nothing, it runs out of the box.
# Role variables
Have a look at: `defaults/main.yml`.
## Mandatory variables
None.
# Dependencies
None.
# Example Playbook
```
- hosts: mons
roles:
- { role: ceph.ceph-docker-common }
```
# Misc
This role is a **mandatory** dependency for the following roles
if you are doing a containerized deployment:
* ceph-mon
* ceph-osd
* ceph-mds
* ceph-rgw
* ceph-restapi
# Contribution
**THIS REPOSITORY DOES NOT ACCEPT PULL REQUESTS**
**PULL REQUESTS MUST GO THROUGH [CEPH-ANSIBLE](https://github.com/ceph/ceph-ansible)**
# License
Apache
# Author Information
This role was created by Andrew Schoen.

42
roles/ceph-fetch-keys/README.md
View File

@ -1,41 +1,3 @@
# Ansible role: Ceph Fetch Keys # Ansible role: ceph-fetch
This role connects to mons and fetches all of keys into Documentation is available at http://docs.ceph.com/ceph-ansible/.
the local ``fetch_directory``.
# Requirements
Nothing, it runs out of the box.
# Role variables
Have a look at: `defaults/main.yml`.
## Mandatory variables
None.
# Dependencies
None.
# Example Playbook
```
- hosts: mons
roles:
- { role: leseb.ceph-fetch-keys }
```
# Contribution
**THIS REPOSITORY DOES NOT ACCEPT PULL REQUESTS**
**PULL REQUESTS MUST GO THROUGH [CEPH-ANSIBLE](https://github.com/ceph/ceph-ansible)**
# License
Apache
# Author Information
This role was created by Andrew Schoen.

71
roles/ceph-iscsi-gw/README.md
View File

@ -1,70 +1,3 @@
# ceph-iscsi-ansible # Ansible role: ceph-iscsi
This project provides a mechanism to deploy iSCSI gateways in front of a ceph cluster using Ansible. The ansible playbooks
provided rely upon configuration logic from the "ceph-iscsi-config" project. This separation provides independence to the
configuration logic, potentially opening up the possibility for puppet/chef to create/manage ceph/iSCSI gateways in the
same way.
## Introduction Documentation is available at http://docs.ceph.com/ceph-ansible/.
At a high level, this project provides custom modules which are responsible for calling the configuration logic, together
with the relevant playbooks. The project defines a new ceph-ansible role; ceph-iscsi-gw, together with two playbooks;
- **ceph-iscsi-gw-yml** ... to define our change the gateway configuration based on group_vars/ceph-iscsi-gw.yml
- **purge_gateways.yml** .. to destroy the LIO configuration, or the LIO and any associated rbd images.
## Features
The combination of the playbooks and the configuration logic deliver the following features;
- confirms RHEL7.3 and aborts if necessary
- ensures targetcli/device-mapper-multipath is installed (for rtslib support)
- configures multipath.conf
- creates rbd's if needed - at allocation time, each rbd is assigned an owner, which will become the preferred path
- checks the size of the rbds at run time and expands if necessary
- maps the rbd's to the host (gateway)
- enables the rbdmap service to start on boot, and reconfigures the target service to be dependent on rbdmap
- adds the rbd's to the /etc/ceph/rbdmap file ensuring the devices are automatically mapped following a gateway reboot
- maps these rbds to LIO
- once mapped, the alua preferred path state is set or cleared (supporting an active/passive topology)
- creates an iscsi target - common iqn, and multiple tpg's
- adds a portal ip based on a the provided IP addresses defined in the group vars to each tpg
- enables the local tpg, other gateways are defined as disabled
- adds all the mapped luns to ALL tpg's (ready for client assignment)
- add clients to the active/enabled tpg, with/without CHAP
- images mapped to clients can be added/removed by changing image_list and rerunning the playbook
- clients can be removed using the state=absent variable and rerunning the playbook. At this point the entry can be
removed from the group variables file
- configuration can be wiped with the purge_gateway playbook
- current state can be seen by looking at the configuration object (stored in the rbd pool)
### Why RHEL 7.3?
There are several system dependencies that are required to ensure the correct (i.e. don't eat my data!) behaviors when OSD connectivity
or gateway nodes fail. RHEL 7.3 delivers the necessary kernel changes, and also provides an updated multipathd, enabling rbd images
to be managed by multipathd.
## Prerequisites
* a working ceph cluster ( *rbd pool defined* )
* a server/host with ceph-ansible installed and working
* nodes intended to be gateways should be at least ceph clients, with the ability to create and map rbd images
## Testing So far
The solution has been tested on a collocated cluster where the osd/mons and gateways all reside on the same node.
## Quick Start
### Prepare the iSCSI Gateway Nodes
1. install the ceph-iscsi-config package on the nodes, intended to be gateways. NB. The playbook includes a check for the presence
of this rpm (https://github.com/pcuzner/ceph-iscsi-config)
### Install the ansible playbooks
1. install the ceph-iscsi-ansible rpm from the packages directory on the node where you already have ceph-ansible installed.
2. update /etc/ansible/hosts to include a host group (ceph-iscsi-gw) for the nodes that you want to become iscsi gateways
3. make a copy of the group_vars/ceph-iscsi-gw.sample file called ceph-iscsi-gw, and update it to define the environment you want
4. run the playbook
```> ansible-playbook ceph-iscsi-gw.yml```
## Purging the configuration
As mentioned above, the project provides a purge-gateways.yml playbook which can remove the LIO configuration alone, or remove
both LIO and all associated rbd images that have been declared in the group_vars/ceph-iscsi-gw file. The purge playbook will
check for any active iscsi sessions, and abort if any are found.
## Known Issues and Considerations
1. the ceph cluster name is the default 'ceph', so the corresponding configuration file /etc/ceph/ceph.conf is assumed to be valid

43
roles/ceph-mds/README.md
View File

@ -1,42 +1,3 @@
# Ansible role: Ceph Metadata # Ansible role: ceph-mds
This role bootstraps Ceph metadata(s). Documentation is available at http://docs.ceph.com/ceph-ansible/.
It can bootstrap dockerized Ceph metadata(s).
# Requirements
Nothing, it runs out of the box.
# Role variables
Have a look at: `defaults/main.yml`.
## Mandatory variables
None.
# Dependencies
The role `leseb.ceph-common` must be installed.
# Example Playbook
```
- hosts: servers
remote_user: ubuntu
roles:
- { role: leseb.ceph-mds }
```
# Contribution
**THIS REPOSITORY DOES NOT ACCEPT PULL REQUESTS**
**PULL REQUESTS MUST GO THROUGH [CEPH-ANSIBLE](https://github.com/ceph/ceph-ansible)**
# License
Apache
# Author Information
This role was created by [Sébastien Han](http://sebastien-han.fr/).

42
roles/ceph-mgr/README.md
View File

@ -1,41 +1,3 @@
# Ansible role: Ceph Manager # Ansible role: ceph-mgr
This role bootstraps the Ceph Manager. Documentation is available at http://docs.ceph.com/ceph-ansible/.
# Requirements
Nothing, it runs out of the box.
# Role variables
Have a look at: `defaults/main.yml`.
## Mandatory variables
None.
# Dependencies
The role `ceph.ceph-common` must be installed.
# Example Playbook
```
- hosts: servers
remote_user: ubuntu
roles:
- { role: ceph.ceph-mgr }
```
# Contribution
**THIS REPOSITORY DOES NOT ACCEPT PULL REQUESTS**
**PULL REQUESTS MUST GO THROUGH [CEPH-ANSIBLE](https://github.com/ceph/ceph-ansible)**
# License
Apache
# Author Information
This role was created by Sebastien Han.

48
roles/ceph-mon/README.md
View File

@ -1,47 +1,3 @@
# Ansible role: Ceph Monitor # Ansible role: ceph-mon
This role mainly bootstraps Ceph monitor(s) but also has several capabilities: Documentation is available at http://docs.ceph.com/ceph-ansible/.
* Deploys Ceph monitor(s)
* Manages Ceph keys
* Can create OpenStack pools, users and keys
* Secures a cluster (protect pools)
* Bootstraps dockerized Ceph monitors
# Requirements
Nothing, it runs out of the box.
# Role variables
Have a look at: `defaults/main.yml`.
## Mandatory variables
None.
# Dependencies
The role `leseb.ceph-common` must be installed.
# Example Playbook
```
- hosts: servers
remote_user: ubuntu
roles:
- { role: leseb.ceph-mon }
```
# Contribution
**THIS REPOSITORY DOES NOT ACCEPT PULL REQUESTS**
**PULL REQUESTS MUST GO THROUGH [CEPH-ANSIBLE](https://github.com/ceph/ceph-ansible)**
# License
Apache
# Author Information
This role was created by [Sébastien Han](http://sebastien-han.fr/).

47
roles/ceph-nfs/README.md
View File

@ -1,46 +1,3 @@
# Ansible role: Ceph NFS Gateway # Ansible role: ceph-nfs
This role bootstraps Ceph NFS Gateway(s). Documentation is available at http://docs.ceph.com/ceph-ansible/.
It can bootstrap dockerized Ceph NFS Gateway(s). NFS support is provided by
the NFS Ganesha project.
It can provide one or both of NFS File access (requires at least one ceph-mds
role) or NFS Object access (requires at least one ceph-rgw role).
# Requirements
Nothing, it runs out of the box.
# Role variables
Have a look at: `defaults/main.yml`.
## Mandatory variables
None.
# Dependencies
The role `ceph.ceph-common` must be installed.
# Example Playbook
```
- hosts: servers
remote_user: ubuntu
roles:
- { role: ceph.ceph-nfs }
```
# Contribution
**THIS REPOSITORY DOES NOT ACCEPT PULL REQUESTS**
**PULL REQUESTS MUST GO THROUGH [CEPH-ANSIBLE](https://github.com/ceph/ceph-ansible)**
# License
Apache
# Author Information
This role was created by [Daniel Gryniewicz](http://redhat.com/).

51
roles/ceph-osd/README.md
View File

@ -1,50 +1,3 @@
# Ansible role: Ceph OSD # Ansible role: ceph-osd
This role bootstraps Ceph OSD(s). Documentation is available at http://docs.ceph.com/ceph-ansible/.
It can bootstrap dockerized Ceph OSD(s).
# Requirements
Nothing, it runs out of the box.
# Role variables
Have a look at: `defaults/main.yml`.
## Mandatory variables
Choose between the following scenario to configure your OSDs, **choose only one**:
* `journal_collocation`
* `raw_multi_journal`
Then:
* `devices`
* `raw_journal_devices` (**only if** you activated `raw_multi_journal`)
# Dependencies
The role `leseb.ceph-common` must be installed.
# Example Playbook
```
- hosts: servers
remote_user: ubuntu
roles:
- { role: leseb.ceph-osd }
```
# Contribution
**THIS REPOSITORY DOES NOT ACCEPT PULL REQUESTS**
**PULL REQUESTS MUST GO THROUGH [CEPH-ANSIBLE](https://github.com/ceph/ceph-ansible)**
# License
Apache
# Author Information
This role was created by [Sébastien Han](http://sebastien-han.fr/).

42
roles/ceph-rbd-mirror/README.md
View File

@ -1,41 +1,3 @@
# Ansible role: Ceph RBD mirror agent # Ansible role: ceph-rbd
This role bootstraps the Ceph RBD mirror agent. Documentation is available at http://docs.ceph.com/ceph-ansible/.
# Requirements
Nothing, it runs out of the box.
# Role variables
Have a look at: `defaults/main.yml`.
## Mandatory variables
None.
# Dependencies
The role `ceph.ceph-common` must be installed.
# Example Playbook
```
- hosts: servers
remote_user: ubuntu
roles:
- { role: ceph.ceph-rbd-mirror }
```
# Contribution
**THIS REPOSITORY DOES NOT ACCEPT PULL REQUESTS**
**PULL REQUESTS MUST GO THROUGH [CEPH-ANSIBLE](https://github.com/ceph/ceph-ansible)**
# License
Apache
# Author Information
This role was created by S2bastien Han.

43
roles/ceph-restapi/README.md
View File

@ -1,42 +1,3 @@
# Ansible role: Ceph REST API # Ansible role: ceph-restapi
This role bootstraps Ceph REST API(s). Documentation is available at http://docs.ceph.com/ceph-ansible/.
It can bootstrap dockerized Ceph REST API(s).
# Requirements
Nothing, it runs out of the box.
# Role variables
Have a look at: `defaults/main.yml`.
## Mandatory variables
None.
# Dependencies
The role `leseb.ceph-common` must be installed.
# Example Playbook
```
- hosts: servers
remote_user: ubuntu
roles:
- { role: leseb.ceph-restapi }
```
# Contribution
**THIS REPOSITORY DOES NOT ACCEPT PULL REQUESTS**
**PULL REQUESTS MUST GO THROUGH [CEPH-ANSIBLE](https://github.com/ceph/ceph-ansible)**
# License
Apache
# Author Information
This role was created by [Sébastien Han](http://sebastien-han.fr/).

47
roles/ceph-rgw/README.md
View File

@ -1,46 +1,3 @@
# Ansible role: Ceph Rados Gateway # Ansible role: ceph-rgw
This role bootstraps Ceph Rados Gateway(s). Documentation is available at http://docs.ceph.com/ceph-ansible/.
It can bootstrap dockerized Ceph Rados Gateway(s).
Civetweb is the only supported method for the Rados Gateway.
It can be configured to support a connection with OpenStack Keystone.
# Requirements
Nothing, it runs out of the box.
# Role variables
Have a look at: `defaults/main.yml`.
## Mandatory variables
None.
# Dependencies
The role `leseb.ceph-common` must be installed.
# Example Playbook
```
- hosts: servers
remote_user: ubuntu
roles:
- { role: leseb.ceph-rgw }
```
# Contribution
**THIS REPOSITORY DOES NOT ACCEPT PULL REQUESTS**
**PULL REQUESTS MUST GO THROUGH [CEPH-ANSIBLE](https://github.com/ceph/ceph-ansible)**
# License
Apache
# Author Information
This role was created by [Sébastien Han](http://sebastien-han.fr/).