Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.aspect.build/llms.txt

Use this file to discover all available pages before exploring further.

The Aspect Workflows Web UI serves as a centralized point for managing and monitoring all build processes and task executions (Bazel invocations) in your environment. Its purpose is to provide a detailed and auditable view of workflows in a secure and accessible web environment.

​
Deployment and security

The Web UI deploys as part of your cloud infrastructure, supported on Amazon Web Services or GCP, with all resource provisioning managed by the aspect_workflows Terraform module. Two key technologies establish access and security for the interface:
  1. Web app activation: The capability activates by including the webapp configuration block in the Aspect Workflows module.
  2. OpenID Connect authentication: Security enforces via OpenID Connect, requiring integration with an external identity provider such as Google. You define essential authentication parameters such as endpoints and client ID, and you must reference the client_secret from a cloud secrets manager such as Amazon Web Services Secrets Manager or GCP Secret Manager to maintain source code integrity.

​
Accessibility and DNS

For the Web UI to be publicly accessible, the architecture requires the creation and configuration of a DNS:
  • Configuration requires referencing an existing managed DNS zone, for example Route53 on Amazon Web Services or GCP DNS within the dns block.
  • The Workflows module is responsible for automatically creating the necessary A records in this zone to route traffic.
  • Access to the service is typically via a specific subdomain, such as app.ci.example.com. The configured value for the zone is the internal resource name of the cloud provider, not the final domain name.

​
Dashboard features

Once accessible, the Web UI acts as an analytics dashboard for Bazel invocations, providing crucial data for analyzing build cycles:
  • Overview: The main dashboard presents a list of recent invocations, showing the current status and duration of each execution.
  • Detailed Inspection: Selecting an invocation reveals a set of information distributed across three categories:
    • Metadata: Includes tracking and context data such as trigger command, repository, branch, commit hash, status, duration, and the Bazel version used.
    • Tests: Allows filtering and sorting of all test targets, displaying the target type and its duration.
    • Build Logs: Provides raw log output, with content search capabilities and options to download or view the full log in another window.