mgr/dashboard: add flag info to config options documentation page

Add information about the supported flags (introduced by
https://github.com/ceph/ceph/pull/22595) to the config options
documentation page.

Fixes: https://tracker.ceph.com/issues/24605
Signed-off-by: Tatjana Dehler <tdehler@suse.com>

diff --git a/src/pybind/mgr/dashboard/frontend/src/app/ceph/cluster/configuration/configuration.component.html b/src/pybind/mgr/dashboard/frontend/src/app/ceph/cluster/configuration/configuration.component.html
index 9e7c64082b446a3399907a6c2bf55c4ca899d9fc..834a21479d04ec6a53534526b4bec00e5a43ead9 100644 (file)
--- a/src/pybind/mgr/dashboard/frontend/src/app/ceph/cluster/configuration/configuration.component.html
+++ b/src/pybind/mgr/dashboard/frontend/src/app/ceph/cluster/configuration/configuration.component.html
@@ -35,4 +35,13 @@
       </span>
     </span>
   </ng-template>
+  <ng-template #confFlagTpl let-value="value">
+    <span *ngIf="value !== ''">
+      <span *ngFor="let flag of value; last as isLast">
+        <span title="{{ flags[flag] }}">
+          {{ flag | uppercase }}{{ !isLast ? "," : "" }}<br/>
+        </span>
+      </span>
+    </span>
+  </ng-template>
 </cd-table>

diff --git a/src/pybind/mgr/dashboard/frontend/src/app/ceph/cluster/configuration/configuration.component.ts b/src/pybind/mgr/dashboard/frontend/src/app/ceph/cluster/configuration/configuration.component.ts
index ef06274935b522725f584fd6714e5d81e3fdbaf4..5a6dc0eac9e7b342a7eb2da126d58e5c3a7cdc02 100644 (file)
--- a/src/pybind/mgr/dashboard/frontend/src/app/ceph/cluster/configuration/configuration.component.ts
+++ b/src/pybind/mgr/dashboard/frontend/src/app/ceph/cluster/configuration/configuration.component.ts
@@ -62,8 +62,19 @@ export class ConfigurationComponent implements OnInit {
       }
     }
   ];
+  flags = {
+    runtime: 'The value can be updated at runtime.',
+    no_mon_update:
+      'Daemons/clients do not pull this value from the monitor config database. ' +
+      'We disallow setting this option via \'ceph config set ...\'. This option should be ' +
+      'configured via ceph.conf or via the command line.',
+    startup: 'Option takes effect only during daemon startup.',
+    cluster_create: 'Option only affects cluster creation.',
+    create: 'Option only affects daemon creation.'
+  };
 
   @ViewChild('confValTpl') public confValTpl: TemplateRef<any>;
+  @ViewChild('confFlagTpl') public confFlagTpl: TemplateRef<any>;
 
   constructor(private configurationService: ConfigurationService) {}
 
@@ -80,6 +91,13 @@ export class ConfigurationComponent implements OnInit {
       { flexGrow: 1, prop: 'source' },
       { flexGrow: 2, prop: 'desc', name: 'Description', cellClass: 'wrap' },
       { flexGrow: 2, prop: 'long_desc', name: 'Long description', cellClass: 'wrap' },
+      {
+        flexGrow: 2,
+        prop: 'flags',
+        name: 'Flags',
+        cellClass: 'wrap',
+        cellTemplate: this.confFlagTpl
+      },
       { flexGrow: 1, prop: 'type' },
       { flexGrow: 1, prop: 'level' },
       { flexGrow: 1, prop: 'default', cellClass: 'wrap' },