diff --git a/otc_metadata/__init__.py b/otc_metadata/__init__.py index 56b98c7..3b458c0 100644 --- a/otc_metadata/__init__.py +++ b/otc_metadata/__init__.py @@ -9,13 +9,13 @@ # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the # License for the specific language governing permissions and limitations # under the License. -__all__ = ['__version__', 'Docs'] +__all__ = ["__version__", "Docs"] import pbr.version from otc_metadata.services import Services # flake8: noqa -__version__ = pbr.version.VersionInfo('otc-metadata').version_string() +__version__ = pbr.version.VersionInfo("otc-metadata").version_string() _service_manager = None diff --git a/otc_metadata/data/__init__.py b/otc_metadata/data/__init__.py index 2102a7e..60b51a1 100644 --- a/otc_metadata/data/__init__.py +++ b/otc_metadata/data/__init__.py @@ -12,30 +12,45 @@ # limitations under the License. import os +import pathlib import yaml -__all__ = ['read_data'] +__all__ = ["read_data"] DATA_DIR = os.path.dirname(__file__) def read_data(filename): - """Return data that is shipped inside the Python package. - - """ + """Return data that is shipped inside the Python package.""" filepath = os.path.join(DATA_DIR, filename) - with open(filepath, 'r') as fd: - return yaml.safe_load(fd) + with open(filepath, "r") as fd: + data = yaml.safe_load(fd) + # Merge data found in individual element files + data.setdefault("documents", list()) + data.setdefault("services", list()) + data.setdefault("service_categories", list()) + for item in pathlib.Path(DATA_DIR, "documents").glob("*.yaml"): + with open(item, "r") as fp: + data["documents"].append(yaml.safe_load(fp)) + for item in pathlib.Path(DATA_DIR, "services").glob("*.yaml"): + with open(item, "r") as fp: + data["services"].append(yaml.safe_load(fp)) + for item in pathlib.Path(DATA_DIR, "service_categories").glob( + "*.yaml" + ): + with open(item, "r") as fp: + data["service_categories"].append(yaml.safe_load(fp)) + + return data def rewrite_data(filename, data): - """Rewrites data formatting it - - """ + """Rewrites data formatting it""" from ruamel.yaml import YAML + _yaml = YAML() _yaml.indent(mapping=2, sequence=4, offset=2) filepath = os.path.join(DATA_DIR, filename) - with open(filepath, 'w') as fd: + with open(filepath, "w") as fd: _yaml.dump(data, fd) diff --git a/otc_metadata/data/documents/aom-api-ref.yaml b/otc_metadata/data/documents/aom-api-ref.yaml new file mode 100644 index 0000000..37f3d12 --- /dev/null +++ b/otc_metadata/data/documents/aom-api-ref.yaml @@ -0,0 +1,9 @@ +--- +hc_location: api/aom +html_location: docs/aom/api-ref +link: /application-operations-management/api-ref/ +pdf_name: aom-api-ref +rst_location: api-ref/source +service_type: aom +title: API Reference +type: api-ref diff --git a/otc_metadata/data/documents/aom-umn.yaml b/otc_metadata/data/documents/aom-umn.yaml new file mode 100644 index 0000000..6553aba --- /dev/null +++ b/otc_metadata/data/documents/aom-umn.yaml @@ -0,0 +1,9 @@ +--- +hc_location: usermanual/aom +html_location: docs/aom/umn +link: /application-operations-management/umn/ +pdf_name: aom-umn +rst_location: umn/source +service_type: aom +title: User Guide +type: umn diff --git a/otc_metadata/data/documents/as-api-ref.yaml b/otc_metadata/data/documents/as-api-ref.yaml new file mode 100644 index 0000000..2fb205b --- /dev/null +++ b/otc_metadata/data/documents/as-api-ref.yaml @@ -0,0 +1,9 @@ +--- +hc_location: api/as +html_location: docs/as/api-ref +link: /auto-scaling/api-ref/ +pdf_name: as-api-ref +rst_location: api-ref/source +service_type: as +title: API Reference +type: api-ref diff --git a/otc_metadata/data/documents/as-dev.yaml b/otc_metadata/data/documents/as-dev.yaml new file mode 100644 index 0000000..2ceb12c --- /dev/null +++ b/otc_metadata/data/documents/as-dev.yaml @@ -0,0 +1,9 @@ +--- +hc_location: devg/as +html_location: docs/as/dev +link: /auto-scaling/dev-guide/ +pdf_name: as-dev-guide +rst_location: dev_guide/source +service_type: as +title: Developer Guide +type: dev diff --git a/otc_metadata/data/documents/as-umn.yaml b/otc_metadata/data/documents/as-umn.yaml new file mode 100644 index 0000000..38a8a0d --- /dev/null +++ b/otc_metadata/data/documents/as-umn.yaml @@ -0,0 +1,9 @@ +--- +hc_location: usermanual/as +html_location: docs/as/umn +link: /auto-scaling/umn/ +pdf_name: as-umn +rst_location: umn/source +service_type: as +title: User Guide +type: umn diff --git a/otc_metadata/data/documents/cbr-api-ref.yaml b/otc_metadata/data/documents/cbr-api-ref.yaml new file mode 100644 index 0000000..e7cfc1a --- /dev/null +++ b/otc_metadata/data/documents/cbr-api-ref.yaml @@ -0,0 +1,9 @@ +--- +hc_location: api/cbr +html_location: docs/cbr/api-ref +link: /cloud-backup-recovery/api-ref/ +pdf_name: cbr-api-ref +rst_location: api-ref/source +service_type: cbr +title: API Reference +type: api-ref diff --git a/otc_metadata/data/documents/cbr-umn.yaml b/otc_metadata/data/documents/cbr-umn.yaml new file mode 100644 index 0000000..960049b --- /dev/null +++ b/otc_metadata/data/documents/cbr-umn.yaml @@ -0,0 +1,9 @@ +--- +hc_location: usermanual/cbr +html_location: docs/cbr/umn +link: /cloud-backup-recovery/umn/ +pdf_name: cbr-umn +rst_location: umn/source +service_type: cbr +title: User Guide +type: umn diff --git a/otc_metadata/data/documents/cce-api-ref.yaml b/otc_metadata/data/documents/cce-api-ref.yaml new file mode 100644 index 0000000..b8a95c6 --- /dev/null +++ b/otc_metadata/data/documents/cce-api-ref.yaml @@ -0,0 +1,9 @@ +--- +hc_location: api2/cce +html_location: docs/cce/api-ref +link: /cloud-container-engine/api-ref/ +pdf_name: cce-api-ref +rst_location: api-ref/source +service_type: cce +title: API Reference +type: api-ref diff --git a/otc_metadata/data/documents/cce-umn.yaml b/otc_metadata/data/documents/cce-umn.yaml new file mode 100644 index 0000000..10601cd --- /dev/null +++ b/otc_metadata/data/documents/cce-umn.yaml @@ -0,0 +1,8 @@ +--- +hc_location: usermanual2/cce +html_location: docs/cce/umn +link: /cloud-container-engine/umn/ +rst_location: umn/source +service_type: cce +title: User Guide +type: umn diff --git a/otc_metadata/data/documents/ces-api-ref.yaml b/otc_metadata/data/documents/ces-api-ref.yaml new file mode 100644 index 0000000..59745a2 --- /dev/null +++ b/otc_metadata/data/documents/ces-api-ref.yaml @@ -0,0 +1,9 @@ +--- +hc_location: api/ces +html_location: docs/ces/api-ref +link: /cloud-eye/api-ref/ +pdf_name: ces-api-ref +rst_location: api-ref/source +service_type: ces +title: API Reference +type: api-ref diff --git a/otc_metadata/data/documents/ces-umn.yaml b/otc_metadata/data/documents/ces-umn.yaml new file mode 100644 index 0000000..2201ac7 --- /dev/null +++ b/otc_metadata/data/documents/ces-umn.yaml @@ -0,0 +1,9 @@ +--- +hc_location: usermanual/ces +html_location: docs/ces/umn +link: /cloud-eye/umn/ +pdf_name: ces-umn +rst_location: umn/source +service_type: ces +title: User Guide +type: umn diff --git a/otc_metadata/data/documents/cts-api-ref.yaml b/otc_metadata/data/documents/cts-api-ref.yaml new file mode 100644 index 0000000..593b866 --- /dev/null +++ b/otc_metadata/data/documents/cts-api-ref.yaml @@ -0,0 +1,9 @@ +--- +hc_location: api/cts +html_location: docs/cts/api-ref +link: /cloud-trace-service/api-ref/ +pdf_name: cts-api-ref +rst_location: api-ref/source +service_type: cts +title: API Reference +type: api-ref diff --git a/otc_metadata/data/documents/cts-umn.yaml b/otc_metadata/data/documents/cts-umn.yaml new file mode 100644 index 0000000..c3ee022 --- /dev/null +++ b/otc_metadata/data/documents/cts-umn.yaml @@ -0,0 +1,9 @@ +--- +hc_location: usermanual/cts +html_location: docs/cts/umn +link: /cloud-trace-service/umn/ +pdf_name: cts-umn +rst_location: umn/source +service_type: cts +title: User Guide +type: umn diff --git a/otc_metadata/data/documents/dc-api-ref.yaml b/otc_metadata/data/documents/dc-api-ref.yaml new file mode 100644 index 0000000..cba0341 --- /dev/null +++ b/otc_metadata/data/documents/dc-api-ref.yaml @@ -0,0 +1,9 @@ +--- +hc_location: api/dc +html_location: docs/dc/api-ref +link: /direct-connect/api-ref/ +pdf_name: dc-api-ref +rst_location: api-ref/source +service_type: dc +title: API Reference +type: api-ref diff --git a/otc_metadata/data/documents/dc-umn.yaml b/otc_metadata/data/documents/dc-umn.yaml new file mode 100644 index 0000000..f32871a --- /dev/null +++ b/otc_metadata/data/documents/dc-umn.yaml @@ -0,0 +1,9 @@ +--- +hc_location: usermanual/dc +html_location: docs/dc/umn +link: /direct-connect/umn/ +pdf_name: dc-umn +rst_location: umn/source +service_type: dc +title: User Guide +type: umn diff --git a/otc_metadata/data/documents/deh-api-ref.yaml b/otc_metadata/data/documents/deh-api-ref.yaml new file mode 100644 index 0000000..f3e08ad --- /dev/null +++ b/otc_metadata/data/documents/deh-api-ref.yaml @@ -0,0 +1,9 @@ +--- +hc_location: api/deh +html_location: docs/deh/api-ref +link: /dedicated-host/api-ref/ +pdf_name: deh-api-ref +rst_location: api-ref/source +service_type: deh +title: API Reference +type: api-ref diff --git a/otc_metadata/data/documents/deh-umn.yaml b/otc_metadata/data/documents/deh-umn.yaml new file mode 100644 index 0000000..aff87fd --- /dev/null +++ b/otc_metadata/data/documents/deh-umn.yaml @@ -0,0 +1,9 @@ +--- +hc_location: usermanual/deh +html_location: docs/deh/umn +link: /dedicated-host/umn/ +pdf_name: deh-umn +rst_location: umn/source +service_type: deh +title: User Guide +type: umn diff --git a/otc_metadata/data/documents/dns-api-ref.yaml b/otc_metadata/data/documents/dns-api-ref.yaml new file mode 100644 index 0000000..ce29abd --- /dev/null +++ b/otc_metadata/data/documents/dns-api-ref.yaml @@ -0,0 +1,9 @@ +--- +hc_location: api/dns +html_location: docs/dns/api-ref +link: /domain-name-service/api-ref/ +pdf_name: dns-api-ref +rst_location: api-ref/source +service_type: dns +title: API Reference +type: api-ref diff --git a/otc_metadata/data/documents/dns-umn.yaml b/otc_metadata/data/documents/dns-umn.yaml new file mode 100644 index 0000000..f00ffd1 --- /dev/null +++ b/otc_metadata/data/documents/dns-umn.yaml @@ -0,0 +1,9 @@ +--- +hc_location: usermanual/dns +html_location: docs/dns/umn +link: /domain-name-service/umn/ +pdf_name: dns-umn +rst_location: umn/source +service_type: dns +title: User Guide +type: umn diff --git a/otc_metadata/data/documents/ecs-api-ref.yaml b/otc_metadata/data/documents/ecs-api-ref.yaml new file mode 100644 index 0000000..e1aab60 --- /dev/null +++ b/otc_metadata/data/documents/ecs-api-ref.yaml @@ -0,0 +1,9 @@ +--- +hc_location: api/ecs +html_location: docs/ecs/api-ref +link: /elastic-cloud-server/api-ref/ +pdf_name: ecs-api-ref +rst_location: api-ref/source +service_type: ecs +title: API Reference +type: api-ref diff --git a/otc_metadata/data/documents/ecs-dev.yaml b/otc_metadata/data/documents/ecs-dev.yaml new file mode 100644 index 0000000..9c3bf01 --- /dev/null +++ b/otc_metadata/data/documents/ecs-dev.yaml @@ -0,0 +1,9 @@ +--- +hc_location: devg/ecs +html_location: docs/ecs/dev +link: /elastic-cloud-server/dev-guide/ +pdf_name: ecs-dev-guide +rst_location: dev_guide/source +service_type: ecs +title: Developer Guide +type: dev diff --git a/otc_metadata/data/documents/ecs-umn.yaml b/otc_metadata/data/documents/ecs-umn.yaml new file mode 100644 index 0000000..698496f --- /dev/null +++ b/otc_metadata/data/documents/ecs-umn.yaml @@ -0,0 +1,9 @@ +--- +hc_location: usermanual/ecs +html_location: docs/ecs/umn +link: /elastic-cloud-server/umn/ +pdf_name: ecs-umn +rst_location: umn/source +service_type: ecs +title: User Guide +type: umn diff --git a/otc_metadata/data/documents/eip-api-ref.yaml b/otc_metadata/data/documents/eip-api-ref.yaml new file mode 100644 index 0000000..6732ef0 --- /dev/null +++ b/otc_metadata/data/documents/eip-api-ref.yaml @@ -0,0 +1,9 @@ +--- +hc_location: api/eip +html_location: docs/eip/api-ref +link: /elastic-ip/api-ref/ +pdf_name: eip-api-ref +rst_location: api-ref/source +service_type: eip +title: API Reference +type: api-ref diff --git a/otc_metadata/data/documents/eip-umn.yaml b/otc_metadata/data/documents/eip-umn.yaml new file mode 100644 index 0000000..92178d7 --- /dev/null +++ b/otc_metadata/data/documents/eip-umn.yaml @@ -0,0 +1,9 @@ +--- +hc_location: usermanual/eip +html_location: docs/eip/umn +link: /elastic-ip/umn/ +pdf_name: eip-umn +rst_location: umn/source +service_type: eip +title: User Guide +type: umn diff --git a/otc_metadata/data/documents/elb-api-ref.yaml b/otc_metadata/data/documents/elb-api-ref.yaml new file mode 100644 index 0000000..a58f5f6 --- /dev/null +++ b/otc_metadata/data/documents/elb-api-ref.yaml @@ -0,0 +1,9 @@ +--- +hc_location: api/elb +html_location: docs/elb/api-ref +link: /elastic-load-balancing/api-ref/ +pdf_name: elb-api-ref +rst_location: api-ref/source +service_type: elb +title: API Reference +type: api-ref diff --git a/otc_metadata/data/documents/elb-umn.yaml b/otc_metadata/data/documents/elb-umn.yaml new file mode 100644 index 0000000..6a0b762 --- /dev/null +++ b/otc_metadata/data/documents/elb-umn.yaml @@ -0,0 +1,9 @@ +--- +hc_location: usermanual/elb +html_location: docs/elb/umn +link: /elastic-load-balancing/umn/ +pdf_name: elb-umn +rst_location: umn/source +service_type: elb +title: User Guide +type: umn diff --git a/otc_metadata/data/documents/evs-api-ref.yaml b/otc_metadata/data/documents/evs-api-ref.yaml new file mode 100644 index 0000000..13f6986 --- /dev/null +++ b/otc_metadata/data/documents/evs-api-ref.yaml @@ -0,0 +1,9 @@ +--- +hc_location: api/evs +html_location: docs/evs/api-ref +link: /elastic-volume-service/api-ref/ +pdf_name: evs-api-ref +rst_location: api-ref/source +service_type: evs +title: API Reference +type: api-ref diff --git a/otc_metadata/data/documents/evs-dev.yaml b/otc_metadata/data/documents/evs-dev.yaml new file mode 100644 index 0000000..4e6b7b1 --- /dev/null +++ b/otc_metadata/data/documents/evs-dev.yaml @@ -0,0 +1,9 @@ +--- +hc_location: devg/evs +html_location: docs/evs/dev +link: /elastic-volume-service/dev-guide/ +pdf_name: evs-dev-guide +rst_location: dev_guide/source +service_type: evs +title: Developer Guide +type: dev diff --git a/otc_metadata/data/documents/evs-umn.yaml b/otc_metadata/data/documents/evs-umn.yaml new file mode 100644 index 0000000..79f95f6 --- /dev/null +++ b/otc_metadata/data/documents/evs-umn.yaml @@ -0,0 +1,9 @@ +--- +hc_location: usermanual/evs +html_location: docs/evs/umn +link: /elastic-volume-service/umn/ +pdf_name: evs-umn +rst_location: umn/source +service_type: evs +title: User Guide +type: umn diff --git a/otc_metadata/data/documents/iam-api-ref.yaml b/otc_metadata/data/documents/iam-api-ref.yaml new file mode 100644 index 0000000..4b0cf65 --- /dev/null +++ b/otc_metadata/data/documents/iam-api-ref.yaml @@ -0,0 +1,9 @@ +--- +hc_location: api/iam +html_location: docs/iam/api-ref +link: /identity-access-management/api-ref/ +pdf_name: iam-api-ref +rst_location: api-ref/source +service_type: iam +title: API Reference +type: api-ref diff --git a/otc_metadata/data/documents/iam-umn.yaml b/otc_metadata/data/documents/iam-umn.yaml new file mode 100644 index 0000000..b6bd99c --- /dev/null +++ b/otc_metadata/data/documents/iam-umn.yaml @@ -0,0 +1,9 @@ +--- +hc_location: usermanual/iam +html_location: docs/iam/umn +link: /identity-access-management/umn/ +pdf_name: iam-umn +rst_location: umn/source +service_type: iam +title: User Guide +type: umn diff --git a/otc_metadata/data/documents/ims-api-ref.yaml b/otc_metadata/data/documents/ims-api-ref.yaml new file mode 100644 index 0000000..e45f8e9 --- /dev/null +++ b/otc_metadata/data/documents/ims-api-ref.yaml @@ -0,0 +1,9 @@ +--- +hc_location: api/ims +html_location: docs/ims/api-ref +link: /image-management-service/api-ref/ +pdf_name: ims-api-ref +rst_location: api-ref/source +service_type: ims +title: API Reference +type: api-ref diff --git a/otc_metadata/data/documents/ims-dev.yaml b/otc_metadata/data/documents/ims-dev.yaml new file mode 100644 index 0000000..5bf2269 --- /dev/null +++ b/otc_metadata/data/documents/ims-dev.yaml @@ -0,0 +1,9 @@ +--- +hc_location: devg/ims +html_location: docs/ims/dev +link: /image-management-service/dev-guide/ +pdf_name: ims-dev-guide +rst_location: dev_guide/source +service_type: ims +title: Developer Guide +type: dev diff --git a/otc_metadata/data/documents/ims-public-images.yaml b/otc_metadata/data/documents/ims-public-images.yaml new file mode 100644 index 0000000..a15dccb --- /dev/null +++ b/otc_metadata/data/documents/ims-public-images.yaml @@ -0,0 +1,8 @@ +--- +html_location: docs/ims/public-images +link: /image-management-service/public-images/ +pdf_name: ims-public-images +rst_location: doc/public-images/source +service_type: ims +title: Public Image Introduction +type: public-images diff --git a/otc_metadata/data/documents/ims-umn.yaml b/otc_metadata/data/documents/ims-umn.yaml new file mode 100644 index 0000000..cb86393 --- /dev/null +++ b/otc_metadata/data/documents/ims-umn.yaml @@ -0,0 +1,9 @@ +--- +hc_location: usermanual/ims +html_location: docs/ims/umn +link: /image-management-service/umn/ +pdf_name: ims-umn +rst_location: umn/source +service_type: ims +title: User Guide +type: umn diff --git a/otc_metadata/data/documents/kms-api-ref.yaml b/otc_metadata/data/documents/kms-api-ref.yaml new file mode 100644 index 0000000..a00e750 --- /dev/null +++ b/otc_metadata/data/documents/kms-api-ref.yaml @@ -0,0 +1,9 @@ +--- +hc_location: api/kms +html_location: docs/kms/api-ref +link: /key-management-service/api-ref/ +pdf_name: kms-api-ref +rst_location: api-ref/source +service_type: kms +title: API Reference +type: api-ref diff --git a/otc_metadata/data/documents/kms-umn.yaml b/otc_metadata/data/documents/kms-umn.yaml new file mode 100644 index 0000000..fe7bf1e --- /dev/null +++ b/otc_metadata/data/documents/kms-umn.yaml @@ -0,0 +1,9 @@ +--- +hc_location: usermanual/kms +html_location: docs/kms/umn +link: /key-management-service/umn/ +pdf_name: kms-umn +rst_location: umn/source +service_type: kms +title: User Guide +type: umn diff --git a/otc_metadata/data/documents/natgw-api-ref.yaml b/otc_metadata/data/documents/natgw-api-ref.yaml new file mode 100644 index 0000000..315373e --- /dev/null +++ b/otc_metadata/data/documents/natgw-api-ref.yaml @@ -0,0 +1,9 @@ +--- +hc_location: api/nat +html_location: docs/natgw/api-ref +link: /nat-gateway/api-ref/ +pdf_name: natgw-api-ref +rst_location: api-ref/source +service_type: natgw +title: API Reference +type: api-ref diff --git a/otc_metadata/data/documents/natgw-umn.yaml b/otc_metadata/data/documents/natgw-umn.yaml new file mode 100644 index 0000000..ccb497c --- /dev/null +++ b/otc_metadata/data/documents/natgw-umn.yaml @@ -0,0 +1,9 @@ +--- +hc_location: usermanual/nat +html_location: docs/natgw/umn +link: /nat-gateway/umn/ +pdf_name: natgw-umn +rst_location: umn/source +service_type: natgw +title: User Guide +type: umn diff --git a/otc_metadata/data/documents/obs-api-ref.yaml b/otc_metadata/data/documents/obs-api-ref.yaml new file mode 100644 index 0000000..7fa9589 --- /dev/null +++ b/otc_metadata/data/documents/obs-api-ref.yaml @@ -0,0 +1,9 @@ +--- +hc_location: api/obs +html_location: docs/obs/api-ref +link: /object-storage-service/api-ref/ +pdf_name: obs-api-ref +rst_location: api-ref/source +service_type: obs +title: API Reference +type: api-ref diff --git a/otc_metadata/data/documents/obs-parallel-file-system.yaml b/otc_metadata/data/documents/obs-parallel-file-system.yaml new file mode 100644 index 0000000..59292bb --- /dev/null +++ b/otc_metadata/data/documents/obs-parallel-file-system.yaml @@ -0,0 +1,9 @@ +--- +hc_location: pfs/obs +html_location: docs/obs/pfs +link: /object-storage-service/parallel-file-system/ +pdf_name: obs-pfs +rst_location: doc/parallel-file-system/source +service_type: obs +title: Parallel File System (PFS) +type: parallel-file-system diff --git a/otc_metadata/data/documents/obs-permissions-configuration-guide.yaml b/otc_metadata/data/documents/obs-permissions-configuration-guide.yaml new file mode 100644 index 0000000..45bbd26 --- /dev/null +++ b/otc_metadata/data/documents/obs-permissions-configuration-guide.yaml @@ -0,0 +1,8 @@ +--- +html_location: docs/obs/perms-cfg +link: /object-storage-service/permissions-configuration-guide/ +pdf_name: obs-perms-cfg +rst_location: doc/permissions-configuration-guide/source +service_type: obs +title: Permissions Configuration Guide +type: permissions-configuration-guide diff --git a/otc_metadata/data/documents/obs-s3api.yaml b/otc_metadata/data/documents/obs-s3api.yaml new file mode 100644 index 0000000..6116f0f --- /dev/null +++ b/otc_metadata/data/documents/obs-s3api.yaml @@ -0,0 +1,9 @@ +--- +hc_location: api_obs/obs +html_location: docs/obs/s3api +link: /object-storage-service/s3api/ +pdf_name: obs-s3api +rst_location: doc/s3api/source +service_type: obs +title: S3 API Reference +type: s3api diff --git a/otc_metadata/data/documents/obs-swiftapi.yaml b/otc_metadata/data/documents/obs-swiftapi.yaml new file mode 100644 index 0000000..94c15b9 --- /dev/null +++ b/otc_metadata/data/documents/obs-swiftapi.yaml @@ -0,0 +1,9 @@ +--- +hc_location: api_swift/obs +html_location: docs/obs/api-swift +link: /object-storage-service/swiftapi/ +pdf_name: obs-swiftapi +rst_location: doc/swiftapi/source +service_type: obs +title: API Reference (Swift) +type: swiftapi diff --git a/otc_metadata/data/documents/obs-tool-guide.yaml b/otc_metadata/data/documents/obs-tool-guide.yaml new file mode 100644 index 0000000..a8e2e16 --- /dev/null +++ b/otc_metadata/data/documents/obs-tool-guide.yaml @@ -0,0 +1,9 @@ +--- +hc_location: browsertg/obs +html_location: docs/obs/tool +link: /object-storage-service/tool-guide/ +pdf_name: obs-tool-guide +rst_location: doc/tool/source +service_type: obs +title: Tool Guide (OBS Browser) +type: tool-guide diff --git a/otc_metadata/data/documents/obs-umn.yaml b/otc_metadata/data/documents/obs-umn.yaml new file mode 100644 index 0000000..ef10359 --- /dev/null +++ b/otc_metadata/data/documents/obs-umn.yaml @@ -0,0 +1,9 @@ +--- +hc_location: usermanual/obs +html_location: docs/obs/umn +link: /object-storage-service/umn/ +pdf_name: obs-umn +rst_location: umn/source +service_type: obs +title: User Guide +type: umn diff --git a/otc_metadata/data/documents/rds-api-ref.yaml b/otc_metadata/data/documents/rds-api-ref.yaml new file mode 100644 index 0000000..6cafe03 --- /dev/null +++ b/otc_metadata/data/documents/rds-api-ref.yaml @@ -0,0 +1,9 @@ +--- +hc_location: api/rds +html_location: docs/rds/api-ref +link: /relational-database-service/api-ref/ +pdf_name: rds-api-ref +rst_location: api-ref/source +service_type: rds +title: API Reference +type: api-ref diff --git a/otc_metadata/data/documents/rds-umn.yaml b/otc_metadata/data/documents/rds-umn.yaml new file mode 100644 index 0000000..769f927 --- /dev/null +++ b/otc_metadata/data/documents/rds-umn.yaml @@ -0,0 +1,9 @@ +--- +hc_location: usermanual/rds +html_location: docs/rds/umn +link: /relational-database-service/umn/ +pdf_name: rds-umn +rst_location: umn/source +service_type: rds +title: User Guide +type: umn diff --git a/otc_metadata/data/documents/sdrs-api-ref.yaml b/otc_metadata/data/documents/sdrs-api-ref.yaml new file mode 100644 index 0000000..56d0e4d --- /dev/null +++ b/otc_metadata/data/documents/sdrs-api-ref.yaml @@ -0,0 +1,9 @@ +--- +hc_location: api/sdrs +html_location: docs/sdrs/api-ref +link: /storage-disaster-recovery-service/api-ref/ +pdf_name: sdrs-api-ref +rst_location: api-ref/source +service_type: sdrs +title: API Reference +type: api-ref diff --git a/otc_metadata/data/documents/sdrs-umn.yaml b/otc_metadata/data/documents/sdrs-umn.yaml new file mode 100644 index 0000000..77ec701 --- /dev/null +++ b/otc_metadata/data/documents/sdrs-umn.yaml @@ -0,0 +1,9 @@ +--- +hc_location: usermanual/sdrs +html_location: docs/sdrs/umn +link: /storage-disaster-recovery-service/umn/ +pdf_name: sdrs-umn +rst_location: umn/source +service_type: sdrs +title: User Guide +type: umn diff --git a/otc_metadata/data/documents/smn-api-ref.yaml b/otc_metadata/data/documents/smn-api-ref.yaml new file mode 100644 index 0000000..a2082dc --- /dev/null +++ b/otc_metadata/data/documents/smn-api-ref.yaml @@ -0,0 +1,9 @@ +--- +hc_location: api/smn +html_location: docs/smn/api-ref +link: /simple-message-notification/api-ref/ +pdf_name: smn-api-ref +rst_location: api-ref/source +service_type: smn +title: API Reference +type: api-ref diff --git a/otc_metadata/data/documents/smn-umn.yaml b/otc_metadata/data/documents/smn-umn.yaml new file mode 100644 index 0000000..bf3922c --- /dev/null +++ b/otc_metadata/data/documents/smn-umn.yaml @@ -0,0 +1,9 @@ +--- +hc_location: usermanual/smn +html_location: docs/smn/umn +link: /simple-message-notification/umn/ +pdf_name: smn-umn +rst_location: umn/source +service_type: smn +title: User Guide +type: umn diff --git a/otc_metadata/data/documents/swr-api-ref.yaml b/otc_metadata/data/documents/swr-api-ref.yaml new file mode 100644 index 0000000..c0bf88c --- /dev/null +++ b/otc_metadata/data/documents/swr-api-ref.yaml @@ -0,0 +1,9 @@ +--- +hc_location: api/swr +html_location: docs/swr/api-ref +link: /software-repository-container/api-ref/ +pdf_name: swr-api-ref +rst_location: api-ref/source +service_type: swr +title: API Reference +type: api-ref diff --git a/otc_metadata/data/documents/swr-umn.yaml b/otc_metadata/data/documents/swr-umn.yaml new file mode 100644 index 0000000..e5b32cf --- /dev/null +++ b/otc_metadata/data/documents/swr-umn.yaml @@ -0,0 +1,9 @@ +--- +hc_location: usermanual/swr +html_location: docs/swr/umn +link: /software-repository-container/umn/ +pdf_name: swr-umn +rst_location: umn/source +service_type: swr +title: User Guide +type: umn diff --git a/otc_metadata/data/documents/tms-api-ref.yaml b/otc_metadata/data/documents/tms-api-ref.yaml new file mode 100644 index 0000000..f933c61 --- /dev/null +++ b/otc_metadata/data/documents/tms-api-ref.yaml @@ -0,0 +1,9 @@ +--- +hc_location: api/tms +html_location: docs/tms/api-ref +link: /tag-management-service/api-ref/ +pdf_name: tms-api-ref +rst_location: api-ref/source +service_type: tms +title: API Reference +type: api-ref diff --git a/otc_metadata/data/documents/tms-umn.yaml b/otc_metadata/data/documents/tms-umn.yaml new file mode 100644 index 0000000..b7b4ed0 --- /dev/null +++ b/otc_metadata/data/documents/tms-umn.yaml @@ -0,0 +1,9 @@ +--- +hc_location: usermanual/tms +html_location: docs/tms/umn +link: /tag-management-service/umn/ +pdf_name: tms-umn +rst_location: umn/source +service_type: tms +title: User Guide +type: umn diff --git a/otc_metadata/data/documents/vpc-api-ref.yaml b/otc_metadata/data/documents/vpc-api-ref.yaml new file mode 100644 index 0000000..c934606 --- /dev/null +++ b/otc_metadata/data/documents/vpc-api-ref.yaml @@ -0,0 +1,9 @@ +--- +hc_location: api/vpc +html_location: docs/vpc/api-ref +link: /virtual-private-cloud/api-ref/ +pdf_name: vpc-api-ref +rst_location: api-ref/source +service_type: vpc +title: API Reference +type: api-ref diff --git a/otc_metadata/data/documents/vpc-umn.yaml b/otc_metadata/data/documents/vpc-umn.yaml new file mode 100644 index 0000000..1968daf --- /dev/null +++ b/otc_metadata/data/documents/vpc-umn.yaml @@ -0,0 +1,9 @@ +--- +hc_location: usermanual/vpc +html_location: docs/vpc/umn +link: /virtual-private-cloud/umn/ +pdf_name: vpc-umn +rst_location: umn/source +service_type: vpc +title: User Guide +type: umn diff --git a/otc_metadata/data/documents/vpcep-api-ref.yaml b/otc_metadata/data/documents/vpcep-api-ref.yaml new file mode 100644 index 0000000..2cc5810 --- /dev/null +++ b/otc_metadata/data/documents/vpcep-api-ref.yaml @@ -0,0 +1,9 @@ +--- +hc_location: api/vpcep +html_location: docs/vpcep/api-ref +link: /vpc-endpoint/api-ref/ +pdf_name: vpcep-api-ref +rst_location: api-ref/source +service_type: vpcep +title: API Reference +type: api-ref diff --git a/otc_metadata/data/documents/vpcep-umn.yaml b/otc_metadata/data/documents/vpcep-umn.yaml new file mode 100644 index 0000000..d3690d7 --- /dev/null +++ b/otc_metadata/data/documents/vpcep-umn.yaml @@ -0,0 +1,9 @@ +--- +hc_location: usermanual/vpcep +html_location: docs/vpcep/umn +link: /vpc-endpoint/umn/ +pdf_name: vpcep-umn +rst_location: umn/source +service_type: vpcep +title: User Guide +type: umn diff --git a/otc_metadata/data/documents/vpn-api-ref.yaml b/otc_metadata/data/documents/vpn-api-ref.yaml new file mode 100644 index 0000000..f2b1375 --- /dev/null +++ b/otc_metadata/data/documents/vpn-api-ref.yaml @@ -0,0 +1,9 @@ +--- +hc_location: api/vpn +html_location: docs/vpn/api-ref +link: /virtual-private-network/api-ref/ +pdf_name: vpn-api-ref +rst_location: api-ref/source +service_type: vpn +title: API Reference +type: api-ref diff --git a/otc_metadata/data/documents/vpn-umn.yaml b/otc_metadata/data/documents/vpn-umn.yaml new file mode 100644 index 0000000..de8ddef --- /dev/null +++ b/otc_metadata/data/documents/vpn-umn.yaml @@ -0,0 +1,9 @@ +--- +hc_location: usermanual/vpn +html_location: docs/vpn/umn +link: /virtual-private-network/umn/ +pdf_name: vpn-umn +rst_location: umn/source +service_type: vpn +title: User Guide +type: umn diff --git a/otc_metadata/data/documents/wafd-api-ref.yaml b/otc_metadata/data/documents/wafd-api-ref.yaml new file mode 100644 index 0000000..17dd7ce --- /dev/null +++ b/otc_metadata/data/documents/wafd-api-ref.yaml @@ -0,0 +1,10 @@ +--- +environment: internal +hc_location: api/dwaf +html_location: docs/wafd/api-ref +link: /web-application-firewall-dedicated/api-ref/ +pdf_name: wafd-api-ref +rst_location: api-ref/source +service_type: wafd +title: API Reference +type: api-ref diff --git a/otc_metadata/data/documents/wafd-umn.yaml b/otc_metadata/data/documents/wafd-umn.yaml new file mode 100644 index 0000000..5aaacfe --- /dev/null +++ b/otc_metadata/data/documents/wafd-umn.yaml @@ -0,0 +1,10 @@ +--- +environment: internal +hc_location: usermanual/dwaf +html_location: docs/wafd/umn +link: /web-application-firewall-dedicated/umn/ +pdf_name: wafd-umn +rst_location: umn/source +service_type: wafd +title: User Guide +type: umn diff --git a/otc_metadata/data/service_categories/application.yaml b/otc_metadata/data/service_categories/application.yaml new file mode 100644 index 0000000..54dcbe2 --- /dev/null +++ b/otc_metadata/data/service_categories/application.yaml @@ -0,0 +1,3 @@ +--- +name: application +title: Application Services diff --git a/otc_metadata/data/service_categories/big_data.yaml b/otc_metadata/data/service_categories/big_data.yaml new file mode 100644 index 0000000..5951c5f --- /dev/null +++ b/otc_metadata/data/service_categories/big_data.yaml @@ -0,0 +1,3 @@ +--- +name: big_data +title: Big Data and Data Analysis diff --git a/otc_metadata/data/service_categories/compute.yaml b/otc_metadata/data/service_categories/compute.yaml new file mode 100644 index 0000000..5e4221e --- /dev/null +++ b/otc_metadata/data/service_categories/compute.yaml @@ -0,0 +1,3 @@ +--- +name: compute +title: Compute diff --git a/otc_metadata/data/service_categories/container.yaml b/otc_metadata/data/service_categories/container.yaml new file mode 100644 index 0000000..90f6142 --- /dev/null +++ b/otc_metadata/data/service_categories/container.yaml @@ -0,0 +1,3 @@ +--- +name: container +title: Container diff --git a/otc_metadata/data/service_categories/database.yaml b/otc_metadata/data/service_categories/database.yaml new file mode 100644 index 0000000..9339f99 --- /dev/null +++ b/otc_metadata/data/service_categories/database.yaml @@ -0,0 +1,3 @@ +--- +name: database +title: Database diff --git a/otc_metadata/data/service_categories/md.yaml b/otc_metadata/data/service_categories/md.yaml new file mode 100644 index 0000000..ad7ccc3 --- /dev/null +++ b/otc_metadata/data/service_categories/md.yaml @@ -0,0 +1,3 @@ +--- +name: md +title: Management & Deployment diff --git a/otc_metadata/data/service_categories/network.yaml b/otc_metadata/data/service_categories/network.yaml new file mode 100644 index 0000000..bd0a98b --- /dev/null +++ b/otc_metadata/data/service_categories/network.yaml @@ -0,0 +1,3 @@ +--- +name: network +title: Networking diff --git a/otc_metadata/data/service_categories/other.yaml b/otc_metadata/data/service_categories/other.yaml new file mode 100644 index 0000000..d5702a9 --- /dev/null +++ b/otc_metadata/data/service_categories/other.yaml @@ -0,0 +1,3 @@ +--- +name: other +title: Other diff --git a/otc_metadata/data/service_categories/security-services.yaml b/otc_metadata/data/service_categories/security-services.yaml new file mode 100644 index 0000000..dd0eae6 --- /dev/null +++ b/otc_metadata/data/service_categories/security-services.yaml @@ -0,0 +1,3 @@ +--- +name: security-services +title: Security Services diff --git a/otc_metadata/data/service_categories/storage.yaml b/otc_metadata/data/service_categories/storage.yaml new file mode 100644 index 0000000..113a4f0 --- /dev/null +++ b/otc_metadata/data/service_categories/storage.yaml @@ -0,0 +1,3 @@ +--- +name: storage +title: Storage diff --git a/otc_metadata/data/services.yaml b/otc_metadata/data/services.yaml index cf54bf6..08bfb79 100644 --- a/otc_metadata/data/services.yaml +++ b/otc_metadata/data/services.yaml @@ -13,519 +13,10 @@ # Please consult with otc_metadata.services.Services:_sort_data for expected # sort order. When unsure perform tools/sort_metadata.py for getting it sorted. +# It is also supported, that content of files under +# documents/services/service_categories is being merged with +# the content here. --- -documents: - - hc_location: api/aom - html_location: docs/aom/api-ref - link: /application-operations-management/api-ref/ - pdf_name: aom-api-ref - rst_location: api-ref/source - service_type: aom - title: API Reference - type: api-ref - - hc_location: usermanual/aom - html_location: docs/aom/umn - link: /application-operations-management/umn/ - pdf_name: aom-umn - rst_location: umn/source - service_type: aom - title: User Guide - type: umn - - hc_location: api/as - html_location: docs/as/api-ref - link: /auto-scaling/api-ref/ - pdf_name: as-api-ref - rst_location: api-ref/source - service_type: as - title: API Reference - type: api-ref - - hc_location: devg/as - html_location: docs/as/dev - link: /auto-scaling/dev-guide/ - pdf_name: as-dev-guide - rst_location: dev_guide/source - service_type: as - title: Developer Guide - type: dev - - hc_location: usermanual/as - html_location: docs/as/umn - link: /auto-scaling/umn/ - pdf_name: as-umn - rst_location: umn/source - service_type: as - title: User Guide - type: umn - - hc_location: api/cbr - html_location: docs/cbr/api-ref - link: /cloud-backup-recovery/api-ref/ - pdf_name: cbr-api-ref - rst_location: api-ref/source - service_type: cbr - title: API Reference - type: api-ref - - hc_location: usermanual/cbr - html_location: docs/cbr/umn - link: /cloud-backup-recovery/umn/ - pdf_name: cbr-umn - rst_location: umn/source - service_type: cbr - title: User Guide - type: umn - - hc_location: api2/cce - html_location: docs/cce/api-ref - link: /cloud-container-engine/api-ref/ - pdf_name: cce-api-ref - rst_location: api-ref/source - service_type: cce - title: API Reference - type: api-ref - - hc_location: usermanual2/cce - html_location: docs/cce/umn - link: /cloud-container-engine/umn/ - rst_location: umn/source - service_type: cce - title: User Guide - type: umn - - hc_location: api/ces - html_location: docs/ces/api-ref - link: /cloud-eye/api-ref/ - pdf_name: ces-api-ref - rst_location: api-ref/source - service_type: ces - title: API Reference - type: api-ref - - hc_location: usermanual/ces - html_location: docs/ces/umn - link: /cloud-eye/umn/ - pdf_name: ces-umn - rst_location: umn/source - service_type: ces - title: User Guide - type: umn - - hc_location: api/cts - html_location: docs/cts/api-ref - link: /cloud-trace-service/api-ref/ - pdf_name: cts-api-ref - rst_location: api-ref/source - service_type: cts - title: API Reference - type: api-ref - - hc_location: usermanual/cts - html_location: docs/cts/umn - link: /cloud-trace-service/umn/ - pdf_name: cts-umn - rst_location: umn/source - service_type: cts - title: User Guide - type: umn - - hc_location: api/dc - html_location: docs/dc/api-ref - link: /direct-connect/api-ref/ - pdf_name: dc-api-ref - rst_location: api-ref/source - service_type: dc - title: API Reference - type: api-ref - - hc_location: usermanual/dc - html_location: docs/dc/umn - link: /direct-connect/umn/ - pdf_name: dc-umn - rst_location: umn/source - service_type: dc - title: User Guide - type: umn - - hc_location: api/deh - html_location: docs/deh/api-ref - link: /dedicated-host/api-ref/ - pdf_name: deh-api-ref - rst_location: api-ref/source - service_type: deh - title: API Reference - type: api-ref - - hc_location: usermanual/deh - html_location: docs/deh/umn - link: /dedicated-host/umn/ - pdf_name: deh-umn - rst_location: umn/source - service_type: deh - title: User Guide - type: umn - - hc_location: api/dns - html_location: docs/dns/api-ref - link: /domain-name-service/api-ref/ - pdf_name: dns-api-ref - rst_location: api-ref/source - service_type: dns - title: API Reference - type: api-ref - - hc_location: usermanual/dns - html_location: docs/dns/umn - link: /domain-name-service/umn/ - pdf_name: dns-umn - rst_location: umn/source - service_type: dns - title: User Guide - type: umn - - hc_location: api/ecs - html_location: docs/ecs/api-ref - link: /elastic-cloud-server/api-ref/ - pdf_name: ecs-api-ref - rst_location: api-ref/source - service_type: ecs - title: API Reference - type: api-ref - - hc_location: devg/ecs - html_location: docs/ecs/dev - link: /elastic-cloud-server/dev-guide/ - pdf_name: ecs-dev-guide - rst_location: dev_guide/source - service_type: ecs - title: Developer Guide - type: dev - - hc_location: usermanual/ecs - html_location: docs/ecs/umn - link: /elastic-cloud-server/umn/ - pdf_name: ecs-umn - rst_location: umn/source - service_type: ecs - title: User Guide - type: umn - - hc_location: api/eip - html_location: docs/eip/api-ref - link: /elastic-ip/api-ref/ - pdf_name: eip-api-ref - rst_location: api-ref/source - service_type: eip - title: API Reference - type: api-ref - - hc_location: usermanual/eip - html_location: docs/eip/umn - link: /elastic-ip/umn/ - pdf_name: eip-umn - rst_location: umn/source - service_type: eip - title: User Guide - type: umn - - hc_location: api/elb - html_location: docs/elb/api-ref - link: /elastic-load-balancing/api-ref/ - pdf_name: elb-api-ref - rst_location: api-ref/source - service_type: elb - title: API Reference - type: api-ref - - hc_location: usermanual/elb - html_location: docs/elb/umn - link: /elastic-load-balancing/umn/ - pdf_name: elb-umn - rst_location: umn/source - service_type: elb - title: User Guide - type: umn - - hc_location: api/evs - html_location: docs/evs/api-ref - link: /elastic-volume-service/api-ref/ - pdf_name: evs-api-ref - rst_location: api-ref/source - service_type: evs - title: API Reference - type: api-ref - - hc_location: devg/evs - html_location: docs/evs/dev - link: /elastic-volume-service/dev-guide/ - pdf_name: evs-dev-guide - rst_location: dev_guide/source - service_type: evs - title: Developer Guide - type: dev - - hc_location: usermanual/evs - html_location: docs/evs/umn - link: /elastic-volume-service/umn/ - pdf_name: evs-umn - rst_location: umn/source - service_type: evs - title: User Guide - type: umn - - hc_location: api/iam - html_location: docs/iam/api-ref - link: /identity-access-management/api-ref/ - pdf_name: iam-api-ref - rst_location: api-ref/source - service_type: iam - title: API Reference - type: api-ref - - hc_location: usermanual/iam - html_location: docs/iam/umn - link: /identity-access-management/umn/ - pdf_name: iam-umn - rst_location: umn/source - service_type: iam - title: User Guide - type: umn - - hc_location: api/ims - html_location: docs/ims/api-ref - link: /image-management-service/api-ref/ - pdf_name: ims-api-ref - rst_location: api-ref/source - service_type: ims - title: API Reference - type: api-ref - - hc_location: devg/ims - html_location: docs/ims/dev - link: /image-management-service/dev-guide/ - pdf_name: ims-dev-guide - rst_location: dev_guide/source - service_type: ims - title: Developer Guide - type: dev - - html_location: docs/ims/public-images - link: /image-management-service/public-images/ - pdf_name: ims-public-images - rst_location: doc/public-images/source - service_type: ims - title: Public Image Introduction - type: public-images - - hc_location: usermanual/ims - html_location: docs/ims/umn - link: /image-management-service/umn/ - pdf_name: ims-umn - rst_location: umn/source - service_type: ims - title: User Guide - type: umn - - hc_location: api/kms - html_location: docs/kms/api-ref - link: /key-management-service/api-ref/ - pdf_name: kms-api-ref - rst_location: api-ref/source - service_type: kms - title: API Reference - type: api-ref - - hc_location: usermanual/kms - html_location: docs/kms/umn - link: /key-management-service/umn/ - pdf_name: kms-umn - rst_location: umn/source - service_type: kms - title: User Guide - type: umn - - hc_location: api/nat - html_location: docs/natgw/api-ref - link: /nat-gateway/api-ref/ - pdf_name: natgw-api-ref - rst_location: api-ref/source - service_type: natgw - title: API Reference - type: api-ref - - hc_location: usermanual/nat - html_location: docs/natgw/umn - link: /nat-gateway/umn/ - pdf_name: natgw-umn - rst_location: umn/source - service_type: natgw - title: User Guide - type: umn - - hc_location: api/obs - html_location: docs/obs/api-ref - link: /object-storage-service/api-ref/ - pdf_name: obs-api-ref - rst_location: api-ref/source - service_type: obs - title: API Reference - type: api-ref - - hc_location: browsertg/obs - html_location: docs/obs/tool - link: /object-storage-service/tool-guide/ - pdf_name: obs-tool-guide - rst_location: doc/tool/source - service_type: obs - title: Tool Guide (OBS Browser) - type: tool-guide - - hc_location: pfs/obs - html_location: docs/obs/pfs - link: /object-storage-service/parallel-file-system/ - pdf_name: obs-pfs - rst_location: doc/parallel-file-system/source - service_type: obs - title: Parallel File System (PFS) - type: parallel-file-system - - html_location: docs/obs/perms-cfg - link: /object-storage-service/permissions-configuration-guide/ - pdf_name: obs-perms-cfg - rst_location: doc/permissions-configuration-guide/source - service_type: obs - title: Permissions Configuration Guide - type: permissions-configuration-guide - - hc_location: api_swift/obs - html_location: docs/obs/api-swift - link: /object-storage-service/swiftapi/ - pdf_name: obs-swiftapi - rst_location: doc/swiftapi/source - service_type: obs - title: API Reference (Swift) - type: swiftapi - - hc_location: api_obs/obs - html_location: docs/obs/s3api - link: /object-storage-service/s3api/ - pdf_name: obs-s3api - rst_location: doc/s3api/source - service_type: obs - title: S3 API Reference - type: s3api - - hc_location: usermanual/obs - html_location: docs/obs/umn - link: /object-storage-service/umn/ - pdf_name: obs-umn - rst_location: umn/source - service_type: obs - title: User Guide - type: umn - - hc_location: api/rds - html_location: docs/rds/api-ref - link: /relational-database-service/api-ref/ - pdf_name: rds-api-ref - rst_location: api-ref/source - service_type: rds - title: API Reference - type: api-ref - - hc_location: usermanual/rds - html_location: docs/rds/umn - link: /relational-database-service/umn/ - pdf_name: rds-umn - rst_location: umn/source - service_type: rds - title: User Guide - type: umn - - hc_location: api/sdrs - html_location: docs/sdrs/api-ref - link: /storage-disaster-recovery-service/api-ref/ - pdf_name: sdrs-api-ref - rst_location: api-ref/source - service_type: sdrs - title: API Reference - type: api-ref - - hc_location: usermanual/sdrs - html_location: docs/sdrs/umn - link: /storage-disaster-recovery-service/umn/ - pdf_name: sdrs-umn - rst_location: umn/source - service_type: sdrs - title: User Guide - type: umn - - hc_location: api/smn - html_location: docs/smn/api-ref - link: /simple-message-notification/api-ref/ - pdf_name: smn-api-ref - rst_location: api-ref/source - service_type: smn - title: API Reference - type: api-ref - - hc_location: usermanual/smn - html_location: docs/smn/umn - link: /simple-message-notification/umn/ - pdf_name: smn-umn - rst_location: umn/source - service_type: smn - title: User Guide - type: umn - - hc_location: api/swr - html_location: docs/swr/api-ref - link: /software-repository-container/api-ref/ - pdf_name: swr-api-ref - rst_location: api-ref/source - service_type: swr - title: API Reference - type: api-ref - - hc_location: usermanual/swr - html_location: docs/swr/umn - link: /software-repository-container/umn/ - pdf_name: swr-umn - rst_location: umn/source - service_type: swr - title: User Guide - type: umn - - hc_location: api/tms - html_location: docs/tms/api-ref - link: /tag-management-service/api-ref/ - pdf_name: tms-api-ref - rst_location: api-ref/source - service_type: tms - title: API Reference - type: api-ref - - hc_location: usermanual/tms - html_location: docs/tms/umn - link: /tag-management-service/umn/ - pdf_name: tms-umn - rst_location: umn/source - service_type: tms - title: User Guide - type: umn - - hc_location: api/vpc - html_location: docs/vpc/api-ref - link: /virtual-private-cloud/api-ref/ - pdf_name: vpc-api-ref - rst_location: api-ref/source - service_type: vpc - title: API Reference - type: api-ref - - hc_location: usermanual/vpc - html_location: docs/vpc/umn - link: /virtual-private-cloud/umn/ - pdf_name: vpc-umn - rst_location: umn/source - service_type: vpc - title: User Guide - type: umn - - hc_location: api/vpcep - html_location: docs/vpcep/api-ref - link: /vpc-endpoint/api-ref/ - pdf_name: vpcep-api-ref - rst_location: api-ref/source - service_type: vpcep - title: API Reference - type: api-ref - - hc_location: usermanual/vpcep - html_location: docs/vpcep/umn - link: /vpc-endpoint/umn/ - pdf_name: vpcep-umn - rst_location: umn/source - service_type: vpcep - title: User Guide - type: umn - - hc_location: api/vpn - html_location: docs/vpn/api-ref - link: /virtual-private-network/api-ref/ - pdf_name: vpn-api-ref - rst_location: api-ref/source - service_type: vpn - title: API Reference - type: api-ref - - hc_location: usermanual/vpn - html_location: docs/vpn/umn - link: /virtual-private-network/umn/ - pdf_name: vpn-umn - rst_location: umn/source - service_type: vpn - title: User Guide - type: umn - - environment: internal - hc_location: api/dwaf - html_location: docs/wafd/api-ref - link: /web-application-firewall-dedicated/api-ref/ - pdf_name: wafd-api-ref - rst_location: api-ref/source - service_type: wafd - title: API Reference - type: api-ref - - environment: internal - hc_location: usermanual/dwaf - html_location: docs/wafd/umn - link: /web-application-firewall-dedicated/umn/ - pdf_name: wafd-umn - rst_location: umn/source - service_type: wafd - title: User Guide - type: umn service_categories: - name: application title: Application Services diff --git a/otc_metadata/data/services/aom.yaml b/otc_metadata/data/services/aom.yaml new file mode 100644 index 0000000..1fbbf89 --- /dev/null +++ b/otc_metadata/data/services/aom.yaml @@ -0,0 +1,16 @@ +--- +environment: public +repositories: +- environment: internal + repo: docs-swiss/application-operations-management + type: gitea +- environment: public + repo: opentelekomcloud-docs-swiss/application-operations-management + type: github +service_category: application +service_title: Application Operations Management +service_type: aom +service_uri: application-operations-management +teams: +- name: docs-orchestration-rw + permission: write diff --git a/otc_metadata/data/services/as.yaml b/otc_metadata/data/services/as.yaml new file mode 100644 index 0000000..f7adbfd --- /dev/null +++ b/otc_metadata/data/services/as.yaml @@ -0,0 +1,16 @@ +--- +environment: public +repositories: +- environment: internal + repo: docs-swiss/auto-scaling + type: gitea +- environment: public + repo: opentelekomcloud-docs-swiss/auto-scaling + type: github +service_category: compute +service_title: Auto Scaling +service_type: as +service_uri: auto-scaling +teams: +- name: docs-compute-rw + permission: write diff --git a/otc_metadata/data/services/cbr.yaml b/otc_metadata/data/services/cbr.yaml new file mode 100644 index 0000000..b723176 --- /dev/null +++ b/otc_metadata/data/services/cbr.yaml @@ -0,0 +1,16 @@ +--- +environment: public +repositories: +- environment: internal + repo: docs-swiss/cloud-backup-recovery + type: gitea +- environment: public + repo: opentelekomcloud-docs-swiss/cloud-backup-recovery + type: github +service_category: storage +service_title: Cloud Backup and Recovery +service_type: cbr +service_uri: cloud-backup-recovery +teams: +- name: docs-storage-rw + permission: write diff --git a/otc_metadata/data/services/cce.yaml b/otc_metadata/data/services/cce.yaml new file mode 100644 index 0000000..a143d70 --- /dev/null +++ b/otc_metadata/data/services/cce.yaml @@ -0,0 +1,16 @@ +--- +environment: public +repositories: +- environment: internal + repo: docs-swiss/cloud-container-engine + type: gitea +- environment: public + repo: opentelekomcloud-docs-swiss/cloud-container-engine + type: github +service_category: container +service_title: Cloud Container Engine +service_type: cce +service_uri: cloud-container-engine +teams: +- name: docs-container-rw + permission: write diff --git a/otc_metadata/data/services/ces.yaml b/otc_metadata/data/services/ces.yaml new file mode 100644 index 0000000..03346e0 --- /dev/null +++ b/otc_metadata/data/services/ces.yaml @@ -0,0 +1,16 @@ +--- +environment: public +repositories: +- environment: internal + repo: docs-swiss/cloud-eye + type: gitea +- environment: public + repo: opentelekomcloud-docs-swiss/cloud-eye + type: github +service_category: md +service_title: Cloud Eye +service_type: ces +service_uri: cloud-eye +teams: +- name: docs-orchestration-rw + permission: write diff --git a/otc_metadata/data/services/cts.yaml b/otc_metadata/data/services/cts.yaml new file mode 100644 index 0000000..6340fbc --- /dev/null +++ b/otc_metadata/data/services/cts.yaml @@ -0,0 +1,16 @@ +--- +environment: public +repositories: +- environment: internal + repo: docs-swiss/cloud-trace-service + type: gitea +- environment: public + repo: opentelekomcloud-docs-swiss/cloud-trace-service + type: github +service_category: md +service_title: Cloud Trace Service +service_type: cts +service_uri: cloud-trace-service +teams: +- name: docs-orchestration-rw + permission: write diff --git a/otc_metadata/data/services/dc.yaml b/otc_metadata/data/services/dc.yaml new file mode 100644 index 0000000..1293a13 --- /dev/null +++ b/otc_metadata/data/services/dc.yaml @@ -0,0 +1,16 @@ +--- +environment: public +repositories: +- environment: internal + repo: docs-swiss/direct-connect + type: gitea +- environment: public + repo: opentelekomcloud-docs-swiss/direct-connect + type: github +service_category: network +service_title: Direct Connect +service_type: dc +service_uri: direct-connect +teams: +- name: docs-network-rw + permission: write diff --git a/otc_metadata/data/services/deh.yaml b/otc_metadata/data/services/deh.yaml new file mode 100644 index 0000000..b1368d2 --- /dev/null +++ b/otc_metadata/data/services/deh.yaml @@ -0,0 +1,16 @@ +--- +environment: public +repositories: +- environment: internal + repo: docs-swiss/dedicated-host + type: gitea +- environment: public + repo: opentelekomcloud-docs-swiss/dedicated-host + type: github +service_category: compute +service_title: Dedicated Host +service_type: deh +service_uri: dedicated-host +teams: +- name: docs-compute-rw + permission: write diff --git a/otc_metadata/data/services/dns.yaml b/otc_metadata/data/services/dns.yaml new file mode 100644 index 0000000..2aeb625 --- /dev/null +++ b/otc_metadata/data/services/dns.yaml @@ -0,0 +1,16 @@ +--- +environment: public +repositories: +- environment: internal + repo: docs-swiss/domain-name-service + type: gitea +- environment: public + repo: opentelekomcloud-docs-swiss/domain-name-service + type: github +service_category: network +service_title: Domain Name Service +service_type: dns +service_uri: domain-name-service +teams: +- name: docs-network-rw + permission: write diff --git a/otc_metadata/data/services/ecs.yaml b/otc_metadata/data/services/ecs.yaml new file mode 100644 index 0000000..4d9932e --- /dev/null +++ b/otc_metadata/data/services/ecs.yaml @@ -0,0 +1,23 @@ +--- +environment: public +repositories: +- assignees: + - docs-compute-ro + environment: internal + repo: docs-swiss/elastic-cloud-server + teams: + - name: docs-compute-ro + permission: read + - name: docs-compute-rw + permission: write + type: gitea +- environment: public + repo: opentelekomcloud-docs-swiss/elastic-cloud-server + type: github +service_category: compute +service_title: Elastic Cloud Server +service_type: ecs +service_uri: elastic-cloud-server +teams: +- name: docs-compute-rw + permission: write diff --git a/otc_metadata/data/services/eip.yaml b/otc_metadata/data/services/eip.yaml new file mode 100644 index 0000000..5568513 --- /dev/null +++ b/otc_metadata/data/services/eip.yaml @@ -0,0 +1,16 @@ +--- +environment: public +repositories: +- environment: internal + repo: docs-swiss/elastic-ip + type: gitea +- environment: public + repo: opentelekomcloud-docs-swiss/elastic-ip + type: github +service_category: network +service_title: Elastic IP +service_type: eip +service_uri: elastic-ip +teams: +- name: docs-network-rw + permission: write diff --git a/otc_metadata/data/services/elb.yaml b/otc_metadata/data/services/elb.yaml new file mode 100644 index 0000000..231c2ba --- /dev/null +++ b/otc_metadata/data/services/elb.yaml @@ -0,0 +1,16 @@ +--- +environment: public +repositories: +- environment: internal + repo: docs-swiss/elastic-load-balancing + type: gitea +- environment: public + repo: opentelekomcloud-docs-swiss/elastic-load-balancing + type: github +service_category: network +service_title: Elastic Load Balancing +service_type: elb +service_uri: elastic-load-balancing +teams: +- name: docs-network-rw + permission: write diff --git a/otc_metadata/data/services/evs.yaml b/otc_metadata/data/services/evs.yaml new file mode 100644 index 0000000..01977c8 --- /dev/null +++ b/otc_metadata/data/services/evs.yaml @@ -0,0 +1,16 @@ +--- +environment: public +repositories: +- environment: internal + repo: docs-swiss/elastic-volume-service + type: gitea +- environment: public + repo: opentelekomcloud-docs-swiss/elastic-volume-service + type: github +service_category: storage +service_title: Elastic Volume Service +service_type: evs +service_uri: elastic-volume-service +teams: +- name: docs-storage-rw + permission: write diff --git a/otc_metadata/data/services/iam.yaml b/otc_metadata/data/services/iam.yaml new file mode 100644 index 0000000..366ac24 --- /dev/null +++ b/otc_metadata/data/services/iam.yaml @@ -0,0 +1,16 @@ +--- +environment: public +repositories: +- environment: internal + repo: docs-swiss/identity-access-management + type: gitea +- environment: public + repo: opentelekomcloud-docs-swiss/identity-access-management + type: github +service_category: security-services +service_title: Identity and Access Management +service_type: iam +service_uri: identity-access-management +teams: +- name: docs-security-services-rw + permission: write diff --git a/otc_metadata/data/services/ims.yaml b/otc_metadata/data/services/ims.yaml new file mode 100644 index 0000000..c36e3df --- /dev/null +++ b/otc_metadata/data/services/ims.yaml @@ -0,0 +1,16 @@ +--- +environment: public +repositories: +- environment: internal + repo: docs-swiss/image-management-service + type: gitea +- environment: public + repo: opentelekomcloud-docs-swiss/image-management-service + type: github +service_category: compute +service_title: Image Management Service +service_type: ims +service_uri: image-management-service +teams: +- name: docs-compute-rw + permission: write diff --git a/otc_metadata/data/services/kms.yaml b/otc_metadata/data/services/kms.yaml new file mode 100644 index 0000000..9712f85 --- /dev/null +++ b/otc_metadata/data/services/kms.yaml @@ -0,0 +1,16 @@ +--- +environment: public +repositories: +- environment: internal + repo: docs-swiss/key-management-service + type: gitea +- environment: public + repo: opentelekomcloud-docs-swiss/key-management-service + type: github +service_category: security-services +service_title: Key Management Service +service_type: kms +service_uri: key-management-service +teams: +- name: docs-security-services-rw + permission: write diff --git a/otc_metadata/data/services/natgw.yaml b/otc_metadata/data/services/natgw.yaml new file mode 100644 index 0000000..7fb2a0c --- /dev/null +++ b/otc_metadata/data/services/natgw.yaml @@ -0,0 +1,16 @@ +--- +environment: public +repositories: +- environment: internal + repo: docs-swiss/nat-gateway + type: gitea +- environment: public + repo: opentelekomcloud-docs-swiss/nat-gateway + type: github +service_category: network +service_title: NAT Gateway +service_type: natgw +service_uri: nat-gateway +teams: +- name: docs-network-rw + permission: write diff --git a/otc_metadata/data/services/obs.yaml b/otc_metadata/data/services/obs.yaml new file mode 100644 index 0000000..a394ec2 --- /dev/null +++ b/otc_metadata/data/services/obs.yaml @@ -0,0 +1,16 @@ +--- +environment: public +repositories: +- environment: internal + repo: docs-swiss/object-storage-service + type: gitea +- environment: public + repo: opentelekomcloud-docs-swiss/object-storage-service + type: github +service_category: storage +service_title: Object Storage Service +service_type: obs +service_uri: object-storage-service +teams: +- name: docs-storage-rw + permission: write diff --git a/otc_metadata/data/services/rds.yaml b/otc_metadata/data/services/rds.yaml new file mode 100644 index 0000000..d3a4b1b --- /dev/null +++ b/otc_metadata/data/services/rds.yaml @@ -0,0 +1,16 @@ +--- +environment: public +repositories: +- environment: internal + repo: docs-swiss/relational-database-service + type: gitea +- environment: public + repo: opentelekomcloud-docs-swiss/relational-database-service + type: github +service_category: database +service_title: Relational Database Service +service_type: rds +service_uri: relational-database-service +teams: +- name: docs-database-rw + permission: write diff --git a/otc_metadata/data/services/sdrs.yaml b/otc_metadata/data/services/sdrs.yaml new file mode 100644 index 0000000..62ff424 --- /dev/null +++ b/otc_metadata/data/services/sdrs.yaml @@ -0,0 +1,16 @@ +--- +environment: public +repositories: +- environment: internal + repo: docs-swiss/storage-disaster-recovery-service + type: gitea +- environment: public + repo: opentelekomcloud-docs-swiss/storage-disaster-recovery-service + type: github +service_category: storage +service_title: Storage Disaster Recovery Service +service_type: sdrs +service_uri: storage-disaster-recovery-service +teams: +- name: docs-storage-rw + permission: write diff --git a/otc_metadata/data/services/smn.yaml b/otc_metadata/data/services/smn.yaml new file mode 100644 index 0000000..516fda7 --- /dev/null +++ b/otc_metadata/data/services/smn.yaml @@ -0,0 +1,16 @@ +--- +environment: public +repositories: +- environment: internal + repo: docs-swiss/simple-message-notification + type: gitea +- environment: public + repo: opentelekomcloud-docs-swiss/simple-message-notification + type: github +service_category: application +service_title: Simple Message Notification +service_type: smn +service_uri: simple-message-notification +teams: +- name: docs-orchestration-rw + permission: write diff --git a/otc_metadata/data/services/swr.yaml b/otc_metadata/data/services/swr.yaml new file mode 100644 index 0000000..fae1c9a --- /dev/null +++ b/otc_metadata/data/services/swr.yaml @@ -0,0 +1,16 @@ +--- +environment: public +repositories: +- environment: internal + repo: docs-swiss/software-repository-container + type: gitea +- environment: public + repo: opentelekomcloud-docs-swiss/software-repository-container + type: github +service_category: container +service_title: Software Repository for Containers +service_type: swr +service_uri: software-repository-container +teams: +- name: docs-container-rw + permission: write diff --git a/otc_metadata/data/services/tms.yaml b/otc_metadata/data/services/tms.yaml new file mode 100644 index 0000000..b3cc3dc --- /dev/null +++ b/otc_metadata/data/services/tms.yaml @@ -0,0 +1,16 @@ +--- +environment: public +repositories: +- environment: internal + repo: docs-swiss/tag-management-service + type: gitea +- environment: public + repo: opentelekomcloud-docs-swiss/tag-management-service + type: github +service_category: md +service_title: Tag Management Service +service_type: tms +service_uri: tag-management-service +teams: +- name: docs-orchestration-rw + permission: write diff --git a/otc_metadata/data/services/vpc.yaml b/otc_metadata/data/services/vpc.yaml new file mode 100644 index 0000000..426ed1d --- /dev/null +++ b/otc_metadata/data/services/vpc.yaml @@ -0,0 +1,16 @@ +--- +environment: public +repositories: +- environment: internal + repo: docs-swiss/virtual-private-cloud + type: gitea +- environment: public + repo: opentelekomcloud-docs-swiss/virtual-private-cloud + type: github +service_category: network +service_title: Virtual Private Cloud +service_type: vpc +service_uri: virtual-private-cloud +teams: +- name: docs-network-rw + permission: write diff --git a/otc_metadata/data/services/vpcep.yaml b/otc_metadata/data/services/vpcep.yaml new file mode 100644 index 0000000..82afb25 --- /dev/null +++ b/otc_metadata/data/services/vpcep.yaml @@ -0,0 +1,16 @@ +--- +environment: public +repositories: +- environment: internal + repo: docs-swiss/vpc-endpoint + type: gitea +- environment: public + repo: opentelekomcloud-docs-swiss/vpc-endpoint + type: github +service_category: network +service_title: VPC Endpoint +service_type: vpcep +service_uri: vpc-endpoint +teams: +- name: docs-network-rw + permission: write diff --git a/otc_metadata/data/services/vpn.yaml b/otc_metadata/data/services/vpn.yaml new file mode 100644 index 0000000..46c06d8 --- /dev/null +++ b/otc_metadata/data/services/vpn.yaml @@ -0,0 +1,16 @@ +--- +environment: public +repositories: +- environment: internal + repo: docs-swiss/virtual-private-network + type: gitea +- environment: public + repo: opentelekomcloud-docs-swiss/virtual-private-network + type: github +service_category: network +service_title: Virtual Private Network +service_type: vpn +service_uri: virtual-private-network +teams: +- name: docs-network-rw + permission: write diff --git a/otc_metadata/data/services/wafd.yaml b/otc_metadata/data/services/wafd.yaml new file mode 100644 index 0000000..f513281 --- /dev/null +++ b/otc_metadata/data/services/wafd.yaml @@ -0,0 +1,16 @@ +--- +environment: public +repositories: +- environment: internal + repo: docs-swiss/web-application-firewall-dedicated + type: gitea +- environment: public + repo: opentelekomcloud-docs-swiss/web-application-firewall-dedicated + type: github +service_category: security-services +service_title: Dedicated Web Application Firewall +service_type: wafd +service_uri: web-application-firewall-dedicated +teams: +- name: docs-security-services-rw + permission: write diff --git a/otc_metadata/docs.py b/otc_metadata/docs.py index 733add1..d1d7c63 100644 --- a/otc_metadata/docs.py +++ b/otc_metadata/docs.py @@ -15,19 +15,18 @@ import copy import otc_metadata.data -__all__ = ['Service'] +__all__ = ["Service"] -BUILTIN_DATA = otc_metadata.data.read_data('docs.yaml') +BUILTIN_DATA = otc_metadata.data.read_data("docs.yaml") def _normalize_type(service_type): if service_type: - return service_type.replace('_', '-') + return service_type.replace("_", "-") class Service(object): - """Encapsulation of the OTC Docs data - """ + """Encapsulation of the OTC Docs data""" def __init__(self): self._service_data = BUILTIN_DATA @@ -35,4 +34,4 @@ class Service(object): @property def all_services(self): "Service Categories data listing." - return copy.deepcopy(self._service_data['services']) + return copy.deepcopy(self._service_data["services"]) diff --git a/otc_metadata/services.py b/otc_metadata/services.py index 195b067..54372aa 100644 --- a/otc_metadata/services.py +++ b/otc_metadata/services.py @@ -41,7 +41,7 @@ class Services(object): # sort docs list by _ self._service_data["documents"] = sorted( sorted_docs, - key=lambda x: f"{x.get('service_type')}{x.get('title')}" + key=lambda x: f"{x.get('service_type')}{x.get('title')}", ) # sort services by <service_type>_<service_title> self._service_data["services"] = sorted( @@ -216,15 +216,15 @@ class Services(object): :param str service_type: Filter by service_type """ res = dict() - res['service'] = {} + res["service"] = {} docs = [] services = self._service_data - for doc in services['documents']: - if doc['service_type'] == service_type: + for doc in services["documents"]: + if doc["service_type"] == service_type: docs.append(doc) - res['documents'] = docs - for service in services['services']: - if service['service_type'] == service_type: - res['service'] = service + res["documents"] = docs + for service in services["services"]: + if service["service_type"] == service_type: + res["service"] = service break return res diff --git a/otc_metadata/tests/test_otc_metadata.py b/otc_metadata/tests/test_otc_metadata.py index 609199f..6820c6d 100644 --- a/otc_metadata/tests/test_otc_metadata.py +++ b/otc_metadata/tests/test_otc_metadata.py @@ -45,6 +45,11 @@ class TestOtcMetadata(TestCase): srv["service_category"] in category, f"Category {srv['service_category']} is present", ) + self.assertGreater( + len(self.data._service_data["service_categories"]), + 1, + "More then 1 service category", + ) def test_doc_contains_required_data(self): srv_types = dict() diff --git a/tools/split_metadata.py b/tools/split_metadata.py new file mode 100644 index 0000000..1db2497 --- /dev/null +++ b/tools/split_metadata.py @@ -0,0 +1,41 @@ +# import copy + +from pathlib import Path +import yaml + +import otc_metadata + +data = otc_metadata.services.Services() + +for item in data.all_docs: + with open( + Path( + otc_metadata.data.DATA_DIR, + "documents", + f"{item['service_type']}-{item['type']}.yaml", + ), + "w", + ) as fp: + yaml.dump(item, fp, explicit_start=True) + +for item in data.all_services: + with open( + Path( + otc_metadata.data.DATA_DIR, + "services", + f"{item['service_type']}.yaml", + ), + "w", + ) as fp: + yaml.dump(item, fp, explicit_start=True) + +for item in data.service_categories: + with open( + Path( + otc_metadata.data.DATA_DIR, + "service_categories", + f"{item['name']}.yaml", + ), + "w", + ) as fp: + yaml.dump(item, fp, explicit_start=True)