Google IDX icon

Google IDX

Google IDX
Join our community

Actions10

Overview

This node integrates with Google Cloud Workstations via the Google IDX API, enabling users to manage and interact with their cloud-based development environments programmatically. It supports various operations such as starting, stopping, resetting, retrieving status, generating access tokens, and running manual commands on workstations.

Common scenarios include:

  • Automating workstation lifecycle management in CI/CD pipelines.
  • Monitoring workstation statuses for operational dashboards.
  • Executing custom commands remotely on specific workstations.
  • Managing multiple user workspaces efficiently within a Google Cloud project.

For example, a developer can use this node to start a workstation before beginning a coding session and stop it afterward to save resources. Another use case is fetching the current status of all workstations to display in an internal admin panel.

Properties

Name Meaning
Project ID Select or enter your Google Cloud project ID. Can be chosen from a list of projects or entered manually as a string.
WorkStation ID The identifier of the workstation command string to execute manually. Expected format: `/[run

Output

The node outputs JSON objects representing the results of the requested operation. The structure varies by operation:

  • For manualWorkstation commands, output includes details like timestamp, access token, project, region, cluster, config, workstation name, exit code, standard output, and standard error from the executed command.
  • For status queries, outputs contain workstation states grouped by starting, running, or stopped.
  • For token generation or start/stop operations, outputs reflect the API response from Google Cloud Workstations.
  • For initialization, outputs summarize total users, total items, and workspace details per user.

If binary data were involved (not evident here), it would typically represent files or logs retrieved from the workstation.

Dependencies

  • Requires an OAuth2 API credential configured for Google IDX API access.
  • Uses Google Cloud Workstations API endpoints.
  • Depends on gcloud CLI installed and accessible if running commands via Docker container.
  • Node uses child process execution to run shell commands inside Docker containers.
  • Requires proper permissions on Google Cloud project to manage workstations.

Troubleshooting

  • Invalid input format for manual commands: The node expects a strict command pattern. Errors occur if the input does not match /[run|start|stop|status|token] -a USER -ws SLUG[,SLUG2] [-c COMMAND]. Ensure correct formatting.
  • Missing required parameters: For example, missing project ID or workstation ID will cause errors.
  • Authentication failures: Ensure the OAuth2 credentials are valid and have necessary scopes.
  • Command execution errors: If the Docker container or gcloud CLI is misconfigured or inaccessible, command execution will fail.
  • API rate limits or transient errors: The node retries some requests on HTTP 503/504 but may fail after retries.
  • Access token expiration: Some operations check token validity; expired tokens require re-authentication.

Links and References

Discussion