Terraform
Explorer for Workspace Visibility
As your organization grows, keeping track of your sprawling infrastructure estate can get increasingly more complicated. The explorer for workspace visibility helps surface a wide range of valuable information from across your organization.
Open the explorer for workspace visibility by clicking Explorer in your organization's top-level side navigation.
The Explorer page displays buttons grouped by Types and Use Cases. Each button offers a new view into your organization or workspace's data. Clicking a button triggers the explorer to perform a query and display the results in a table of data.
The Types buttons present generic use cases. For example, "Workspaces" displays a paginated and unfiltered list of your organization's workspaces and each workspace's accompanying data. The Use Cases buttons present sorted and filtered results to give you a focused view of your organizational data.
You can sort each column of the explorer results table. Clicking a hyperlinked field shows increasingly specific views of your data. For example, a workspace's modules count field links to a view of that workspace's associated modules.
Clearing a query takes you back to the explorer landing page. To clear a query, click the back arrow at the top left of your current explorer view page.
Permissions
The explorer for workspace visibility requires access to a broad range of an organization's data. To use the explorer, you must have either of the following organization permissions:
- Organization owner
- View all workspaces or greater
Types
The explorer for workspace visibility supports four types:
Use cases
The explorer for workspace visibility provides the following queries for specific use cases:
- Top module versions shows modules sorted by usage frequency.
- Latest Terraform versions displays a sorted list of Terraform versions in use.
- Top provider versions lists providers sorted by usage frequency.
- Workspaces without VCS lists workspaces not backed by VCS.
- Workspace VCS source lists VCS-backed workspaces sorted by repository name.
- Workspaces with failed checks lists workspaces that failed at least one continuous validation check.
- Drifted workspaces displays workspaces with drift and relevant drift information.
- Workspace VCS source displays a subset of workspace data sorted by the underlying VCS repository.
- All workspace versions is a simplified view of your workspaces with current run and version information.
- Runs by status provides a run-focused view by sorting workspaces by their current run status.
- Top Terraform versions lists all Terraform versions by usage frequency
- Latest updated workspaces displays your most recently updated workspaces.
- Oldest applied workspaces sorts workspaces by the date of the current applied run.
Custom filter conditions
The explorer's query builder allows you to execute queries with custom filter conditions against any of the supported types.
To use the query builder, select a type or use case from the explorer home page. Expand the Modify conditions section to show the filter conditions in use for the current query and to define new filter conditions.
Each filter condition is represented by a row of inputs, each made up of a target field, operator, and value.
Choose a target field from the first dropdown to select field that the explorer will run the query against. The options available will vary based on the target field's data type.
Choose an operator from the second dropdown. The options available will vary based on the target field's data type.
Provide a value in the third field to compare against the target field's value.
Click Run Query to evaluate the filter conditions.
Tip: Inspect the filter conditions used by the various pre-canned Use Cases to learn how they are constructed.
You can create multiple filter conditions for a query. When you provide multiple conditions, the explorer evaluates them at query time with a logical AND. To add a new condition, use the Add condition button below the condition list. To remove a condition, use the trash bin button on the right hand side of the condition.
Save a view
You can save explorer views to revisit a custom query or use case.
Note: The ability to save views in the explorer is in public beta. All APIs and workflows are subject to change.
You can save the explorer’s view of your data by performing the following steps:
- Navigate to the Explorer page in the sidebar of your organization.
- Click on a tile in the Types or Use cases section.
- Define a query using the query building interface.
- By default, the explorer displays all available information, but you can adjust which columns you want your view to include.
- Open the Actions dropdown menu and select Save view, saving the last query you performed in the explorer.
- Specify a new, unique name for your saved view.
- Click Save.
When your explorer saves a view, it saves the last query it performed. If you change a query and do not rerun it, the explorer does not save those changes.
After you have saved a view of your data, you can access it from the explorer’s main page underneath the Saved views tab. Saved views keep track of the following attributes:
- The name of the saved view.
- The type of data you are querying, either module, workspace, provider, or Terraform versions.
- The owner of the saved view.
- When the saved view was last updated.
You can rename or delete a saved view from the Saved views tab by opening the ellipsis menu next to a view and selecting either Rename or Delete.
Manage a saved view
Complete the following steps to update a saved view:
- Open the view in the explorer and make changes.
- Open the Actions dropdown menu and select Save view.
Complete the following steps to save a new view based on an existing saved view:
- Open a saved view in the explorer and make changes.
- Open the Actions dropdown menu and select Save as.
- Entering a name for this new saved view.
- Click Save.
Complete the following steps to delete a saved view:
- Open a saved view in the explorer.
- Choose Delete view from the Actions drop-down menu.
- Click Delete when prompted to confirm that you want to permanently delete the view.