From 5e1823de06e7b385b26e79b8dfaa89d6181321ca Mon Sep 17 00:00:00 2001 From: Joseph Davis Date: Thu, 16 May 2019 15:38:07 -0700 Subject: [PATCH] Fix a typo and add troubleshooting in tools README It was discovered that the example paths included in the README.rst used monasca-persister rather than monasca_persister. Also added a footnote with two error messages that occur when the contact_points is not specified correctly. Story: 2005305 Task: 30611 Change-Id: I0c53af817504e638bd82401ca0b62874cb591f36 --- .../cassandra/recreate-metric-id/README.rst | 40 ++++++++++++++----- 1 file changed, 31 insertions(+), 9 deletions(-) diff --git a/monasca_persister/tools/cassandra/recreate-metric-id/README.rst b/monasca_persister/tools/cassandra/recreate-metric-id/README.rst index 734120b1..a0946392 100644 --- a/monasca_persister/tools/cassandra/recreate-metric-id/README.rst +++ b/monasca_persister/tools/cassandra/recreate-metric-id/README.rst @@ -24,13 +24,19 @@ Usage Steps to use this tool: - Log in to one node where monasca-persister is deployed. + - Identify installation path to monasca-persister. This may be a virtual environment such as - `/opt/stack/venv/monasca-/lib/python2.7/site-packages/monasca-persister` - or as in devstack `/opt/stack/monasca-persister/monasca_persister/`. + `/opt/stack/venv/monasca-/lib/python2.7/site-packages/monasca_persister` + or as in devstack + `/opt/stack/monasca-persister/monasca_persister/`. + - Identify the existing configuration for monasca-persister. If using a - java deployment, it may be in `/opt/stack/service/monasca/etc/persister-config.yml` - or in devstack `/etc/monasca/persister.conf` + java deployment, it may be in + `/opt/stack/service/monasca/etc/persister-config.yml` + or in devstack + `/etc/monasca/persister.conf` + - Copy and modify the config template file. :: @@ -39,18 +45,22 @@ Steps to use this tool: vi /opt/stack/service/monasca/etc/persister-recreate.ini - Copy the values from the monasca-persister config in to the new .ini, - particularly the password. In some cases, the single IP for the - management network of one of the Cassandra nodes may need to be given, - rather than the list of hostnames as specified in the .yml. + particularly the password. + + - The single IP for the management network of one of the Cassandra nodes + should be given for the contact_points value, rather than the list of + hostnames as specified in the .yml. [#f1]_ + - Copy the `persister-recreate-metric-id.py` and `persister-check-missing-metric-id.py` files in to place with the monasca-persister code. :: - cp persister-*-metric-id.py /opt/stack/venv/monasca-/lib/python2.7/site-packages/monasca-persister + cp persister-*-metric-id.py /opt/stack/venv/monasca-/lib/python2.7/site-packages/monasca_persister - Ensure the `mon-persister` user has permission to access both `persister-recreate.ini` and `persister-recreate-metric-id.py`. + - Invoke the tool to generate a log of rows needing repair. :: @@ -68,6 +78,18 @@ Steps to use this tool: may be deleted. +.. [#f1] Using the wrong format locator for the contact_points may result in errors: + + - Giving the wrong IP address: + :: + + NoHostAvailable: ('Unable to connect to any servers', {'192.168.0.0': error(111, "Tried connecting to [('192.168.0.0', 9042)]. Last error: Connection refused")}) + + - Giving a hostname rather than IP: + :: + + gaierror: [Errno -2] Name or service not known + License ======= @@ -85,4 +107,4 @@ Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and -limitations under the License. \ No newline at end of file +limitations under the License.