openstack/barbican
Code Issues Proposed changes

Update README.rst - few small fix

Browse Source 
Change-Id: Ia6dd3f44e86252c887a2ba1e6ddae4c279ac1abe
This commit is contained in:
Ivan Anfimov 2025-02-17 17:55:35 +00:00
parent 55c758eb7c
commit ad0d0754d8
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.rst
View File

@ -8,6 +8,7 @@ Team and repository tags
.. Change things from this point on .. Change things from this point on
========
Barbican Barbican
======== ========
@ -17,7 +18,7 @@ including large ephemeral Clouds.
Barbican is an OpenStack project developed by the `Barbican Project Team Barbican is an OpenStack project developed by the `Barbican Project Team
<https://wiki.openstack.org/wiki/Barbican>`_ with support from <https://wiki.openstack.org/wiki/Barbican>`_ with support from
`Rackspace Hosting <http://www.rackspace.com/`>_, EMC, Ericsson, `Rackspace Hosting <https://www.rackspace.com/>`_, EMC, Ericsson,
Johns Hopkins University, HP, Red Hat, Cisco Systems, and many more. Johns Hopkins University, HP, Red Hat, Cisco Systems, and many more.
The full documentation can be found on the `Barbican Developer Documentation The full documentation can be found on the `Barbican Developer Documentation
@ -33,7 +34,7 @@ Future design work is tracked at
https://specs.openstack.org/openstack/barbican-specs. https://specs.openstack.org/openstack/barbican-specs.
For development questions or discussion, use the `OpenStack-discuss For development questions or discussion, use the `OpenStack-discuss
mailing list <http://lists.openstack.org/pipermail/openstack-discuss/>`_ mailing list <https://lists.openstack.org/mailman3/lists/openstack-discuss.lists.openstack.org/>`_
at `openstack-discuss@lists.openstack.org` and let us know what you at `openstack-discuss@lists.openstack.org` and let us know what you
think, just add think, just add
`[barbican]` to the subject. You can also join our IRC channel `[barbican]` to the subject. You can also join our IRC channel
@ -43,8 +44,8 @@ Client Libraries
---------------- ----------------
* `python-barbicanclient * `python-barbicanclient
<https://opendev.org/openstack/python-barbicanclient>`_ - <https://opendev.org/openstack/python-barbicanclient>`_ - A convenient Python-based library
A convenient Python-based library to interact with the Barbican API. to interact with the Barbican API.
Getting Started Getting Started
--------------- ---------------
@ -62,7 +63,7 @@ application use.
Barbican was designed to solve this problem. The system was motivated by Barbican was designed to solve this problem. The system was motivated by
internal Rackspace needs, requirements from internal Rackspace needs, requirements from
`OpenStack <http://www.openstack.org/>`_ and a realization that the `OpenStack <https://www.openstack.org/>`_ and a realization that the
current state current state
of the art could use some help. of the art could use some help.
@ -71,11 +72,10 @@ Barbican will handle many types of secrets, including:
* **Symmetric Keys** - Used to perform reversible encryption of data at rest, * **Symmetric Keys** - Used to perform reversible encryption of data at rest,
typically using the AES algorithm set. This type of key is required to enable typically using the AES algorithm set. This type of key is required to enable
features like `encrypted Swift containers and Cinder features like `encrypted Swift containers and Cinder
volumes <http://www.openstack.org/software/openstack-storage/>`_, `encrypted volumes <https://www.openstack.org/software/>`_, encrypted Cloud Backups etc.
Cloud Backups <http://www.rackspace.com/cloud/backup/>`_, etc.
* **Asymmetric Keys** - Asymmetric key pairs (sometimes referred to as * **Asymmetric Keys** - Asymmetric key pairs (sometimes referred to as
`public / private keys `public / private keys
<http://en.wikipedia.org/wiki/Public-key_cryptography>`_) are used in <https://en.wikipedia.org/wiki/Public-key_cryptography>`_) are used in
many scenarios where communication between untrusted parties is many scenarios where communication between untrusted parties is
desired. The most common case is with SSL/TLS certificates, but also desired. The most common case is with SSL/TLS certificates, but also
is used in solutions like SSH keys, S/MIME (mail) encryption and is used in solutions like SSH keys, S/MIME (mail) encryption and