You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by el...@apache.org on 2014/10/07 14:58:49 UTC

svn commit: r1629882 - in /directory/site/trunk/content/fortress/quick-start/apacheds: section-IV.mdtext section-IX.mdtext section-V.mdtext section-VI.mdtext section-VII.mdtext section-VIII.mdtext section-X.mdtext

Author: elecharny
Date: Tue Oct  7 12:58:48 2014
New Revision: 1629882

URL: http://svn.apache.org/r1629882
Log:
Adding the last ApacheDS quick start pages

Added:
    directory/site/trunk/content/fortress/quick-start/apacheds/section-IV.mdtext
    directory/site/trunk/content/fortress/quick-start/apacheds/section-IX.mdtext
    directory/site/trunk/content/fortress/quick-start/apacheds/section-V.mdtext
    directory/site/trunk/content/fortress/quick-start/apacheds/section-VI.mdtext
    directory/site/trunk/content/fortress/quick-start/apacheds/section-VII.mdtext
    directory/site/trunk/content/fortress/quick-start/apacheds/section-VIII.mdtext
    directory/site/trunk/content/fortress/quick-start/apacheds/section-X.mdtext

Added: directory/site/trunk/content/fortress/quick-start/apacheds/section-IV.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/fortress/quick-start/apacheds/section-IV.mdtext?rev=1629882&view=auto
==============================================================================
--- directory/site/trunk/content/fortress/quick-start/apacheds/section-IV.mdtext (added)
+++ directory/site/trunk/content/fortress/quick-start/apacheds/section-IV.mdtext Tue Oct  7 12:58:48 2014
@@ -0,0 +1,69 @@
+Title: Section IV - Instructions to regression test Fortress and ApacheDS
+NavPrev: section-III.html
+NavPrevText: Section III - Instructions to configure ApacheDS and load with seed data
+NavUp: apacheds.html
+NavUpText: Quickstart ApacheDS - Table of contents
+NavNext: section-V.html
+NavNextText: Section V - Instructions to install Commander Web UI Demo
+Notice: 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.
+
+## Section IV - Instructions to regression test Fortress and ApacheDS on target machine (optional)
+
+### Step 1
+
+From FORTRESS_HOME root folder, enter the following command from a system prompt:
+
+    ./b.sh test-full 
+
+<CENTER>
+  <IMG src="../../images/Screenshot10-ant-test-init.png" alt="Screenshot"/>
+</CENTER>
+
+Note: The Fortress regression tests will run for around 3 minutes.
+
+### Step 2
+
+Verify these tests ran with no ERRORS.
+
+    BUILD SUCCESSFUL 
+
+<CENTER>
+  <IMG src="../../images/Screenshot11-ant-test-success.png" alt="Screenshot" width="766" height="59"/>
+</CENTER>
+
+### Step 3
+
+To re-run these tests: 
+
+    ./b.sh test-full
+
+<DIV class="note" markdown="1">
+    WARNING messages in test output are good as these are negative tests in action.
+</DIV>
+
+<CENTER>
+  <IMG src="../../images/Screenshot12-junit-warn.png" alt="Screenshot"/>
+</CENTER>
+
+<DIV class="note" markdown="1">
+    If you made it this far without junit or ant ERRORS, the Fortress and ApacheDS IAM system are certified to run on your machine. 
+</DIV>
+
+<DIV class="note" markdown="1">
+    These tests load tens of thousands of records into your newly installed directory. The 'init-apacheds' and 'test-full' targets may be re-run as often as necessary. After regressions testing has completed, you may run the 'init-apacheds' target to remove all test data from the directory. 
+</DIV>

Added: directory/site/trunk/content/fortress/quick-start/apacheds/section-IX.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/fortress/quick-start/apacheds/section-IX.mdtext?rev=1629882&view=auto
==============================================================================
--- directory/site/trunk/content/fortress/quick-start/apacheds/section-IX.mdtext (added)
+++ directory/site/trunk/content/fortress/quick-start/apacheds/section-IX.mdtext Tue Oct  7 12:58:48 2014
@@ -0,0 +1,90 @@
+Title: Section IX - Instructions to regression test EnMasse Policy server
+NavPrev: section-VIII.html
+NavPrevText: Section VIII - Instructions to install EnMasse Policy Server Demo
+NavUp: apacheds.html
+NavUpText: Quickstart ApacheDS - Table of contents
+NavNext: section-X.html
+NavNextText: Section X - misc info about other utilities
+Notice: 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.
+
+## Section XII - Instructions to regression test EnMasse Policy server on target machine (optional)
+
+### Step 1
+
+Edit file named 'build.properties' and enable REST protocol here:
+
+    enable.mgr.impl.rest=true
+
+Accept the defaults for other HTTP parameters in build.properties:
+
+    http.user=demouser4 
+    http.pw=gX9JbCTxJW5RiH+otQEX0Ja0RIAoPBQf 
+    http.host=localhost 
+    http.port=8080
+
+Should look like the following: 
+
+<CENTER>
+  <IMG src="../../images/Screenshot41-enmasse-http-settings.png" alt="Screenshot" width="766" height="88"/>
+</CENTER>
+
+### Step 2
+
+Save and exit the text file editor
+
+### Step 3
+
+From FORTRESS_HOME root folder, enter the following command from a system prompt:
+
+    ./b.sh test-full 
+
+
+wrong picture...
+
+<CENTER>
+  <IMG src="../../images/Screenshot10-ant-test-init.png" alt="Screenshot"/>
+</CENTER>
+
+Note: The EnMasse regression tests will run for around 20 minutes.
+
+### Step 4
+
+Verify these tests ran with no ERRORS.
+
+    BUILD SUCCESSFUL 
+
+<CENTER>
+  <IMG src="../../images/Screenshot43-ant-enmasse-test-success.png" alt="Screenshot"/>
+</CENTER>
+
+### Step 5
+
+This regression test may be rerun as often as necessary:
+
+    ./b.sh test-full
+
+Note 1 : WARNING messages in test output are good as these are negative tests in action : 
+
+<CENTER>
+  <IMG src="../../images/Screenshot12-junit-warn.png" alt="Screenshot" width="766" height="34"/>
+</CENTER>
+
+Note 2: If you made it this far without junit or ant ERRORS, EnMasse is installed and certified to run on your machine.
+
+Note 3: These tests load tens of thousands of records into your directory. The 'test-full' target may be re-run as often as necessary. After regressions testing have completed, you may run the 'init-slapd' target to remove all test data from the directory. 
+

Added: directory/site/trunk/content/fortress/quick-start/apacheds/section-V.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/fortress/quick-start/apacheds/section-V.mdtext?rev=1629882&view=auto
==============================================================================
--- directory/site/trunk/content/fortress/quick-start/apacheds/section-V.mdtext (added)
+++ directory/site/trunk/content/fortress/quick-start/apacheds/section-V.mdtext Tue Oct  7 12:58:48 2014
@@ -0,0 +1,67 @@
+Title: Section V - Instructions to run the Fortress Command Line Interpreter (CLI) utility
+NavPrev: section-IV.html
+NavPrevText: Section IV - Instructions to regression test Fortress and ApacheDS
+NavUp: apacheds.html
+NavUpText: Quickstart ApacheDS - Table of contents
+NavNext: section-VI.html
+NavNextText: Section VI - Instructions to run Fortress Console
+Notice: 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.
+
+## Section V - Instructions to run the Fortress Command Line Interpreter (CLI) utility
+
+This command line tool provides an interactive session with the user based on a simple command line syntax.
+
+### Step 1
+
+To start the CLI, enter:
+
+    ./b.sh cli 
+
+<CENTER>
+  <IMG src="../../images/Screenshot13-ant-cli.png" alt="Screenshot" width="766" height="48"/>
+</CENTER>
+
+Which will bring up the command interpreter: 
+
+<CENTER>
+  <IMG src="../../images/Screenshot14-cli.png" alt="Screenshot" width="766" height="78"/>
+</CENTER>
+
+### Step 2
+
+enter the command:
+
+    review fuser -u demo 
+
+<CENTER>
+  <IMG src="../../images/Screenshot15-cli-review.png" alt="Screenshot" width="766" height="78"/>
+</CENTER>
+ 
+This example will return all users with userId that begins with 'demo':
+
+<CENTER>
+  <IMG src="../../images/Screenshot16-cli-fuser.png" alt="Screenshot" width="766" height="682"/>
+</CENTER>
+
+### Step 3
+
+To learn more about the CLI and what it can do, follow instructions in the command line interpreter reference manual in the javadoc located here:
+
+    [Command Line Interpreter](link...)
+
+Note: if javadocs are not found, go to [Section VII](section-VII.html)
\ No newline at end of file

Added: directory/site/trunk/content/fortress/quick-start/apacheds/section-VI.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/fortress/quick-start/apacheds/section-VI.mdtext?rev=1629882&view=auto
==============================================================================
--- directory/site/trunk/content/fortress/quick-start/apacheds/section-VI.mdtext (added)
+++ directory/site/trunk/content/fortress/quick-start/apacheds/section-VI.mdtext Tue Oct  7 12:58:48 2014
@@ -0,0 +1,85 @@
+Title: Section VI - Instructions to run Fortress Console
+NavPrev: section-V.html
+NavPrevText: Section V -Instructions to run the Fortress Command Line Interpreter (CLI) utility
+NavUp: apacheds.html
+NavUpText: Quickstart ApacheDS - Table of contents
+NavNext: section-VII.html
+NavNextText: Section VII - Instructions to generate and view Javadoc
+Notice: 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.
+
+## Section VI - Instructions to run Fortress Console (optional)
+
+For tasks like one-time setup of new users, password resets, searches the Fortress Console application can be used.
+
+### Step 1
+
+From FORTRESS_HOME root folder, enter the following command from a system prompt:
+
+    ./b.sh console 
+
+<CENTER>
+  <IMG src="../../images/Screenshot17-ant-console.png" alt="Screenshot" width="766" height="49"/>
+</CENTER>
+
+### Some Console Screenshots... 
+
+#### Main Menu: 
+
+<CENTER>
+  <IMG src="../../images/Screenshot18-console-main.png" alt="Screenshot"/>
+</CENTER>
+
+#### Admin Manager Functions
+
+Enter choice 1 and follow the screen prompts to edit RBAC data: 
+
+<CENTER>
+  <IMG src="../../images/Screenshot19-console-admin.png" alt="Screenshot"/>
+</CENTER>
+
+#### Review Manager Functions
+
+Enter choice 2 and follow the screen prompts to search RBAC data: 
+
+<CENTER>
+  <IMG src="../../images/Screenshot20-console-review.png" alt="Screenshot"/>
+</CENTER>
+
+#### Access Manager Functions
+
+Enter choice 3 and follow the screen prompts to test RBAC policies: 
+
+<CENTER>
+  <IMG src="../../images/Screenshot21-console-access.png" alt="Screenshot"/>
+</CENTER>
+
+#### Delegated Admin Manager Functions
+
+Enter choice 4 and follow the screen prompts to setup ARBAC delegated policies: 
+
+<CENTER>
+  <IMG src="../../images/Screenshot22-console-deladmin.png" alt="Screenshot"/>
+</CENTER>
+
+#### Audit Manager Functions
+
+Enter choice 8 and follow the screen prompts to search through the AUDIT log: 
+
+<CENTER>
+  <IMG src="../../images/Screenshot23-console-audit.png" alt="Screenshot"/>
+</CENTER>

Added: directory/site/trunk/content/fortress/quick-start/apacheds/section-VII.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/fortress/quick-start/apacheds/section-VII.mdtext?rev=1629882&view=auto
==============================================================================
--- directory/site/trunk/content/fortress/quick-start/apacheds/section-VII.mdtext (added)
+++ directory/site/trunk/content/fortress/quick-start/apacheds/section-VII.mdtext Tue Oct  7 12:58:48 2014
@@ -0,0 +1,66 @@
+Title: Section VII - Instructions to generate and view Javadoc
+NavPrev: section-VI.html
+NavPrevText: Section VI - Instructions to run Fortress Console
+NavUp: apacheds.html
+NavUpText: Quickstart ApacheDS - Table of contents
+NavNext: section-VIII.html
+NavNextText: Section VIII - Instructions to install EnMasse Policy Server Demo
+Notice: 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.
+
+## Section VII - Instructions to generate and view Javadoc (optional)
+
+### Step 1
+
+Run the javadoc target:
+
+	./b.sh javadoc 
+
+<CENTER>
+  <IMG src="../../images/Screenshot24-ant-javadoc.png" alt="Screenshot" width="766" height="61"/>
+</CENTER>
+
+
+### Step 2
+
+Navigate to where docs are generated:
+
+<CENTER>
+  <IMG src="../../images/Screenshot25-javadoc-listing.png" alt="Screenshot" width="766" height="114"/>
+</CENTER>
+
+### Step 3
+
+Open 'index.html' using your preferred HTML Browser :
+
+<CENTER>
+  <IMG src="../../images/Screenshot26-javadoc.png" alt="Screenshot" width="766" height="463"/>
+</CENTER>
+
+### Step 4
+
+The javadoc provides coverage of the Fortress APIs and also provides explanations on how RBAC, ARBAC, PW Policies and Audit work.
+
+### Step 5
+
+Good places to start learning about Fortress : 
+
+* Fortress Manager Summary
+* RBAC Summary
+* Audit Manager
+* Command Line Interpreter
+* FortressAntTask

Added: directory/site/trunk/content/fortress/quick-start/apacheds/section-VIII.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/fortress/quick-start/apacheds/section-VIII.mdtext?rev=1629882&view=auto
==============================================================================
--- directory/site/trunk/content/fortress/quick-start/apacheds/section-VIII.mdtext (added)
+++ directory/site/trunk/content/fortress/quick-start/apacheds/section-VIII.mdtext Tue Oct  7 12:58:48 2014
@@ -0,0 +1,46 @@
+Title: Section VIII - Instructions to install EnMasse Policy Server Demo
+NavPrev: section-VII.html
+NavPrevText: Section VII - Instructions to generate and view Javadoc
+NavUp: apacheds.html
+NavUpText: Quickstart ApacheDS - Table of contents
+NavNext: section-IX.html
+NavNextText: Section IX - Instructions to regression test EnMasse Policy server
+Notice: 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.
+
+## Section VIII - Instructions to install EnMasse Policy Server Demo (optional)
+
+### Step 1
+
+Run the install-enmasse-demo target:
+
+    ./b.sh install-enmasse-demo 
+
+### Step 2
+
+Verify it ran correctly according to Ant.
+
+    BUILD SUCCESSFUL
+
+<CENTER>
+  <IMG src="../../images/Screenshot42-install-enmasse-demo-success.png" alt="Screenshot" width="766" height="278"/>
+</CENTER>
+
+
+### Step 3
+
+After above step completes, Fortress EnMasse will be installed 

Added: directory/site/trunk/content/fortress/quick-start/apacheds/section-X.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/fortress/quick-start/apacheds/section-X.mdtext?rev=1629882&view=auto
==============================================================================
--- directory/site/trunk/content/fortress/quick-start/apacheds/section-X.mdtext (added)
+++ directory/site/trunk/content/fortress/quick-start/apacheds/section-X.mdtext Tue Oct  7 12:58:48 2014
@@ -0,0 +1,36 @@
+Title: Section X - More Utilities
+NavPrev: section-XIII.html
+NavPrevText: Section XIII - Instructions to regression test EnMasse Policy server
+NavUp: apacheds.html
+NavUpText: Quickstart ApacheDS - Table of contents
+Notice: 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.
+
+## Section X - More Utilities
+Other execution targets you may find useful:
+
+
+* 'test-samples' - contains examples of how the Fortress API's work check out the following javadoc for more info on the samples package: Samples Javadoc 
+* 'admin' - provides an XML-centric way to provision RBAC data policies and user accounts. check out the following javadoc for more info on this utility: Fortress Ant admin script utility document
+* 'encrypt' - interface to jacypt encryption utility
+* 'start-slapd' - Starts OpenLDAP on target machine.
+* 'stop-slapd' - Stops OpenLDAP on target machine. Note: for slapd commands sudo or elevated privileges may be required.
+* display all ant targets available: 
+
+<CENTER>
+  <IMG src="../../images/Screenshot27-ant-p.png" alt="Screenshot" width="766" height="628"/>
+</CENTER>