Browse Source

update README

  add basic instructions for building/installing plugin

Change-Id: I8820b6c7770410a0175a5d8d245d1c0b9df2a6af
changes/67/235167/2
vsaienko 3 years ago
parent
commit
e73c709f3d
1 changed files with 31 additions and 1 deletions
  1. 31
    1
      README.md

+ 31
- 1
README.md View File

@@ -1,4 +1,34 @@
1 1
 ldap
2 2
 ============
3 3
 
4
-Plugin description
4
+LDAP is a Fuel plugin that allows to use existing LDAP server
5
+as authentication backend for Keystone
6
+
7
+This repo contains all necessary files to build LDAP Fuel plugin.
8
+Supported Fuel version is 7.0.
9
+
10
+Building the plugin
11
+-------------------
12
+
13
+1. Clone the LDAP plugin repo from `https://github.com/stackforge/fuel-plugin-ldap`.
14
+2. Install Fuel Plugin Builder:
15
+
16
+    ``pip install fuel-plugin-builder``
17
+
18
+3. Execute ``fpb --build <path>`` command, where <path> is the path to the plugin's main
19
+   folder (fuel-plugin-ldap). For example:
20
+
21
+   ``fpb --build fuel-plugin-ldap/``
22
+
23
+4. The ldap-<x.x.x>.rpm plugin file will be created.
24
+
25
+5. Move this file to the Fuel Master node with secure copy (scp):
26
+
27
+    ``scp ldap-<x.x.x>.rpm root@:<the_Fuel_Master_node_IP address>:/tmp``
28
+   ``cd /tmp``
29
+
30
+6. Install it using the following command:
31
+
32
+    ``fuel plugins --install ldap-<x.x.x>.rpm``
33
+
34
+6. Plugin is ready to use and can be enabled on the Settings tab of the Fuel web UI.

Loading…
Cancel
Save