From c67db09e953b51e4bd45791e3d8e364b1f2a64b8 Mon Sep 17 00:00:00 2001 From: "Hasko, Vladimir" Date: Tue, 15 Aug 2023 08:40:01 +0000 Subject: [PATCH] updating run.yaml for parameters needed for confpy generator Reviewed-by: vladimirhasko Co-authored-by: Hasko, Vladimir Co-committed-by: Hasko, Vladimir --- metadata.yaml | 327 +++++++++++++++++++++++++++--- playbooks/run.yaml | 6 + roles/convert_doc/tasks/main.yaml | 49 +++++ templates/conf.py | 11 + 4 files changed, 369 insertions(+), 24 deletions(-) diff --git a/metadata.yaml b/metadata.yaml index caed09e3..69b20fa3 100644 --- a/metadata.yaml +++ b/metadata.yaml @@ -3,17 +3,21 @@ categories: security-services: - service_title: Anti DDoS service_type: antiddos + service_category: security-services + service_environment: internal docs: - html_location: docs/antiddos/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /anti-ddos/api-ref/ pdf_name: antiddos-api-ref hc_location: api/antiddos - html_location: docs/antiddos/umn rst_location: umn/source title: User Guide type: umn + link: /anti-ddos/umn/ pdf_name: antiddos-umn hc_location: usermanual/antiddos teams: @@ -22,58 +26,93 @@ categories: repository: docs/anti-ddos - service_title: Database Security Service service_type: dbss + service_category: security-services + service_environment: internal docs: - html_location: docs/dbss/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /database-security-service/api-ref/ pdf_name: dbss-api-ref - html_location: docs/dbss/umn rst_location: umn/source title: User Guide type: umn + link: /database-security-service/umn/ pdf_name: dbss-umn teams: - name: docs-security-services-rw permission: write repository: docs/database-security-service + - service_title: Host Security Service + service_type: hss + service_category: security-services + service_environment: internal + docs: + - html_location: docs/host-security-service/api-ref + rst_location: api-ref/source + title: API Reference + type: api-ref + link: /host-security-service/api-ref/ + pdf_name: hss-api-ref + - html_location: docs/host-security-service/umn + rst_location: umn/source + title: User Guide + type: umn + link: /host-security-service/umn/ + pdf_name: hss-umn + hc_location: usermanual/nosql + teams: + - name: docs-security-services-rw + permission: write + repository: docs/host-security-service - service_title: Identity and Access Management service_type: iam + service_category: security-services + service_environment: internal docs: - html_location: docs/iam/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /identity-access-management/api-ref/ pdf_name: iam-api-ref hc_location: api/iam - - html_location: docs/iam/umn - rst_location: umn/source - title: User Guide - type: umn - pdf_name: iam-umn - hc_location: usermanual/iam - html_location: docs/iam/permissions rst_location: doc/permissions/source title: Permissions type: permissions + link: /identity-access-management/permissions/ pdf_name: iam-permissions + - html_location: docs/iam/umn + rst_location: umn/source + title: User Guide + type: umn + link: /identity-access-management/umn/ + pdf_name: iam-umn + hc_location: usermanual/iam teams: - name: docs-security-services-rw permission: write repository: docs/identity-access-management - service_title: Key Management Service service_type: kms + service_category: security-services + service_environment: internal docs: - html_location: docs/kms/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /key-management-service/api-ref/ pdf_name: kms-api-ref hc_location: api/kms - html_location: docs/kms/umn rst_location: umn/source title: User Guide type: umn + link: /key-management-service/umn/ pdf_name: kms-umn hc_location: usermanual/kms teams: @@ -82,17 +121,21 @@ categories: repository: docs/key-management-service - service_title: Web Application Firewall service_type: waf + service_category: security-services + service_environment: internal docs: - html_location: docs/waf/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /web-application-firewall/api-ref/ pdf_name: waf-api-ref hc_location: api/waf - html_location: docs/waf/umn rst_location: umn/source title: User Guide type: umn + link: /web-application-firewall/umn/ pdf_name: waf-umn hc_location: usermanual/waf teams: @@ -101,22 +144,27 @@ categories: repository: docs/web-application-firewall - service_title: Dedicated Web Application Firewall service_type: wafd + service_category: security-services + service_environment: internal docs: - html_location: docs/wafd/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /web-application-firewall-dedicated/api-ref/ pdf_name: wafd-api-ref hc_location: api/dwaf - html_location: docs/wafd/best-practice rst_location: doc/best-practice/source title: Best Practice type: best-practice + link: /web-application-firewall-dedicated/best-practice/ pdf_name: wafd-best-practice - html_location: docs/wafd/umn rst_location: umn/source title: User Guide type: umn + link: /web-application-firewall-dedicated/umn/ pdf_name: wafd-umn hc_location: usermanual/dwaf teams: @@ -126,17 +174,21 @@ categories: application: - service_title: Application Operations Management service_type: aom + service_category: application + service_environment: internal docs: - html_location: docs/aom/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /application-operations-management/api-ref/ pdf_name: aom-api-ref hc_location: api/aom - html_location: docs/aom/umn rst_location: umn/source title: User Guide type: umn + link: /application-operations-management/umn/ pdf_name: aom-umn hc_location: usermanual/aom teams: @@ -145,16 +197,20 @@ categories: repository: docs/application-operations-management - service_title: Cloud Service Engine service_type: cse + service_category: application + service_environment: internal docs: - html_location: docs/cse/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /cloud-service-engine/api-ref/ pdf_name: cse-api-ref - html_location: docs/cse/umn rst_location: umn/source title: User Guide type: umn + link: /cloud-service-engine/umn/ pdf_name: cse-umn teams: - name: docs-orchestration-rw @@ -162,23 +218,28 @@ categories: repository: docs/cloud-service-engine - service_title: Distributed Message Service service_type: dms + service_category: application + service_environment: internal docs: - html_location: docs/dms/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /distributed-message-service/api-ref/ pdf_name: dms-api-ref hc_location: api/dms - html_location: docs/dms/dev rst_location: dev_guide/source title: Developer Guide type: dev + link: /distributed-message-service/dev-guide/ pdf_name: dms-dev-guide hc_location: devg/dms - html_location: docs/dms/umn rst_location: umn/source title: User Guide type: umn + link: /distributed-message-service/umn/ pdf_name: dms-umn hc_location: usermanual/dms teams: @@ -187,17 +248,21 @@ categories: repository: docs/distributed-message-service - service_title: Simple Message Notification service_type: smn + service_category: application + service_environment: internal docs: - html_location: docs/smn/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /simple-message-notification/api-ref/ pdf_name: smn-api-ref hc_location: api/smn - html_location: docs/smn/umn rst_location: umn/source title: User Guide type: umn + link: /simple-message-notification/umn/ pdf_name: smn-umn hc_location: usermanual/smn teams: @@ -207,16 +272,20 @@ categories: big_data: - service_title: API Gateway (APIG) service_type: apig + service_category: big_data + service_environment: internal docs: - html_location: docs/apig/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /api-gateway/api-ref/ pdf_name: apig-api-ref - html_location: docs/apig/umn rst_location: umn/source title: User Guide type: umn + link: /api-gateway/umn/ pdf_name: apig-umn teams: - name: docs-bigdata-ai-rw @@ -224,17 +293,21 @@ categories: repository: docs/api-gateway - service_title: Cloud Search Service service_type: css + service_category: big_data + service_environment: internal docs: - html_location: docs/css/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /cloud-search-service/api-ref/ pdf_name: css-api-ref hc_location: api/css - html_location: docs/css/umn rst_location: umn/source title: User Guide type: umn + link: /cloud-search-service/umn/ pdf_name: css-umn hc_location: usermanual/css teams: @@ -243,16 +316,20 @@ categories: repository: docs/cloud-search-service - service_title: DataArts Studio service_type: dataarts_studio + service_category: big_data + service_environment: internal docs: - html_location: docs/dataartsstudio/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /data-arts-studio/api-ref/ pdf_name: dataarts_studio-api-ref - html_location: docs/dataartsstudio/umn rst_location: umn/source title: User Guide type: umn + link: /data-arts-studio/umn/ pdf_name: dataarts_studio-umn teams: - name: docs-bigdata-ai-rw @@ -260,17 +337,21 @@ categories: repository: docs/data-arts-studio - service_title: Data Ingestion Service service_type: dis + service_category: big_data + service_environment: internal docs: - html_location: docs/dis/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /data-ingestion-service/api-ref/ pdf_name: dis-api-ref hc_location: api/dis - html_location: docs/dis/umn rst_location: umn/source title: User Guide type: umn + link: /data-ingestion-service/umn/ pdf_name: dis-umn hc_location: usermanual/dis teams: @@ -279,17 +360,21 @@ categories: repository: docs/data-ingestion-service - service_title: Data Lake Insight service_type: dli + service_category: big_data + service_environment: internal docs: - html_location: docs/dli/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /data-lake-insight/api-ref/ pdf_name: dli-api-ref hc_location: api/dli - html_location: docs/dli/umn rst_location: umn/source title: User Guide type: umn + link: /data-lake-insight/umn/ pdf_name: dli-umn hc_location: usermanual/dli teams: @@ -298,29 +383,35 @@ categories: repository: docs/data-lake-insight - service_title: Data Warehouse Service service_type: dws + service_category: big_data + service_environment: internal docs: - html_location: docs/dws/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /data-warehouse-service/api-ref/ pdf_name: dws-api-ref hc_location: api/dws - html_location: docs/dws/dev rst_location: dev_guide/source title: Developer Guide type: dev + link: /data-warehouse-service/dev-guide/ pdf_name: dws-dev-guide hc_location: devg/dws - html_location: docs/dws/tool rst_location: doc/tool/source title: Tool Guide type: tool-guide + link: /data-warehouse-service/tool-guide/ pdf_name: dws-tool-guide hc_location: tg/dws - html_location: docs/dws/umn rst_location: umn/source title: User Guide type: umn + link: /data-warehouse-service/umn/ hc_location: usermanual/dws teams: - name: docs-bigdata-ai-rw @@ -328,54 +419,65 @@ categories: repository: docs/data-warehouse-service - service_title: ModelArts service_type: ma + service_category: big_data + service_environment: internal docs: - html_location: docs/modelarts/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /modelarts/api-ref/ pdf_name: ma-api-ref hc_location: api/ma - - html_location: docs/modelarts/umn - rst_location: umn/source - title: User Guide - type: umn - pdf_name: ma-umn - hc_location: usermanual/ma - html_location: docs/modelarts/sdk-ref rst_location: doc/sdk-ref/source title: ModelArts Software Development Kit (ModelArts SDK) type: sdk-ref + link: /modelarts/sdk-ref/ pdf_name: ma-sdk-ref hc_location: sdk/ma + - html_location: docs/modelarts/umn + rst_location: umn/source + title: User Guide + type: umn + link: /modelarts/umn/ + pdf_name: ma-umn + hc_location: usermanual/ma teams: - name: docs-bigdata-ai-rw permission: write repository: docs/modelarts - service_title: MapReduce Service service_type: mrs + service_category: big_data + service_environment: internal docs: - html_location: docs/mrs/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /mapreduce-service/api-ref/ pdf_name: mrs-api-ref hc_location: api/mrs - html_location: docs/mrs/component-operation-guide rst_location: doc/component-operation-guide/source title: Component Operation Guide type: operation-guide + link: /mapreduce-service/operation-guide/ pdf_name: mrs-component-operation-guide hc_location: cmpntguide/mrs - html_location: docs/mrs/component-operation-guide-lts rst_location: doc/component-operation-guide-lts/source title: Component Operation Guide (LTS) type: operation-guide-lts + link: /mapreduce-service/operation-guide-lts/ pdf_name: mrs-component-operation-guide-lts hc_location: cmpntguide-lts/mrs - html_location: docs/mrs/umn rst_location: umn/source title: User Guide type: umn + link: /mapreduce-service/umn/ pdf_name: mrs-umn hc_location: usermanual/mrs teams: @@ -385,23 +487,28 @@ categories: compute: - service_title: Auto Scaling service_type: as + service_category: compute + service_environment: internal docs: - html_location: docs/as/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /auto-scaling/api-ref/ pdf_name: as-api-ref hc_location: api/as - html_location: docs/as/dev rst_location: dev_guide/source title: Developer Guide type: dev + link: /auto-scaling/dev-guide/ pdf_name: as-dev-guide hc_location: devg/as - html_location: docs/as/umn rst_location: umn/source title: User Guide type: umn + link: /auto-scaling/umn/ pdf_name: as-umn hc_location: usermanual/as teams: @@ -410,29 +517,35 @@ categories: repository: docs/auto-scaling - service_title: Bare Metal Server service_type: bms + service_category: compute + service_environment: internal docs: - html_location: docs/bms/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /bare-metal-server/api-ref/ pdf_name: bms-api-ref hc_location: api/bms - html_location: docs/bms/dev rst_location: dev_guide/source title: Developer Guide type: dev + link: /bare-metal-server/dev-guide/ pdf_name: bms-dev-guide hc_location: devg/bms - html_location: docs/bms/image-creation-guide rst_location: doc/image-creation-guide/source title: Private Image Creation Guide type: image-creation-guide + link: /bare-metal-server/image-creation-guide/ pdf_name: bms-image-creation-guide hc_location: bpicg/bms - html_location: docs/bms/umn rst_location: umn/source title: User Guide type: umn + link: /bare-metal-server/umn/ pdf_name: bms-umn hc_location: usermanual/bms teams: @@ -441,17 +554,21 @@ categories: repository: docs/bare-metal-server - service_title: Dedicated Host service_type: deh + service_category: compute + service_environment: internal docs: - html_location: docs/deh/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /dedicated-host/api-ref/ pdf_name: deh-api-ref hc_location: api/deh - html_location: docs/deh/umn rst_location: umn/source title: User Guide type: umn + link: /dedicated-host/umn/ pdf_name: deh-umn hc_location: usermanual/deh teams: @@ -460,28 +577,34 @@ categories: repository: docs/dedicated-host - service_title: Elastic Cloud Server service_type: ecs + service_category: compute + service_environment: internal docs: - html_location: docs/ecs/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /elastic-cloud-server/api-ref/ pdf_name: ecs-api-ref hc_location: api/ecs - html_location: docs/ecs/best-practice rst_location: doc/best-practice/source title: Best Practice type: best-practice + link: /elastic-cloud-server/best-practice/ pdf_name: ecs-best-practice - html_location: docs/ecs/dev rst_location: dev_guide/source title: Developer Guide type: dev + link: /elastic-cloud-server/dev-guide/ pdf_name: ecs-dev-guide hc_location: devg/ecs - html_location: docs/ecs/umn rst_location: umn/source title: User Guide type: umn + link: /elastic-cloud-server/umn/ pdf_name: ecs-umn hc_location: usermanual/ecs teams: @@ -490,26 +613,32 @@ categories: repository: docs/elastic-cloud-server - service_title: FunctionGraph service_type: fg + service_category: compute + service_environment: internal docs: - html_location: docs/fg/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /function-graph/api-ref/ pdf_name: fg-api-ref - html_location: docs/fg/best-practice rst_location: doc/best-practice/source title: Best Practice type: best-practice + link: /function-graph/best-practice/ pdf_name: fg-best-practice - html_location: docs/fg/dev rst_location: dev_guide/source title: Developer Guide type: dev + link: /function-graph/dev-guide/ pdf_name: fg-dev-guide - html_location: docs/fg/umn rst_location: umn/source title: User Guide type: umn + link: /function-graph/umn/ pdf_name: fg-umn teams: - name: docs-compute-rw @@ -517,23 +646,28 @@ categories: repository: docs/function-graph - service_title: Image Management Service service_type: ims + service_category: compute + service_environment: internal docs: - html_location: docs/ims/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /image-management-service/api-ref/ pdf_name: ims-api-ref hc_location: api/ims - html_location: docs/ims/dev rst_location: dev_guide/source title: Developer Guide type: dev + link: /image-management-service/dev-guide/ pdf_name: ims-dev-guide hc_location: devg/ims - html_location: docs/ims/umn rst_location: umn/source title: User Guide type: umn + link: /image-management-service/umn/ pdf_name: ims-umn hc_location: usermanual/ims teams: @@ -543,17 +677,21 @@ categories: storage: - service_title: Cloud Backup and Recovery service_type: cbr + service_category: storage + service_environment: internal docs: - html_location: docs/cbr/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /cloud-backup-recovery/api-ref/ pdf_name: cbr-api-ref hc_location: api/cbr - html_location: docs/cbr/umn rst_location: umn/source title: User Guide type: umn + link: /cloud-backup-recovery/umn/ pdf_name: cbr-umn hc_location: usermanual/cbr teams: @@ -562,17 +700,21 @@ categories: repository: docs/cloud-backup-recovery - service_title: Cloud Server Backup Service service_type: csbs + service_category: storage + service_environment: internal docs: - html_location: docs/csbs/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /cloud-server-backup-service/api-ref/ pdf_name: csbs-api-ref hc_location: api/csbs - html_location: docs/csbs/umn rst_location: umn/source title: User Guide type: umn + link: /cloud-server-backup-service/umn/ pdf_name: csbs-umn hc_location: usermanual/csbs teams: @@ -581,23 +723,28 @@ categories: repository: docs/cloud-server-backup-service - service_title: Elastic Volume Service service_type: evs + service_category: storage + service_environment: internal docs: - html_location: docs/evs/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /elastic-volume-service/api-ref/ pdf_name: evs-api-ref hc_location: api/evs - html_location: docs/evs/dev rst_location: dev_guide/source title: Developer Guide type: dev + link: /elastic-volume-service/dev-guide/ pdf_name: evs-dev-guide hc_location: devg/evs - html_location: docs/evs/umn rst_location: umn/source title: User Guide type: umn + link: /elastic-volume-service/umn/ pdf_name: evs-umn hc_location: usermanual/evs teams: @@ -606,46 +753,55 @@ categories: repository: docs/elastic-volume-service - service_title: Object Storage Service service_type: obs + service_category: storage + service_environment: internal docs: - html_location: docs/obs/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /object-storage-service/api-ref/ pdf_name: obs-api-ref hc_location: api/obs - - html_location: docs/obs/tool - rst_location: doc/tool/source - title: Tool Guide (OBS Browser) - type: tool-guide - pdf_name: obs-tool-guide - hc_location: browsertg/obs + - html_location: docs/obs/api-swift + rst_location: doc/swiftapi/source + title: API Reference (Swift) - Deprecated + type: swiftapi + link: /object-storage-service/swiftapi/ + pdf_name: obs-swiftapi + hc_location: api_swift/obs - html_location: docs/obs/pfs rst_location: doc/parallel-file-system/source title: Parallel File System (PFS) type: parallel-file-system + link: /object-storage-service/parallel-file-system/ pdf_name: obs-pfs hc_location: pfs/obs - html_location: docs/obs/perms-cfg rst_location: doc/permissions-configuration-guide/source title: Permissions Configuration Guide type: permissions-configuration-guide + link: /object-storage-service/permissions-configuration-guide/ pdf_name: obs-perms-cfg - - html_location: docs/obs/api-swift - rst_location: doc/swiftapi/source - title: API Reference (Swift) - Deprecated - type: swiftapi - pdf_name: obs-swiftapi - hc_location: api_swift/obs - html_location: docs/obs/s3api rst_location: doc/s3api/source title: S3 API Reference type: s3api + link: /object-storage-service/s3api/ pdf_name: obs-s3api hc_location: api_obs/obs + - html_location: docs/obs/tool + rst_location: doc/tool/source + title: Tool Guide (OBS Browser) + type: tool-guide + link: /object-storage-service/tool-guide/ + pdf_name: obs-tool-guide + hc_location: browsertg/obs - html_location: docs/obs/umn rst_location: umn/source title: User Guide type: umn + link: /object-storage-service/umn/ pdf_name: obs-umn hc_location: usermanual/obs teams: @@ -654,17 +810,21 @@ categories: repository: docs/object-storage-service - service_title: Storage Disaster Recovery Service service_type: sdrs + service_category: storage + service_environment: internal docs: - html_location: docs/sdrs/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /storage-disaster-recovery-service/api-ref/ pdf_name: sdrs-api-ref hc_location: api/sdrs - html_location: docs/sdrs/umn rst_location: umn/source title: User Guide type: umn + link: /storage-disaster-recovery-service/umn/ pdf_name: sdrs-umn hc_location: usermanual/sdrs teams: @@ -673,17 +833,21 @@ categories: repository: docs/storage-disaster-recovery-service - service_title: Scalable File Service service_type: sfs + service_category: storage + service_environment: internal docs: - html_location: docs/sfs/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /scalable-file-service/api-ref/ pdf_name: sfs-api-ref hc_location: api/sfs - html_location: docs/sfs/umn rst_location: umn/source title: User Guide type: umn + link: /scalable-file-service/umn/ pdf_name: sfs-umn hc_location: usermanual/sfs teams: @@ -692,17 +856,21 @@ categories: repository: docs/scalable-file-service - service_title: Volume Backup Service service_type: vbs + service_category: storage + service_environment: internal docs: - html_location: docs/vbs/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /volume-backup-service/api-ref/ pdf_name: vbs-api-ref hc_location: api/vbs - html_location: docs/vbs/umn rst_location: umn/source title: User Guide type: umn + link: /volume-backup-service/umn/ pdf_name: vbs-umn hc_location: usermanual/vbs teams: @@ -712,17 +880,21 @@ categories: container: - service_title: Cloud Container Engine service_type: cce + service_category: container + service_environment: internal docs: - html_location: docs/cce/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /cloud-container-engine/api-ref/ pdf_name: cce-api-ref hc_location: api2/cce - html_location: docs/cce/umn rst_location: umn/source title: User Guide type: umn + link: /cloud-container-engine/umn/ hc_location: usermanual2/cce teams: - name: docs-container-rw @@ -730,16 +902,20 @@ categories: repository: docs/cloud-container-engine - service_title: Cloud Container Instance service_type: cci + service_category: container + service_environment: internal docs: - html_location: docs/cci/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /cloud-container-instance/api-ref/ pdf_name: cci-api-ref - html_location: docs/cci/umn rst_location: umn/source title: User Guide type: umn + link: /cloud-container-instance/umn/ pdf_name: cci-umn teams: - name: docs-container-rw @@ -747,17 +923,21 @@ categories: repository: docs/cloud-container-instance - service_title: Software Repository for Containers service_type: swr + service_category: container + service_environment: internal docs: - html_location: docs/swr/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /software-repository-container/api-ref/ pdf_name: swr-api-ref hc_location: api/swr - html_location: docs/swr/umn rst_location: umn/source title: User Guide type: umn + link: /software-repository-container/umn/ pdf_name: swr-umn hc_location: usermanual/swr teams: @@ -767,17 +947,21 @@ categories: md: - service_title: Cloud Eye service_type: ces + service_category: md + service_environment: internal docs: - html_location: docs/ces/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /cloud-eye/api-ref/ pdf_name: ces-api-ref hc_location: api/ces - html_location: docs/ces/umn rst_location: umn/source title: User Guide type: umn + link: /cloud-eye/umn/ pdf_name: ces-umn hc_location: usermanual/ces teams: @@ -786,17 +970,21 @@ categories: repository: docs/cloud-eye - service_title: Cloud Trace Service service_type: cts + service_category: md + service_environment: internal docs: - html_location: docs/cts/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /cloud-trace-service/api-ref/ pdf_name: cts-api-ref hc_location: api/cts - html_location: docs/cts/umn rst_location: umn/source title: User Guide type: umn + link: /cloud-trace-service/umn/ pdf_name: cts-umn hc_location: usermanual/cts teams: @@ -805,17 +993,21 @@ categories: repository: docs/cloud-trace-service - service_title: Log Tank Service service_type: lts + service_category: md + service_environment: internal docs: - html_location: docs/lts/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /log-tank-service/api-ref/ pdf_name: lts-api-ref hc_location: api/lts - html_location: docs/lts/umn rst_location: umn/source title: User Guide type: umn + link: /log-tank-service/umn/ pdf_name: lts-umn hc_location: usermanual/lts teams: @@ -824,17 +1016,21 @@ categories: repository: docs/log-tank-service - service_title: Resource Management Service service_type: rms + service_category: md + service_environment: internal docs: - html_location: docs/rms/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /resource-management-service/api-ref/ pdf_name: rms-api-ref hc_location: api/rms - html_location: docs/rms/umn rst_location: umn/source title: User Guide type: umn + link: /resource-management-service/umn/ pdf_name: rms-umn hc_location: usermanual/rms teams: @@ -843,17 +1039,21 @@ categories: repository: docs/resource-management-service - service_title: Resource Template Service service_type: rts + service_category: md + service_environment: internal docs: - html_location: docs/rts/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /resource-template-service/api-ref/ pdf_name: rts-api-ref hc_location: api/rts - html_location: docs/rts/umn rst_location: umn/source title: User Guide type: umn + link: /resource-template-service/umn/ pdf_name: rts-umn hc_location: usermanual/rts teams: @@ -862,17 +1062,21 @@ categories: repository: docs/resource-template-service - service_title: Tag Management Service service_type: tms + service_category: md + service_environment: internal docs: - html_location: docs/tms/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /tag-management-service/api-ref/ pdf_name: tms-api-ref hc_location: api/tms - html_location: docs/tms/umn rst_location: umn/source title: User Guide type: umn + link: /tag-management-service/umn/ pdf_name: tms-umn hc_location: usermanual/tms teams: @@ -882,17 +1086,21 @@ categories: network: - service_title: Direct Connect service_type: dc + service_category: network + service_environment: internal docs: - html_location: docs/dc/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /direct-connect/api-ref/ pdf_name: dc-api-ref hc_location: api/dc - html_location: docs/dc/umn rst_location: umn/source title: User Guide type: umn + link: /direct-connect/umn/ pdf_name: dc-umn hc_location: usermanual/dc teams: @@ -901,17 +1109,21 @@ categories: repository: docs/direct-connect - service_title: Domain Name Service service_type: dns + service_category: network + service_environment: internal docs: - html_location: docs/dns/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /domain-name-service/api-ref/ pdf_name: dns-api-ref hc_location: api/dns - html_location: docs/dns/umn rst_location: umn/source title: User Guide type: umn + link: /domain-name-service/umn/ pdf_name: dns-umn hc_location: usermanual/dns teams: @@ -920,17 +1132,21 @@ categories: repository: docs/domain-name-service - service_title: Elastic IP service_type: eip + service_category: network + service_environment: internal docs: - html_location: docs/eip/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /elastic-ip/api-ref/ pdf_name: eip-api-ref hc_location: api/eip - html_location: docs/eip/umn rst_location: umn/source title: User Guide type: umn + link: /elastic-ip/umn/ pdf_name: eip-umn hc_location: usermanual/eip teams: @@ -939,17 +1155,21 @@ categories: repository: docs/elastic-ip - service_title: Elastic Load Balancing service_type: elb + service_category: network + service_environment: internal docs: - html_location: docs/elb/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /elastic-load-balancing/api-ref/ pdf_name: elb-api-ref hc_location: api/elb - html_location: docs/elb/umn rst_location: umn/source title: User Guide type: umn + link: /elastic-load-balancing/umn/ pdf_name: elb-umn hc_location: usermanual/elb teams: @@ -958,16 +1178,20 @@ categories: repository: docs/elastic-load-balancing - service_title: Enterprise Router service_type: er + service_category: network + service_environment: internal docs: - html_location: docs/er/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /enterprise-router/api-ref/ pdf_name: er-api-ref - html_location: docs/er/umn rst_location: umn/source title: User Guide type: umn + link: /enterprise-router/umn/ pdf_name: er-umn teams: - name: docs-network-rw @@ -975,17 +1199,21 @@ categories: repository: docs/enterprise-router - service_title: NAT Gateway service_type: natgw + service_category: network + service_environment: internal docs: - html_location: docs/natgw/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /nat-gateway/api-ref/ pdf_name: natgw-api-ref hc_location: api/nat - html_location: docs/natgw/umn rst_location: umn/source title: User Guide type: umn + link: /nat-gateway/umn/ pdf_name: natgw-umn hc_location: usermanual/nat teams: @@ -994,17 +1222,21 @@ categories: repository: docs/nat-gateway - service_title: Private Link Access Service service_type: plas + service_category: network + service_environment: internal docs: - html_location: docs/plas/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /private-link-access-service/api-ref/ pdf_name: plas-api-ref hc_location: api/plas - html_location: docs/plas/umn rst_location: umn/source title: User Guide type: umn + link: /private-link-access-service/umn/ pdf_name: plas-umn hc_location: usermanual/plas teams: @@ -1013,17 +1245,21 @@ categories: repository: docs/private-link-access-service - service_title: Virtual Private Cloud service_type: vpc + service_category: network + service_environment: internal docs: - html_location: docs/vpc/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /virtual-private-cloud/api-ref/ pdf_name: vpc-api-ref hc_location: api/vpc - html_location: docs/vpc/umn rst_location: umn/source title: User Guide type: umn + link: /virtual-private-cloud/umn/ pdf_name: vpc-umn hc_location: usermanual/vpc teams: @@ -1032,17 +1268,21 @@ categories: repository: docs/virtual-private-cloud - service_title: VPC Endpoint service_type: vpcep + service_category: network + service_environment: internal docs: - html_location: docs/vpcep/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /vpc-endpoint/api-ref/ pdf_name: vpcep-api-ref hc_location: api/vpcep - html_location: docs/vpcep/umn rst_location: umn/source title: User Guide type: umn + link: /vpc-endpoint/umn/ pdf_name: vpcep-umn hc_location: usermanual/vpcep teams: @@ -1051,17 +1291,21 @@ categories: repository: docs/vpc-endpoint - service_title: Virtual Private Network service_type: vpn + service_category: network + service_environment: internal docs: - html_location: docs/vpn/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /virtual-private-network/api-ref/ pdf_name: vpn-api-ref hc_location: api/vpn - html_location: docs/vpn/umn rst_location: umn/source title: User Guide type: umn + link: /virtual-private-network/umn/ pdf_name: vpn-umn hc_location: usermanual/vpn teams: @@ -1071,17 +1315,21 @@ categories: database: - service_title: Distributed Cache Service service_type: dcs + service_category: database + service_environment: internal docs: - html_location: docs/dcs/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /distributed-cache-service/api-ref/ pdf_name: dcs-api-ref hc_location: api/dcs - html_location: docs/dcs/umn rst_location: umn/source title: User Guide type: umn + link: /distributed-cache-service/umn/ pdf_name: dcs-umn hc_location: usermanual/dcs teams: @@ -1090,16 +1338,20 @@ categories: repository: docs/distributed-cache-service - service_title: Distributed Database Middleware service_type: ddm + service_category: database + service_environment: internal docs: - html_location: docs/ddm/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /distributed-database-middleware/api-ref/ pdf_name: ddm-api-ref - html_location: docs/ddm/umn rst_location: umn/source title: User Guide type: umn + link: /distributed-database-middleware/umn/ pdf_name: ddm-umn teams: - name: docs-database-rw @@ -1107,16 +1359,20 @@ categories: repository: docs/distributed-database-middleware - service_title: Document Database Service service_type: dds + service_category: database + service_environment: internal docs: - html_location: docs/dds/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /document-database-service/api-ref/ hc_location: api/dds - html_location: docs/dds/umn rst_location: umn/source title: User Guide type: umn + link: /document-database-service/umn/ pdf_name: dds-umn hc_location: usermanual/dds teams: @@ -1125,17 +1381,21 @@ categories: repository: docs/document-database-service - service_title: Data Replication Service service_type: drs + service_category: database + service_environment: internal docs: - html_location: docs/drs/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /data-replication-service/api-ref/ pdf_name: drs-api-ref hc_location: api/drs - html_location: docs/drs/umn rst_location: umn/source title: User Guide type: umn + link: /data-replication-service/umn/ pdf_name: drs-umn hc_location: usermanual/drs teams: @@ -1144,17 +1404,21 @@ categories: repository: docs/data-replication-service - service_title: GaussDB (for MySQL) service_type: gaussdb_mysql + service_category: database + service_environment: internal docs: - html_location: docs/gaussdb_mysql/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /gaussdb-mysql/api-ref/ pdf_name: gaussdb_mysql-api-ref hc_location: api/gaussdb - html_location: docs/gaussdb_mysql/umn rst_location: umn/source title: User Guide type: umn + link: /gaussdb-mysql/umn/ pdf_name: gaussdb_mysql-umn hc_location: usermanual/gaussdb teams: @@ -1163,16 +1427,20 @@ categories: repository: docs/gaussdb-mysql - service_title: GaussDB NoSQL service_type: gaussdb_nosql + service_category: database + service_environment: internal docs: - html_location: docs/gaussdb_nosql/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /gaussdb_nosql/api-ref/ pdf_name: gaussdb_nosql-api-ref - html_location: docs/gaussdb_nosql/umn rst_location: umn/source title: User Guide type: umn + link: /gaussdb-nosql/umn/ pdf_name: gauss_nosql hc_location: usermanual/nosql teams: @@ -1181,17 +1449,21 @@ categories: repository: docs/gaussdb-nosql - service_title: GaussDB (openGauss) service_type: opengauss + service_category: database + service_environment: internal docs: - html_location: docs/opengauss/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /gaussdb-opengauss/api-ref/ pdf_name: opengauss-api-ref hc_location: api/opengauss - html_location: docs/opengauss/umn rst_location: umn/source title: User Guide type: umn + link: /gaussdb-opengauss/umn/ pdf_name: opengauss-umn hc_location: usermanual/opengauss teams: @@ -1200,17 +1472,21 @@ categories: repository: docs/gaussdb-opengauss - service_title: Relational Database Service service_type: rds + service_category: database + service_environment: internal docs: - html_location: docs/rds/api-ref rst_location: api-ref/source title: API Reference type: api-ref + link: /relational-database-service/api-ref/ pdf_name: rds-api-ref hc_location: api/rds - html_location: docs/rds/umn rst_location: umn/source title: User Guide type: umn + link: /relational-database-service/umn/ pdf_name: rds-umn hc_location: usermanual/rds teams: @@ -1220,11 +1496,14 @@ categories: other: - service_title: Status Dashboard service_type: sd + service_category: other + service_environment: internal docs: - html_location: docs/sd/umn rst_location: umn/source title: User Guide type: umn + link: /status-dashboard/umn/ pdf_name: sd-umn hc_location: usermanual/sd teams: diff --git a/playbooks/run.yaml b/playbooks/run.yaml index 7de81085..bb584419 100644 --- a/playbooks/run.yaml +++ b/playbooks/run.yaml @@ -25,7 +25,13 @@ dest: "{{ ansible_user_dir }}/{{ doc.0.repository }}/{{ doc.1.rst_location }}" source: "{{ zuul.project.src_dir }}/{{ doc.1.html_location }}" doc_title: "{{ [ doc.0.service_title, doc.1.title ] | join(' - ') }}" + doc_short_title: "{{ doc.1.title | default(None) }}" + doc_environment: "{{ doc.0.service_environment | default(None) }}" + doc_link: "{{ doc.1.link | default(None) }}" + doc_type: "{{ doc.1.type | default(None) }}" doc_service: "{{ doc.0.service_title | default(None) }}" + doc_service_category: "{{ doc.0.service_category | default(None) }}" + doc_service_type: "{{ doc.0.service_type | default(None) }}" doc_repo_name: "{{ doc.0.repository | default(None) }}" doc_pdf_name: "{{ doc.1.pdf_name | default(None) }}" loop: "{{ doc_exports_var | subelements('docs') }}" diff --git a/roles/convert_doc/tasks/main.yaml b/roles/convert_doc/tasks/main.yaml index ecebb39d..120603f9 100644 --- a/roles/convert_doc/tasks/main.yaml +++ b/roles/convert_doc/tasks/main.yaml @@ -20,6 +20,34 @@ - "doc_title is defined" - "doc_title | length > 0" +- name: Add document title to parameters + ansible.builtin.set_fact: + convert_params: "{{ convert_params }} --doc-title '{{ doc_short_title }}'" + when: + - "doc_short_title is defined" + - "doc_short_title | length > 0" + +- name: Add environment to parameters + ansible.builtin.set_fact: + convert_params: "{{ convert_params }} --doc-environment '{{ doc_environment }}'" + when: + - "doc_environment is defined" + - "doc_environment | length > 0" + +- name: Add link to parameters + ansible.builtin.set_fact: + convert_params: "{{ convert_params }} --doc-link '{{ doc_link }}'" + when: + - "doc_link is defined" + - "doc_link | length > 0" + +- name: Add documentation type to parameters + ansible.builtin.set_fact: + convert_params: "{{ convert_params }} --doc-type '{{ doc_type }}'" + when: + - "doc_type is defined" + - "doc_type | length > 0" + - name: Add service to parameters ansible.builtin.set_fact: convert_params: "{{ convert_params }} --service '{{ doc_service }}'" @@ -27,6 +55,27 @@ - "doc_service is defined" - "doc_service | length > 0" +- name: Add service title to parameters + ansible.builtin.set_fact: + convert_params: "{{ convert_params }} --service-title '{{ doc_service }}'" + when: + - "doc_service is defined" + - "doc_service | length > 0" + +- name: Add service category to parameters + ansible.builtin.set_fact: + convert_params: "{{ convert_params }} --service-category '{{ doc_service_category }}'" + when: + - "doc_service_category is defined" + - "doc_service_category | length > 0" + +- name: Add service type to parameters + ansible.builtin.set_fact: + convert_params: "{{ convert_params }} --service-type '{{ doc_service_type }}'" + when: + - "doc_service_type is defined" + - "doc_service_type | length > 0" + - name: Add repo_name to parameters ansible.builtin.set_fact: convert_params: "{{ convert_params }} --repo-name '{{ doc_repo_name }}'" diff --git a/templates/conf.py b/templates/conf.py index 11f08baa..c578a1ca 100644 --- a/templates/conf.py +++ b/templates/conf.py @@ -30,6 +30,17 @@ otcdocs_repo_name = '{{ repo_name }}' otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com' otcdocs_git_type = 'gitea' +# Those variables are needed for indexing into OpenSearch +otcdocs_doc_environment = '{{ doc_environment }}' +otcdocs_doc_link = '{{ doc_link }}' +otcdocs_doc_title = '{{ doc_title }}' +otcdocs_doc_type = '{{ doc_type }}' +otcdocs_service_category = '{{ service_category }}' +otcdocs_service_title = '{{ service_title }}' +otcdocs_service_type = '{{ service_type }}' +otcdocs_search_environment = 'hc_de' +otcdocs_search_url = "https://opensearch.eco.tsi-dev.otc-service.com/" + # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here.