Remove maven usage from api-jobs.yaml

Change all jobs to openstack-doc-tools setup.

Introduce new job template '{name}-tox-doc-{envlist}' that is
used for all api jobs that publish to docs.openstack.org.

Introduce new publishers 'upload-to-docs-site' and 'upload-to-api-site'.

The job names are changed as follows:

* openstack-api-quick-start -> api-site-tox-doc-publishdocs
* openstack-api-ref: Converted from maven to freestyle.
* block-api-v2.0 -> volume-api-tox-doc-publishdocs
* compute-api-v2.0 -> compute-api-tox-doc-publishdocs
* identity-api-v2.0, identity-api-v3 -> identity-api-tox-doc-publishdocs
  (handles also api v3)
* image-api-v1.1, image-api-v2.0 -> both handled by
  image-api-tox-doc-publishdocs
* network-api-v1, network-api-v2 -> netconn-api-tox-doc-publishdocs
* object-api-v1.0 -> object-api-tox-doc-publishdocs

ATTENTION root team:
This changes openstack-api-ref from maven to freestyle. Please delete
openstack-api-ref after approval so that it gets recreated correctly.

Change-Id: I8b91bfa462224f0e6114ce2b8cb80942810b0a0e

modules/openstack_project/files/jenkins_job_builder/config/api-jobs.yaml

@@ -1,56 +1,44 @@
-# this replaces the old openstack-api-quick-start job
+- job-template:
-- job:
+    name: '{name}-tox-doc-{envlist}'
-    name: openstack-api-quick-start
-    project-type: maven
-    concurrent: false
-    node: bare-precise
 
-    prebuilders:
+    wrappers:
+      - timeout:
+          timeout: 40
+          fail: true
+      - timestamps
+
+    builders:
       - gerrit-git-prep
-
+      - tox:
-    maven:
+          envlist: '{envlist}'
-      maven-name: Maven3
+          github-org: '{github-org}'
-      root-module:
+          project: '{name}'
-        group-id: org.openstack.docs
-        artifact-id: openstack-guide
-      root-pom: api-quick-start/pom.xml
-      goals: 'clean generate-sources -B'
 
     publishers:
       - console-log
-      - ftp:
+      - upload-to-docs-site
-          site: docs.openstack.org
+      - upload-doc-build-results
-          source: 'api-quick-start/target/docbkx/webhelp/api-quick-start-onepager-external/**'
+
-          target: 'api/quick-start/'
+    node: '{node}'
-          remove-prefix: 'api-quick-start/target/docbkx/webhelp/api-quick-start-onepager-external/'
+
-          excludes: '**/*.xml,**/null*'
 
 # this replaces the old openstack-api-site job in Jenkins
 - job:
     name: openstack-api-ref
-    project-type: maven
     concurrent: false
     node: bare-precise
 
-    prebuilders:
+    builders:
       - gerrit-git-prep
-
+      - tox:
-    maven:
+          envlist: 'publishdocs-api'
-      maven-name: Maven3
+          github-org: 'openstack'
-      root-module:
+          project: 'api-site'
-        group-id: org.openstack.docs
-        artifact-id: openstack-guide
-      root-pom: api-ref/pom.xml
-      goals: 'clean generate-sources -B'
 
     publishers:
       - console-log
-      - ftp:
+      - upload-to-api-site
-          site: api.openstack.org
+      - upload-doc-build-results
-          source: 'api-ref/target/docbkx/html/**'
-          target: ''
-          remove-prefix: 'api-ref/target/docbkx/html/'
-          excludes: '**/*.xml,**/null*'
 
 
 # in zuul/layout.yaml specified to only run against master branch.
@@ -72,149 +60,6 @@
           excludes: ''
       - console-log
 
-- job:
-    name: image-api-v2.0
-    project-type: maven
-    concurrent: true
-    node: bare-precise
-
-    wrappers:
-      - timeout:
-          timeout: 40
-          fail: true
-      - timestamps
-
-    prebuilders:
-      - gerrit-git-prep
-      - markdown-docbook:
-          filename: "image-api-v2.0"
-
-    properties:
-      - inject:
-          script-file: /usr/local/jenkins/slave_scripts/docbook-properties.sh
-          properties-file: gerrit-doc.properties
-
-    maven:
-      maven-name: Maven3
-      root-module:
-        group-id: org.openstack.docs
-        artifact-id: openstack-guide
-      root-pom: openstack-image-service-api/src/markdown/pom.xml
-      goals: 'clean generate-sources -B'
-
-    publishers:
-      - console-log
-      - ftp:
-          site: docs.openstack.org
-          source: 'openstack-image-service-api/src/markdown/target/docbkx/webhelp/api/openstack-image-service/2.0/**'
-          target: '/'
-          remove-prefix: 'openstack-image-service-api/src/markdown/target/docbkx/webhelp/'
-          excludes: '**/*.xml,**/null*'
-
-
-# this replaces the old openstack-netconn-api-doc job
-- job:
-    name: network-api-v1
-    project-type: maven
-    concurrent: false
-    node: bare-precise
-
-    prebuilders:
-      - gerrit-git-prep
-
-    maven:
-      maven-name: Maven3
-      root-module:
-        group-id: org.openstack.docs
-        artifact-id: openstack-network-api-v1
-      root-pom: v1.0/pom.xml
-      goals: 'clean generate-sources -B'
-
-    publishers:
-      - console-log
-      - ftp:
-          site: docs.openstack.org
-          source: 'v1.0/target/docbkx/webhelp/openstack-network/**'
-          target: ''
-          remove-prefix: 'v1.0/target/docbkx/webhelp'
-          excludes: '**/*.xml,**/null*'
-
-- job:
-    name: network-api-v2
-    project-type: maven
-    node: bare-precise
-
-    prebuilders:
-      - gerrit-git-prep
-
-    maven:
-      maven-name: Maven3
-      root-module:
-        group-id: org.openstack.docs
-        artifact-id: openstack-network-api-v2
-      root-pom: v2.0/pom.xml
-      goals: 'clean generate-sources -B'
-
-    publishers:
-      - console-log
-      - ftp:
-          site: docs.openstack.org
-          source: 'v2.0/target/docbkx/webhelp/openstack-network/**'
-          target: 'api/openstack-network/2.0/'
-          remove-prefix: 'v2.0/target/docbkx/webhelp/openstack-network/'
-          excludes: '**/*.xml,**/null*'
-
-- job:
-    name: object-api-v1.0
-    project-type: maven
-    concurrent: false
-    node: bare-precise
-
-    prebuilders:
-      - gerrit-git-prep
-
-    maven:
-      maven-name: Maven3
-      root-module:
-        group-id: org.openstack.docs
-        artifact-id: openstack-object-api-guide
-      root-pom: openstack-object-storage-dev/pom.xml
-      goals: 'clean generate-sources -B'
-
-    publishers:
-      - console-log
-      - ftp:
-          site: docs.openstack.org
-          source: 'openstack-object-storage-dev/target/docbkx/webhelp/**'
-          target: ''
-          remove-prefix: 'openstack-object-storage-dev/target/docbkx/webhelp/'
-          excludes: '**/*.xml,**/null*'
-
-- job:
-    name: compute-api-v2.0
-    project-type: maven
-    concurrent: false
-    node: bare-precise
-
-    prebuilders:
-      - gerrit-git-prep
-
-    maven:
-      maven-name: Maven3
-      root-module:
-        group-id: org.openstack.docs
-        artifact-id: openstack-guide
-      root-pom: openstack-compute-api-2/pom.xml
-      goals: 'clean generate-sources -B'
-
-    publishers:
-      - console-log
-      - ftp:
-          site: docs.openstack.org
-          source: 'openstack-compute-api-2/target/docbkx/webhelp/api/openstack-compute/2/**'
-          target: ''
-          remove-prefix: 'openstack-compute-api-2/target/docbkx/webhelp'
-          excludes: '**/*.xml,**/null*'
 
 - job:
     name: compute-api-v2.0-wadl
@@ -234,122 +79,3 @@
           excludes: '**/*.xml,**/null*'
       - console-log
 
-- job:
-    name: block-api-v2.0
-    project-type: maven
-    concurrent: false
-    node: bare-precise
-
-    prebuilders:
-      - gerrit-git-prep
-
-    maven:
-      maven-name: Maven3
-      root-module:
-        group-id: org.openstack.docs
-        artifact-id: openstack-guide
-      root-pom: v2/pom.xml
-      goals: 'clean generate-sources -B'
-
-    publishers:
-      - console-log
-      - ftp:
-          site: docs.openstack.org
-          source: 'v2/target/docbkx/webhelp/api/openstack-block-storage/2.0/**'
-          target: ''
-          remove-prefix: 'v2/target/docbkx/webhelp'
-          excludes: '**/*.xml,**/null*'
-
-# this replaces the old openstack-identity-api-doc job
-- job:
-    name: identity-api-v2.0
-    project-type: maven
-    concurrent: false
-    node: bare-precise
-
-    prebuilders:
-      - gerrit-git-prep
-
-    maven:
-      maven-name: Maven3
-      root-module:
-        group-id: org.openstack.identity
-        artifact-id: docs
-      root-pom: openstack-identity-api/v2.0/pom.xml
-      goals: 'clean generate-sources -B'
-
-    publishers:
-      - console-log
-      - ftp:
-          site: docs.openstack.org
-          source: 'openstack-identity-api/v2.0/target/docbkx/webhelp/api/openstack-identity-service/2.0/**'
-          target: ''
-          remove-prefix: 'openstack-identity-api/v2.0/target/docbkx/webhelp/'
-          excludes: '**/*.xml,**/null*'
-
-- job:
-    name: identity-api-v3
-    project-type: maven
-    concurrent: true
-    node: bare-precise
-
-    wrappers:
-      - timeout:
-          timeout: 40
-          fail: true
-      - timestamps
-
-    prebuilders:
-      - gerrit-git-prep
-      - markdown-docbook:
-          filename: "identity-api-v3"
-
-    properties:
-      - inject:
-          script-file: /usr/local/jenkins/slave_scripts/docbook-properties.sh
-          properties-file: gerrit-doc.properties
-
-    maven:
-      maven-name: Maven3
-      root-module:
-        group-id: org.openstack.docs
-        artifact-id: openstack-guide
-      root-pom: openstack-identity-api/v3/pom.xml
-      goals: 'clean generate-sources -B'
-
-    publishers:
-      - console-log
-      - ftp:
-          site: docs.openstack.org
-          source: 'openstack-identity-api/v3/markdown/target/docbkx/webhelp/api/openstack-identity-service/3/**'
-          target: ''
-          remove-prefix: 'openstack-identity-api/v3/markdown/target/docbkx/webhelp/'
-          excludes: '**/*.xml,**/null*'
-
-
-# this replaces the old openstack-image-api-doc job
-- job:
-    name: image-api-v1.1
-    project-type: maven
-    concurrent: false
-    node: bare-precise
-
-    prebuilders:
-      - gerrit-git-prep
-
-    maven:
-      maven-name: Maven3
-      root-module:
-        group-id: org.openstack.docs
-        artifact-id: openstack-guide
-      root-pom: openstack-image-service-api/pom.xml
-      goals: 'clean generate-sources -B'
-
-    publishers:
-      - console-log
-      - ftp:
-          site: docs.openstack.org
-          source: 'openstack-image-service-api/target/docbkx/webhelp/api/openstack-image-service/1.1/**'
-          target: ''
-          remove-prefix: 'openstack-image-service-api/target/docbkx/webhelp'
-          excludes: '**/*.xml,**/null*'

modules/openstack_project/files/jenkins_job_builder/config/macros.yaml

@@ -344,6 +344,25 @@
               keep-hierarchy: true
               copy-after-failure: true
 
+
+- publisher:
+    name: upload-to-api-site
+    publishers:
+      - ftp:
+          site: api.openstack.org
+          source: 'publish-docs/**'
+          target: '/'
+          remove-prefix: 'publish-docs/'
+
+- publisher:
+    name: upload-to-docs-site
+    publishers:
+      - ftp:
+          site: docs.openstack.org
+          source: 'publish-docs/**'
+          target: '/'
+          remove-prefix: 'publish-docs/'
+
 - publisher:
     name: upload-doc-build-results
     publishers:

modules/openstack_project/files/jenkins_job_builder/config/projects.yaml

@@ -311,8 +311,9 @@
     doc-publisher-site: docs.openstack.org
 
     jobs:
-      - compute-api-v2.0
       - openstack-doc-jobs
+      - '{name}-tox-doc-{envlist}':
+          envlist: publishdocs
 
 
 - project:
@@ -574,8 +575,9 @@
     doc-publisher-site: docs.openstack.org
 
     jobs:
-      - identity-api-v2.0
       - openstack-doc-jobs
+      - '{name}-tox-doc-{envlist}':
+          envlist: publishdocs
 
 
 - project:
@@ -587,7 +589,8 @@
 
     jobs:
       - openstack-doc-jobs
-      - image-api-v1.1
+      - '{name}-tox-doc-{envlist}':
+          envlist: publishdocs
 
 
 - project:
@@ -623,19 +626,9 @@
     doc-publisher-site: docs.openstack.org
 
     jobs:
-      - network-api-v1
       - openstack-doc-jobs
-
+      - '{name}-tox-doc-{envlist}':
-
+          envlist: publishdocs
-- project:
-    name: netconn-api-v20
-    github-org: openstack
-    node: bare-precise
-    tarball-site: tarballs.openstack.org
-    doc-publisher-site: docs.openstack.org
-
-    jobs:
-      - network-api-v2
 
 
 - project:
@@ -684,8 +677,9 @@
     doc-publisher-site: docs.openstack.org
 
     jobs:
-      - object-api-v1.0
       - openstack-doc-jobs
+      - '{name}-tox-doc-{envlist}':
+          envlist: publishdocs
 
 
 - project:
@@ -2125,6 +2119,8 @@
 
     jobs:
       - openstack-doc-jobs
+      - '{name}-tox-doc-{envlist}':
+          envlist: publishdocs
 
 
 - project:
@@ -2135,7 +2131,6 @@
     jobs:
       - openstack-doc-jobs
 
-
 - project:
     name: volume-api
     github-org: openstack
@@ -2143,6 +2138,8 @@
 
     jobs:
       - openstack-doc-jobs
+      - '{name}-tox-doc-{envlist}':
+          envlist: publishdocs
 
 - project:
     name: python-openstacksdk

modules/openstack_project/files/zuul/layout.yaml

@@ -2198,7 +2198,7 @@ projects:
     template:
       - name: openstack-doc-gate
     post:
-      - compute-api-v2.0
+      - compute-api-tox-doc-publishdocs
       - compute-api-v2.0-wadl
 
   - name: openstack/database-api
@@ -2209,33 +2209,31 @@ projects:
     template:
       - name: openstack-doc-gate
     post:
-      - identity-api-v2.0
+      - identity-api-tox-doc-publishdocs
 
   - name: openstack/image-api
     template:
       - name: openstack-doc-gate
     post:
-      - image-api-v1.1
+      - image-api-tox-doc-publishdocs
-      - image-api-v2.0
 
   - name: openstack/netconn-api
     template:
       - name: openstack-doc-gate
     post:
-      - network-api-v1
+      - netconn-api-tox-doc-publishdocs
-      - network-api-v2
 
   - name: openstack/object-api
     template:
       - name: openstack-doc-gate
     post:
-      - object-api-v1.0
+      - object-api-tox-doc-publishdocs
 
   - name: openstack/volume-api
     template:
       - name: openstack-doc-gate
     post:
-      - block-api-v2.0
+      - volume-api-tox-doc-publishdocs
 
 # Section: OpenStack documentation projects
 
@@ -2243,7 +2241,7 @@ projects:
     template:
       - name: openstack-doc-gate
     post:
-      - openstack-api-quick-start
+      - api-site-tox-doc-publishdocs
       - openstack-api-site
       - openstack-api-ref
       - manuals-upstream-translation-update