Merge remote-tracking branch 'origin/1.39.0'

.gitlab-ci.yml

@@ -66,26 +66,41 @@ lint:
         - npm run lint
 
 test_node:4:
-    image: $DOCKER_URL/node:4
     stage: test
     needs: []
     tags:
         - cm-official-docker-executor
     script:
-        - npm install --global [email protected]
+        # npm install fails for some packages on older versions of node, so use a newer
+        # version just for the install
+        - curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash
+        - export NVM_DIR="$HOME/.nvm"
+        - source "$NVM_DIR/nvm.sh"
+        - nvm install 4
+        - nvm install --latest-npm 12
+        - nvm use 12
         - npm install --no-optional
         - npm install [email protected]
+        - nvm use 4
         - npm test
 
 test_node:6:
-    image: $DOCKER_URL/node:6
     stage: test
     needs: []
     tags:
         - cm-official-docker-executor
     script:
-        - npm install --no-optional
-        - npm install [email protected]
+        # npm install fails for some packages on older versions of node, so use a newer
+        # version just for the install
+        - curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash
+        - export NVM_DIR="$HOME/.nvm"
+        - source "$NVM_DIR/nvm.sh"
+        - nvm install 6
+        - nvm install --latest-npm 12
+        - nvm use 12
+        - npm ci --no-optional
+        - npm install [email protected]
+        - nvm use 6
         - npm test -- $TEST_REPORTER_OPTIONS
     artifacts:
         when: always
@@ -201,11 +216,14 @@ reactivate_big_iq_license:
       - node scripts/dev/reactivateBigIq.js
 
 build_api_docs:
-  image: $DOCKER_URL/node:12
+  image: $DOCKER_URL/node:16
   stage: apidocs
   needs: []
   script:
     # install packages
+    # package-lock ends up with OS specific info during npm install, so
+    # make sure it is right for the platform we're on
+    - rm package-lock.json
     - npm install
     # generate docs
     - npm run make-api-docs
@@ -221,7 +239,7 @@ create_docs:
     image: ${CONTAINTHEDOCS_IMAGE}
     stage: build
     allow_failure: true
-    needs: 
+    needs:
         - build_api_docs
     script:
         - if [ "$CI_COMMIT_REF_NAME" = "docs-staging" ] || [ "$CI_COMMIT_REF_NAME" = "docs-latest" ]; then
@@ -248,7 +266,7 @@ create_docs:
     tags:
       - do-test-docker-executor
     stage: deploy
-    timeout: 1 hour
+    timeout: 2 hours
     script:
       - apk update
       # Need to add bash, because included sh doen't support arrays
@@ -279,7 +297,7 @@ create_docs:
         - ${TEST_HARNESS_FILE}
       expire_in: 1 day
     retry:
-      max: 1
+      max: 2
       when: script_failure
 
 deploy_for_this_project:
@@ -360,7 +378,7 @@ integration-test:
         - apt-get install -y expect
         - scripts/dev/collectRemoteIntegrationTestLogs.sh ${TEST_HARNESS_FILE}
     artifacts:
-        name: f5-declarative-onboarding-$CI_BUILD_REF
+        name: f5-declarative-onboarding-$CI_COMMIT_SHA
         when: always
         paths:
             - test/logs
@@ -441,17 +459,6 @@ pages:
         - COVERAGE_DOCS=${PUBLIC_DIR}/coverage-docs
         - mkdir -p ${COVERAGE_DOCS}
         - cp -R coverage/* ${COVERAGE_DOCS}
-        ## place code contribution docs (includes presentation) under: /contribute-docs ##
-        - CONTRIBUTE_DOCS=${PUBLIC_DIR}/contribute-docs
-        - CONTRIBUTE_DIR=contributing
-        # install presentation site dependencies
-        - cd ${CONTRIBUTE_DIR} && npm install && cd ..
-        - mkdir -p ${CONTRIBUTE_DOCS}
-        - cp -R ${CONTRIBUTE_DIR}/* ${CONTRIBUTE_DOCS}
-        - BASE_URL_FOR_LINKS=${CI_PROJECT_URL}/tree/${CI_COMMIT_REF_NAME}/${CONTRIBUTE_DIR}/
-        - README=${CONTRIBUTE_DOCS}/README.md
-        # make absolute URL(s) for relative URL(s) outside current directory '../'
-        - sed -i -E 's/\[.*\]\(\.\./&SED_TEMP/' ${README} && sed -i "s|..SED_TEMP|${BASE_URL_FOR_LINKS}..|" ${README}
     artifacts:
         paths:
             - public

CHANGELOG.md

@@ -1,6 +1,18 @@
 # Changelog
 Changes to this project are documented in this file. More detail and links can be found in the Declarative Onboarding [Document Revision History](https://clouddocs.f5.com/products/extensions/f5-declarative-onboarding/latest/revision-history.html).
 
+## 1.39.0
+### Added
+
+### Fixed
+- AUTOTOOL-3849: DeviceCertificate hangs on BIG-IQ with no error response to user
+- AUTOTOOL-3741: Failure to configure BIG-IP when built-in admin account is disabled
+- AUTOTOOL-3867: Empty object defaults can cause upgrade failures
+
+### Changed
+
+### Removed
+
 ## 1.38.0
 ### Added
 - AUTOTOOL-118: ([Github Issue 9](https://github.com/F5Networks/f5-declarative-onboarding/issues/9)): Support for revoking license on a BIG-IP

SUPPORT.md

@@ -13,10 +13,9 @@ Currently supported versions:
 
 | Software Version | Release Type  | First Customer Ship | End of Support  |
 |------------------|---------------|---------------------|-----------------|
-| DO 1.36.0        | Feature       | 09-Feb-2023         | 09-May-2023     |
 | DO 1.36.1        | LTS           | 09-Mar-2023         | 09-Mar-2024     |
-| DO 1.37.0        | Feature       | 27-Mar-2022         | 27-Jun-2023     |
 | DO 1.38.0        | Feature       | 22-May-2023         | 22-Aug-2023     |
+| DO 1.39.0        | Feature       | 24-Jul-2023         | 24-Oct-2023     |
 
 
 \* Fix for Allowed schema version
@@ -65,6 +64,8 @@ Versions no longer supported:
 | DO 1.27.1        | LTS           | 08-Mar-2022         | 08-Mar-2023     |
 | DO 1.34.0        | Feature       | 15-Nov-2022         | 15-Feb-2023     |
 | DO 1.35.0        | Feature       | 12-Jan-2023         | 12-Apr-2023     |
+| DO 1.36.0        | Feature       | 09-Feb-2023         | 09-May-2023     |
+| DO 1.37.0        | Feature       | 27-Mar-2022         | 27-Jun-2023     |
 
 \* Fix for updated Docker Container packaging only
 

contributing/process_release.md

@@ -32,14 +32,14 @@
 * Go to the atg-build project in GitLab
   * Edit the DO schedule to set the `gitBranch` variable to the LTS branch.
   * Run the DO schedule.
-  * After the build completes, edit the DO schedule to set the `gitBranch` variable back to develop.
+  * After the build completes, edit the DO schedule to set the `gitBranch` variable back to `develop`.
 * Using the GUI create a tag off the LTS branch (e.g. 1.36.1)
   * In the GUI go to `Repository -> Tags -> New tag`.
   * The name of the tag should be the LTS version with a 'v' at the front (e.g. v1.36.1).
   * Update the `createFrom` to point at the LTS branch.
   * Set the message to: `LTS release v<LTS version>` (e.g. "LTS release v1.36.1")
-* Merge the LTS branch (without updating the package version) into develop and create an MR for this.
-* Merge the LTS branch (only update package version if LTS is latest) into master and create an MR for this.
+* Merge the LTS branch (without updating the package version) into `develop` and create an MR for this.
+* Merge the LTS branch (only update package version if LTS is latest) into `main` and create an MR for this.
 
 ## Process for release
 ### Begin process release at the very beginning of the first sprint of a new release, by performing the following actions
@@ -64,7 +64,7 @@
   * `git checkout develop`
   * `git pull`
   * Determine the `<new-version-number>` by incrementing the minor release number, and setting the patch number to 0 (e.g. 1.35.0 becomes 1.36.0).
-  * `get checkout -b bump-to-<new-version-number>`
+  * `git checkout -b bump-to-<new-version-number>`
   * `git checkout <version> src/schema/<version>`
     * This pulls in the new schema directory from the release branch
   * Edit package.json and package-lock.json to `<new-version-number>-0` (e.g. 1.36.0-0).
@@ -74,11 +74,11 @@
     ```
     ## <new-version-number>
     ### Added
- 
+
     ### Fixed
- 
+
     ### Changed
- 
+
     ### Removed
     ```
   * git add, commit, and push.
@@ -88,19 +88,19 @@
 
 ### Actions on night before Go/No-Go meeting:
 * Using the GUI, create 2 MRs
-  * 1 MR to merge release branch to `master`.
+  * 1 MR to merge release branch to `main`.
   * 1 MR to merge release branch to `develop`.
   * Do not squash commits.
   * Do not delete branch.
   * You can self-approve and merge these MRs.
   * Note: If the GUI suggests a rebase, do a merge locally instead (see below). DO NOT TRUST the GUI rebase tool, it lies!
-    * `git checkout <master/develop>`
+    * `git checkout <main/develop>`
     * `git pull`
-    * `git checkout -b merge-<version>-to-<master/develop>`
+    * `git checkout -b merge-<version>-to-<main/develop>`
     * `git merge <version>`
     * `git push`
-    * Via GUI, create an MR to merge this into `<master/develop>`
-* Using the GUI, create a tag on the `master` branch in the format `v<version>` (e.g. `v1.34.0`).
+    * Via GUI, create an MR to merge this into `<main/develop>`
+* Using the GUI, create a tag on the `main` branch in the format `v<version>` (e.g. `v1.34.0`).
 ### Actions after go ahead from Go/No-Go meeting:
 * Confirm with Hannah things are good to go.
 * Close your Jira task when the release is complete.

docs/conf.py

@@ -85,7 +85,7 @@
 # The short X.Y version.
 version = u''
 # The full version, including alpha/beta/rc tags.
-release = u'1.37.0'
+release = u'1.39.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/declarations/auth.rst

@@ -37,7 +37,7 @@ This example declaration contains all three authentication methods with the **en
 
 For more information on options and BIG-IP DO usage, see |auth| and the subsequent entries in the Schema Reference.
 
-.. NOTE:: We updated this example for the following: |br| - BIG-IP DO 1.17 includes a CA certificate for LDAP using the new **sslCaCert** property. |br| - BIG-IP DO 1.21 includes the ability to enable or disable LDAP referral chasing using the new **referrals** Boolean (BIG-IP 15.1 and later only). |br| See |authldap| in the Schema Reference for BIG-IP DO information and BIG-IP DO usage. |br| **IMPORTANT**: If you attempt to use the example declaration on a previous version that does not include one of these features, it will fail.  You can remove the lines highlighted in yellow for previous versions of BIG-IP DO.
+.. NOTE:: We updated this example for the following: |br| - BIG-IP DO 1.17 includes a CA certificate for LDAP using the new **sslCaCert** property. |br| - BIG-IP DO 1.21 includes the ability to enable or disable LDAP referral chasing using the new **referrals** Boolean (BIG-IP 15.1 and later only). |br| See |authldap| in the Schema Reference for BIG-IP DO information and BIG-IP DO usage. Also see the LDAP example :ref:`Reference CA cert via URL<ldap-ssl>`. |br| **IMPORTANT**: If you attempt to use the example declaration on a previous version that does not include one of these features, it will fail.  You can remove the lines highlighted in yellow for previous versions of BIG-IP DO.
 
 In the following declaration snippet we show only the classes related to authentication.  You can use this class as a part of a larger BIG-IP Declarative Onboarding declaration.
 
@@ -149,6 +149,26 @@ See |pp| in the schema reference for specific details on each of the parameters
 
 :ref:`Back to top<auth-examples>`
 
+|
+
+.. _ldap-ssl:
+
+Referencing a URL in the sslCaCert property of Authentication_ldap
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+.. sidebar:: :fonticon:`fa fa-info-circle fa-lg` Version Notice:
+
+   Support for the **sslCaCert** property in the Authentication_ldap class is available in BIG-IP DO v1.38 and later.
+
+
+This example shows how you can reference an SSL CA certificate by URL in the **sslCaCert** property of the **Authentication_ldap** class in BIG-IP DO 1.38 and later. This class allows you reference a certificate rather than have the entire base64 value in the declaration.
+
+See |authldap| in the schema reference for more information and DO usage.
+
+.. literalinclude:: ../../examples/ldapSslCaCertUrlRef.json
+   :language: json
+
+:ref:`Back to top<auth-examples>`
+
 
 
 .. |certclass| raw:: html