carlos / carloku Public

Download this file

1	# The console
2
3	[console.carloku.com](https://console.carloku.com) is the same platform your
4	terminal talks to, with a browser in front of it. You sign in with a passkey
5	through Keymail, and the account you sign in to is the one
6	`carlos auth login` connects a terminal to — the short code the CLI prints
7	is approved in this browser.
8
9	Most weeks you will barely open it. Deploys, config, logs and domains are all
10	commands, and the console reads the records those commands write. Where it
11	earns its place is the handful of jobs with no command behind them, and
12	looking at an app somebody else on your team deployed.
13
14	## What each page shows
15
16	The bar across the top is per account: Apps, Fleet, Team and Settings, plus
17	a switcher for moving between accounts when you belong to more than one.
18
19	Apps is the list: each app's name, the address it answers on, a health chip,
20	and the version live right now. A Trash link appears under it once something
21	is in it. Opening an app gives you six tabs.
22
23	Overview answers *is it up* in a sentence — the hostname, the running version,
24	when it was published and by whom — then tiles for running copies, CPU and
25	memory, web addresses and versions, and a left-to-right diagram of the
26	channels a version travels through. [Channels](/docs/channels/) explains what
27	that diagram is drawing.
28
29	Versions is the release history. Every version you have shipped with its
30	label, kind and build time and a promote control per row; underneath, the
31	channels, what each holds, when a baked version goes live, and rollback.
32	Canaries and semver tags sit at the bottom of the same page.
33
34	Running is the copies themselves — address, health, version, channel, CPU,
35	memory — and where the app is placed. A copy reading *asleep* is annotated
36	there as waking on the next request, which [Restarting and
37	sleeping](/docs/sleeping/) explains at more length.
38
39	Logs is the window `carlos logs` prints, with a form for narrowing it.
40	Activity is the other one: when, who, what, for every change made to this
41	app. That record has no CLI verb, so the console is where you read it.
42
43	Settings carries the app's name and rename, its domains with their DNS and
44	TLS state alongside the attach form, its object store, its email
45	configuration, a link through to the pipeline rules, and deletion.
46
47	Back at account level, Fleet answers where this account's work actually runs:
48	the shared platform boxes your apps are placed on, and any boxes of your own.
49	Team and Settings are the subject of [Members and service
50	credentials](/docs/members/).
51
52	## Jobs that only happen here
53
54	Approving a terminal is the first one you meet: `carlos auth login` prints a
55	code, and nothing is granted until you type it into the console and confirm.
56
57	The rest cluster around authority and permanence. Inviting a teammate,
58	removing one and handing over ownership live on the Team page; minting,
59	rotating and revoking a credential a server holds live on Account settings.
60
61	Deletion is the other cluster. A deleted app goes to Trash and stays
62	restorable for 30 days, keeping its releases, channels and history.
63	Restoring gives all of that back with no routes, so the app comes back with
64	nowhere to serve from until you make one:
65
66	```sh
67	carlos instances create -app hello -host hello.bdf.oncarlos.com
68	```
69
70	That is the same command [Deploying](/docs/deploying/) names when a channel
71	has no instance following it. The console's own confirmation currently tells
72	you to run `carlos add` instead — don't. That verb edits a box's route
73	registry from the box, and your app doesn't come with a box you can log in
74	to.
75
76	An owner can also destroy an app immediately from the same page; that asks
77	for the app's name typed out and then for your passkey.
78
79	And when the day's app-creation budget is spent, the console's Create app
80	form is the way through — it has no limit of its own. [Limits and getting
81	help](/docs/limits/) has the numbers.
82
83	## Your own settings
84
85	Your address in the header opens a page listing every terminal signed in as
86	you: where it signed in from, when, when it was last used, and when it
87	expires. Each row has a revoke control. A laptop that went missing is the
88	reason this page exists — revoking there kills that terminal's access
89	without touching anyone else's.
90