Skip to content

Commit

Permalink
Merge pull request #324 from ceph/mergify/bp/squid/pr-323
Browse files Browse the repository at this point in the history
doc: update README.md (backport #323)
  • Loading branch information
asm0deuz authored Nov 14, 2024
2 parents 1df94b3 + a3ac181 commit 3f68a15
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,25 @@
# cephadm-ansible

cephadm-ansible is a collection of Ansible playbooks to simplify
workflows that are not covered by [cephadm]. The workflows covered
are:
cephadm-ansible is a collection of Ansible playbooks and modules
to simplify workflows that are not covered by [cephadm].

Some examples of workflows covered with playbooks are the following:

* Distribute ssh key: Copy an SSH public key to a specified user on remote hosts
* Preflight: Initial setup of hosts before bootstrapping the cluster
* Client: Setting up client hosts
* Purge: Remove a Ceph cluster
* RocksDB resharding: Reshard the rocksDB database for a given OSD
* Insecure registry: Add registry as insecure to registries.conf

This project provides some Ansible modules which allow you to write your own playbooks:

* cephadm_registry_login: Log in to container registry
* cephadm_bootstrap: Bootstrap a Ceph cluster using cephadm
* ceph_orch_host: Add/Remove hosts (Can also add label(s) to hosts)
* ceph_orch_apply: Apply a service spec
* ceph_orch_daemon: Stop/Start daemon(s)
* ceph_config: Set ceph configuration

# Terminology
**<ins>admin host</ins>:**\
Expand Down

0 comments on commit 3f68a15

Please sign in to comment.