Fix inaccurate documentation for TargetHttpsProxy resource #10874

Hamzawy63 · 2024-06-04T19:30:20Z

This PR

Fixes inaccurate documentation for certificateManagerCertificates and certificateMap fields in TargetHttpsProxy
Fixes inaccurate documentation for certificateManagerCertificates field in RegionTargetHttpsProxy
Addresses documentation issue referenced in Resource google_compute_target_https_proxy fails to provision with certificate_manager_certificates attribute hashicorp/terraform-provider-google#17176

Release Note Template for Downstream PRs (will be copied)

compute: updated documentation of google_compute_target_https_proxy and google_compute_region_target_https_proxy

github-actions · 2024-06-05T09:47:05Z

Hello! I am a robot. Tests will require approval from a repository maintainer to run.

@melinath, a repository maintainer, has been assigned to review your changes. If you have not received review feedback within 2 business days, please leave a comment on this PR asking them to take a look.

You can help make sure that review is quick by doing a self-review and by running impacted tests locally.

pawelJas · 2024-06-05T12:22:21Z

mmv1/products/compute/TargetHttpsProxy.yaml

@@ -134,7 +134,8 @@ properties:
    name: 'certificateManagerCertificates'
    description: |
      URLs to certificate manager certificate resources that are used to authenticate connections between users and the load balancer.
-      Currently, you may specify up to 15 certificates. Certificate manager certificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED.
+      Currently, you may specify up to 15 certificates. Certificate manager certificates only apply when the load balancing scheme is set to INTERNAL_MANAGED.


"Currently, you may specify up to 15 certificates." this is not true for CertificateManagerCertificates.

I would suggest something like below. In line with sslCertificate definition.

URLs to Certificate manager certificate resources that are used to authenticate connections between users and the load balancer. Certificate manager certificates only apply when the load balancing scheme is set to INTERNAL_MANAGED. SslCertificates and CertificateManagerCertificates can not be defined together. Accepted format is `//certificatemanager.googleapis.com/projects/{project}/locations/{location}/certificates/{resourceName}` or just the self_link `projects/{project}/locations/{location}/certificates/{resourceName}`

Done! Just to confirm, the 15 certificate limit is still true for sslCertificates and not for certificate manager certificate, right?

Yes, exactly.

pawelJas

Please also update RegionTargetHttpsProxy - The 15 limit is not true and also regional INTERNAL_SELF_MANAGED doesn't exists so it can be dropped.

Suggestion:

URLs to Certificate manager certificate resources that are used to authenticate connections between users and the load balancer.
SslCertificates and CertificateManagerCertificates can not be defined together.
Accepted format is `//certificatemanager.googleapis.com/projects/{project}/locations/{location}/certificates/{resourceName}` or just the self_link `projects/{project}/locations/{location}/certificates/{resourceName}`

melinath

Removing from my queue pending the changes suggested above; I will rely on y'all to let me know when these docs are accurate & then merge.

modular-magician · 2024-06-05T18:01:10Z

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

google provider: Diff ( 4 files changed, 10 insertions(+), 8 deletions(-))
google-beta provider: Diff ( 4 files changed, 10 insertions(+), 8 deletions(-))

modular-magician · 2024-06-05T18:19:13Z

Tests analytics

Total tests: 952
Passed tests: 877
Skipped tests: 74
Affected tests: 1

Click here to see the affected service packages

compute

Action taken

Found 1 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests

TestAccComputeInstanceNetworkIntefaceWithSecurityPolicy

Get to know how VCR tests work

modular-magician · 2024-06-05T18:44:44Z

$\textcolor{red}{\textsf{Tests failed during RECORDING mode:}}$
TestAccComputeInstanceNetworkIntefaceWithSecurityPolicy[Error message] [Debug log]

$\textcolor{red}{\textsf{Please fix these to complete your PR.}}$
View the build log or the debug log for each test

melinath

a couple minor nits based on the dev docs style guide.

melinath · 2024-06-06T21:57:54Z

mmv1/products/compute/TargetHttpsProxy.yaml

@@ -134,7 +134,8 @@ properties:
    name: 'certificateManagerCertificates'
    description: |
      URLs to certificate manager certificate resources that are used to authenticate connections between users and the load balancer.
-      Currently, you may specify up to 15 certificates. Certificate manager certificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED.
+      Certificate manager certificates only apply when the load balancing scheme is set to INTERNAL_MANAGED.
+      For EXTERNAL and EXTERNAL_MANAGED please use certificate_map instead.


https://developers.google.com/style/word-list#please

Suggested change

For EXTERNAL and EXTERNAL_MANAGED please use certificate_map instead.

For EXTERNAL and EXTERNAL_MANAGED, use certificate_map instead.

melinath · 2024-06-06T21:58:00Z

mmv1/products/compute/TargetHttpsProxy.yaml

@@ -164,7 +165,8 @@ properties:
    name: 'certificateMap'
    description: |
      A reference to the CertificateMap resource uri that identifies a certificate map
-      associated with the given target proxy. This field can only be set for global target proxies.
+      associated with the given target proxy. This field is only supported for EXTERNAL and EXTERNAL_MANAGED load balancing schemes.
+      For INTERNAL_MANAGED, please use certificate_manager_certificates instead.


Suggested change

For INTERNAL_MANAGED, please use certificate_manager_certificates instead.

For INTERNAL_MANAGED, use certificate_manager_certificates instead.

melinath · 2024-06-06T22:00:17Z

mmv1/products/compute/RegionTargetHttpsProxy.yaml

@@ -140,8 +140,7 @@ properties:
    name: 'certificateManagerCertificates'
    description: |
      URLs to certificate manager certificate resources that are used to authenticate connections between users and the load balancer.
-      Currently, you may specify up to 15 certificates. Certificate manager certificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED.
-      sslCertificates and certificateManagerCertificates fields can not be defined together.
+      sslCertificates and certificateManagerCertificates can not be defined together.


https://developers.google.com/style/contractions#negation-contractions

Suggested change

sslCertificates and certificateManagerCertificates can not be defined together.

sslCertificates and certificateManagerCertificates can't be defined together.

modular-magician · 2024-06-07T12:06:43Z

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

google provider: Diff ( 4 files changed, 10 insertions(+), 8 deletions(-))
google-beta provider: Diff ( 4 files changed, 10 insertions(+), 8 deletions(-))

modular-magician · 2024-06-07T12:22:21Z

Tests analytics

Total tests: 955
Passed tests: 880
Skipped tests: 74
Affected tests: 1

Click here to see the affected service packages

compute

Action taken

Found 1 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests

TestAccComputeInstanceNetworkIntefaceWithSecurityPolicy

Get to know how VCR tests work

modular-magician · 2024-06-07T12:49:36Z

$\textcolor{red}{\textsf{Tests failed during RECORDING mode:}}$
TestAccComputeInstanceNetworkIntefaceWithSecurityPolicy[Error message] [Debug log]

$\textcolor{red}{\textsf{Please fix these to complete your PR.}}$
View the build log or the debug log for each test

melinath

LGTM, going ahead with merge since @pawelJas has also approved

melinath · 2024-06-07T16:40:34Z

failing test is unrelated

…udPlatform#10874) Co-authored-by: Hamza Hassan <hamzahassan@google.com>

modular-magician added the awaiting-approval Pull requests that needs reviewer's approval to run presubmit tests label Jun 4, 2024

Stanwise approved these changes Jun 5, 2024

View reviewed changes

Hamzawy63 marked this pull request as ready for review June 5, 2024 09:46

github-actions bot requested a review from melinath June 5, 2024 09:47

pawelJas reviewed Jun 5, 2024

View reviewed changes

melinath requested changes Jun 5, 2024

View reviewed changes

Fix inaccurate documentation for certificate Manager fields

43e8e71

Hamzawy63 force-pushed the compute-target-https-proxy-update-documentation branch from cc215a9 to 43e8e71 Compare June 5, 2024 17:49

github-actions bot requested a review from melinath June 5, 2024 17:50

modular-magician added service/compute-l7-load-balancer and removed awaiting-approval Pull requests that needs reviewer's approval to run presubmit tests labels Jun 5, 2024

melinath requested review from Stanwise and pawelJas June 6, 2024 21:57

melinath requested changes Jun 6, 2024

View reviewed changes

pawelJas approved these changes Jun 7, 2024

View reviewed changes

Address documentation style issues

36be1ab

github-actions bot requested a review from melinath June 7, 2024 11:56

melinath approved these changes Jun 7, 2024

View reviewed changes

melinath merged commit b6e0064 into GoogleCloudPlatform:main Jun 7, 2024
11 of 12 checks passed

This was referenced Jun 7, 2024

Fix inaccurate documentation for TargetHttpsProxy resource hashicorp/terraform-provider-google-beta#7481

Merged

Fix inaccurate documentation for TargetHttpsProxy resource hashicorp/terraform-provider-google#18358

Merged

jessdejong pushed a commit to jessdejong/magic-modules that referenced this pull request Jun 10, 2024

Fix inaccurate documentation for TargetHttpsProxy resource (GoogleClo…

1f2c92f

…udPlatform#10874) Co-authored-by: Hamza Hassan <hamzahassan@google.com>

BBBmau pushed a commit to BBBmau/magic-modules that referenced this pull request Jun 24, 2024

Fix inaccurate documentation for TargetHttpsProxy resource (GoogleClo…

c58e202

…udPlatform#10874) Co-authored-by: Hamza Hassan <hamzahassan@google.com>

pcostell pushed a commit to pcostell/magic-modules that referenced this pull request Jul 16, 2024

Fix inaccurate documentation for TargetHttpsProxy resource (GoogleClo…

cd75b67

…udPlatform#10874) Co-authored-by: Hamza Hassan <hamzahassan@google.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix inaccurate documentation for TargetHttpsProxy resource #10874

Fix inaccurate documentation for TargetHttpsProxy resource #10874

Hamzawy63 commented Jun 4, 2024 •

edited

Loading

github-actions bot commented Jun 5, 2024

pawelJas Jun 5, 2024 •

edited

Loading

Hamzawy63 Jun 5, 2024

pawelJas Jun 5, 2024

pawelJas left a comment

melinath left a comment

modular-magician commented Jun 5, 2024

modular-magician commented Jun 5, 2024

modular-magician commented Jun 5, 2024

melinath left a comment

melinath Jun 6, 2024 •

edited

Loading

Hamzawy63 Jun 7, 2024

melinath Jun 6, 2024

Hamzawy63 Jun 7, 2024

melinath Jun 6, 2024

Hamzawy63 Jun 7, 2024

modular-magician commented Jun 7, 2024

modular-magician commented Jun 7, 2024

modular-magician commented Jun 7, 2024

melinath left a comment

melinath commented Jun 7, 2024

	For EXTERNAL and EXTERNAL_MANAGED please use certificate_map instead.
	For EXTERNAL and EXTERNAL_MANAGED, use certificate_map instead.

	For INTERNAL_MANAGED, please use certificate_manager_certificates instead.
	For INTERNAL_MANAGED, use certificate_manager_certificates instead.

	sslCertificates and certificateManagerCertificates can not be defined together.
	sslCertificates and certificateManagerCertificates can't be defined together.

Fix inaccurate documentation for TargetHttpsProxy resource #10874

Fix inaccurate documentation for TargetHttpsProxy resource #10874

Conversation

Hamzawy63 commented Jun 4, 2024 • edited Loading

github-actions bot commented Jun 5, 2024

pawelJas Jun 5, 2024 • edited Loading

Choose a reason for hiding this comment

Hamzawy63 Jun 5, 2024

Choose a reason for hiding this comment

pawelJas Jun 5, 2024

Choose a reason for hiding this comment

pawelJas left a comment

Choose a reason for hiding this comment

melinath left a comment

Choose a reason for hiding this comment

modular-magician commented Jun 5, 2024

Diff report

modular-magician commented Jun 5, 2024

Tests analytics

Action taken

modular-magician commented Jun 5, 2024

melinath left a comment

Choose a reason for hiding this comment

melinath Jun 6, 2024 • edited Loading

Choose a reason for hiding this comment

Hamzawy63 Jun 7, 2024

Choose a reason for hiding this comment

melinath Jun 6, 2024

Choose a reason for hiding this comment

Hamzawy63 Jun 7, 2024

Choose a reason for hiding this comment

melinath Jun 6, 2024

Choose a reason for hiding this comment

Hamzawy63 Jun 7, 2024

Choose a reason for hiding this comment

modular-magician commented Jun 7, 2024

Diff report

modular-magician commented Jun 7, 2024

Tests analytics

Action taken

modular-magician commented Jun 7, 2024

melinath left a comment

Choose a reason for hiding this comment

melinath commented Jun 7, 2024

Hamzawy63 commented Jun 4, 2024 •

edited

Loading

pawelJas Jun 5, 2024 •

edited

Loading

melinath Jun 6, 2024 •

edited

Loading