Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: update documentation to point to security best practice #14942

Merged
merged 4 commits into from
Jan 22, 2025

Conversation

cuiy0006
Copy link
Collaborator

@cuiy0006 cuiy0006 commented Jan 16, 2025

This change is Reviewable

@cuiy0006 cuiy0006 requested a review from a team as a code owner January 16, 2025 19:08
@cuiy0006 cuiy0006 added the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Jan 16, 2025
Copy link

codecov bot commented Jan 16, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.91%. Comparing base (63bc533) to head (b9cc1e3).
Report is 5 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #14942   +/-   ##
=======================================
  Coverage   92.91%   92.91%           
=======================================
  Files        2351     2351           
  Lines      210082   210082           
=======================================
+ Hits       195202   195203    +1     
+ Misses      14880    14879    -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@scotthart scotthart left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewable status: 0 of 3 files reviewed, 2 unresolved discussions (waiting on @cuiy0006)


google/cloud/credentials.h line 122 at r2 (raw file):

 *   credentials.
 *
 * Important: If you accept a credential configuration (credential

s/Important:/@warning

This will add some additional highlighting during doc rendering.

Code quote:

Important:

google/cloud/credentials.h line 276 at r2 (raw file):

 * Azure, or SAML 2.0.
 *
 * Important: If you accept a credential configuration (credential

s/Important:/@warning

This will add some additional highlighting during doc rendering.

Code quote:

Important:

@scotthart scotthart removed the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Jan 22, 2025
Copy link
Member

@scotthart scotthart left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed 2 of 3 files at r2, 1 of 1 files at r3, all commit messages.
Reviewable status: all files reviewed, 2 unresolved discussions (waiting on @cuiy0006)

@scotthart scotthart merged commit 6af1613 into googleapis:main Jan 22, 2025
74 of 75 checks passed
@cuiy0006 cuiy0006 deleted the add-warning-3rd-party-credential branch January 23, 2025 14:52
ddelgrosso1 added a commit that referenced this pull request Apr 9, 2025
* ci: disable deprecated warnings for windows GHA builds (#14875)

* feat(spanner): add samples for MR CMEK (#14674)

* docs(release): update changelog for the 2024-12 release (#14876)

* docs(release): update changelog for the 2024-12 release

* add lastest changes to release

* add latest changelog

* chore: update version to v2.33.0-rc (#14877)

* chore(deps): update dependency rules_python to v1 (#14880)

* chore(deps): update dependency google_cloud_cpp to v2.32.0 (#14879)

* ci: fix spanner samples integration tests (#14883)

* ci: fix spanner samples (#14885)

* chore(deps): update dependency build_bazel_rules_apple to v3.16.0 (#14881)

* chore(deps): update dependency curl to v8.8.0.bcr.2 (#14882)

* ci: specify bazel version for quickstarts used in the quickstart-bazel build (#14892)

* docs(storage): Update build instructions for gcs+grpc (#14833)

* docs(storage): Update build instructions for gcs+grpc

* and end mark

* spacing + feedback on prometheus

* checkers

* cleanup(cmake): REGAPIC helper (#14894)

* impl(bigquerycontrol): promote from experimental to transitional (#14887)

* bazel: update gapic.bzl to work with REST transport (#14895)

* fix(gkeconnect): service only supports REST endpoint (#14897)

* impl(gkeconnect): only needs proto target (#14898)

* ci: add 3PI(workforce) to SA impersonation integration tests for universe domain (#14878)

* ci: add 3PI(workforce) to SA impersonation integration tests for universe domain

* format

* disable SC2046

* chore(deps): update dependency build_bazel_rules_apple to v3.16.1 (#14899)

* impl(otel): include algorithm header (#14900)

* chore(deps): update protobuf to v29.2 (#14903)

* chore: update googleapis SHA circa 2024-12-13 (#14905)

* chore: update googleapis SHA circa 2024-12-13

PiperOrigin-RevId: 706010293

* docs(release): update changelog for the second 2024-12 release (#14906)

* chore: version bump to 2.34.0-rc (#14907)

* chore(deps): update dependency zlib to v1.3.1.bcr.4 (#14909)

* ci: fix renovate script (#14911)

* docs: remove references to ADC environment variable (#14914)

* ci: fix bazel/deps-cache.py (#14912)

* chore(compute): regenerate protos in 2025 (#14916)

* chore(deps): update dependency google_cloud_cpp to v2.33.0 (#14908)

* chore(deps): update grpc to v1.69.0 (#14888)

* chore(deps): update dependency mozilla/sccache to v0.9.1 (#14889)

* impl(bigquery): Json parsing changes for custom BigQuery library (#14918)

* chore(deps): update protobuf to v29.3 (#14919)

* chore(deps): update dependency rules_proto to v7.1.0 (#14904)

* chore(deps): update rules_cc to v0.0.17 (#14921)

* impl(rest): support LRO operation types without name method (#14924)

* chore(deps): update dependency com_github_zeux_pugixml to v1.15 (#14928)

* chore: update googleapis SHA circa 2025-01-10 (#14926)

PiperOrigin-RevId: 714068635

* chore(deps): update dependency platforms to v0.0.11 (#14927)

* chore: update auth links (#14931)

* chore: update auth links

* manual changes

* chore(compute): update discovery doc circa 20241231 (#14933)

* feat(otel): copy service labels into GCM Metric (#14930)

* chore(deps): update dependency google_benchmark to v1.9.0 (#14935)

* chore(deps): update dependency pugixml to v1.15 (#14934)

* feat(storage): add MoveObject functionality to JSON and gRPC (#14936)

* feat(storage): add MoveObject functionality to JSON and gRPC

* add moveobject integration test and update testbench version

* checkers

* add patchbucket call to integration test

* use folder enabled bucket

* create folder bucket in emulator

* make non-pure virtual to fix abi issue

* impl(bigquery): Fixed jobs and tables response for empty use case (#14938)

* fix(otel): Exporter creating Monitored Resource with task_id for Cloud Run (#14923)

When inside a Cloud Run environment, the `MonitoredResource` in a `CreateTimeSeriesRequest` to the Cloud Monitoring API does not include the necessary fields for the `generic_task` resource type, and is rejected.

Should follow the well-tested Golang implementation where the `faas.instance` OTel Resource Attribute is mapped to `MonitoredResource` `task_id`. As the `service.namespace` OTel Resource Attribute is not set by the Resource Detector from within Cloud Run, it should be mapped as an empty string, rather than being left absent.

https://github.com/GoogleCloudPlatform/opentelemetry-operations-go/blob/8da0f42dab085c916987891419461d583a2aa96e/internal/resourcemapping/resourcemapping.go#L153

* docs(release): update changelog for the 2025-01 release (#14939)

* chore: version bump to 2.35.0-rc (#14943)

* chore(deps): update dependency rules_python to v1.1.0 (#14946)

* ci(spanner): use enterprise edition in instance autoscaler sample (#14949)

* doc: update documentation to point to security best practice (#14942)

* chore(otel): prepare for otel-cpp 1.19 (#14950)

* chore(deps): update dependency google_cloud_cpp to v2.34.0 (#14945)

* chore(deps): update dependency google_benchmark to v1.9.1 (#14937)

* ci(optimization): pass quickstart if service is unavailable (#14955)

* docs(pubsub): Add Pub/Sub ingestion from Kafka samples (#14954)

* ci(gha): update sccache version and windows destination dir (#14956)

* chore(deps): update abseil to v20240722.1 (#14952)

* chore(deps): update opentelemetry to v1.19.0 (#14948)

* fix: Make bool_flag public (#14961)

* chore(deps): update dependency opentelemetry-cpp to v1.19.0 (#14960)

* docs: add code formatting to `msbuild` (#14962)

* chore: update googleapis SHA circa 2025-01-28  (#14964)

* chore: update googleapis SHA circa 2025-01-28

PiperOrigin-RevId: 720741557

* ci: disable execution of resourcesettings quickstart (#14966)

* docs(release): update changelog for the 2025-02 release (#14965)

* chore: version bump to 2.36.0-rc (#14968)

* cleanup: disable modernize-type-traits in .clang-tidy (#14973)

* feat(parametermanager): generate library (#14971)

* cleanup: changes following clang-tidy suggestions (#14976)

* cleanup: changes following clang-tidy suggestions

* fix

* fix

* chore(deps): update dependency google_cloud_cpp to v2.35.0 (#14970)

* chore(deps): update dependency c-ares to v1.19.1 (#14975)

* chore(deps): update dependency build_bazel_rules_apple to v3.17.1 (#14953)

* chore(deps): update dependency bazel to v7.5.0 (#14959)

* chore(deps): update dependency zlib to v1.3.1.bcr.5 (#14963)

* cleanup: changes following clang-tidy suggestions (#14977)

* chore(deps): update abseil to v20250127 (#14957)

Co-authored-by: Yao Cui <cuiyao@google.com>

* remove patches from builds, merge fixes

---------

Co-authored-by: Scott Hart <sdhart@google.com>
Co-authored-by: panerorenn9541 <36008213+panerorenn9541@users.noreply.github.com>
Co-authored-by: Yao Cui <cuiyao@google.com>
Co-authored-by: Mend Renovate <bot@renovateapp.com>
Co-authored-by: Darren Bolduc <dbolduc@google.com>
Co-authored-by: Carlos O'Ryan <coryan@google.com>
Co-authored-by: jsrinnn <114950032+jsrinnn@users.noreply.github.com>
Co-authored-by: Douglas Heriot <git@douglasheriot.com>
Co-authored-by: Mike Prieto <mikeprieto@google.com>
Co-authored-by: Sven Grossmann <Svennergr@gmail.com>
ddelgrosso1 added a commit that referenced this pull request Apr 9, 2025
* ci: disable deprecated warnings for windows GHA builds (#14875)

* feat(spanner): add samples for MR CMEK (#14674)

* docs(release): update changelog for the 2024-12 release (#14876)

* docs(release): update changelog for the 2024-12 release

* add lastest changes to release

* add latest changelog

* chore: update version to v2.33.0-rc (#14877)

* chore(deps): update dependency rules_python to v1 (#14880)

* chore(deps): update dependency google_cloud_cpp to v2.32.0 (#14879)

* ci: fix spanner samples integration tests (#14883)

* ci: fix spanner samples (#14885)

* chore(deps): update dependency build_bazel_rules_apple to v3.16.0 (#14881)

* chore(deps): update dependency curl to v8.8.0.bcr.2 (#14882)

* ci: specify bazel version for quickstarts used in the quickstart-bazel build (#14892)

* docs(storage): Update build instructions for gcs+grpc (#14833)

* docs(storage): Update build instructions for gcs+grpc

* and end mark

* spacing + feedback on prometheus

* checkers

* cleanup(cmake): REGAPIC helper (#14894)

* impl(bigquerycontrol): promote from experimental to transitional (#14887)

* bazel: update gapic.bzl to work with REST transport (#14895)

* fix(gkeconnect): service only supports REST endpoint (#14897)

* impl(gkeconnect): only needs proto target (#14898)

* ci: add 3PI(workforce) to SA impersonation integration tests for universe domain (#14878)

* ci: add 3PI(workforce) to SA impersonation integration tests for universe domain

* format

* disable SC2046

* chore(deps): update dependency build_bazel_rules_apple to v3.16.1 (#14899)

* impl(otel): include algorithm header (#14900)

* chore(deps): update protobuf to v29.2 (#14903)

* chore: update googleapis SHA circa 2024-12-13 (#14905)

* chore: update googleapis SHA circa 2024-12-13

PiperOrigin-RevId: 706010293

* docs(release): update changelog for the second 2024-12 release (#14906)

* chore: version bump to 2.34.0-rc (#14907)

* chore(deps): update dependency zlib to v1.3.1.bcr.4 (#14909)

* ci: fix renovate script (#14911)

* docs: remove references to ADC environment variable (#14914)

* ci: fix bazel/deps-cache.py (#14912)

* chore(compute): regenerate protos in 2025 (#14916)

* chore(deps): update dependency google_cloud_cpp to v2.33.0 (#14908)

* chore(deps): update grpc to v1.69.0 (#14888)

* chore(deps): update dependency mozilla/sccache to v0.9.1 (#14889)

* impl(bigquery): Json parsing changes for custom BigQuery library (#14918)

* chore(deps): update protobuf to v29.3 (#14919)

* chore(deps): update dependency rules_proto to v7.1.0 (#14904)

* chore(deps): update rules_cc to v0.0.17 (#14921)

* impl(rest): support LRO operation types without name method (#14924)

* chore(deps): update dependency com_github_zeux_pugixml to v1.15 (#14928)

* chore: update googleapis SHA circa 2025-01-10 (#14926)

PiperOrigin-RevId: 714068635

* chore(deps): update dependency platforms to v0.0.11 (#14927)

* chore: update auth links (#14931)

* chore: update auth links

* manual changes

* chore(compute): update discovery doc circa 20241231 (#14933)

* feat(otel): copy service labels into GCM Metric (#14930)

* chore(deps): update dependency google_benchmark to v1.9.0 (#14935)

* chore(deps): update dependency pugixml to v1.15 (#14934)

* feat(storage): add MoveObject functionality to JSON and gRPC (#14936)

* feat(storage): add MoveObject functionality to JSON and gRPC

* add moveobject integration test and update testbench version

* checkers

* add patchbucket call to integration test

* use folder enabled bucket

* create folder bucket in emulator

* make non-pure virtual to fix abi issue

* impl(bigquery): Fixed jobs and tables response for empty use case (#14938)

* fix(otel): Exporter creating Monitored Resource with task_id for Cloud Run (#14923)

When inside a Cloud Run environment, the `MonitoredResource` in a `CreateTimeSeriesRequest` to the Cloud Monitoring API does not include the necessary fields for the `generic_task` resource type, and is rejected.

Should follow the well-tested Golang implementation where the `faas.instance` OTel Resource Attribute is mapped to `MonitoredResource` `task_id`. As the `service.namespace` OTel Resource Attribute is not set by the Resource Detector from within Cloud Run, it should be mapped as an empty string, rather than being left absent.

https://github.com/GoogleCloudPlatform/opentelemetry-operations-go/blob/8da0f42dab085c916987891419461d583a2aa96e/internal/resourcemapping/resourcemapping.go#L153

* docs(release): update changelog for the 2025-01 release (#14939)

* chore: version bump to 2.35.0-rc (#14943)

* chore(deps): update dependency rules_python to v1.1.0 (#14946)

* ci(spanner): use enterprise edition in instance autoscaler sample (#14949)

* doc: update documentation to point to security best practice (#14942)

* chore(otel): prepare for otel-cpp 1.19 (#14950)

* chore(deps): update dependency google_cloud_cpp to v2.34.0 (#14945)

* chore(deps): update dependency google_benchmark to v1.9.1 (#14937)

* ci(optimization): pass quickstart if service is unavailable (#14955)

* docs(pubsub): Add Pub/Sub ingestion from Kafka samples (#14954)

* ci(gha): update sccache version and windows destination dir (#14956)

* chore(deps): update abseil to v20240722.1 (#14952)

* chore(deps): update opentelemetry to v1.19.0 (#14948)

* fix: Make bool_flag public (#14961)

* chore(deps): update dependency opentelemetry-cpp to v1.19.0 (#14960)

* docs: add code formatting to `msbuild` (#14962)

* chore: update googleapis SHA circa 2025-01-28  (#14964)

* chore: update googleapis SHA circa 2025-01-28

PiperOrigin-RevId: 720741557

* ci: disable execution of resourcesettings quickstart (#14966)

* docs(release): update changelog for the 2025-02 release (#14965)

* chore: version bump to 2.36.0-rc (#14968)

* cleanup: disable modernize-type-traits in .clang-tidy (#14973)

* feat(parametermanager): generate library (#14971)

* cleanup: changes following clang-tidy suggestions (#14976)

* cleanup: changes following clang-tidy suggestions

* fix

* fix

* chore(deps): update dependency google_cloud_cpp to v2.35.0 (#14970)

* chore(deps): update dependency c-ares to v1.19.1 (#14975)

* chore(deps): update dependency build_bazel_rules_apple to v3.17.1 (#14953)

* chore(deps): update dependency bazel to v7.5.0 (#14959)

* chore(deps): update dependency zlib to v1.3.1.bcr.5 (#14963)

* cleanup: changes following clang-tidy suggestions (#14977)

* chore(deps): update abseil to v20250127 (#14957)

Co-authored-by: Yao Cui <cuiyao@google.com>

* remove patches from builds, merge fixes

---------

Co-authored-by: Scott Hart <sdhart@google.com>
Co-authored-by: panerorenn9541 <36008213+panerorenn9541@users.noreply.github.com>
Co-authored-by: Yao Cui <cuiyao@google.com>
Co-authored-by: Mend Renovate <bot@renovateapp.com>
Co-authored-by: Darren Bolduc <dbolduc@google.com>
Co-authored-by: Carlos O'Ryan <coryan@google.com>
Co-authored-by: jsrinnn <114950032+jsrinnn@users.noreply.github.com>
Co-authored-by: Douglas Heriot <git@douglasheriot.com>
Co-authored-by: Mike Prieto <mikeprieto@google.com>
Co-authored-by: Sven Grossmann <Svennergr@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants