Manually update READMEs, quickstart, and top-level stuff

googleapis · Jul 10, 2024 · c4ba783 · c4ba783
1 parent 97949cc
commit c4ba783
Show file tree

Hide file tree

Showing 8 changed files with 45 additions and 19 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,11 @@ breaking changes in the upcoming 3.x release. This release is scheduled for
 
 ### New Libraries
 
+We are happy to announce the following GA libraries. Unless specifically noted,
+the APIs in these libraries are stable, and are ready for production use.
+
+- [Privileged Access Manager API](/google/cloud/privilegedaccessmanager/README.md)
+
 The following experimental libraries are now available:
 
 - [Cloud BigQuery Control API](/google/cloud/bigquerycontrol/README.md) -

diff --git a/cmake/GoogleCloudCppFeatures.cmake b/cmake/GoogleCloudCppFeatures.cmake
@@ -128,6 +128,7 @@ set(GOOGLE_CLOUD_CPP_GA_LIBRARIES
     "policysimulator"
     "policytroubleshooter"
     "privateca"
+    "privilegedaccessmanager"
     "profiler"
     "publicca"
     "pubsub"

diff --git a/google/cloud/privilegedaccessmanager/CMakeLists.txt b/google/cloud/privilegedaccessmanager/CMakeLists.txt
@@ -30,8 +30,7 @@ if (BUILD_TESTING AND GOOGLE_CLOUD_CPP_ENABLE_CXX_EXCEPTIONS)
         COMMAND
             cmake -P "${PROJECT_SOURCE_DIR}/cmake/quickstart-runner.cmake"
             $<TARGET_FILE:privilegedaccessmanager_quickstart>
-            GOOGLE_CLOUD_PROJECT GOOGLE_CLOUD_CPP_TEST_REGION # EDIT HERE
-    )
+            GOOGLE_CLOUD_PROJECT GOOGLE_CLOUD_CPP_TEST_REGION)
     set_tests_properties(privilegedaccessmanager_quickstart
                          PROPERTIES LABELS "integration-test;quickstart")
 endif ()
diff --git a/google/cloud/privilegedaccessmanager/README.md b/google/cloud/privilegedaccessmanager/README.md
@@ -3,7 +3,18 @@
 This directory contains an idiomatic C++ client library for the
 [Privileged Access Manager API][cloud-service-docs].
 
-\<UNKNOWN - NO SERVICE CONFIG DOCUMENTATION SUMMARY>
+Privileged Access Manager (PAM) helps you on your journey towards least
+privilege and helps mitigate risks tied to privileged access misuse or abuse.
+PAM allows you to shift from always-on standing privileges towards on-demand
+access with just-in-time, time-bound, and approval-based access elevations. PAM
+allows IAM administrators to create entitlements that can grant just-in-time,
+temporary access to any resource scope. Requesters can explore eligible
+entitlements and request the access needed for their task. Approvers are
+notified when approvals await their decision. Streamlined workflows facilitated
+by using PAM can support various use cases, including emergency access for
+incident responders, time-boxed access for developers for critical deployment or
+maintenance, temporary access for operators for data ingestion and audits, JIT
+access to service accounts for automated tasks, and more.
 
 While this library is **GA**, please note that the Google Cloud C++ client
 libraries do **not** follow [Semantic Versioning](https://semver.org/).
@@ -18,7 +29,7 @@ this library.
 <!-- inject-quickstart-start -->
 
 ```cc
-#include "google/cloud/privilegedaccessmanager/v1/ EDIT HERE _client.h"
+#include "google/cloud/privilegedaccessmanager/v1/privileged_access_manager_client.h"
 #include "google/cloud/location.h"
 #include <iostream>
 
@@ -30,12 +41,11 @@ int main(int argc, char* argv[]) try {
 
   auto const location = google::cloud::Location(argv[1], argv[2]);
 
-  namespace privilegedaccessmanager =
-      ::google::cloud::privilegedaccessmanager_v1;
-  auto client = privilegedaccessmanager::ServiceClient(
-      privilegedaccessmanager::MakeServiceConnection());  // EDIT HERE
+  namespace pam = ::google::cloud::privilegedaccessmanager_v1;
+  auto client = pam::PrivilegedAccessManagerClient(
+      pam::MakePrivilegedAccessManagerConnection());
 
-  for (auto r : client.List /*EDIT HERE*/ (location.FullName())) {
+  for (auto r : client.ListEntitlements(location.FullName())) {
     if (!r) throw std::move(r).status();
     std::cout << r->DebugString() << "\n";
   }

diff --git a/google/cloud/privilegedaccessmanager/doc/main.dox b/google/cloud/privilegedaccessmanager/doc/main.dox
@@ -4,7 +4,18 @@
 
 An idiomatic C++ client library for the [Privileged Access Manager API][cloud-service-docs].
 
-<UNKNOWN - NO SERVICE CONFIG DOCUMENTATION SUMMARY>
+Privileged Access Manager (PAM) helps you on your journey towards least
+privilege and helps mitigate risks tied to privileged access misuse or abuse.
+PAM allows you to shift from always-on standing privileges towards on-demand
+access with just-in-time, time-bound, and approval-based access elevations. PAM
+allows IAM administrators to create entitlements that can grant just-in-time,
+temporary access to any resource scope. Requesters can explore eligible
+entitlements and request the access needed for their task. Approvers are
+notified when approvals await their decision. Streamlined workflows facilitated
+by using PAM can support various use cases, including emergency access for
+incident responders, time-boxed access for developers for critical deployment or
+maintenance, temporary access for operators for data ingestion and audits, JIT
+access to service accounts for automated tasks, and more.
 
 While this library is **GA**, please note that the Google Cloud C++ client libraries do **not** follow
 [Semantic Versioning](https://semver.org/).

diff --git a/google/cloud/privilegedaccessmanager/quickstart/README.md b/google/cloud/privilegedaccessmanager/quickstart/README.md
@@ -73,7 +73,7 @@ https://cloud.google.com/docs/authentication/production
 1. Run the example, changing the placeholder(s) to appropriate values:
 
    ```bash
-   bazel run :quickstart -- [...]
+   bazel run :quickstart -- [PROJECT_ID] [LOCATION_ID]
    ```
 
 ## Using with CMake
@@ -110,7 +110,7 @@ https://cloud.google.com/docs/authentication/production
 1. Run the example, changing the placeholder(s) to appropriate values:
 
    ```bash
-   .build/quickstart [...]
+   .build/quickstart [PROJECT_ID] [LOCATION_ID]
    ```
 
 ## Platform Specific Notes
@@ -151,4 +151,4 @@ set GRPC_DEFAULT_SSL_ROOTS_FILE_PATH=%cd%\roots.pem
 [grpc-roots-pem-bug]: https://github.com/grpc/grpc/issues/16571
 [homebrew-cmake-link]: https://formulae.brew.sh/formula/cmake
 [howto-setup-dev-workstation]: /doc/contributor/howto-guide-setup-development-workstation.md
-[quickstart-link]: https://cloud.google.com/privilegedaccessmanager/docs/quickstart
+[quickstart-link]: https://cloud.google.com/iam/docs/pam-create-entitlements
diff --git a/google/cloud/privilegedaccessmanager/quickstart/quickstart.cc b/google/cloud/privilegedaccessmanager/quickstart/quickstart.cc
@@ -13,7 +13,7 @@
 // limitations under the License.
 
 //! [all]
-#include "google/cloud/privilegedaccessmanager/v1/ EDIT HERE _client.h"
+#include "google/cloud/privilegedaccessmanager/v1/privileged_access_manager_client.h"
 #include "google/cloud/location.h"
 #include <iostream>
 
@@ -25,12 +25,11 @@ int main(int argc, char* argv[]) try {
 
   auto const location = google::cloud::Location(argv[1], argv[2]);
 
-  namespace privilegedaccessmanager =
-      ::google::cloud::privilegedaccessmanager_v1;
-  auto client = privilegedaccessmanager::ServiceClient(
-      privilegedaccessmanager::MakeServiceConnection());  // EDIT HERE
+  namespace pam = ::google::cloud::privilegedaccessmanager_v1;
+  auto client = pam::PrivilegedAccessManagerClient(
+      pam::MakePrivilegedAccessManagerConnection());
 
-  for (auto r : client.List /*EDIT HERE*/ (location.FullName())) {
+  for (auto r : client.ListEntitlements(location.FullName())) {
     if (!r) throw std::move(r).status();
     std::cout << r->DebugString() << "\n";
   }

diff --git a/libraries.bzl b/libraries.bzl
@@ -187,6 +187,7 @@ GOOGLE_CLOUD_CPP_GA_LIBRARIES = [
     "policysimulator",
     "policytroubleshooter",
     "privateca",
+    "privilegedaccessmanager",
     "profiler",
     "publicca",
     "pubsub",