aboutsummaryrefslogtreecommitdiffstats
path: root/docs/honeycomb_url_files.rst
diff options
context:
space:
mode:
authorTibor <tifrank@cisco.com>2016-04-06 13:33:42 +0200
committerGerrit Code Review <gerrit@fd.io>2016-04-13 16:00:37 +0000
commit3121b691debad27fcea1c6e2031e4a2544e42fbf (patch)
tree29173fdc965709cf568d2f75c7b62ed320c8d362 /docs/honeycomb_url_files.rst
parentd9c35ed4fe07f506a8146cfc295d96049d5a76e9 (diff)
Honeycomb setup and utils
- re-implement HTTPCodes as IntEnum rather then dictionary - add methods to manipulate data using honeycomb - get, set, delete - change the name of url file from vpp_version.url to oper_vpp_version.url - improve checking of startup and shutdown state of honeycomb - PEP8 fixes - add docstrings in all modules and classes - move logging to the lowest possible level - improve logging in exceptions - add method exec_command_sudo_log to resources.libraries.python.ssh module Change-Id: I54e0c6b45313e3a3c11bafa475488ae2b1e605c2 Signed-off-by: Tibor Frank <tifrank@cisco.com>
Diffstat (limited to 'docs/honeycomb_url_files.rst')
-rw-r--r--docs/honeycomb_url_files.rst22
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/honeycomb_url_files.rst b/docs/honeycomb_url_files.rst
new file mode 100644
index 0000000000..4dfa10c516
--- /dev/null
+++ b/docs/honeycomb_url_files.rst
@@ -0,0 +1,22 @@
+# Copyright (c) 2016 Cisco and/or its affiliates.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# 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.
+
+Documentation to files used to store URLs to resources in Honeycomb.
+====================================================================
+
+A URL file is a text file encoded in utf-8 with a path to a resource in
+Honeycomb. There is only one line in each file.
+
+The URL is stored without host and port with leading slash. There is no slash at
+the end, e.g.:
+ /restconf/config/v3po:vpp/bridge-domains