This project aims to deploy a DocDokuPLM platform with docker-compose, for debugging and development only

Requirements

• Docker
• Docker Compose
• Git

platform-ctl is a command wrapper that aims to ease build, deployment and starting/stopping the whole software stack.

Run platform-ctl help to list all commands

First step is to clone the repositories and to create the base images. This may take a while, let's have a coffee break.

You can clone with ssh or https (default).

./platform-ctl init-repo [ssh|https]
./platform-ctl build-images

Then it's time to package some artifacts

./platform-ctl build-artifacts

Start the platform

./platform-ctl up

Deploy the artifacts

./platform-ctl deploy

Launch your browser once artifacts are all deployed

./platform-ctl browser [dev|prod]

Get platform health

./platofrm-ctl heatlh

List platform containers

./platform-ctl status

Output logs from all containers

./platform-ctl logs

You can run any command in the build env with

./platform-ctl run "<command>"

Example

./platform-ctl run "mvn clean install -f /src/docdoku-plm/pom.xml"

Or open a shell into the container

./platform-ctl run "bash"

Look at the build-env/Dockerfile for more details on the system

You can create an admin account, or users accounts

./platform-ctl create-user demo changeit
./platform-ctl create-admin root supersecret

You can also directly connect to the sql instance

./platform-ctl sql

You will be asked for your MySQL password (See db/init.sql)

This will shut down all containers

./platform-ctl down

Add to your /etc/hosts file

127.0.0.1	docdokuplm.local

You can edit the sources in the volumes/src folder and work with git as usual. Run the command git fetch --unshallow on each repository to get the full history.

Use the remote debug feature from your IDE. Payara debug port is 19009.

Add to your remote target options -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=19009

Available apps and ports on docdokuplm.local

• 14848: payara admin
• 19009: payara debug
• 10080: front (dist) + webservices
• 10081: front (dev) + webservices
• 10082: elasticsearch
• 10083: kibana
• 10084: MailHog

For more advanced commands, all docker-compose commands are supported. See https://docs.docker.com/compose/reference/ for full details

platform-ctl can be symlinked or added to your PATH

(sudo) ln -s /path/to/platform-ctl /usr/bin/

If you're using Ubuntu, you may need to increase virtual memory

https://www.elastic.co/guide/en/elasticsearch/reference/current/vm-max-map-count.html

You may also need to increase ulimit

https://www.elastic.co/guide/en/elasticsearch/reference/current/setting-system-settings.html

Download and install from .deb file or from your repository (apt-get install docker-ce)

https://download.docker.com/linux/

Install docker-compose if not installed

Download the latest release from https://github.com/docker/compose/releases/

Make it executable and create a symlink or copy it to /usr/local/bin/

Add your user to docker group. Run as root:

# usermod -aG docker your_user_name
# gpasswd -a your_user_name docker

Start the service as root:

# service docker start

Check if install is OK. Run as user:

$ docker ps

Download and open the docker-ce .dmg file from official site. Or browser https://download.docker.com/mac/

Run

$ open -a Docker

Or use the application search bar and type Docker

TODO ...

For local development, you need to trust the self signed certificates.

Copy the certificates from the container to your host

platform-ctl backup-ssl

This will copy the certs to ./volumes/ssl/

To restore saved certs (in case of deploying a new proxy image)

platform-ctl restore-ssl

The JVM running your Java client SDK applications needs to trust the certificate

(sudo) keytool -importcert -file cert.crt -keystore $JAVA_HOME/jre/lib/security/cacerts -storepass changeit -noprompt -alias "docdokuplm.local.cert.crt"

(sudo) keytool -importcert -file rootCA.pem -keystore $JAVA_HOME/jre/lib/security/cacerts -storepass changeit -noprompt -alias "docdokuplm.local.rootCA.pem"

Open keychain access and import both rootCA.pem and cert.crt file. Double click both and set "trust always".

Using ca-certificates

Run as root

apt-get install ca-certificates
cp /host/path/to/certs/* /usr/share/ca-certificates/
update-ca-certificates

TODO ...