Make platformdoc docker container 81/11781/2
authorLusheng Ji <lji@research.att.com>
Mon, 11 Sep 2017 23:38:09 +0000 (23:38 +0000)
committerLusheng Ji <lji@research.att.com>
Tue, 12 Sep 2017 01:42:11 +0000 (01:42 +0000)
Issue-Id: DCAEGEN2-60
Change-Id: Id57ab539707a43883ff957a23d2459a9b12df22e
Signed-off-by: Lusheng Ji <lji@research.att.com>
27 files changed:
mvn-phase-lib.sh [new file with mode: 0755]
mvn-phase-script.sh
platformdoc/Dockerfile [moved from Dockerfile with 100% similarity]
platformdoc/README.md [moved from README.md with 100% similarity]
platformdoc/docs/architecture/pieces.md [moved from docs/architecture/pieces.md with 100% similarity]
platformdoc/docs/architecture/service-discovery.md [moved from docs/architecture/service-discovery.md with 100% similarity]
platformdoc/docs/components/component-specification/cdap-specification.md [moved from docs/components/component-specification/cdap-specification.md with 100% similarity]
platformdoc/docs/components/component-specification/common-specification.md [moved from docs/components/component-specification/common-specification.md with 100% similarity]
platformdoc/docs/components/component-specification/docker-specification.md [moved from docs/components/component-specification/docker-specification.md with 100% similarity]
platformdoc/docs/components/component-specification/generated-configuration.md [moved from docs/components/component-specification/generated-configuration.md with 100% similarity]
platformdoc/docs/components/component-specification/start-here.md [moved from docs/components/component-specification/start-here.md with 100% similarity]
platformdoc/docs/components/component-type-cdap.md [moved from docs/components/component-type-cdap.md with 100% similarity]
platformdoc/docs/components/component-type-docker.md [moved from docs/components/component-type-docker.md with 100% similarity]
platformdoc/docs/components/data-formats.md [moved from docs/components/data-formats.md with 100% similarity]
platformdoc/docs/components/dcae-cli/dmaap-connection-objects.md [moved from docs/components/dcae-cli/dmaap-connection-objects.md with 100% similarity]
platformdoc/docs/components/dcae-cli/quickstart.md [moved from docs/components/dcae-cli/quickstart.md with 100% similarity]
platformdoc/docs/components/dcae-cli/walkthrough.md [moved from docs/components/dcae-cli/walkthrough.md with 100% similarity]
platformdoc/docs/components/intro.md [moved from docs/components/intro.md with 100% similarity]
platformdoc/docs/glossary.md [moved from docs/glossary.md with 100% similarity]
platformdoc/docs/images/IO.graffle [moved from docs/images/IO.graffle with 100% similarity]
platformdoc/docs/images/dmd vision.graffle [moved from docs/images/dmd vision.graffle with 100% similarity]
platformdoc/docs/images/dmdvision.png [moved from docs/images/dmdvision.png with 100% similarity]
platformdoc/docs/images/io.png [moved from docs/images/io.png with 100% similarity]
platformdoc/docs/index.md [moved from docs/index.md with 100% similarity]
platformdoc/mkdocs.yml [moved from mkdocs.yml with 100% similarity]
platformdoc/pom.xml [new file with mode: 0644]
pom.xml

diff --git a/mvn-phase-lib.sh b/mvn-phase-lib.sh
new file mode 100755 (executable)
index 0000000..2a924f7
--- /dev/null
@@ -0,0 +1,296 @@
+#!/bin/bash
+
+# ================================================================================
+# Copyright (c) 2017 AT&T Intellectual Property. All rights reserved.
+# ================================================================================
+# Licensed 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.
+# ============LICENSE_END=========================================================
+#
+# ECOMP is a trademark and service mark of AT&T Intellectual Property.
+
+
+clean_templated_files() 
+{
+  TEMPLATE_FILES=$(find . -name "*-template")
+  for F in $TEMPLATE_FILES; do
+    F2=$(echo "$F" | sed 's/-template$//')
+    rm -f "$F2"
+  done
+}
+clean_tox_files() 
+{
+  TOX_FILES=$(find . -name ".tox")
+  TOX_FILES="$TOX_FILES $(find . -name 'venv-tox')"
+  for F in $TOX_FILES; do
+    rm -rf "$F"
+  done
+}
+
+expand_templates() 
+{
+  # set up env variables, get ready for template resolution
+  # NOTE: CCSDK artifacts do not distinguish REALESE vs SNAPSHOTs
+  export ONAPTEMPLATE_RAWREPOURL_org_onap_ccsdk_platform_plugins_releases="$MVN_RAWREPO_BASEURL_DOWNLOAD/org.onap.ccsdk.platform.plugins"
+  export ONAPTEMPLATE_RAWREPOURL_org_onap_ccsdk_platform_plugins_snapshots="$MVN_RAWREPO_BASEURL_DOWNLOAD/org.onap.ccsdk.platform.plugins"
+  export ONAPTEMPLATE_RAWREPOURL_org_onap_ccsdk_platform_blueprints_releases="$MVN_RAWREPO_BASEURL_DOWNLOAD/org.onap.ccsdk.platform.blueprints"
+  export ONAPTEMPLATE_RAWREPOURL_org_onap_ccsdk_platform_blueprints_snapshots="$MVN_RAWREPO_BASEURL_DOWNLOAD/org.onap.ccsdk.platform.blueprints"
+  export ONAPTEMPLATE_RAWREPOURL_org_onap_dcaegen2_releases="$MVN_RAWREPO_BASEURL_DOWNLOAD/org.onap.dcaegen2/releases"
+  export ONAPTEMPLATE_RAWREPOURL_org_onap_dcaegen2_snapshots="$MVN_RAWREPO_BASEURL_DOWNLOAD/org.onap.dcaegen2/snapshots"
+  export ONAPTEMPLATE_RAWREPOURL_org_onap_dcaegen2_platform_plugins_releases="$MVN_RAWREPO_BASEURL_DOWNLOAD/org.onap.dcaegen2.platform.plugins/releases"
+  export ONAPTEMPLATE_RAWREPOURL_org_onap_dcaegen2_platform_plugins_snapshots="$MVN_RAWREPO_BASEURL_DOWNLOAD/org.onap.dcaegen2.platform.plugins/snapshots"
+  export ONAPTEMPLATE_RAWREPOURL_org_onap_dcaegen2_platform_blueprints_releases="$MVN_RAWREPO_BASEURL_DOWNLOAD/org.onap.dcaegen2.platform.blueprints/releases"
+  export ONAPTEMPLATE_RAWREPOURL_org_onap_dcaegen2_platform_blueprints_snapshots="$MVN_RAWREPO_BASEURL_DOWNLOAD/org.onap.dcaegen2.platform.blueprints/snapshots"
+
+  export ONAPTEMPLATE_PYPIURL_org_onap_dcaegen2="${MVN_NEXUSPROXY}/content/sites/pypi"
+
+  export ONAPTEMPLATE_DOCKERREGURL_org_onap_dcaegen2_releases="$MVN_DOCKERREGISTRY_DAILY"
+  export ONAPTEMPLATE_DOCKERREGURL_org_onap_dcaegen2_snapshots="$MVN_DOCKERREGISTRY_DAILY/snapshots"
+
+
+  TEMPLATE_FILES=$(find . -name "*-template")
+  for F in $TEMPLATE_FILES; do
+    F2=$(echo "$F" | sed 's/-template$//')
+    cp "$F" "$F2"
+    MOD=$(stat --format '%a' "$F")
+    chmod "$MOD" "$F2"
+  done
+   
+
+  TEMPLATES=$(env |grep ONAPTEMPLATE)
+  if [ -z "$TEMPLATES" ]; then
+    return 0
+  fi
+
+  echo "====> Resolving the following temaplate from environment variables "
+  echo "[$TEMPLATES]"
+  SELFFILE=$(echo "$0" | rev | cut -f1 -d '/' | rev)
+  for TEMPLATE in $TEMPLATES; do
+    KEY=$(echo "$TEMPLATE" | cut -f1 -d'=')
+    VALUE=$(echo "$TEMPLATE" | cut -f2 -d'=')
+    VALUE2=$(echo "$TEMPLATE" | cut -f2 -d'=' |sed 's/\//\\\//g')
+    set +e
+    FILES=$(grep -rl "$KEY")
+    set -e
+
+    if [ -z "$FILES" ]; then
+      continue
+    fi
+
+    # assuming FILES is not longer than 2M bytes, the limit for variable value max size on this VM
+    for F in $FILES; do
+      if [[ $F == *"$SELFFILE" ]]; then
+        continue
+      fi
+      if [[ "$F" == *-template ]]; then
+        continue
+      fi
+
+      echo "======> Resolving template $KEY to value $VALUE for file $F"
+      sed -i "s/{{[[:space:]]*$KEY[[:space:]]*}}/$VALUE2/g" "$F"
+      #cat "$F"
+    done
+
+    #if [ ! -z "$FILES" ]; then
+    #   echo "====> Resolving template $VALUE to value $VALUE"
+    #   #CMD="grep -rl \"$VALUE\" | tr '\n' '\0' | xargs -0 sed -i \"s/{{[[:space:]]*$VALUE[[:space:]]*}}/$VALUE/g\""
+    #   grep -rl "$KEY" | tr '\n' '\0' | xargs -0 sed -i 's/$KEY/$VALUE2/g'
+    #   #echo $CMD
+    #   #eval $CMD
+    #fi
+  done
+  echo "====> Done template reolving"
+}
+
+
+run_tox_test() 
+{ 
+  set -x
+  CURDIR=$(pwd)
+  TOXINIS=$(find . -name "tox.ini")
+  for TOXINI in "${TOXINIS[@]}"; do
+    DIR=$(echo "$TOXINI" | rev | cut -f2- -d'/' | rev)
+    cd "${CURDIR}/${DIR}"
+    rm -rf ./venv-tox ./.tox
+    virtualenv ./venv-tox
+    source ./venv-tox/bin/activate
+    pip install --upgrade pip
+    pip install --upgrade tox argparse
+    pip freeze
+    tox
+    deactivate
+    rm -rf ./venv-tox ./.tox
+  done
+}
+
+build_wagons() 
+{
+  rm -rf ./*.wgn venv-pkg
+
+  SETUPFILES=$(find . -name "setup.py")
+  for SETUPFILE in $SETUPFILES; do
+    PLUGIN_DIR=$(echo "$SETUPFILE" |rev | cut -f 2- -d '/' |rev)
+    PLUGIN_NAME=$(grep 'name' "$SETUPFILE" | cut -f2 -d'=' | sed 's/[^0-9a-zA-Z\.]*//g')
+    PLUGIN_VERSION=$(grep 'version' "$SETUPFILE" | cut -f2 -d'=' | sed 's/[^0-9\.]*//g')
+
+    echo "In $PLUGIN_DIR, $PLUGIN_NAME, $PLUGIN_VERSION"
+
+    virtualenv ./venv-pkg
+    source ./venv-pkg/bin/activate
+    pip install --upgrade pip
+    pip install wagon
+    wagon create --format tar.gz "$PLUGIN_DIR"
+    deactivate
+    rm -rf venv-pkg
+
+    PKG_FILE_NAMES=( "${PLUGIN_NAME}-${PLUGIN_VERSION}"*.wgn )
+    echo Built package: "${PKG_FILE_NAMES[@]}"
+  done
+}
+
+
+upload_raw_file() 
+{
+  # Extract the username and password to the nexus repo from the settings file
+  USER=$(xpath -q -e "//servers/server[id='$MVN_RAWREPO_SERVERID']/username/text()" "$SETTINGS_FILE")
+  PASS=$(xpath -q -e "//servers/server[id='$MVN_RAWREPO_SERVERID']/password/text()" "$SETTINGS_FILE")
+  NETRC=$(mktemp)
+  echo "machine $MVN_RAWREPO_HOST login $USER password $PASS" > "$NETRC"
+
+  REPO="$MVN_RAWREPO_BASEURL_UPLOAD"
+
+  OUTPUT_FILE=$1
+  EXT=$(echo "$OUTPUT_FILE" | rev |cut -f1 -d '.' |rev)
+  if [ "$EXT" == 'yaml' ]; then
+    OUTPUT_FILE_TYPE='text/x-yaml'
+  elif [ "$EXT" == 'sh' ]; then
+    OUTPUT_FILE_TYPE='text/x-shellscript'
+  elif [ "$EXT" == 'gz' ]; then
+    OUTPUT_FILE_TYPE='application/gzip'
+  elif [ "$EXT" == 'wgn' ]; then
+    OUTPUT_FILE_TYPE='application/gzip'
+  else
+    OUTPUT_FILE_TYPE='application/octet-stream'
+  fi
+
+
+  if [ "$MVN_DEPLOYMENT_TYPE" == 'SNAPSHOT' ]; then
+    SEND_TO="${REPO}/${FQDN}/snapshots"
+  elif [ "$MVN_DEPLOYMENT_TYPE" == 'STAGING' ]; then
+    SEND_TO="${REPO}/${FQDN}/releases"
+  else
+    echo "Unreconfnized deployment type, quit"
+    exit
+  fi
+  if [ ! -z "$MVN_PROJECT_MODULEID" ]; then
+    SEND_TO="$SEND_TO/$MVN_PROJECT_MODULEID"
+  fi
+
+  echo "Sending ${OUTPUT_FILE} to Nexus: ${SEND_TO}"
+  curl -vkn --netrc-file "${NETRC}" --upload-file "${OUTPUT_FILE}" -X PUT -H "Content-Type: $OUTPUT_FILE_TYPE" "${SEND_TO}/${OUTPUT_FILE}-${MVN_PROJECT_VERSION}-${TIMESTAMP}"
+  curl -vkn --netrc-file "${NETRC}" --upload-file "${OUTPUT_FILE}" -X PUT -H "Content-Type: $OUTPUT_FILE_TYPE" "${SEND_TO}/${OUTPUT_FILE}-${MVN_PROJECT_VERSION}"
+  curl -vkn --netrc-file "${NETRC}" --upload-file "${OUTPUT_FILE}" -X PUT -H "Content-Type: $OUTPUT_FILE_TYPE" "${SEND_TO}/${OUTPUT_FILE}"
+}
+
+
+
+upload_wagons_and_type_yamls()
+{
+  WAGONS=$(ls -1 ./*.wgn)
+  for WAGON in $WAGONS ; do
+    WAGON_NAME=$(echo "$WAGON" | cut -f1 -d '-')
+    WAGON_VERSION=$(echo "$WAGON" | cut -f2 -d '-')
+    WAGON_TYPEFILE=$(grep -rl "$WAGON_NAME" | grep yaml | head -1)
+   
+    upload_raw_file "$WAGON"
+    upload_raw_file "$WAGON_TYPEFILE"
+  done
+}
+
+upload_files_of_extension()
+{
+  FILES=$(ls -1 ./*."$1")
+  for F in $FILES ; do
+    upload_raw_file "$F"
+  done
+}
+
+
+
+build_and_push_docker()
+{
+  IMAGENAME="onap/${FQDN}.${MVN_PROJECT_MODULEID}"
+  IMAGENAME=$(echo "$IMAGENAME" | sed -e 's/_*$//g' -e 's/\.*$//g')
+
+  # use the major and minor version of the MVN artifact version as docker image version
+  VERSION="${MVN_PROJECT_VERSION//[^0-9.]/}"
+  VERSION2=$(echo "$VERSION" | cut -f1-2 -d'.')
+
+  LFQI="${IMAGENAME}:${VERSION}-${TIMESTAMP}"
+  BUILD_PATH="${WORKSPACE}"
+  # build a docker image
+  docker build --rm -f "${WORKSPACE}"/Dockerfile -t "${LFQI}" "${BUILD_PATH}"
+
+  REPO=""
+  if [ $MVN_DEPLOYMENT_TYPE == "SNAPSHOT" ]; then
+     REPO=$MVN_DOCKERREGISTRY_DAILY
+  elif [ $MVN_DEPLOYMENT_TYPE == "STAGING" ]; then
+     # there seems to be no staging docker registry?  set to use SNAPSHOT also
+     #REPO=$MVN_DOCKERREGISTRY_RELEASE
+     REPO=$MVN_DOCKERREGISTRY_DAILY
+  else
+     echo "Fail to determine DEPLOYMENT_TYPE"
+     REPO=$MVN_DOCKERREGISTRY_DAILY
+  fi
+  echo "DEPLOYMENT_TYPE is: $MVN_DEPLOYMENT_TYPE, repo is $REPO"
+
+  if [ ! -z "$REPO" ]; then
+    USER=$(xpath -e "//servers/server[id='$REPO']/username/text()" "$SETTINGS_FILE")
+    PASS=$(xpath -e "//servers/server[id='$REPO']/password/text()" "$SETTINGS_FILE")
+    if [ -z "$USER" ]; then
+      echo "Error: no user provided"
+    fi
+    if [ -z "$PASS" ]; then
+      echo "Error: no password provided"
+    fi
+    [ -z "$PASS" ] && PASS_PROVIDED="<empty>" || PASS_PROVIDED="<password>"
+    echo docker login "$REPO" -u "$USER" -p "$PASS_PROVIDED"
+    docker login "$REPO" -u "$USER" -p "$PASS"
+
+    if [ $MVN_DEPLOYMENT_TYPE == "SNAPSHOT" ]; then
+      REPO="$REPO/snapshots"
+    elif [ $MVN_DEPLOYMENT_TYPE == "STAGING" ]; then
+      # there seems to be no staging docker registry?  set to use SNAPSHOT also
+      #REPO=$MVN_DOCKERREGISTRY_RELEASE
+      REPO="$REPO"
+    else
+      echo "Fail to determine DEPLOYMENT_TYPE"
+      REPO="$REPO/unknown"
+    fi
+
+    OLDTAG="${LFQI}"
+    PUSHTAGS="${REPO}/${IMAGENAME}:${VERSION2}-${TIMESTAMP} ${REPO}/${IMAGENAME}:${VERSION2} ${REPO}/${IMAGENAME}:${VERSION2}-latest"
+    for NEWTAG in ${PUSHTAGS}
+    do
+      echo "tagging ${OLDTAG} to ${NEWTAG}"
+      docker tag "${OLDTAG}" "${NEWTAG}"
+      echo "pushing ${NEWTAG}"
+      docker push "${NEWTAG}"
+      OLDTAG="${NEWTAG}"
+    done
+  fi
+
+}
+
+
+
index 904c74a..d940041 100755 (executable)
 #!/bin/bash
 
+# ================================================================================
+# Copyright (c) 2017 AT&T Intellectual Property. All rights reserved.
+# ================================================================================
+# Licensed 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.
+# ============LICENSE_END=========================================================
+#
+# ECOMP is a trademark and service mark of AT&T Intellectual Property.
+
+set -ex
+
+
 echo "running script: [$0] for module [$1] at stage [$2]"
 
-echo "=> Prepare environment "
-#env
+MVN_PROJECT_MODULEID="$1"
+MVN_PHASE="$2"
+
+
+PROJECT_ROOT=$(dirname $0)
 
-TIMESTAMP=$(date +%C%y%m%dT%H%M%S) 
-export BUILD_NUMBER="${TIMESTAMP}"
+FQDN="${MVN_PROJECT_GROUPID}.${MVN_PROJECT_ARTIFACTID}"
+if [ "$MVN_PROJECT_MODULEID" == "__" ]; then
+  MVN_PROJECT_MODULEID=""
+fi
+
+if [[ "$MVN_PROJECT_VERSION" == *SNAPSHOT ]]; then
+  echo "=> for SNAPSHOT artifact build"
+  MVN_DEPLOYMENT_TYPE='SNAPSHOT'
+else
+  echo "=> for STAGING/RELEASE artifact build"
+  MVN_DEPLOYMENT_TYPE='STAGING'
+fi
+echo "MVN_DEPLOYMENT_TYPE is             [$MVN_DEPLOYMENT_TYPE]"
 
-# expected environment variables 
+
+TIMESTAMP=$(date +%C%y%m%dT%H%M%S)
+
+# expected environment variables
 if [ -z "${MVN_NEXUSPROXY}" ]; then
     echo "MVN_NEXUSPROXY environment variable not set.  Cannot proceed"
     exit
 fi
-MVN_NEXUSPROXY_HOST=$(echo $MVN_NEXUSPROXY |cut -f3 -d'/' | cut -f1 -d':')
+MVN_NEXUSPROXY_HOST=$(echo "$MVN_NEXUSPROXY" |cut -f3 -d'/' | cut -f1 -d':')
+echo "=> Nexus Proxy at $MVN_NEXUSPROXY_HOST, $MVN_NEXUSPROXY"
+
+if [ -z "$WORKSPACE" ]; then
+    WORKSPACE=$(pwd)
+fi
 
+if [ -z "$SETTINGS_FILE" ]; then
+    echo "SETTINGS_FILE environment variable not set.  Cannot proceed"
+    exit
+fi
+   
 
-# use the version text detect which phase we are in in LF CICD process: verify, merge, or (daily) release
 
-# mvn phase in life cycle 
+# mvn phase in life cycle
 MVN_PHASE="$2"
 
+
+echo "MVN_PROJECT_MODULEID is            [$MVN_PROJECT_MODULEID]"
+echo "MVN_PHASE is                       [$MVN_PHASE]"
+echo "MVN_PROJECT_GROUPID is             [$MVN_PROJECT_GROUPID]"
+echo "MVN_PROJECT_ARTIFACTID is          [$MVN_PROJECT_ARTIFACTID]"
+echo "MVN_PROJECT_VERSION is             [$MVN_PROJECT_VERSION]"
+echo "MVN_NEXUSPROXY is                  [$MVN_NEXUSPROXY]"
+echo "MVN_RAWREPO_BASEURL_UPLOAD is      [$MVN_RAWREPO_BASEURL_UPLOAD]"
+echo "MVN_RAWREPO_BASEURL_DOWNLOAD is    [$MVN_RAWREPO_BASEURL_DOWNLOAD]"
+MVN_RAWREPO_HOST=$(echo "$MVN_RAWREPO_BASEURL_UPLOAD" | cut -f3 -d'/' |cut -f1 -d':')
+echo "MVN_RAWREPO_HOST is                [$MVN_RAWREPO_HOST]"
+echo "MVN_RAWREPO_SERVERID is            [$MVN_RAWREPO_SERVERID]"
+echo "MVN_DOCKERREGISTRY_DAILY is        [$MVN_DOCKERREGISTRY_DAILY]"
+echo "MVN_DOCKERREGISTRY_RELEASE is      [$MVN_DOCKERREGISTRY_RELEASE]"
+
+
+source "${PROJECT_ROOT}"/mvn-phase-lib.sh 
+
+
+# Customize the section below for each project
 case $MVN_PHASE in
 clean)
   echo "==> clean phase script"
+  clean_templated_files
+  clean_tox_files
+  rm -rf ./venv-* ./*.wgn ./site
   ;;
 generate-sources)
   echo "==> generate-sources phase script"
+  expand_templates
   ;;
 compile)
   echo "==> compile phase script"
@@ -42,6 +113,30 @@ install)
   ;;
 deploy)
   echo "==> deploy phase script"
+
+  case $MVN_PROJECT_MODULEID in
+  platformdoc)
+    set -x
+    CURDIR=$(pwd)
+    virtualenv ./venv-doc
+    source ./venv-doc/bin/activate
+    pip install --upgrade pip
+    pip install --upgrade mkdocs mkdocs-material
+    pip freeze
+
+    mkdocs build
+    build_and_push_docker
+    deactivate
+    rm -rf ./venv-doc
+
+    # build docker image from Docker file (under module dir) and push to registry
+    build_and_push_docker
+    ;;
+  *)
+    echo "====> unknown mvn project module"
+    ;;
+  esac
+
   ;;
 *)
   echo "==> unprocessed phase"
similarity index 100%
rename from Dockerfile
rename to platformdoc/Dockerfile
similarity index 100%
rename from README.md
rename to platformdoc/README.md
similarity index 100%
rename from docs/index.md
rename to platformdoc/docs/index.md
similarity index 100%
rename from mkdocs.yml
rename to platformdoc/mkdocs.yml
diff --git a/platformdoc/pom.xml b/platformdoc/pom.xml
new file mode 100644 (file)
index 0000000..83c21fc
--- /dev/null
@@ -0,0 +1,174 @@
+<?xml version="1.0"?>
+<!--
+================================================================================
+Copyright (c) 2017 AT&T Intellectual Property. All rights reserved.
+================================================================================
+Licensed 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.
+============LICENSE_END=========================================================
+
+ECOMP is a trademark and service mark of AT&T Intellectual Property.
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <parent>
+    <groupId>org.onap.dcaegen2</groupId>
+    <artifactId>dcaegen2</artifactId>
+    <version>1.0.0-SNAPSHOT</version>
+  </parent>
+  <groupId>org.onap.dcaegen2</groupId>
+  <artifactId>platformdoc</artifactId>
+  <name>dcaegen2-platformdoc</name>
+  <version>1.0.0-SNAPSHOT</version>
+  <url>http://maven.apache.org</url>
+
+  <properties>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    <sonar.skip>true</sonar.skip>
+    <sonar.sources>.</sonar.sources>
+    <!-- customize the SONARQUBE URL -->
+    <!-- sonar.host.url>http://localhost:9000</sonar.host.url -->
+    <!-- below are language dependent -->
+    <!-- for Python -->
+    <sonar.language>py</sonar.language>
+    <sonar.pluginName>Python</sonar.pluginName>
+    <sonar.inclusions>**/*.py</sonar.inclusions>
+    <!-- for JavaScaript -->
+    <!--
+    <sonar.language>js</sonar.language>
+    <sonar.pluginName>JS</sonar.pluginName>
+    <sonar.inclusions>**/*.js</sonar.inclusions>
+    -->
+  </properties>
+  <build>
+    <finalName>${project.artifactId}-${project.version}</finalName>
+    <plugins>
+      <!-- plugin>
+        <artifactId>maven-assembly-plugin</artifactId>
+        <version>2.4.1</version>
+        <configuration>
+          <descriptors>
+            <descriptor>assembly/dep.xml</descriptor>
+          </descriptors>
+        </configuration>
+        <executions>
+          <execution>
+            <id>make-assembly</id>
+            <phase>package</phase>
+            <goals>
+              <goal>single</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin -->
+      <!-- now we configure custom action (calling a script) at various lifecycle phases -->
+      <plugin>
+        <groupId>org.codehaus.mojo</groupId>
+        <artifactId>exec-maven-plugin</artifactId>
+        <version>1.2.1</version>
+        <executions>
+          <execution>
+            <id>clean phase script</id>
+            <phase>clean</phase>
+            <goals>
+              <goal>exec</goal>
+            </goals>
+            <configuration>
+              <arguments>
+                <argument>${project.artifactId}</argument>
+                <argument>clean</argument>
+              </arguments>
+            </configuration>
+          </execution>
+          <execution>
+            <id>generate-sources script</id>
+            <phase>generate-sources</phase>
+            <goals>
+              <goal>exec</goal>
+            </goals>
+            <configuration>
+              <arguments>
+                <argument>${project.artifactId}</argument>
+                <argument>generate-sources</argument>
+              </arguments>
+            </configuration>
+          </execution>
+          <execution>
+            <id>compile script</id>
+            <phase>compile</phase>
+            <goals>
+              <goal>exec</goal>
+            </goals>
+            <configuration>
+              <arguments>
+                <argument>${project.artifactId}</argument>
+                <argument>compile</argument>
+              </arguments>
+            </configuration>
+          </execution>
+          <execution>
+            <id>package script</id>
+            <phase>package</phase>
+            <goals>
+              <goal>exec</goal>
+            </goals>
+            <configuration>
+              <arguments>
+                <argument>${project.artifactId}</argument>
+                <argument>package</argument>
+              </arguments>
+            </configuration>
+          </execution>
+          <execution>
+            <id>test script</id>
+            <phase>test</phase>
+            <goals>
+              <goal>exec</goal>
+            </goals>
+            <configuration>
+              <arguments>
+                <argument>${project.artifactId}</argument>
+                <argument>test</argument>
+              </arguments>
+            </configuration>
+          </execution>
+          <execution>
+            <id>install script</id>
+            <phase>install</phase>
+            <goals>
+              <goal>exec</goal>
+            </goals>
+            <configuration>
+              <arguments>
+                <argument>${project.artifactId}</argument>
+                <argument>install</argument>
+              </arguments>
+            </configuration>
+          </execution>
+          <execution>
+            <id>deploy script</id>
+            <phase>deploy</phase>
+            <goals>
+              <goal>exec</goal>
+            </goals>
+            <configuration>
+              <arguments>
+                <argument>${project.artifactId}</argument>
+                <argument>deploy</argument>
+              </arguments>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
+    </plugins>
+  </build>
+</project>
diff --git a/pom.xml b/pom.xml
index 1cb2dbc..c8ba29c 100644 (file)
--- a/pom.xml
+++ b/pom.xml
@@ -32,8 +32,14 @@ ECOMP is a trademark and service mark of AT&T Intellectual Property.
 
   <version>1.0.0-SNAPSHOT</version>
   <url>http://maven.apache.org</url>
+  <packaging>pom</packaging>
+  <modules>
+     <module>platformdoc</module>
+  </modules>
+
   <properties>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    <sonar.skip>true</sonar.skip>
     <sonar.sources>.</sonar.sources>
     <!-- customize the SONARQUBE URL -->
     <!-- sonar.host.url>http://localhost:9000</sonar.host.url -->
@@ -60,6 +66,7 @@ ECOMP is a trademark and service mark of AT&T Intellectual Property.
           <version>1.6.7</version>
           <configuration>
             <skipNexusStagingDeployMojo>true</skipNexusStagingDeployMojo>
+            <skip>true</skip>
           </configuration>
         </plugin>
         <plugin>
@@ -72,8 +79,8 @@ ECOMP is a trademark and service mark of AT&T Intellectual Property.
           </configuration>
         </plugin>
         <!-- first disable the default Java plugins at various stages -->
-        <!-- maven-resources-plugin is called during "*resource" phases by default behavior.  it prepares the resources
-       dir.  we do not need it -->
+        <!-- maven-resources-plugin is called during "*resource" phases by default behavior.  it prepares 
+         the resources dir.  we do not need it -->
         <plugin>
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-resources-plugin</artifactId>
@@ -104,7 +111,7 @@ ECOMP is a trademark and service mark of AT&T Intellectual Property.
           </executions>
         </plugin>
         <!-- maven-install-plugin is called during "install" phase by default behavior.  it tries to copy stuff under 
-       target dir to ~/.m2.  we do not need it -->
+         target dir to ~/.m2.  we do not need it -->
         <plugin>
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-install-plugin</artifactId>
@@ -114,7 +121,7 @@ ECOMP is a trademark and service mark of AT&T Intellectual Property.
           </configuration>
         </plugin>
         <!-- maven-surefire-plugin is called during "test" phase by default behavior.  it triggers junit test.
-       we do not need it -->
+         we do not need it -->
         <plugin>
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-surefire-plugin</artifactId>
@@ -123,189 +130,27 @@ ECOMP is a trademark and service mark of AT&T Intellectual Property.
             <skipTests>true</skipTests>
           </configuration>
         </plugin>
+        <plugin>
+          <groupId>org.codehaus.mojo</groupId>
+          <artifactId>exec-maven-plugin</artifactId>
+          <version>1.2.1</version>
+          <configuration>
+            <executable>${session.executionRootDirectory}/mvn-phase-script.sh</executable>
+            <environmentVariables>
+              <!-- make mvn properties as env for our script -->
+              <MVN_PROJECT_GROUPID>${parent.groupId}</MVN_PROJECT_GROUPID>
+              <MVN_PROJECT_ARTIFACTID>${parent.artifactId}</MVN_PROJECT_ARTIFACTID>
+              <MVN_PROJECT_VERSION>${parent.version}</MVN_PROJECT_VERSION>
+              <MVN_NEXUSPROXY>${onap.nexus.url}</MVN_NEXUSPROXY>
+              <MVN_RAWREPO_BASEURL_UPLOAD>${onap.nexus.rawrepo.baseurl.upload}</MVN_RAWREPO_BASEURL_UPLOAD>
+              <MVN_RAWREPO_BASEURL_DOWNLOAD>${onap.nexus.rawrepo.baseurl.download}</MVN_RAWREPO_BASEURL_DOWNLOAD>
+              <MVN_RAWREPO_SERVERID>${onap.nexus.rawrepo.serverid}</MVN_RAWREPO_SERVERID>
+              <MVN_DOCKERREGISTRY_DAILY>${onap.nexus.dockerregistry.daily}</MVN_DOCKERREGISTRY_DAILY>
+              <MVN_DOCKERREGISTRY_RELEASE>${onap.nexus.dockerregistry.release}</MVN_DOCKERREGISTRY_RELEASE>
+            </environmentVariables>
+          </configuration>
+        </plugin>
       </plugins>
     </pluginManagement>
-    <plugins>
-      <!-- plugin>
-        <artifactId>maven-assembly-plugin</artifactId>
-        <version>2.4.1</version>
-        <configuration>
-          <descriptors>
-            <descriptor>assembly/dep.xml</descriptor>
-          </descriptors>
-        </configuration>
-        <executions>
-          <execution>
-            <id>make-assembly</id>
-            <phase>package</phase>
-            <goals>
-              <goal>single</goal>
-            </goals>
-          </execution>
-        </executions>
-      </plugin -->
-      <!-- now we configure custom action (calling a script) at various lifecycle phases -->
-      <plugin>
-        <groupId>org.codehaus.mojo</groupId>
-        <artifactId>exec-maven-plugin</artifactId>
-        <version>1.2.1</version>
-        <executions>
-          <execution>
-            <id>clean phase script</id>
-            <phase>clean</phase>
-            <goals>
-              <goal>exec</goal>
-            </goals>
-            <configuration>
-              <executable>${session.executionRootDirectory}/mvn-phase-script.sh</executable>
-              <arguments>
-                <argument>${project.artifactId}</argument>
-                <argument>clean</argument>
-              </arguments>
-              <environmentVariables>
-                <!-- make mvn properties as env for our script -->
-                <MVN_PROJECT_GROUPID>${project.groupId}</MVN_PROJECT_GROUPID>
-                <MVN_PROJECT_ARTIFACTID>${project.artifactId}</MVN_PROJECT_ARTIFACTID>
-                <MVN_PROJECT_VERSION>${project.version}</MVN_PROJECT_VERSION>
-                <MVN_NEXUSPROXY>${onap.nexus.url}</MVN_NEXUSPROXY>
-                <!--MVN_DOCKERREG_URL>${docker.push.registry}</MVN_DOCKERREG_URL-->
-              </environmentVariables>
-            </configuration>
-          </execution>
-          <execution>
-            <id>generate-sources script</id>
-            <phase>generate-sources</phase>
-            <goals>
-              <goal>exec</goal>
-            </goals>
-            <configuration>
-              <executable>mvn-phase-script.sh</executable>
-              <arguments>
-                <argument>${project.artifactId}</argument>
-                <argument>generate-sources</argument>
-              </arguments>
-              <environmentVariables>
-                <!-- make mvn properties as env for our script -->
-                <MVN_PROJECT_GROUPID>${project.groupId}</MVN_PROJECT_GROUPID>
-                <MVN_PROJECT_ARTIFACTID>${project.artifactId}</MVN_PROJECT_ARTIFACTID>
-                <MVN_PROJECT_VERSION>${project.version}</MVN_PROJECT_VERSION>
-                <MVN_NEXUSPROXY>${onap.nexus.url}</MVN_NEXUSPROXY>
-                <!--MVN_DOCKERREG_URL>${docker.push.registry}</MVN_DOCKERREG_URL-->
-              </environmentVariables>
-            </configuration>
-          </execution>
-          <execution>
-            <id>compile script</id>
-            <phase>compile</phase>
-            <goals>
-              <goal>exec</goal>
-            </goals>
-            <configuration>
-              <executable>mvn-phase-script.sh</executable>
-              <arguments>
-                <argument>${project.artifactId}</argument>
-                <argument>compile</argument>
-              </arguments>
-              <environmentVariables>
-                <!-- make mvn properties as env for our script -->
-                <MVN_PROJECT_GROUPID>${project.groupId}</MVN_PROJECT_GROUPID>
-                <MVN_PROJECT_ARTIFACTID>${project.artifactId}</MVN_PROJECT_ARTIFACTID>
-                <MVN_PROJECT_VERSION>${project.version}</MVN_PROJECT_VERSION>
-                <MVN_NEXUSPROXY>${onap.nexus.url}</MVN_NEXUSPROXY>
-                <!--MVN_DOCKERREG_URL>${docker.push.registry}</MVN_DOCKERREG_URL-->
-              </environmentVariables>
-            </configuration>
-          </execution>
-          <execution>
-            <id>package script</id>
-            <phase>package</phase>
-            <goals>
-              <goal>exec</goal>
-            </goals>
-            <configuration>
-              <executable>mvn-phase-script.sh</executable>
-              <arguments>
-                <argument>${project.artifactId}</argument>
-                <argument>package</argument>
-              </arguments>
-              <environmentVariables>
-                <!-- make mvn properties as env for our script -->
-                <MVN_PROJECT_GROUPID>${project.groupId}</MVN_PROJECT_GROUPID>
-                <MVN_PROJECT_ARTIFACTID>${project.artifactId}</MVN_PROJECT_ARTIFACTID>
-                <MVN_PROJECT_VERSION>${project.version}</MVN_PROJECT_VERSION>
-                <MVN_NEXUSPROXY>${onap.nexus.url}</MVN_NEXUSPROXY>
-                <!--MVN_DOCKERREG_URL>${docker.push.registry}</MVN_DOCKERREG_URL-->
-              </environmentVariables>
-            </configuration>
-          </execution>
-          <execution>
-            <id>test script</id>
-            <phase>test</phase>
-            <goals>
-              <goal>exec</goal>
-            </goals>
-            <configuration>
-              <executable>mvn-phase-script.sh</executable>
-              <arguments>
-                <argument>${project.artifactId}</argument>
-                <argument>test</argument>
-              </arguments>
-              <environmentVariables>
-                <!-- make mvn properties as env for our script -->
-                <MVN_PROJECT_GROUPID>${project.groupId}</MVN_PROJECT_GROUPID>
-                <MVN_PROJECT_ARTIFACTID>${project.artifactId}</MVN_PROJECT_ARTIFACTID>
-                <MVN_PROJECT_VERSION>${project.version}</MVN_PROJECT_VERSION>
-                <MVN_NEXUSPROXY>${onap.nexus.url}</MVN_NEXUSPROXY>
-                <!--MVN_DOCKERREG_URL>${docker.push.registry}</MVN_DOCKERREG_URL-->
-              </environmentVariables>
-            </configuration>
-          </execution>
-          <execution>
-            <id>install script</id>
-            <phase>install</phase>
-            <goals>
-              <goal>exec</goal>
-            </goals>
-            <configuration>
-              <executable>mvn-phase-script.sh</executable>
-              <arguments>
-                <argument>${project.artifactId}</argument>
-                <argument>install</argument>
-              </arguments>
-              <environmentVariables>
-                <!-- make mvn properties as env for our script -->
-                <MVN_PROJECT_GROUPID>${project.groupId}</MVN_PROJECT_GROUPID>
-                <MVN_PROJECT_ARTIFACTID>${project.artifactId}</MVN_PROJECT_ARTIFACTID>
-                <MVN_PROJECT_VERSION>${project.version}</MVN_PROJECT_VERSION>
-                <MVN_NEXUSPROXY>${onap.nexus.url}</MVN_NEXUSPROXY>
-                <!--MVN_DOCKERREG_URL>${docker.push.registry}</MVN_DOCKERREG_URL-->
-              </environmentVariables>
-            </configuration>
-          </execution>
-          <execution>
-            <id>deploy script</id>
-            <phase>deploy</phase>
-            <goals>
-              <goal>exec</goal>
-            </goals>
-            <configuration>
-              <executable>mvn-phase-script.sh</executable>
-              <arguments>
-                <argument>${project.artifactId}</argument>
-                <argument>deploy</argument>
-              </arguments>
-              <environmentVariables>
-                <!-- make mvn properties as env for our script -->
-                <MVN_PROJECT_GROUPID>${project.groupId}</MVN_PROJECT_GROUPID>
-                <MVN_PROJECT_ARTIFACTID>${project.artifactId}</MVN_PROJECT_ARTIFACTID>
-                <MVN_PROJECT_VERSION>${project.version}</MVN_PROJECT_VERSION>
-                <MVN_NEXUSPROXY>${onap.nexus.url}</MVN_NEXUSPROXY>
-                <!--MVN_DOCKERREG_URL>${docker.push.registry}</MVN_DOCKERREG_URL-->
-              </environmentVariables>
-            </configuration>
-          </execution>
-        </executions>
-      </plugin>
-    </plugins>
   </build>
 </project>