This is an automated email from the ASF dual-hosted git repository.
zrhoffman pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficcontrol.git
The following commit(s) were added to refs/heads/master by this push:
new a04ba89 Add deprecation notices to legacy Riak tools (#6362)
a04ba89 is described below
commit a04ba89ce61aa45c234d3631a1f682215f436f22
Author: ocket8888 <[email protected]>
AuthorDate: Thu Dec 9 10:32:02 2021 -0700
Add deprecation notices to legacy Riak tools (#6362)
---
docs/source/tools/traffic_vault_util.rst | 4 ++++
experimental/emulated_vault/README.md | 8 ++++++--
2 files changed, 10 insertions(+), 2 deletions(-)
diff --git a/docs/source/tools/traffic_vault_util.rst
b/docs/source/tools/traffic_vault_util.rst
index d6231cd..7c28d4b 100644
--- a/docs/source/tools/traffic_vault_util.rst
+++ b/docs/source/tools/traffic_vault_util.rst
@@ -18,6 +18,10 @@
*************************
Traffic Vault Util (Riak)
*************************
+.. deprecated:: ATCv6
+ When support for the Riak backend is removed, support for this tool will
+ also be dropped.
+
The ``traffic_vault_util`` tool - located at
:file:`tools/traffic_vault_util.go` in the `Apache Traffic Control repository
<https://github.com/apache/trafficcontrol>`_ - is used to view and modify the
contents of a Traffic Vault Riak cluster. The tool contains basic operations to
display the buckets, keys and values stored within Riak.
.. note:: This tool does not apply to the PostgreSQL Traffic Vault backend.
diff --git a/experimental/emulated_vault/README.md
b/experimental/emulated_vault/README.md
index c25ff5b..0c931fa 100644
--- a/experimental/emulated_vault/README.md
+++ b/experimental/emulated_vault/README.md
@@ -19,9 +19,13 @@
# Emulated Vault - Background
+!!! Deprecated
+ Since this tool is meant specifically to emulate the deprecated Riak backend
+ for Traffic Vault, it will be removed when support for that backend is.
+
The emulated_vault module supplies a HTTP server mimicking RIAK behavior for
usage as traffic-control vault.
It may be used in order to replace RIAK traffic_vault, as it is much more
simple to install.
-The server may use different type of persistent storage (e.g. file-system),
using the proper adapter.
+The server may use different type of persistent storage (e.g. file-system),
using the proper adapter.
The resiliency of the stored keys is derived from the resiliency of the
underlying storage.
# Installation
@@ -43,7 +47,7 @@ Before doing that, you would probably need to adjust the
opt/emulated_vault/conf
1. Changing the db-path to one you have access to
2. Disable ssl (just to make it easier)
-Additionally, the vault-debug script is also available to work against the DB
with command line.
+Additionally, the vault-debug script is also available to work against the DB
with command line.
It is mostly useful when developing a new adapter.
# Contact
