From f76bc2a3b84a06c84839fb8738e454d389b74535 Mon Sep 17 00:00:00 2001
From: Patricia Reinoso <patricia.reinoso@canonical.com>
Date: Thu, 14 May 2026 10:40:50 +0200
Subject: [PATCH] patch: improve role documentation

---
 config.yaml | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/config.yaml b/config.yaml
index a48358dbd..abe46bd62 100644
--- a/config.yaml
+++ b/config.yaml
@@ -4,8 +4,16 @@
 options:
   role:
     description: |
-      role config option exists to deploy the charmed-mongodb application as a shard, 
-      config-server, or as a replica set.
+      Specifies the deployment role for the charmed-mongodb application.
+
+      Valid values:
+        - `replication`: Deploy as a MongoDB replica set
+        - `config-server`: Deploy as a MongoDB config server
+        - `shard`: Deploy as a MongoDB shard
+
+      This option must be set at deployment time and cannot be changed afterward.
+
+      Changing the value causes the charm to enter a blocked state.
     type: string
     default: replication
   ldap-user-to-dn-mapping: