From a3ac181351d15c99b736f908c83f22ca23d1ddfe Mon Sep 17 00:00:00 2001 From: Guillaume Abrioux Date: Wed, 13 Nov 2024 12:57:33 +0100 Subject: [PATCH] doc: update README.md This update the README.md in order to mention about some new playbooks that were introduced and the supported Ansible module this project provides. Signed-off-by: Guillaume Abrioux (cherry picked from commit dc90c8cca2a6dc0b4f47baf7a27df8bf46bef162) --- README.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 859f6f6..a3a4bc3 100644 --- a/README.md +++ b/README.md @@ -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 **admin host:**\