Run commands from the command palette
Jump to a service, run its deploy, restart and copy commands, find a setting by name, compare environments, open alerts, generate a domain or open a shell, and deploy a repository by pasting its URL, all from the keyboard.
With many services in a project, the canvas is slow to scan and the sheet's tabs are slow to walk. The command palette reaches any service, setting or common action from one prompt.
Before you begin
- The verbs under a service apply inside a project, to the environment on screen. Deploy and restart need the same permissions as the service's right-click menu; a command you cannot run is not listed.
- A deploy in a protected environment asks for approval, as it does from the canvas.
Open the palette
Press Ctrl K (⌘K on a Mac) on any screen, or select the search box in the top bar. Press Esc to close it.
Find a command by typing
The prompt matches the letters you type in order, not side by side: dpl finds Deployments. A match at the start of a word, or letters that sit together, ranks higher. Among similar matches, what you used most recently comes first. The letters that matched are highlighted in each row.
On an empty prompt the list shows Recent (the last three things you opened), Needs attention (services that are not healthy), and Suggested, then everything else. Only ten rows are drawn at a time; the line under the list says how many more there are.
Run a command on a service
Type a service's name. Press Enter to open it, or press → with the caret at the end of the text. A row with a › on its right opens a second level.
The service's name appears as a breadcrumb in the prompt. Pick a command, or type to narrow the list:
- Open the service.
- Deploy latest, which builds the tracked branch of a Git service. For an image service the same command is Redeploy. In a protected environment it reads Request deploy….
- Redeploy, which re-releases what a Git service runs now. It shows only when the service has a running release.
- Restart, which asks you to confirm and then restarts the instances one at a time. It shows only while the service is running.
- Logs, Variables, Deployments, Metrics and Settings, each opening that tab.
- Copy internal URL, the address other services in the environment use.
- Open domain, the service's public or tailnet address. It shows only when the service has one.
- Open variable followed by a key, for each variable set on the service. It opens the Variables tab scrolled to that row.
Press Backspace on an empty prompt, or select the breadcrumb, to go back one level.
A service that exists only in a staged change set offers Review and deploy (or View approval) in place of the deploy and restart commands.
Find a setting by name
Type the name of a setting to list it under every service that has it. Each row reads the service, Settings and the section, for example checkout › Settings › Scaling. Selecting a row opens that service's Settings tab scrolled to the section.
| Type | Jumps to |
|---|---|
replicas, instance size | Scaling |
health check, readiness, port | Processes |
release command, migrate | Release command |
auto-deploy | Source, where the Auto-deploy switch is |
deploy after | Deploy after |
volumes, disk | Storage |
domains, hostname | Networking |
The word you type must be at least three characters and must start a word in the setting's name, so re lists nothing. Add part of a service's name to narrow the rows: replicas checkout.
Run an environment or service action
Some commands are listed only when the thing they act on exists. Type any of the words in the table, or scroll the empty prompt.
| Command | Listed when | What it does |
|---|---|---|
| Compare with NAME… | You are in a project that has another persistent environment. NAME is the environment the comparison opens against. | Opens the Compare environments panel. See Compare and sync environments. |
| Open alerts | The environment has an open or acknowledged alert. The row says how many alerts are open, or that all are acknowledged. | Opens the Alerts panel. See Get alerted when a service crosses a threshold. |
| Recently deleted | Anywhere in the organization. | Opens Settings > Recently deleted. See Restore a deleted resource. |
| Generate domain for NAME | A service's sheet is open, you have the deployer role or higher, your organization has a generated domain base, and the service has no generated domain in this environment yet. | Creates the domain in one step, shows Domain generated, and opens the service's Settings tab at Networking. See Add a custom domain. |
| Open shell in NAME | A service's sheet is open, you have the admin role or higher, and the control plane says the service can have a shell here. A database, an environment with no cluster, a protected environment where the organization has not allowed shells, and an agent too old to open one all hide it. | Opens the service's Instances tab and a terminal in its first running instance. See Open a shell and browse files in an instance. |
| Deploy anyway: NAME | A service's sheet is open in a preview environment, a focused preview skipped the service, and you have the deployer role or higher. | Builds the service from the pull request's head at once. A preview is never protected, so nothing is staged. See Preview environments. |
| Show traffic on the canvas, Show wiring on the canvas | You are in a project. Only the mode that is not showing is listed. | Switches the canvas between Wiring and Traffic. See Projects and environments. |
Deploy a repository by pasting its URL
Paste a repository's address. It can be a web address on GitHub, GitLab or Codeberg, including a link to a file or branch inside it, or any https address that ends in .git. An address that carries a user name or password is not recognized.
Select Deploy owner/repo…. Add to canvas opens on Add from a repository with the repository chosen on the Git connection that serves its host.
If no Git connection serves the host, the dialog says so and offers Add public repository, which adds the repository by its URL. It builds from its Dockerfile as a web service on port 8080. A private repository needs a connection first. See Connect Git providers and registries.
Outside a project the same row opens New project instead.
Verify
After Deploy latest, a toast reads Building NAME from its branch. After Restart, it reads Restarting NAME. After a settings jump, the section's heading flashes once.
Next steps
Get alerted when a service crosses a threshold
Turn on, tune and acknowledge the alert rules of a service. Covers the four rules (volume usage, memory, restart loops and CPU), when an alert opens and resolves, the canvas pill and Alerts panel, and who is notified.
Use the nebula command line
Install the nebula command, log in, and use it to check status, read logs, change variables, deploy, run a command with a service's variables and plan nebula.toml changes from a terminal.