Merge branch '2021_copyright' into 'master'

2021 copyright

See merge request devops-program/docker-builds!408

CONTRIBUTING.md

@@ -2,29 +2,29 @@
 
 Thanks for taking the time to contribute!
 
-## How can I contribute?
+## How Can I Contribute?
 
-### Reporting bugs
+### Reporting Bugs
 
-#### How do I submit a bug report?
+#### How Do I Submit a Bug Report?
 
-Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). You can report a bug by submitting an issue in the Ping Identity DevOps [issue tracker](https://github.com/pingidentity/pingidentity-devops-getting-started/issues). To help the maintainers understand and reproduce the problem, please try to provide information like the following:
+Bugs are tracked as [GitHub Issues](https://guides.github.com/features/issues/). You can report a bug by submitting an issue in the Ping Identity DevOps [Issue Tracker](https://github.com/pingidentity/pingidentity-devops-getting-started/issues). To help the maintainers understand and reproduce the problem, please try to provide information like the following:
 
 * A clear and descriptive title.
 * A description of what happened and a description of what you expected to happen.
 * An example with the exact steps needed to reproduce the problem. If relevant, sample code is helpful.
 
 Please understand that bug reports are reviewed and prioritized internally, and we may not be able to address all bug reports or provide an estimated time for resolution.
 
-#### Suggesting enhancements
+#### Suggesting Enhancements
 
-As with bugs, requests are tracked as [GitHub issues](https://guides.github.com/features/issues/). You can suggest an enhancement by submitting an issue in the Ping Identity DevOps [issue tracker](https://github.com/pingidentity/pingidentity-devops-getting-started/issues).
+As with bugs, requests are tracked as [GitHub Issues](https://guides.github.com/features/issues/). You can suggest an enhancement by submitting an issue in the Ping Identity DevOps [Issue Tracker](https://github.com/pingidentity/pingidentity-devops-getting-started/issues).
 
 Please understand that enhancement requests are reviewed and prioritized internally, and we may not be able to address all requests or provide an estimated time for resolution.
 
-#### Alternate routes for submitting bugs and suggesting enhancements
+#### Alternate Routes for Submitting Bugs and Suggesting Enhancements
 
-If you would rather not have your issue discussed in public, you can email bug reports or enhancement requests to [devops_program@pingidentity.com](mailto:devops_program@pingidentity.com).
+If you would rather not have your issue discussed on the public repository, you can open an issue from Ping Identity's [Support Portal](https://support.pingidentity.com/s/).
 
 ### Contributing Code Changes
 

DISCLAIMER

@@ -1,5 +1,5 @@
 /***************************************************************************
- * Copyright (C) 2019 Ping Identity Corporation
+ * Copyright (C) 2021 Ping Identity Corporation
  * All rights reserved.
  *
  *      Ping Identity Corporation

README.md

@@ -12,5 +12,4 @@ Provides all components to build out the Ping Identity DevOps Docker Images for
 
 ## Troubleshooting
 
-This repository is in active development and has not been officially released.
 If you experience issues with this project, please see details on contributing feedback at [Contributing](CONTRIBUTING.md).

ci_scripts/deploy_docs.sh

@@ -64,9 +64,9 @@ append_footer ()
 
     append_doc ""
     append_doc "---"
-    test -n "${_srcFile}" && append_doc "This document auto-generated from _[${_srcFile}](https://github.com/pingidentity/pingidentity-docker-builds/blob/master/${_srcFile})_"
+    test -n "${_srcFile}" && append_doc "This document is auto-generated from _[${_srcFile}](https://github.com/pingidentity/pingidentity-docker-builds/blob/master/${_srcFile})_"
     append_doc ""
-    append_doc "Copyright (c) 2020 Ping Identity Corporation. All rights reserved."
+    append_doc "Copyright (c) 2021 Ping Identity Corporation. All rights reserved."
 }
 
 #
@@ -83,8 +83,8 @@ append_env_table_header ()
 
                 append_doc "## Environment Variables"
                 append_doc "In addition to environment variables inherited from **[pingidentity/pingbase](https://devops.pingidentity.com/docker-images/pingbase/)**,"
-                append_doc "the following environment \`ENV\` variables can be used with "
-                append_doc "this image. "
+                append_doc "the following environment \`ENV\` variables can be used with"
+                append_doc "this image."
                 append_doc ""
 
                 append_doc "| ENV Variable  | Default     | Description"
@@ -97,8 +97,8 @@ append_env_table_header ()
                 ENV_TABLE_ACTIVE="true"
 
                 append_doc "## Environment Variables"
-                append_doc "The following environment \`ENV\` variables can be used with "
-                append_doc "this image. "
+                append_doc "The following environment \`ENV\` variables can be used with"
+                append_doc "this image."
                 append_doc ""
 
                 append_doc "| ENV Variable  | Default     | Description"
@@ -117,7 +117,7 @@ append_env_variable ()
     envDesc="${1}" && shift
     envDef="${1}" && shift
 
-    append_doc "| ${envVar}  | ${envDef}  | ${envDesc}"
+    append_doc "| ${envVar}  | ${envDef}  | ${envDesc} |"
 }
 
 #

ldap-sdk-tools/README.md

@@ -21,4 +21,4 @@ Please contact devops_program@pingidentity.com for details
 
 ## Copyright
 
-Copyright © 2020 Ping Identity. All rights reserved.
+Copyright © 2021 Ping Identity Corporation. All rights reserved.

pingaccess/README.md

@@ -21,4 +21,4 @@ Please contact devops_program@pingidentity.com for details
 
 ## Copyright
 
-Copyright © 2020 Ping Identity. All rights reserved.
+Copyright © 2021 Ping Identity Corporation. All rights reserved.

pingcentral/README.md

@@ -21,4 +21,4 @@ Please contact devops_program@pingidentity.com for details
 
 ## Copyright
 
-Copyright © 2020 Ping Identity. All rights reserved.
+Copyright © 2021 Ping Identity Corporation. All rights reserved.

pingcommon/opt/staging/hooks/03-build-run-plan.sh

@@ -24,10 +24,8 @@
 #
 if test -d "${SERVER_ROOT_DIR}"
 then
-    # echo "Found SERVER_ROOT: ${SERVER_ROOT_DIR}"
     RUN_PLAN="RESTART"
 else
-    # echo "Missing SERVER_ROOT: ${SERVER_ROOT_DIR}"
     RUN_PLAN="START"
 fi
 

pingdatacommon/opt/server/lib/_script-util.sh

@@ -23,7 +23,7 @@
 # CDDL HEADER END
 #
 #
-#      Portions Copyright 2008-2018 Ping Identity Corporation
+#      Portions Copyright 2008-2021 Ping Identity Corporation
 #      Portions Copyright 2008 Sun Microsystems, Inc.
 
 #

pingdataconsole/README.md

@@ -21,4 +21,4 @@ Please contact devops_program@pingidentity.com for details
 
 ## Copyright
 
-Copyright © 2020 Ping Identity. All rights reserved.
+Copyright © 2021 Ping Identity Corporation. All rights reserved.

pingdatagovernance/Dockerfile

@@ -50,7 +50,7 @@ ARG LICENSE_VERSION
 ENV PING_PRODUCT=PingDataGovernance
 #-- Name of License File
 ENV LICENSE_FILE_NAME=PingDataGovernance.lic
-#-- Shortname used when retrieving license from License Server
+#-- Short name used when retrieving license from License Server
 ENV LICENSE_SHORT_NAME=PG
 #-- Version used when retrieving license from License Server
 ENV LICENSE_VERSION=${LICENSE_VERSION}
@@ -60,11 +60,11 @@ ENV MAX_HEAP_SIZE=1g
 
 ENV STARTUP_COMMAND="${SERVER_ROOT_DIR}/bin/start-server"
 
-#-- Adding lockdown mode so non administrive connections be made until server
+#-- Adding lockdown mode so non administrative connections be made until server
 #-- has been started with replication enabled
 ENV STARTUP_FOREGROUND_OPTS="--nodetach"
 
-#-- Adding lockdown mode so non administrive connections be made until server
+#-- Adding lockdown mode so non administrative connections be made until server
 #-- has been started with replication enabled
 ENV STARTUP_BACKGROUND_OPTS=""
 
@@ -111,8 +111,8 @@ COPY --from=final-staging ["/","/"]
 #-   docker logs -f pingdatagovernance
 #- ```
 #-
-#- You should see the ouptut from a PingDataGovernance install and configuration, ending with a message the the PingDataGovernance has
-#- started.  After it starts, you will see some typical access logs.  Simply ``Ctrl-C`` afer to stop tailing the logs.
+#- You should see the output from a PingDataGovernance install and configuration, ending with a message the the PingDataGovernance has
+#- started.  After it starts, you will see some typical access logs.  Simply ``Ctrl-C`` after to stop tailing the logs.
 #-
 #-
 #- ## Stopping/Removing the container

pingdatagovernance/README.md

@@ -21,4 +21,4 @@ Please contact devops_program@pingidentity.com for details
 
 ## Copyright
 
-Copyright © 2020 Ping Identity. All rights reserved.
+Copyright © 2021 Ping Identity Corporation. All rights reserved.

pingdatagovernancepap/Dockerfile

@@ -50,7 +50,7 @@ ARG LICENSE_VERSION
 ENV PING_PRODUCT=PingDataGovernance-PAP
 #-- Name of License File
 ENV LICENSE_FILE_NAME=PingDataGovernance.lic
-#-- Shortname used when retrieving license from License Server
+#-- Short name used when retrieving license from License Server
 ENV LICENSE_SHORT_NAME=PG
 #-- Version used when retrieving license from License Server
 ENV LICENSE_VERSION=${LICENSE_VERSION}
@@ -60,11 +60,11 @@ ENV MAX_HEAP_SIZE=384m
 
 ENV STARTUP_COMMAND="${SERVER_ROOT_DIR}/bin/start-server"
 
-#-- Adding lockdown mode so non administrive connections be made until server
+#-- Adding lockdown mode so non administrative connections be made until server
 #-- has been started with replication enabled
 ENV STARTUP_FOREGROUND_OPTS="--nodetach"
 
-#-- Adding lockdown mode so non administrive connections be made until server
+#-- Adding lockdown mode so non administrative connections be made until server
 #-- has been started with replication enabled
 ENV STARTUP_BACKGROUND_OPTS=""
 

pingdatagovernancepap/README.md

@@ -21,4 +21,4 @@ Please contact devops_program@pingidentity.com for details
 
 ## Copyright
 
-Copyright © 2020 Ping Identity. All rights reserved.
+Copyright © 2021 Ping Identity Corporation. All rights reserved.

pingdatagovernancepap/opt/server/bin/start-server-pre-82

@@ -5,9 +5,9 @@ test -n "${VERBOSE}" && set -x
 # #%L
 # PAP Setup CLI
 # %%
-# Copyright (C) 2019 - 2020 Ping Identity Corporation
+# Copyright (C) 2019 - 2021 Ping Identity Corporation
 # %%
-# Copyright 2019 - 2020 Ping Identity Corporation
+# Copyright 2019 - 2021 Ping Identity Corporation
 # All Rights Reserved.
 # #L%
 ###
@@ -25,12 +25,11 @@ isProcessRunning ()
 
 PRG="${0}"
 # Need this for relative symlinks.
-while test -h "${PRG}" ; 
+while test -h "${PRG}" ;
 do
-    # TODO: Arno - use readlink here
     ls=$( ls -ld "${PRG}" )
     link=$( expr "$ls" : '.*-> \(.*\)$' )
-    if expr "${link}" : '/.*' > /dev/null ; 
+    if expr "${link}" : '/.*' > /dev/null ;
     then
         PRG="${link}"
     else
@@ -47,13 +46,13 @@ APP_HOME=$( pwd -P )
 # shellcheck disable=SC1090
 . "${APP_HOME}/bin/_common-vars"
 
-if ! test -f "${CONFIG_FILE}" || ! test -s "${CONFIG_FILE}" ; 
+if ! test -f "${CONFIG_FILE}" || ! test -s "${CONFIG_FILE}" ;
 then
     echo "No configuration file found. Please run setup first."
     exit 2
 fi
 
-if ! test -f "${DEFAULT_LICENSE}" && ! test -s "${DEFAULT_LICENSE}" ; 
+if ! test -f "${DEFAULT_LICENSE}" && ! test -s "${DEFAULT_LICENSE}" ;
 then
 echo "Could not find a valid PingDataGovernance license file."
 exit 3
@@ -74,22 +73,16 @@ else
     # Restore user's cwd before script started
     cd "$SAVED" >/dev/null || exit 5
 
-    # TODO - Arno - use awk here 
-    # url=$( grep 'REST_URL' "${CONFIG_FILE}" | sed -E "s/\"//g" )
-    # url="${url##*REST_URL: }"
-    # url="${url%api/}"
-    # url=$(eval echo \"${url}\")
-    # TODO - Arno - find a way to avoid using eval here
     url=$( eval echo "$( awk '$1~/REST_URL/{gsub(/"/,"",$2);gsub(/api\//,"",$2);print $2}' "${CONFIG_FILE}" )" )
 
     echo "Please wait a few moments for the PingDataGovernance Policy Administration GUI to start..."
 
     timeout=20
-    while test ${timeout} -gt 0 ; 
+    while test ${timeout} -gt 0 ;
     do
         # fgrep -iq -e "error" -e "exception:" -e "aborted" "${LOG_DIR}/${APP_NAME}.log" >/dev/null 2>&1
         awk 'IGNORECASE=1;BEGIN{f=1}/error/||/exception:/||/aborted/{f=0}END{exit f}' "${LOG_DIR}/${APP_NAME}.log"
-        if test ${?} -eq 0 ; 
+        if test ${?} -eq 0 ;
         then
             echo "An error occurred. Please see ${LOG_DIR}/${APP_NAME}.log for details."
             exit 6
@@ -100,7 +93,6 @@ else
             PID=$( cat "${PID_FILE}" )
             if isProcessRunning ${PID} ;
             then
-                # TODO - Arno - not convinced case-insensitivity is required or advisable here
                 grep -Fiq "Server: Started" "${LOG_DIR}/${APP_NAME}.log"
                 if test ${?} -eq 0 ;
                 then
@@ -111,7 +103,7 @@ else
                         # --retry-max-time 30 \
                         # --retry-connrefused \
                         # --retry-delay 3 \
-                    if test ${?} -eq 0 && test "${httpCode}" = "200" ; 
+                    if test ${?} -eq 0 && test "${httpCode}" = "200" ;
                     then
                         echo "To access the Policy Administration GUI, open ${url} in your browser."
                         exit 0

pingdatasync/README.md

@@ -21,4 +21,4 @@ Please contact devops_program@pingidentity.com for details
 
 ## Copyright
 
-Copyright © 2020 Ping Identity. All rights reserved.
+Copyright © 2021 Ping Identity Corporation. All rights reserved.

pingdelegator/README.md

@@ -21,4 +21,4 @@ Please contact devops_program@pingidentity.com for details
 
 ## Copyright
 
-Copyright © 2020 Ping Identity. All rights reserved.
+Copyright © 2021 Ping Identity Corporation. All rights reserved.

pingdirectory/Dockerfile

@@ -47,7 +47,7 @@ ARG LICENSE_VERSION
 ENV PING_PRODUCT=PingDirectory
 #-- Name of License File
 ENV LICENSE_FILE_NAME=PingDirectory.lic
-#-- Shortname used when retrieving license from License Server
+#-- Short name used when retrieving license from License Server
 ENV LICENSE_SHORT_NAME=PD
 #-- Version used when retrieving license from License Server
 ENV LICENSE_VERSION=${LICENSE_VERSION}
@@ -62,11 +62,11 @@ ENV STARTUP_COMMAND="${SERVER_ROOT_DIR}/bin/start-server"
 #-- Public hostname of the DA app
 ENV PD_DELEGATOR_PUBLIC_HOSTNAME=localhost
 
-#-- Adding lockdown mode so non administrive connections be made until server
+#-- Adding lockdown mode so non administrative connections be made until server
 #-- has been started with replication enabled
 ENV STARTUP_FOREGROUND_OPTS="--nodetach"
 
-#-- Adding lockdown mode so non administrive connections be made until server
+#-- Adding lockdown mode so non administrative connections be made until server
 #-- has been started with replication enabled
 ENV STARTUP_BACKGROUND_OPTS=""
 
@@ -138,7 +138,7 @@ COPY --from=final-staging ["/","/"]
 #- You should see the ouptut from a PingDirectory install and configuration, ending with a message the the PingDirectory has started.  After it starts, you will see some typical access logs.  Simply ``Ctrl-C`` afer to stop tailing the logs.
 #-
 #- ## Running a sample 100/sec search rate test
-#- With the PingDirectory running from the pevious section, you can run a ``searchrate`` job that will send load to the directory at a rate if 100/sec using the following command.
+#- With the PingDirectory running from the previous section, you can run a ``searchrate`` job that will send load to the directory at a rate if 100/sec using the following command.
 #-
 #- ```
 #- docker exec -it pingdirectory \

pingdirectory/README.md

@@ -21,4 +21,4 @@ Please contact devops_program@pingidentity.com for details
 
 ## Copyright
 
-Copyright © 2020 Ping Identity. All rights reserved.
+Copyright © 2021 Ping Identity Corporation. All rights reserved.

pingdirectoryproxy/Dockerfile

@@ -47,7 +47,7 @@ ARG LICENSE_VERSION
 ENV PING_PRODUCT=PingDirectoryProxy
 #-- Name of License File
 ENV LICENSE_FILE_NAME=PingDirectory.lic
-#-- Shortname used when retrieving license from License Server
+#-- Short name used when retrieving license from License Server
 ENV LICENSE_SHORT_NAME=PD
 #-- Version used when retrieving license from License Server
 ENV LICENSE_VERSION=${LICENSE_VERSION}
@@ -60,11 +60,11 @@ ENV STARTUP_COMMAND="${SERVER_ROOT_DIR}/bin/start-server"
 #-- Public hostname of the DA app
 ENV PD_DELEGATOR_PUBLIC_HOSTNAME=localhost
 
-#-- Adding lockdown mode so non administrive connections be made until server
+#-- Adding lockdown mode so non administrative connections be made until server
 #-- has been started with replication enabled
 ENV STARTUP_FOREGROUND_OPTS="--nodetach"
 
-#-- Adding lockdown mode so non administrive connections be made until server
+#-- Adding lockdown mode so non administrative connections be made until server
 #-- has been started with replication enabled
 ENV STARTUP_BACKGROUND_OPTS=""
 
@@ -111,10 +111,10 @@ COPY --from=final-staging ["/","/"]
 #-   docker logs -f pingdirectoryproxy
 #- ```
 #-
-#- You should see the ouptut from a PingDirectoryProxy install and configuration, ending with a message the the PingDirectoryProxy has started.  After it starts, you will see some typical access logs.  Simply ``Ctrl-C`` afer to stop tailing the logs.
+#- You should see the output from a PingDirectoryProxy install and configuration, ending with a message the the PingDirectoryProxy has started.  After it starts, you will see some typical access logs.  Simply ``Ctrl-C`` afer to stop tailing the logs.
 #-
 #- ## Running a sample 100/sec search rate test
-#- With the PingDirectoryProxy running from the pevious section, you can run a ``searchrate`` job that will send load to the directory at a rate if 100/sec using the following command.
+#- With the PingDirectoryProxy running from the previous section, you can run a ``searchrate`` job that will send load to the directory at a rate if 100/sec using the following command.
 #-
 #- ```
 #- docker exec -it pingdirectoryproxy \

pingdirectoryproxy/README.md

@@ -21,4 +21,4 @@ Please contact devops_program@pingidentity.com for details
 
 ## Copyright
 
-Copyright © 2020 Ping Identity. All rights reserved.
+Copyright © 2021 Ping Identity Corporation. All rights reserved.

pingdownloader/Dockerfile

@@ -28,7 +28,7 @@ CMD ["--help"]
 #-
 #- -c, --conserve-name: use this option to conserve the original file name. By   default, the downloader will rename the file product.zip
 #-
-#- -n, --dry-run:	this will cause the URL to be displayed but the the bits not to be downloaded
+#- -n, --dry-run: this will cause the URL to be displayed but the the bits not to be downloaded
 #-
 #- ```
 #- ## Examples