directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From smckin...@apache.org
Subject directory-fortress-core git commit: FC-125 - OpenLDAP Quickstarts - convert doc to md
Date Tue, 08 Dec 2015 20:38:05 GMT
Repository: directory-fortress-core
Updated Branches:
  refs/heads/master faa1a32f6 -> a9315f371


 FC-125 - OpenLDAP Quickstarts - convert doc to md


Project: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/repo
Commit: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/commit/a9315f37
Tree: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/tree/a9315f37
Diff: http://git-wip-us.apache.org/repos/asf/directory-fortress-core/diff/a9315f37

Branch: refs/heads/master
Commit: a9315f3719a81c3c7daec55242daf3830fb21669
Parents: faa1a32
Author: Shawn McKinney <smckinney@apache.org>
Authored: Tue Dec 8 14:38:03 2015 -0600
Committer: Shawn McKinney <smckinney@apache.org>
Committed: Tue Dec 8 14:38:03 2015 -0600

----------------------------------------------------------------------
 README-QUICKSTART-SLAPD.md  | 276 +++++++++++++++++++++++++++++++++++++++
 README-QUICKSTART-SLAPD.txt | 223 -------------------------------
 2 files changed, 276 insertions(+), 223 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/a9315f37/README-QUICKSTART-SLAPD.md
----------------------------------------------------------------------
diff --git a/README-QUICKSTART-SLAPD.md b/README-QUICKSTART-SLAPD.md
new file mode 100644
index 0000000..9622a31
--- /dev/null
+++ b/README-QUICKSTART-SLAPD.md
@@ -0,0 +1,276 @@
+
+   Licensed to the Apache Software Foundation (ASF) under one
+   or more contributor license agreements.  See the NOTICE file
+   distributed with this work for additional information
+   regarding copyright ownership.  The ASF licenses this file
+   to you under the Apache License, Version 2.0 (the
+   "License"); you may not use this file except in compliance
+   with the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing,
+   software distributed under the License is distributed on an
+   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+   KIND, either express or implied.  See the License for the
+   specific language governing permissions and limitations
+   under the License.
+
+# README for Apache Fortress and OpenLDAP QUICKSTART
+ Apache Fortress Version 1.0-RC41 System Architecture Diagram
+ ![OpenLDAP Accelerator System Architecture](images/fortress-openldap-accel-system-arch.png
"OpenLDAP & Apache Fortress System Architecture")
+
+-------------------------------------------------------------------------------
+
+This README Covers these sections:
+ * SECTION 1 - OpenLDAP Machine Prereqs
+ * SECTION 2 - Apache Fortress Core and OpenLDAP Quickstart
+ * SECTION 3 - Apache Fortress Realm Setup
+ * SECTION 4 - Apache Tomcat Setup Fortress Usage
+ * SECTION 5 - Apache Fortress Rest Setup
+ * SECTION 6 - Apache Fortress Web Setup
+
+ Sections 3++ are not required for OpenLDAP Accelerator usage
+-------------------------------------------------------------------------------
+
+# SECTION 1 - OpenLDAP Machine Prereqs
+- 2 Cores, 4GB RAM
+- Java 7++
+- git, ant, maven3++
+- Symas OpenLDAP Silver v.2.4.43++
+  + slapo rbac, access log , pwpolicy overlays
+- slapd.properties file tailored for slapd slapo-rbac overlay enablement. This file will
be used during section 3 to seed openldap with the correct configuration.
+- Apache Fortress v1.0-RC41++
+  + Core, Realm*, Rest* and Web*
+- Tomcat* v7++
+
+ *optional components
+
+___________________________________________________________________________________
+# SECTION 2 - Apache Fortress Core and OpenLDAP Quickstart
+
+1. Download and prepare the package:
+ ```
+ git clone https://git-wip-us.apache.org/repos/asf/directory-fortress-core.git
+ cd directory-fortress-core
+ cp build.properties.example build.properties
+ cp slapd.properties.example slapd.properties
+ ```
+
+2. Download Symas OpenLDAP Silver Binaries:
+ https://symas.com/downloads/
+
+3. Place it under this folder: [directory-fortress-core/ldap](./ldap)
+
+4. Edit the slapd install properties file:
+ ```
+ vi slapd.properties
+ ```
+
+5. Add sudo pw to run install script (if running slapd with sudo per step 10):
+ ```
+ sudo.pw=mysudopassword
+ ```
+
+6. Update with slapd install for package downladed.
+
+ a. For Debian installs:
+ ```
+ slapd.install=dpkg -i symas-openldap-silver.version.platform.deb
+ ```
+
+ b. For Redhat:
+ ```
+ slapd.install=rpm -i symas-openldap-silver.version.platform.rpm
+ ```
+
+7. Specify whether you want to enable slapo-rbac overlay:
+
+ a. Yes, I want to enable slapo-rbac:
+ ```
+ rbac.accelerator=true
+ ```
+
+ note: to use this option, symas-openldap version 2.4.43++ is required.
+
+ b. No, I don't want to enable slapo-rbac:
+ ```
+ rbac.accelerator=false
+ ```
+
+8. Save and exit
+
+9. Run the maven install:
+ ```
+ mvn clean install
+ ```
+
+10. Install, configure and load openldap with DIT and seed data:
+
+ a. If sudo:
+ ```
+ sudo ./b.sh init-slapd
+ ```
+
+ b. No sudo, running as priv user:
+ ```
+ ./b.sh init-slapd
+ ```
+
+11. Run the fortress core regression tests:
+ ```
+ mvn test -Dtest=FortressJUnitTest
+ ```
+
+12. Run the openldap accelerator regression tests:
+ ```
+ mvn test -Dtest=AccelMgrImplTest
+ ```
+
+ note: only run this test if slapo-rbac overlay enabled.
+
+13. All tests should run without errors.
+
+14. Try the fortress console:
+ ```
+ mvn install -Pconsole
+ ```
+___________________________________________________________________________________
+# SECTION 3 - Apache Fortress Realm Setup
+
+During this section, you will be asked to setup Apache Fortress Realm.
+
+1. Download and prepare:
+ ```
+ git clone https://git-wip-us.apache.org/repos/asf/directory-fortress-realm.git
+ cd directory-fortress-realm
+ ```
+
+2. Build:
+ ```
+ mvn clean install
+ ```
+
+___________________________________________________________________________________
+# SECTION 4 - Apache Tomcat Setup Fortress Usage
+
+During this section, you will be asked to setup Apache Tomcat 8 and prepare for usage with
Apache Fortress
+
+1. Download and prepare the package:
+ ```
+ wget http://apache.mirrorcatalogs.com/tomcat/tomcat-8/v8.0.29/bin/apache-tomcat-8.0.29.tar.gz
+ tar -xvf apache-tomcat-8.0.29.tar.gz
+ sudo mv apache-tomcat-8.0.29 /usr/local/tomcat8
+ ```
+ note: change the tomcat version as neeeded - v7 and beyond are ok.
+
+2. Copy the fortress realm proxy jar into tomcat/lib folder:
+ ```
+ sudo cp ./directory-fortress-realm/proxy/target/fortress-realm-proxy-1.0-RC41-SNAPSHOT.jar
/usr/local/tomcat8/lib
+ ```
+
+3. Prepare tomcat fortress usage:
+ ```
+ sudo vi /usr/local/tomcat8/conf/tomcat-users.xml
+ ```
+
+4. Add tomcat user to deploy fortress:
+ ```
+ <role rolename="manager-script"/>
+ <role rolename="manager-gui"/>
+ <user username="tcmanager" password="m@nager123" roles="manager-script"/>
+ <user username="tcmanagergui" password="m@nager123" roles="manager-gui"/>
+ ```
+
+5. Save and exit tomcat-users.xml file
+
+6. Start tomcat server:
+ ```
+ sudo /usr/local/tomcat8/bin/startup.sh
+ ```
+
+7.  Verify clean logs after startup:
+ ```
+ tail -f -n10000 /usr/local/tomcat8/logs/catalina.out
+ ```
+
+8.  Verify setup by signing onto the Tomcat Manager app with credentials userId: tcmanagergui,
password: m@nager123
+ ```
+ http://hostname:8080/manager
+ ```
+
+___________________________________________________________________________________
+# SECTION 5 - Apache Fortress Rest Setup
+
+During this section, you will be asked to setup Apache Fortress Rest Application
+
+1. Download and prepare the package:
+ ```
+ git clone https://git-wip-us.apache.org/repos/asf/directory-fortress-enmasse.git
+ cp ./directory-fortress-core/config/fortress.properties ./directory-fortress-enmasse/src/main/resources
+ cd directory-fortress-enmasse
+ ```
+
+2. Build:
+ ```
+ mvn clean install
+ ```
+
+3. Perform fortress rest test policy load:
+ ```
+ mvn install -Dload.file=./src/main/resources/FortressRestServerPolicy.xml
+ ```
+
+4. Deploy:
+ ```
+ mvn tomcat:deploy
+ ```
+
+5. Redeploy (if need be):
+ ```
+ mvn tomcat:redeploy
+ ```
+
+6. Smoke test:
+ ```
+ mvn test -Dtest=EmTest
+ ```
+
+___________________________________________________________________________________
+# SECTION 6 - Apache Fortress Web Setup
+
+During this section, you will be asked to setup Apache Fortress Web Application
+
+1. Download and prepare the package:
+ ```
+ git clone https://git-wip-us.apache.org/repos/asf/directory-fortress-commander.git
+ cp ./directory-fortress-core/config/fortress.properties ./directory-fortress-commander/src/main/resources
+ cd directory-fortress-commander
+ ```
+
+2. Build:
+ ```
+ mvn clean install
+ ```
+
+3. Perform fortress web test policy load:
+ ```
+ mvn install -Dload.file=./src/main/resources/FortressWebDemoUsers.xml
+ ```
+
+4. Deploy:
+ ```
+ mvn tomcat:deploy
+ ```
+
+5. Redeploy (if need be):
+ ```
+ mvn tomcat:redeploy
+ ```
+
+6. Open browser and test (creds: test/password):
+ ```
+ http://hostname:8080/fortress-web
+ ```
+
+7. Click on the links, to pull up various views on the data stored in the directory.
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/directory-fortress-core/blob/a9315f37/README-QUICKSTART-SLAPD.txt
----------------------------------------------------------------------
diff --git a/README-QUICKSTART-SLAPD.txt b/README-QUICKSTART-SLAPD.txt
deleted file mode 100644
index 6bfb873..0000000
--- a/README-QUICKSTART-SLAPD.txt
+++ /dev/null
@@ -1,223 +0,0 @@
-#
-#   Licensed to the Apache Software Foundation (ASF) under one
-#   or more contributor license agreements.  See the NOTICE file
-#   distributed with this work for additional information
-#   regarding copyright ownership.  The ASF licenses this file
-#   to you under the Apache License, Version 2.0 (the
-#   "License"); you may not use this file except in compliance
-#   with the License.  You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing,
-#   software distributed under the License is distributed on an
-#   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-#   KIND, either express or implied.  See the License for the
-#   specific language governing permissions and limitations
-#   under the License.
-#
-___________________________________________________________________________________
-###################################################################################
-# README for Apache Fortress and OpenLDAP QUICKSTART
-# Version 1.0-RC41
-###################################################################################
-
-Covers these sections
-
-SECTION 1 - Machine Prereqs
-SECTION 2 - Apache Fortress Core and OpenLDAP Quickstart
-SECTION 3 - Apache Fortress Realm Setup
-SECTION 4 - Apache Tomcat Setup Fortress Usage
-SECTION 5 - Apache Fortress Rest Setup
-SECTION 6 - Apache Fortress Web Setup
-
-Sections 3++ are not required for OpenLDAP Accelerator usage
-
-___________________________________________________________________________________
-###################################################################################
-SECTION 1 - Machine Prereqs
-###################################################################################
-
-- 2 Cores, 4GB RAM
-- Java 7++
-- git, ant, maven3++
-- Symas OpenLDAP Silver v.2.4.43++
-  + slapo rbac, access log , pwpolicy overlays
-- slapd.properties file tailored for slapd slapo-rbac overlay enablement. This file will
be used during section 3 to seed openldap with the correct configuration.
-- Apache Fortress v1.0-RC41++
-  + Core, Realm*, Rest* and Web*
-- Tomcat* v7++
-
-*optional
-
-___________________________________________________________________________________
-###################################################################################
-SECTION 2 - Apache Fortress Core and OpenLDAP Quickstart
-###################################################################################
-
-1. download and prepare the package:
-git clone https://git-wip-us.apache.org/repos/asf/directory-fortress-core.git
-cd directory-fortress-core
-cp build.properties.example build.properties
-cp slapd.properties.example slapd.properties
-
-2. Download Symas OpenLDAP Silver Binaries:
-https://symas.com/downloads/
-
-3. Place it under this folder:
-directory-fortress-core/ldap
-
-4. edit the install script:
-vi build.properties
-
-5. add sudo priv to script (if using sudo on step 7):
-sudo.pw=mysudopassword
-
-6. Update with slapd install for package downladed.
-
-a. For Debian installs:
-slapd.install=dpkg -i symas-openldap-silver.version.platform.deb
-
-b. For Redhat:
-slapd.install=rpm -i symas-openldap-silver.version.platform.rpm
-
-7. Specify whether you want to enable slapo-rbac overlay:
-
-a. enable slapo-rbac:
-rbac.accelerator=true
-
-note: to use this option, symas-openldap version 2.4.43++ is required.
-
-b. don't enable slapo-rbac:
-rbac.accelerator=false
-
-8. save and exit
-
-9. run the maven install:
-mvn clean install
-
-10. install, configure and load openldap with DIT and seed data:
-sudo ./b.sh init-slapd
-
-or if running as priv user:
-./b.sh init-slapd
-
-11. run the fortress core regression tests:
-mvn test -Dtest=FortressJUnitTest
-
-12. run the openldap accelerator regression tests:
-mvn test -Dtest=AccelMgrImplTest
-
-note: only run this test if slapo-rbac overlay enabled.
-
-13. all tests should run without errors.
-
-14. run the console:
-mvn install -Pconsole
-
-___________________________________________________________________________________
-###################################################################################
-SECTION 3 - Apache Fortress Realm Setup
-###################################################################################
-
-During this section, you will be asked to setup Apache Fortress Realm.
-
-1. download and prepare:
-git clone https://git-wip-us.apache.org/repos/asf/directory-fortress-realm.git
-cd directory-fortress-realm
-
-2. build:
-mvn clean install
-
-___________________________________________________________________________________
-###################################################################################
-SECTION 4 - Apache Tomcat Setup Fortress Usage
-###################################################################################
-
-During this section, you will be asked to setup Apache Tomcat 8 and prepare for usage with
Apache Fortress
-
-1. download and prepare the package:
-wget http://apache.mirrorcatalogs.com/tomcat/tomcat-8/v8.0.29/bin/apache-tomcat-8.0.29.tar.gz
-tar -xvf apache-tomcat-8.0.29.tar.gz
-sudo mv apache-tomcat-8.0.29 /usr/local/tomcat8
-
-2. copy the fortress realm proxy jar into tomcat/lib folder:
-sudo cp ./directory-fortress-realm/proxy/target/fortress-realm-proxy-1.0-RC41-SNAPSHOT.jar
/usr/local/tomcat8/lib
-
-3. prepare tomcat fortress usage:
-sudo vi /usr/local/tomcat8/conf/tomcat-users.xml
-
-4. add tomcat user to deploy fortress:
-<role rolename="manager-script"/>
-<role rolename="manager-gui"/>
-<user username="tcmanager" password="m@nager123" roles="manager-script"/>
-<user username="tcmanagergui" password="m@nager123" roles="manager-gui"/>
-
-5. save and exit tomcat-users.xml file
-
-6. start tomcat server:
-sudo /usr/local/tomcat8/bin/startup.sh
-
-7.  Verify clean logs after startup:
-tail -f -n10000 /usr/local/tomcat8/logs/catalina.out
-
-8.  Verify setup by signing onto the Tomcat Manager app with credentials userId: tcmanagergui,
password: m@nager123
-http://hostname:8080/manager
-
-___________________________________________________________________________________
-###################################################################################
-SECTION 5 - Apache Fortress Rest Setup
-###################################################################################
-
-During this section, you will be asked to setup Apache Fortress Rest Application
-
-1. download and prepare the package:
-git clone https://git-wip-us.apache.org/repos/asf/directory-fortress-enmasse.git
-cp ./directory-fortress-core/config/fortress.properties ./directory-fortress-enmasse/src/main/resources
-cd directory-fortress-enmasse
-
-2. build:
-mvn clean install
-
-3. perform fortress rest test policy load:
-mvn install -Dload.file=./src/main/resources/FortressRestServerPolicy.xml
-
-4. deploy:
-mvn tomcat:deploy
-
-5. redeploy (if need be):
-mvn tomcat:redeploy
-
-6. smoke test:
-mvn test -Dtest=EmTest
-
-___________________________________________________________________________________
-###################################################################################
-SECTION 6 - Apache Fortress Web Setup
-###################################################################################
-
-During this section, you will be asked to setup Apache Fortress Web Application
-
-1. download and prepare the package:
-git clone https://git-wip-us.apache.org/repos/asf/directory-fortress-commander.git
-cp ./directory-fortress-core/config/fortress.properties ./directory-fortress-commander/src/main/resources
-cd directory-fortress-commander
-
-2. build:
-mvn clean install
-
-3. perform fortress web test policy load:
-mvn install -Dload.file=./src/main/resources/FortressWebDemoUsers.xml
-
-4. deploy:
-mvn tomcat:deploy
-
-5. redeploy (if need be):
-mvn tomcat:redeploy
-
-6. open browser and test (creds: test/password):
-http://hostname:8080/fortress-web
-
-7. Click on the links, to pull up various views on the data stored in the directory.
-
-**** End of README *****
\ No newline at end of file


Mime
View raw message