Skip to content

Commit

Permalink
docs: update related docs about IKeyVault removal
Browse files Browse the repository at this point in the history
Signed-off-by: Kairo Araujo <[email protected]>
  • Loading branch information
Kairo Araujo committed Jul 25, 2024
1 parent 306c741 commit 8a8853e
Show file tree
Hide file tree
Showing 9 changed files with 7 additions and 396 deletions.
6 changes: 0 additions & 6 deletions docs/diagrams/repository-service-tuf-worker-C2.puml
Original file line number Diff line number Diff line change
Expand Up @@ -56,14 +56,8 @@ Container_Boundary(repository_storage, "Storage Service"){
Container_Ext(aws_s3, "AWS S3", "Storage", $tags="aws_s3") #Grey
Container_Ext(azure_blob, "Azure Blob", "Storage", $tags="azure_blob") #Grey
}
Container_Boundary(key_storage, "Key Vault Service"){
Container_Ext(key_fs, "Filesystem", "Storage", $tags="storage_service") #Grey
Container_Ext(aws_kms, "AWS KMS", "Storage", $tags="aws_kms") #Grey
Container_Ext(azure_kv, "Azure Key Vault", "Storage", $tags="azure_kv") #Grey
}
Rel_D(broker, repository_service_tuf_worker, "Consumer", "Tasks")
Rel_U(repository_service_tuf_worker, broker, "Publisher", "Tasks Results")
Rel_U(key_storage, repository_service_tuf_worker, "Read", "Online Keys")
BiRel_U(repository_service_tuf_worker, redis, "Repository Configuration", "Consumer")
BiRel_U(repository_service_tuf_worker, sql, "TargetsFiles, TargetsRoles", "")
BiRel_R(repository_service_tuf_worker, data_dir, "Write/Read", "Service settings")
Expand Down
9 changes: 0 additions & 9 deletions docs/diagrams/repository-service-tuf-worker-C3.puml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@


AddContainerTag("webui", $sprite="application_server", $legendText="Web UI Interface", $bgColor=Gray)
AddContainerTag("key_service", $sprite="lock_with_key_security", $legendText="Key Service", $bgColor=Gray)
AddContainerTag("storage_service", $sprite="file_server", $legendText="Storage Service", $bgColor=Gray)
AddContainerTag("rest_api", $sprite="web_server", $legendText="Repository REST API")
AddContainerTag("repository_service_tuf_worker", $sprite="service_application", $legendText="Repository Metadata Worker")
Expand Down Expand Up @@ -54,12 +53,8 @@ System_Boundary(repository_service_tuf_worker, "Repository Service for TUF Worke
}
Container_Boundary(interfaces, "interfaces") #CornflowerBlue {
Container(IStorage, "Storage Interface")
Container(IKeyVault, "Key Vault Interface")
}
Container_Boundary(services, "services") #DeepSkyBlue{
Container_Boundary(keyvault, "keyvault") #LightSteelBlue {
Container(LocalKeyVault, "LocalKeyVault", "File System")
}
Container_Boundary(storage, "storage") #LightSteelBlue {
Container(LocalStorage, "LocalStorage", "File System")
}
Expand All @@ -73,14 +68,10 @@ Container_Ext(broker, "Broker", "RabbitMQ, Redis, etc", $tags="queue") #Grey
Container_Ext(redis, "Redis", "Redis Server", $tags="queue") #Grey
Container_Ext(sql, "SQL", "SQL Server", $tags="sql_db") #Grey
Container_Ext(ext_storage, "Metadata Storage", "specific technology", $tags="key_service") #Grey
Container_Ext(ext_key_storage, "Key Vault Storage", "specific technology", $tags="storage_service") #Grey

Rel(LocalStorage, ext_storage, " ")
Rel(LocalKeyVault, ext_key_storage, " ")
Rel(IKeyVault, LocalKeyVault, "uses")
Rel(IStorage, LocalStorage, "uses")
Rel(metadata_repository, IStorage, " ")
Rel(metadata_repository, IKeyVault, " ")
Rel(metadata_repository, celery, " ")
Rel(metadata_repository, repository, " ")
Rel(metadata_repository, dynaconf, " ")
Expand Down
Binary file modified docs/source/_static/repository-service-tuf-worker-C2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/_static/repository-service-tuf-worker-C3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 2 additions & 13 deletions docs/source/devel/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Bootstrap
@enduml

Adding/Removing artifacts
-----------------------
-------------------------

As mentioned at the container level, the domain of ``repository-service-tuf-worker``
(Repository Worker) is managing the TUF Repository Metadata.
Expand Down Expand Up @@ -108,9 +108,7 @@ About **Bump Roles** (``bump_online_roles``) that contain online keys is easy.
These roles have short expiration (defined during repository configuration) and
must be "bumped" frequently. The implementation in the RepositoryMetadata

**Publish the new Hashed Bins Target Roles** (``publish_artifacts``) is part of the
solution for the :ref:`Repository Worker scalability, Issue 17
<devel/known_issues:(Solved) Scalability>`.
**Publish the new Hashed Bins Target Roles** (``publish_artifacts``)

To understand more, every time the API sends a task to add a new artifact(s), the
Hashed Bins Roles must be changed to add the new artifact(s), followed by a new
Expand Down Expand Up @@ -219,14 +217,6 @@ AWSS3
1. Initiate the aws development environment ``make run-dev DC=aws``


Important issues/problems
#########################

.. toctree::
:maxdepth: 1

known_issues

Implementation
##############

Expand All @@ -238,5 +228,4 @@ Implementation
repository_service_tuf_worker.models.targets
repository_service_tuf_worker.services
repository_service_tuf_worker.services.storage
repository_service_tuf_worker.services.keyvault
modules
Loading

0 comments on commit 8a8853e

Please sign in to comment.