Skip to main content

Overview

After logging in you land on the Dashboard. Every screen in the GUI shares the same frame: the top bar, for searching and starting runs, and the navigation bar on the left, for moving between screens.

The dashboard, with the top bar and navigation bar

KeyElementKeyElement
ANavigation bar toggleGNavigation bar
BSearchHManage activity count
CActive runsIManage security and Administration
DRunJVersions
ETheme toggleKDashboard time range
FUser menuLPanel controls

The top bar​

ElementFunction
Navigation bar toggleCollapse or expand the navigation bar.
Instance nameShown beside the logo when your administrator has given the instance a title. Hover over it to see the support contact. See instance info.
SearchSearch pages, resources, steps and activity, or run a command. Press Ctrl+L (⌘+L on a Mac) to open it from anywhere. See search.
CompareShown while you have a project, environment, asset or agent pinned for comparison. See project details. A pinned change is shown the same way. See comparing two changes.
NewCreate a project, environment, asset, agent, template, template version, Git remote, workflow or policy from any screen. See creating and editing from anywhere.
Active runsThe number of changes and workflow runs currently in flight that you can access, leaving out archived activity. Select it to list them.
RunRun a change or a workflow, or run bulk changes.
Theme toggleSwitch between the light and dark themes.
User menuMy account, Display name (local users only, to set the name the GUI shows for you), Manage all notifications, Secret management and Logout. The foot of the menu shows who you are logged in as. Secret management has a Secret vault tab to store or retrieve secret values and files in the secret vault, and an AES encryption tab to encrypt values without touching the vault. Values are hidden as you type them and when they are retrieved; select the eye button to show one.

My account​

Select My account from the user menu to manage your own settings. It has three tabs:

TabFunction
Notification preferencesThe channels OpsChain notifies you on, and browser notifications. See user preferences. The bell on a change or workflow run page opens the same preferences without leaving the page.
Secret vault credentialsThe secret vault credentials OpsChain uses when you store or read secrets. The table lists your credentials by secret vault: a Session credential comes from signing in and ends when you sign out, and a Registered credential is a token you added, which you can change with Replace token or remove with Delete. A card above the table names the global secret vault and says which credential OpsChain is using for it, or that you have none. Use Add credential to choose a vault, the bundled secret vault or an external one, and register a token for it. The list of vaults leaves out those you already hold a credential for, and no vault is chosen for you unless you opened the dialog from an error naming one. See secret vault credentials.
API keysYour API keys, when each expires and whether it has secret vault access. Create API key takes a Description and an Expiry date (90 days by default, at most a year); entering your password in Give this key secret vault access lets the key read and write secrets as you. The key's token is shown once, when it is created. Where a key cannot reach the secret vault, its Create a new key with vault access button starts a replacement that can. Select Revoke on a key, or select several and choose Revoke API keys from Bulk actions, to remove keys you no longer need. See API keys.

When OpsChain cannot store or read a secret because you have no credential for its secret vault, the error links to the Secret vault credentials tab with Add credential open for that vault.

The navigation bar​

ItemScreen
DashboardThis screen - see the dashboard.
ProjectsYour projects and everything in them: environments, assets, agents, templates, Git remotes, workflows, properties and settings. See projects.
ActivityEvery change and workflow run available to you, with filters. See activity.
Scheduled activityChanges and workflow runs scheduled to run later, on a repeat, or on new commits. See scheduled activities.
WorkflowsThe workflow list and editor. See workflows.
ArtifactsEvery artifact you can read, across all projects. See artifacts.
Audit historyEvents raised across OpsChain. See audit history.
Manage activitySteps waiting for your approval or continuation, or for someone in your LDAP groups. A count beside it shows how many are waiting. See manage activity.
Manage securityAuthorisation policies, users and groups, and, for superusers, secret vault policies. See manage security.
AdministrationSystem information, configuration, data cleanup, remote runners and the licence.

Manage security and Administration are listed for every user, but some of the actions on those screens are available only to superusers. Below them, Versions opens the version info dialog.

The dashboard​

The dashboard charts the changes and workflow runs created in a time range you choose, as a grid of panels, alongside panels showing what is happening now, such as the steps waiting for your approval and the most recent activities.

Dashboard chart drill-down

The toolbar above the panels sets the time range: a calendar period such as Today, Last week or This month, a period up to now such as Last 7 days, or From and To dates and times. The arrows either side of From and To move them a day at a time. The line beneath the toolbar states the exact period the figures cover, in your time zone, and each figure is compared with the period before it - the previous month for This month, for example. The toolbar also groups the charts by hour, day, week or month, limits them to changes or workflows, and to the projects you pick. Archived activity is left out unless you tick Include archived, which also lets you pick archived projects - unticking it drops any archived project from your selection. The refresh button fetches the figures again, and its dropdown refreshes them automatically. As the screen narrows, these controls fold into the Filters button one at a time.

Click a segment, bar or point on a chart to list the changes and workflow runs behind it. Type in Quick search to filter the list, and click a run to open its activity details.

Arranging the dashboard​

Open Add panels to see every panel with its description, and drag a panel onto the dashboard. Drag a panel by its title bar to move it, and by its bottom-right corner to resize it; hover over it and click the cross to remove it. The button beside Add panels resets the dashboard to its default layout.

Add panels list

The layout and the toolbar settings are saved in your browser, so the dashboard looks the same next time you open it there. On a narrower screen the panels reflow into fewer columns, and a layout you arrange at that width is kept for it.

Creating and editing from anywhere​

Projects, environments, assets, agents, templates, template versions, Git remotes, workflows and policies can be created and edited from any screen, without first opening the screen they belong to.

  • Create - choose the kind of resource from New in the top bar (Alt+N), or search for it, for example create an asset. Where it belongs - its project, environment or template - starts as the one you are viewing, and can be changed in the form. New lists only what you are permitted to create, and is hidden if you can create nothing.
  • Edit - search for edit, update or rename followed by the resource's name, for example edit dev - see search commands. On a resource's own page, its edit button opens the same form.

Opened away from the resource's own page, the form shows the project, environment and asset the resource belongs to, each linking to its page, so you can check you have the right one before saving.

Saving leaves you where you were, and a notification links to the saved resource. Where a form needs something that does not exist yet - a Git remote for a template, or a template for an asset - use the link beneath that field, for example Create a Git remote, to create it in a second form over the first. Saving or closing the second form returns you to the first as you left it, with the new resource ready to pick.

Creating a workflow opens a new draft in the workflow editor. Editing a workflow opens it in the editor, and editing a policy opens its rules; Rename changes their name and description.

Downloading lists and logs​

The activity, projects, environments, assets and agents lists each have a CSV button that downloads every row matching the current filters as a CSV file. The activity download lists its changes and workflow runs oldest first, whatever sort the list is using. Each file is named after the project, environment or asset the list belongs to — bank_dev_assets.csv for the assets of the dev environment in the bank project, for example.

Each log viewer, and the log dialog on the pods screen, has a Download button that saves the whole log as a .log file, oldest line first, with each line's timestamp and category. A change's log download includes its child steps' lines when the viewer is showing them.

Both downloads stream from the server straight to disk, so a large list or log does not have to load in the browser first. The buttons are disabled, with the tooltip Nothing to download, while the list or log is empty.

Keyboard shortcuts​

These shortcuts work from any screen in the GUI.

ShortcutAction
Ctrl+L (⌘+L on a Mac)Open or close search.
/Open search, while you are not typing in a field or editor.
Alt+N (⌥+N on a Mac)Open the New menu, while you are not typing in a field or editor. See creating and editing from anywhere.
Alt+C (⌥+C on a Mac)Open the run change dialog.
Alt+W (⌥+W on a Mac)Open the run workflow dialog.
Alt+B (⌥+B on a Mac)Open the run bulk changes screen, starting from the project, environment or asset you are viewing.
Alt+E (⌥+E on a Mac)Open Secret management on its Secret vault tab. Does nothing unless you have access to secret management.
?List these shortcuts, while you are not typing in a field or editor.
EscClose the dialog on top. With one dialog open over another, only the top one closes.

Some screens add shortcuts of their own:

  • The search dialog has shortcuts for moving between tabs and results - see search keyboard shortcuts.
  • The workflow editor's Quick add buttons insert step snippets with Ctrl/⌘+1 to 6 - see editor pane.
  • In a step tree, Ctrl+F (⌘+F on a Mac) jumps to the tree's search box in place of the browser's find, and the search moves between matches with Enter and Shift+Enter - see navigating the step tree view.
  • The JSON editors for properties and settings list their shortcuts under Shortcuts - see editor shortcuts.