Workload Manager Basics
Workload Manager validates enterprise workloads against Google Cloud best
practices and recommendations. The public client libraries are centered on
evaluations: define a resource scope, choose built-in or custom rules, run an
evaluation, then inspect results and scanned resources.
Use This Flow
flowchart LR
Rules["List rules"] --> Eval["Create or update evaluation"]
Resources["Project, folder, or org scope"] --> Eval
Eval --> Run["Run evaluation"]
Run --> Results["Inspect evaluation results"]
Results --> Remediate["Remediate findings"]
Results --> Export["Optional BigQuery export"]
Core API Constraints
To ensure compatibility, security, and successful integration:
- Public Surface Only: You MUST strictly interact with Workload Manager
using the official public
google-cloud-workloadmanager client library or
the public REST API (workloadmanager.googleapis.com/v1).
- No Internal or Undocumented APIs: Do NOT attempt to use internal RPC
protocols, private service backends, or undocumented discovery mechanisms.
They are not supported for public integrations and will fail.
- No Service-Specific CLI: There is no public
gcloud workload-manager
CLI command group. Use gcloud only for authentication, IAM role
assignment, and fetching raw REST tokens.
- Sandbox Execution Robustness (Auth/Mock Fallbacks): When gcloud
authentication or Workload Manager API calls fail in sandboxed or restricted
environments (e.g., due to Context Aware Access token blocks, missing API
enablement, or
mock resources returning 404/403), immediately fall back to presenting
example code and static findings from your references instead of entering
retry loops. Present the correct client library code structure or REST API
payload example, clearly explain the auth or resource limitation, and list
typical rules or mock findings statically to satisfy the request.
Prerequisites
Enable the Workload Manager API:
gcloud services enable workloadmanager.googleapis.com --quiet
Authenticate locally using Application Default Credentials (ADC) before
using client libraries:
gcloud auth application-default login
Ensure the Workload Manager service agent has the required roles granted in
your project (mandatory for API/client library usage, see
IAM & Security).
Grant the least-privileged role needed for the task. Start with
roles/workloadmanager.viewer for read-only access to evaluation resources
and use roles/workloadmanager.evaluationAdmin or
roles/workloadmanager.admin only when creating, updating, running, or
deleting evaluations.
Quick Client Library Example
Use the Python client library for the first working automation path:
python3 -m pip install --upgrade google-cloud-workloadmanager
from google.cloud import workloadmanager_v1
project_id = "PROJECT_ID"
location = "LOCATION"
parent = f"projects/{project_id}/locations/{location}"
client = workloadmanager_v1.WorkloadManagerClient()
rules = client.list_rules(
request=workloadmanager_v1.ListRulesRequest(
parent=parent,
evaluation_type=workloadmanager_v1.Evaluation.EvaluationType.OTHER,
)
)
for rule in rules.rules:
print(rule.name, rule.display_name, rule.severity)
Reference Directory
Core Concepts: Evaluations, rules, results,
scanned resources, supported workload types, and API shape.
General Best Practices: Google Cloud
general best-practice posture checks, OTHER evaluation guidance, custom
Rego rules, and scale/automation patterns.
Client Libraries: Python and Go client
library examples for listing rules, creating evaluations, running
evaluations, and reading findings.
REST Usage: Direct REST examples for the public
Workload Manager API and operations polling.
Public CLI Status: No documented
service-specific gcloud workload-manager command group; use gcloud only
for auth, IAM, API enablement, and REST tokens.
Public MCP Status: No documented public
Workload Manager MCP server; use client libraries or REST API instead.
Setup Prerequisites: Terraform examples
only for adjacent prerequisites such as API enablement, IAM, BigQuery export
datasets, and KMS keys. This is not Workload Manager resource management.
IAM & Security: Workload Manager roles,
least-privilege guidance, service agents, data handling, and CMEK notes.
If product behavior or API fields are not covered here, check the current
Workload Manager product documentation and client library reference before
implementing.
Authoritative References
Additional Context
1---2name: workload-manager-basics3metadata:4 source: https://skillmd.com/skills/google/workload-manager-basics5 category: CloudObservabilityAndMonitoring6description: >-7 Use this skill to manage Google Cloud Workload Manager evaluations, rules,8 scanned resources, and validation results by using public client libraries9 and the REST API. Use when you need to inspect workload best-practice rules,10 create and run evaluations for Google Cloud general best practices, SAP, SQL11 Server, or custom organizational rules, review violations, export results to12 BigQuery, or automate Workload Manager through client libraries because no13 service-specific public CLI or MCP server is available. Don't use for general14 Google Compute Engine instance management, VPC configuration, or standard IAM15 auditing.16---1718# Workload Manager Basics1920Workload Manager validates enterprise workloads against Google Cloud best21practices and recommendations. The public client libraries are centered on22evaluations: define a resource scope, choose built-in or custom rules, run an23evaluation, then inspect results and scanned resources.2425## Use This Flow2627```mermaid28flowchart LR29 Rules["List rules"] --> Eval["Create or update evaluation"]30 Resources["Project, folder, or org scope"] --> Eval31 Eval --> Run["Run evaluation"]32 Run --> Results["Inspect evaluation results"]33 Results --> Remediate["Remediate findings"]34 Results --> Export["Optional BigQuery export"]35```3637## Core API Constraints3839To ensure compatibility, security, and successful integration:4041* **Public Surface Only:** You MUST strictly interact with Workload Manager42 using the official public `google-cloud-workloadmanager` client library or43 the public REST API (`workloadmanager.googleapis.com/v1`).44* **No Internal or Undocumented APIs:** Do NOT attempt to use internal RPC45 protocols, private service backends, or undocumented discovery mechanisms.46 They are not supported for public integrations and will fail.47* **No Service-Specific CLI:** There is no public `gcloud workload-manager`48 CLI command group. Use `gcloud` only for authentication, IAM role49 assignment, and fetching raw REST tokens.50* **Sandbox Execution Robustness (Auth/Mock Fallbacks):** When gcloud51 authentication or Workload Manager API calls fail in sandboxed or restricted52 environments (e.g., due to Context Aware Access token blocks, missing API53 enablement, or54 mock resources returning 404/403), immediately fall back to presenting55 example code and static findings from your references instead of entering56 retry loops. Present the correct client library code structure or REST API57 payload example, clearly explain the auth or resource limitation, and list58 typical rules or mock findings statically to satisfy the request.5960## Prerequisites61621. Enable the Workload Manager API:6364 ```bash65 gcloud services enable workloadmanager.googleapis.com --quiet66 ```67682. Authenticate locally using Application Default Credentials (ADC) before69 using client libraries:7071 ```bash72 gcloud auth application-default login73 ```74753. Ensure the Workload Manager service agent has the required roles granted in76 your project (mandatory for API/client library usage, see77 [IAM & Security](references/iam-security.md)).78794. Grant the least-privileged role needed for the task. Start with80 `roles/workloadmanager.viewer` for read-only access to evaluation resources81 and use `roles/workloadmanager.evaluationAdmin` or82 `roles/workloadmanager.admin` only when creating, updating, running, or83 deleting evaluations.8485## Quick Client Library Example8687Use the Python client library for the first working automation path:8889```bash90python3 -m pip install --upgrade google-cloud-workloadmanager91```9293```python94from google.cloud import workloadmanager_v19596project_id = "PROJECT_ID"97location = "LOCATION"98parent = f"projects/{project_id}/locations/{location}"99100client = workloadmanager_v1.WorkloadManagerClient()101102rules = client.list_rules(103 request=workloadmanager_v1.ListRulesRequest(104 parent=parent,105 evaluation_type=workloadmanager_v1.Evaluation.EvaluationType.OTHER,106 )107)108109for rule in rules.rules:110 print(rule.name, rule.display_name, rule.severity)111```112113## Reference Directory114115- [Core Concepts](references/core-concepts.md): Evaluations, rules, results,116 scanned resources, supported workload types, and API shape.117118- [General Best Practices](references/general-best-practices.md): Google Cloud119 general best-practice posture checks, `OTHER` evaluation guidance, custom120 Rego rules, and scale/automation patterns.121122- [Client Libraries](references/client-library-usage.md): Python and Go client123 library examples for listing rules, creating evaluations, running124 evaluations, and reading findings.125126- [REST Usage](references/rest-usage.md): Direct REST examples for the public127 Workload Manager API and operations polling.128129- [Public CLI Status](references/public-cli-status.md): No documented130 service-specific `gcloud workload-manager` command group; use `gcloud` only131 for auth, IAM, API enablement, and REST tokens.132133- [Public MCP Status](references/public-mcp-status.md): No documented public134 Workload Manager MCP server; use client libraries or REST API instead.135136- [Setup Prerequisites](references/setup-prerequisites.md): Terraform examples137 only for adjacent prerequisites such as API enablement, IAM, BigQuery export138 datasets, and KMS keys. This is not Workload Manager resource management.139140- [IAM & Security](references/iam-security.md): Workload Manager roles,141 least-privilege guidance, service agents, data handling, and CMEK notes.142143If product behavior or API fields are not covered here, check the current144Workload Manager product documentation and client library reference before145implementing.146147## Authoritative References148149- [Workload Manager overview](https://docs.cloud.google.com/workload-manager/docs/overview)150- [Google Cloud best practices](https://docs.cloud.google.com/workload-manager/docs/reference/best-practices-general)151- [Workload Manager REST API](https://docs.cloud.google.com/workload-manager/docs/reference/rest)152- [About custom rules](https://docs.cloud.google.com/workload-manager/docs/evaluate/custom-rules/about-custom-rules)153- [Write custom rules using Rego](https://docs.cloud.google.com/workload-manager/docs/evaluate/custom-rules/rego-custom-rules)154- [Python package](https://pypi.org/project/google-cloud-workloadmanager/)155- [Workload Manager IAM roles](https://docs.cloud.google.com/iam/docs/roles-permissions/workloadmanager)156- For additional information, use the Developer Knowledge MCP server `search_documents` tool.157158## Additional Context159160- [Mastering cloud posture management with Workload Manager](https://discuss.google.dev/t/mastering-cloud-posture-management-security-reliability-and-finops-with-workload-manager/318258)