Browse Source

Update README

Update the castellan-ui README with a
Features section and Troubleshooting
section.

Change-Id: I8939abfac71536eb277b97b0d998155c4501f4bd
Kaitlin Farr 1 year ago
parent
commit
c1ba5aa7af
1 changed files with 54 additions and 5 deletions
  1. 54
    5
      README.rst

+ 54
- 5
README.rst View File

@@ -11,7 +11,31 @@ Generic Key Manager UI Plugin for Horizon
11 11
 Features
12 12
 --------
13 13
 
14
-* TODO
14
+--------------------+------------------+---------------------------+---------------+-----------+--------------+
15
+|                    | Import from file | Import using direct input | Download      | Delete    | Generate [1] |
16
+====================+==================+===========================+===============+===========+==============+
17
+| X.509 Certificates | supported [2]    | supported [2]             | supported [2] | supported | N/A          |
18
+--------------------+------------------+---------------------------+---------------+-----------+--------------+
19
+| Private Keys       | supported [2]    | supported [2]             | supported [2] | supported | supported    |
20
+--------------------+------------------+---------------------------+---------------+-----------+--------------+
21
+| Public Keys        | supported [2]    | supported [2]             | supported [2] | supported | supported    |
22
+--------------------+------------------+---------------------------+---------------+-----------+--------------+
23
+| Symmetric Keys     | supported [3]    | supported [4]             | supported [3] | supported | supported    |
24
+--------------------+------------------+---------------------------+---------------+-----------+--------------+
25
+| Opaque Data        | supported [3]    | supported [4]             | supported [3] | supported | N/A          |
26
+--------------------+------------------+---------------------------+---------------+-----------+--------------+
27
+| Passphrases [5]    | X                | supported                 | X             | supported | N/A          |
28
+--------------------+------------------+---------------------------+---------------+-----------+--------------+
29
+
30
+1. Key managers typically support generating keys only and do not generate
31
+   other types of objects. Private and public keys will be generated as a key
32
+   pair, and symmetric keys can be generated individually.
33
+2. Supports Privacy-enhanced Electronic Mail (PEM) formatted objects.
34
+3. Raw bytes represent the object.
35
+4. Object bytes are represented using hex characters.
36
+5. Because passphrases are typically not saved to files, passphrases are
37
+   imported through a form on the web page and are not downloadable, only
38
+   viewed through the web page.
15 39
 
16 40
 Enabling in DevStack
17 41
 --------------------
@@ -32,7 +56,9 @@ Begin by cloning the Horizon and Castellan UI repositories::
32 56
 Create a virtual environment and install Horizon dependencies::
33 57
 
34 58
     cd horizon
35
-    python tools/install_venv.py
59
+    virtualenv horizon_dev
60
+    . horizon_dev/bin/activate
61
+    pip install -r requirements.txt
36 62
 
37 63
 Set up your ``local_settings.py`` file::
38 64
 
@@ -49,9 +75,10 @@ editor. You will want to customize several settings:
49 75
 
50 76
 Install Castellan UI with all dependencies in your virtual environment::
51 77
 
52
-    tools/with_venv.sh pip install -e ../castellan-ui/
78
+   . horizon_dev/bin/activate
79
+   pip install -e ../castellan-ui/
53 80
 
54
-And enable it in Horizon::
81
+And enable it in Horizon (use full paths instead of relative paths)::
55 82
 
56 83
     ln -s ../castellan-ui/castellan_ui/enabled/_90_project_key_manager_panelgroup.py openstack_dashboard/local/enabled
57 84
     ln -s ../castellan-ui/castellan_ui/enabled/_91_project_key_manager_x509_certificates_panel.py openstack_dashboard/local/enabled
@@ -63,7 +90,29 @@ And enable it in Horizon::
63 90
 
64 91
 To run horizon with the newly enabled Castellan UI plugin run::
65 92
 
66
-    ./run_tests.sh --runserver 0.0.0.0:8080
93
+    python manage.py runserver -- 0.0.0.0:8080
67 94
 
68 95
 to have the application start on port 8080 and the horizon dashboard will be
69 96
 available in your browser at http://localhost:8080/
97
+
98
+Troubleshooting Tips
99
+--------------------
100
+
101
+If you are using Barbican plugin for Castellan, be sure to note that Barbican
102
+requires the 'admin' or 'creator' role be assigned to a user before the user
103
+can list or create key manager objects. The error message that appears if this
104
+is not the case is as follows::
105
+
106
+    Could not list objects: Key manager error: Forbidden: Secret(s) retrieval attempt not allowed - please review your user/project privileges
107
+
108
+To add the appropriate role for a non-admin user, use the following command (as an admin)  ::
109
+
110
+    openstack role add --user <username> --project <project name> creator
111
+
112
+See Also
113
+--------
114
+
115
+* Castellan: https://github.com/openstack/castellan
116
+* Barbican: https://github.com/openstack/barbican
117
+* Vault: https://github.com/hashicorp/vault
118
+* PyKMIP: https://github.com/OpenKMIP/PyKMIP

Loading…
Cancel
Save