From 8453c0edba0bd682d9eb0af9bf206e622630607a Mon Sep 17 00:00:00 2001 From: John Spray Date: Mon, 16 Apr 2018 17:30:18 -0400 Subject: [PATCH] doc: update config-key->config in mgr module docs Signed-off-by: John Spray --- doc/mgr/balancer.rst | 2 +- doc/mgr/dashboard.rst | 10 +++++----- doc/mgr/influx.rst | 8 ++++---- doc/mgr/localpool.rst | 4 ++-- doc/mgr/restful.rst | 16 ++++++++-------- 5 files changed, 20 insertions(+), 20 deletions(-) diff --git a/doc/mgr/balancer.rst b/doc/mgr/balancer.rst index 191c45593be8a..fd8a8ced698c8 100644 --- a/doc/mgr/balancer.rst +++ b/doc/mgr/balancer.rst @@ -50,7 +50,7 @@ such that the percentage of PGs that are misplaced (i.e., that need to be moved) is below a threshold of (by default) 5%. The ``max_misplaced`` threshold can be adjusted with:: - ceph config-key set mgr/balancer/max_misplaced .07 # 7% + ceph config set mgr mgr/balancer/max_misplaced .07 # 7% Modes diff --git a/doc/mgr/dashboard.rst b/doc/mgr/dashboard.rst index fca5e8e161a27..50acef13b17e1 100644 --- a/doc/mgr/dashboard.rst +++ b/doc/mgr/dashboard.rst @@ -104,8 +104,8 @@ Since each ``ceph-mgr`` hosts its own instance of dashboard, it may also be necessary to configure them separately. The hostname and port can be changed via the configuration key facility:: - $ ceph config-key set mgr/dashboard/$name/server_addr $IP - $ ceph config-key set mgr/dashboard/$name/server_port $PORT + $ ceph config set mgr mgr/dashboard/$name/server_addr $IP + $ ceph config set mgr mgr/dashboard/$name/server_port $PORT where ``$name`` is the ID of the ceph-mgr who is hosting this dashboard web app. @@ -113,8 +113,8 @@ dashboard web app. These settings can also be configured cluster-wide and not manager specific. For example,:: - $ ceph config-key set mgr/dashboard/server_addr $IP - $ ceph config-key set mgr/dashboard/server_port $PORT + $ ceph config set mgr mgr/dashboard/server_addr $IP + $ ceph config set mgr mgr/dashboard/server_port $PORT If the port is not configured, the web app will bind to port ``7000``. If the address it not configured, the web app will bind to ``::``, @@ -200,6 +200,6 @@ to use hyperlinks that include your prefix, you can set the :: - ceph config-key set mgr/dashboard/url_prefix $PREFIX + ceph config set mgr mgr/dashboard/url_prefix $PREFIX so you can access the dashboard at ``http://$IP:$PORT/$PREFIX/``. diff --git a/doc/mgr/influx.rst b/doc/mgr/influx.rst index 066c958a0e727..c9a58a831f4ad 100644 --- a/doc/mgr/influx.rst +++ b/doc/mgr/influx.rst @@ -36,7 +36,7 @@ Set configuration values using the following command: :: - ceph config-key set mgr/influx/ + ceph config set mgr mgr/influx/ The most important settings are ``hostname``, ``username`` and ``password``. @@ -44,9 +44,9 @@ For example, a typical configuration might look like this: :: - ceph config-key set mgr/influx/hostname influx.mydomain.com - ceph config-key set mgr/influx/username admin123 - ceph config-key set mgr/influx/password p4ssw0rd + ceph config set mgr mgr/influx/hostname influx.mydomain.com + ceph config set mgr mgr/influx/username admin123 + ceph config set mgr mgr/influx/password p4ssw0rd Additional optional configuration settings are: diff --git a/doc/mgr/localpool.rst b/doc/mgr/localpool.rst index 5779b7cf175b7..b31ed6049fc9a 100644 --- a/doc/mgr/localpool.rst +++ b/doc/mgr/localpool.rst @@ -31,5 +31,5 @@ The *localpool* module understands the following options: These options are set via the config-key interface. For example, to change the replication level to 2x with only 64 PGs, :: - ceph config-key set mgr/localpool/num_rep 2 - ceph config-key set mgr/localpool/pg_num 64 + ceph config set mgr mgr/localpool/num_rep 2 + ceph config set mgr mgr/localpool/pg_num 64 diff --git a/doc/mgr/restful.rst b/doc/mgr/restful.rst index 5ffb16fedb079..ccd550f6eae9a 100644 --- a/doc/mgr/restful.rst +++ b/doc/mgr/restful.rst @@ -40,15 +40,15 @@ can be generated with a command similar to:: The ``restful.crt`` should then be signed by your organization's CA (certificate authority). Once that is done, you can set it with:: - ceph config-key set mgr/restful/$name/crt -i restful.crt - ceph config-key set mgr/restful/$name/key -i restful.key + ceph config set mgr mgr/restful/$name/crt -i restful.crt + ceph config set mgr mgr/restful/$name/key -i restful.key where ``$name`` is the name of the ``ceph-mgr`` instance (usually the hostname). If all manager instances are to share the same certificate, you can leave off the ``$name`` portion:: - ceph config-key set mgr/restful/crt -i restful.crt - ceph config-key set mgr/restful/key -i restful.key + ceph config set mgr mgr/restful/crt -i restful.crt + ceph config set mgr mgr/restful/key -i restful.key Configuring IP and port @@ -62,16 +62,16 @@ Since each ``ceph-mgr`` hosts its own instance of *restful*, it may also be necessary to configure them separately. The IP and port can be changed via the configuration key facility:: - ceph config-key set mgr/restful/$name/server_addr $IP - ceph config-key set mgr/restful/$name/server_port $PORT + ceph config set mgr mgr/restful/$name/server_addr $IP + ceph config set mgr mgr/restful/$name/server_port $PORT where ``$name`` is the ID of the ceph-mgr daemon (usually the hostname). These settings can also be configured cluster-wide and not manager specific. For example,:: - ceph config-key set mgr/restful/server_addr $IP - ceph config-key set mgr/restful/server_port $PORT + ceph config set mgr mgr/restful/server_addr $IP + ceph config set mgr mgr/restful/server_port $PORT If the port is not configured, *restful* will bind to port ``8003``. If the address it not configured, the *restful* will bind to ``::``, -- 2.39.5