Skip to content
Permalink
Browse files
some minor improvements
  • Loading branch information
shawnmckinney committed Jan 2, 2022
1 parent c93e1ac commit 4847880cda9cd9c6e5155790633f1f4c0de94eda
Showing 2 changed files with 34 additions and 38 deletions.
@@ -16,7 +16,7 @@
specific language governing permissions and limitations
under the License.

# APACHEDS & Fortress QUICKSTART on DOCKER
# APACHEDS & Apache Fortress QUICKSTART on DOCKER

-------------------------------------------------------------------------------
## Table of Contents
@@ -25,8 +25,8 @@
* SECTION 1. Prerequisites
* SECTION 2. APACHEDS Docker Image
* SECTION 3. Apache Fortress Setup
* SECTION 3. Apache Fortress Core Integration Test
* SECTION 4. Docker Commands
* SECTION 4. Apache Fortress Core Integration Test
* SECTION 5. Docker Command Reference
___________________________________________________________________________________
## Document Overview

@@ -37,36 +37,35 @@ ________________________________________________________________________________
## SECTION 1. Prerequisites

Minimum software requirements:
* RHEL or Debian Machine
* Linux Machine with docker-engine
* Java SDK >= 8
* Apache Maven >= 3
* docker-engine

___________________________________________________________________________________
## SECTION 2. ApacheDS Docker Image

1. Download the package:
1. Get the Apache Fortress Core package:

a. from git latest:
a. clone git latest:
```bash
git clone https://gitbox.apache.org/repos/asf/directory-fortress-core.git
cd directory-fortress-core
```

b. from git latest release:
b. clone git release:
```bash
git clone --branch 2.0.7 https://gitbox.apache.org/repos/asf/directory-fortress-core.git
cd directory-fortress-core
```

c. or from Apache:
c. or download source package from Apache:
```bash
wget https://www.apache.org/dist/directory/fortress/dist/2.0.7/fortress-core-2.0.7-source-release.zip
unzip fortress-core-2.0.7-source-release.zip
cd fortress-core-2.0.7
```

2. To build the apachedirectory apacheds docker image (trailing dot matters):
2. Build the ApacheDS docker image (trailing dot matters):

```bash
docker build -t apachedirectory/apacheds-for-apache-fortress-tests -f src/docker/apacheds-for-apache-fortress-tests/Dockerfile .
@@ -78,7 +77,7 @@ docker build -t apachedirectory/apacheds-for-apache-fortress-tests -f src/docker
docker pull apachedirectory/apacheds-for-apache-fortress-tests
```

3. Run the docker container:
3. Run the ApacheDS docker image:

```bash
docker run --name=apacheds -d -p 10389:10389 -P apachedirectory/apacheds-for-apache-fortress-tests
@@ -87,7 +86,7 @@ docker run --name=apacheds -d -p 10389:10389 -P apachedirectory/apacheds-for-apa
* Here we're mapping the internal port for running image to what the host machine uses, w/ apacheds' default of 10389
* Setting name=apacheds for managing image.

4. Verify it's running:
4. Verify the image started successfully:

```bash
root@localhost:/opt/fortress/directory-fortress-core# docker ps
@@ -150,9 +149,9 @@ export PATH=$PATH:$M2_HOME/bin
cp build.properties.example build.properties
```
* Seeds the fortress properties with defaults for apacheds.
* [build.properties.example](build.properties.example) contains the default config for the apacheds docker image.
* Learn how the fortress config subsystem works: [README-CONFIG](README-CONFIG.md).
* Seeds the fortress properties with defaults for ApacheDS usage.
* [build.properties.example](build.properties.example) contains the default config for the apacheds docker image.
* Learn how the fortress config subsystem works: [README-CONFIG](README-CONFIG.md).
3. Run the maven install to build fortress and initialize config settings:
@@ -177,7 +176,7 @@ mvn -Dtest=FortressJUnitTest test
```
More about this step:
* Tests the APIs against your LDAP server.*
* Tests the APIs against your LDAP server.
3. Verify the tests worked:
@@ -269,7 +268,7 @@ fortress-load-debug:
* SECTION 14. Instructions to performance test.
___________________________________________________________________________________
## SECTION 5. Docker Commands
## SECTION 5. Docker Command Reference
Here are some common commands needed to manage the Docker image.
@@ -16,7 +16,7 @@
specific language governing permissions and limitations
under the License.

# OpenLDAP & Fortress QUICKSTART on DOCKER
# OpenLDAP & Apache Fortress QUICKSTART on DOCKER

-------------------------------------------------------------------------------
## Table of Contents
@@ -26,7 +26,7 @@
* SECTION 2. OpenLDAP Docker Image
* SECTION 3. Apache Fortress Core Setup
* SECTION 4. Apache Fortress Core Integration Test
* SECTION 5. Docker Commands
* SECTION 5. Docker Command Reference
___________________________________________________________________________________
## Document Overview

@@ -37,36 +37,35 @@ ________________________________________________________________________________
## SECTION 1. Prerequisites

Minimum software requirements:
* RHEL or Debian Machine
* Linux Machine with docker-engine
* Java SDK >= 8
* Apache Maven >= 3
* docker-engine

___________________________________________________________________________________
## SECTION 2. OpenLDAP Docker Image

1. Download the package:
1. Get the Apache Fortress Core package:

a. from git latest:
a. clone git latest:
```bash
git clone https://gitbox.apache.org/repos/asf/directory-fortress-core.git
cd directory-fortress-core
```

b. from git latest release:
b. clone git release:
```bash
git clone --branch 2.0.7 https://gitbox.apache.org/repos/asf/directory-fortress-core.git
cd directory-fortress-core
```

c. or from Apache:
c. or download source package from Apache:
```bash
wget https://www.apache.org/dist/directory/fortress/dist/2.0.7/fortress-core-2.0.7-source-release.zip
unzip fortress-core-2.0.7-source-release.zip
cd fortress-core-2.0.7
```

2. Now build the apachedirectory openldap docker image (trailing dot matters):
2. Build the OpenLDAP docker image (trailing dot matters):

```bash
docker build -t apachedirectory/openldap-for-apache-fortress-tests -f src/docker/openldap-for-apache-fortress-tests/Dockerfile .
@@ -78,23 +77,24 @@ docker build -t apachedirectory/openldap-for-apache-fortress-tests -f src/docker
docker pull apachedirectory/openldap-for-apache-fortress-tests
```

3. Run the docker container:
3. Run the OpenLDAP docker image:

```bash
docker run --name=openldap -d -p 389:389 -P apachedirectory/openldap-for-apache-fortress-tests
```

* Depending on your Docker setup, may need to run this step as root or sudo priv's.
* Here we're mapping the internal port for running image to what the host machine uses, w/ OpenLDAP's default of 389
* Setting name=openldap for managing image.

4. Verify it's running:
4. Verify the image started successfully:

```bash
root@localhost:/opt/fortress/directory-fortress-core# docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
8ca5feb67906 apachedirectory/openldap-for-apache-fortress-tests "/opt/symas/lib/slap…" 3 seconds ago Up 2 seconds 0.0.0.0:389->389/tcp, :::389->389/tcp openldap
```

5. Manage:
5. Manage OpenLDAP Image:

a. start
```bash
@@ -149,9 +149,9 @@ cp build.properties.example build.properties
cp slapd.properties.example slapd.properties
```

* Seeds the fortress properties with defaults for openldap.
* [slapd.properties.example](slapd.properties.example) contains the default config for openldap docker image.
* Learn how the fortress config subsystem works: [README-CONFIG](README-CONFIG.md).
* Seeds the fortress properties with defaults for OpenLDAP usage.
* [slapd.properties.example](slapd.properties.example) contains the default config for openldap docker image.
* Learn how the fortress config subsystem works: [README-CONFIG](README-CONFIG.md).

3. Run the maven install to build fortress and initialize config settings:

@@ -176,10 +176,7 @@ mvn -Dtest=FortressJUnitTest test
```

More about this step:
* Provides the coordinates to the ldap server running inside Docker container.
* Replace the 'fortress.port' value with result from ```echo $CONTAINER_PORT```.
* if Docker image running on a different machine, replace fortress.host to point to it.
* Tests the APIs against your LDAP server.*
* Tests the APIs against your LDAP server.

3. Verify the tests worked:

@@ -271,7 +268,7 @@ fortress-load-debug:
* SECTION 14. Instructions to performance test.

___________________________________________________________________________________
## SECTION 5. Docker Commands
## SECTION 5. Docker Command Reference

#### Build image

0 comments on commit 4847880

Please sign in to comment.