docs: Update guide and devel about KeyVault (#516)

* docs: remove reference to old KeyVault Service Signed-off-by: Kairo Araujo <[email protected]> * docs: remove reference to use rstuf to generate key Signed-off-by: Kairo Araujo <[email protected]> * Update docs/source/devel/design.rst Co-authored-by: Martin Vrachev <[email protected]> * Update docs/source/devel/design.rst Co-authored-by: Martin Vrachev <[email protected]> --------- Signed-off-by: Kairo Araujo <[email protected]> Co-authored-by: Martin Vrachev <[email protected]>
repository-service-tuf · May 15, 2024 · 05ba79f · 05ba79f
1 parent 49a4760
commit 05ba79f
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 19 deletions.
diff --git a/docs/source/devel/design.rst b/docs/source/devel/design.rst
@@ -7,9 +7,8 @@ Context level
 The ``repository-service-tuf-worker``, in the context perspective, is a Consumer and
 Publisher from the Broker that receives tasks to perform in the
 `TUF Metadata Repository`. The `Metadata Repository` is stored using a
-*Repository Storage Service* that reads/writes this data. For signing
-this Metadata, the ``repository-service-tuf-worker`` uses the *Key Vault Repository
-Service* to access the online keys.
+*Repository Storage Service* that reads/writes this data. For signing some of
+the Metadata, the ``repository-service-tuf-worker`` uses the online key.
 
 .. image:: /_static/repository-service-tuf-worker-C1.png
 
@@ -22,22 +21,15 @@ Repository worker that performs actions to the TUF Metadata.
 
 It will consume tasks from the Broker server and execute the task actions in
 the Metadata Repository using the ``Storage Service`` to handle the TUF
-Metadata. For signing the Metadata, it will use the ``Key Vault Service`` to
-manage the keys. After executing any action, ``repository-service-tuf-api`` publishes to
+Metadata. After executing any task, ``repository-service-tuf-api`` publishes to
 the Broker.
 
-The ``repository-service-tuf-worker`` implements the services ``Storage Service`` and the
-``Key Vault Service`` to support different technologies for storage and key
-vault storage.
+The ``repository-service-tuf-worker`` implements the service ``Storage Service``.
 
 Current supported Storage Services types:
     - LocalStorage (File System)
     - S3Storage (AWS S3 Object Storage -- to be implemented)
 
-Current supported Key Vault Service types:
-    - LocalKeyVault (File System)
-    - KMS (AWS KMS -- to be implemented)
-
 The ``repository-service-tuf-worker`` stores configuration settings. These are the
 **Worker Settings**.
 

diff --git a/docs/source/devel/index.rst b/docs/source/devel/index.rst
@@ -206,6 +206,9 @@ RSTUF Worker Backend Services Development
 Storage
 =======
 
+LocalStorage
+------------
+
 The default RSTUF Worker source code is configured to use  `LocalStorage`.
 
 1. Initiate the local development environment ``make run-dev``
@@ -215,12 +218,6 @@ AWSS3
 
 1. Initiate the aws development environment ``make run-dev DC=aws``
 
-KeyVault
-========
-
-The default RSTUF Worker source code is configured to use  `LocalKeyVault`.
-
-1. Initiate the local development environment ``make run-dev``
 
 Important issues/problems
 #########################

diff --git a/docs/source/guide/Docker_README.md b/docs/source/guide/Docker_README.md
@@ -29,7 +29,7 @@ metadata when an artifact is added or removed.
 Here are some things you need to know:
 * The key must be compatible with
   [Secure Systems Library](https://github.com/secure-systems-lab/securesystemslib).
-  If you do not have a key we suggest you use the [RSTUF CLI tool to generate the key](https://repository-service-tuf.readthedocs.io/en/latest/guide/repository-service-tuf-cli/index.html).
+
 * This key must be the same one used during the [RSTUF CLI ceremony](https://repository-service-tuf.readthedocs.io/en/latest/guide/repository-service-tuf-cli/index.html#ceremony-ceremony).
 
 For more information read the [Deployment documentation](https://repository-service-tuf.readthedocs.io/en/latest/guide/deployment/index.html).