stado web declare
Invocation
stado web declare [OPTIONS] --hostname <HOSTNAME> <NAME>Purpose
Declare a web product: where it runs, as whom, and on which hostname. With `--redirect-to` the product is a hostname and a target and nothing else: the edge answers it with a 308 and there is no unit, no release and no host, so `--host`, `--port` and `--consumer` are refused beside it.
Required inputs and options
| Input or option | Contract |
|---|---|
<NAME> | Product name, matching `product` in its `.wisent-release.json` |
--host <HOST> | Registry target the unit runs on |
--port <PORT> | Loopback port the unit listens on |
--hostname <HOSTNAME> | Public hostname the product answers on |
--consumer <CONSUMER> | Skarbiec consumer identity the unit runs as |
--redirect-to <REDIRECT_TO> | Where this hostname redirects, instead of running a unit: an https URL with a host and no query or fragment |
--path-prefix <PATH_PREFIX> | A path prefix under a hostname another declaration owns, for a unit product mounted inside that hostname's site block |
--upstream-service <UPSTREAM_SERVICE> | A registry service this hostname is published in front of, instead of a unit this product owns. The service directory answers which host it is active on and which address it serves |
--readyz <READYZ> | Request path that proves the unit is ready [default: /] |
--edge <EDGE> | Which edge terminates TLS for the hostname [default: stado] [possible values: stado, cloudflare] |
--env <ENV> | Plain environment entry, `NAME=value`; repeatable |
--secret <SECRETS> | Secret environment entry, `NAME=item#field`; repeatable |
--database <DATABASE> | Declared database the product reads |
--database-field <DATABASE_FIELD> | Field of the database's Skarbiec item to deliver [default: pooler_url] |
--database-variable <DATABASE_VARIABLE> | Variable the database field is delivered as [default: DATABASE_URL] |
--json | Emit machine-readable output |
Output and state effect
It performs the operation described above and emits its operator result on standard output or standard error. Any state change is limited to the resources and records named by the purpose and options on this page.
Refusals
- Before dispatch, Stado refuses a missing required token shown in the invocation, an unknown option, or a value outside a listed value set; argument-usage failures exit with code 2.