Skip to content
Install

Create a status page

A status page tells your users whether your apps and databases are up, without giving them an Orchard account. Orchard sets each component’s status from the state of the cluster, so the page stays current without anyone updating it. Because of this, you cannot set a status or post an incident message by hand.

  • For the dashboard, the Owner role in the organization.
  • For the CLI, the Owner or Admin role in the organization.
  • For a host, BASE_DOMAIN set on your instance.
  1. Go to Organization settings > Status page.
  2. Select New page.
  3. In Title, enter the page title.
  4. In Slug, enter the path for the page. The page is served at /status/<slug>.
  5. (Optional) In Host, enter a subdomain of your instance domain.
  6. (Optional) In Description, enter a line of text to show below the title.
  7. In Components, select Add an app or database, then select a resource. Repeat this step for each resource.
  8. (Optional) Change the name of a component. Use the arrows to change the order.
  9. Keep Public turned on.
  10. Select Create page.

The page appears in the Status pages list with its URL.

ItemLimit
Pages10 for each organization
Components40 for each page
Title1 to 120 characters
Description500 characters
Slug3 to 64 characters: lowercase letters, digits, and hyphens
Host3 to 50 characters: letters, digits, and hyphens

Slugs and hosts are unique across the instance. The slugs new, edit, resolve, api, and admin are reserved. Common hosts, such as www, api, status, and docs, are also reserved.

StatusAppDatabase
OperationalAll replicas are ready and no alert is firing.The database is ready.
DegradedSome replicas are not ready or are crashing, or an alert is firing.The database is restoring, creating, starting, scaling, or updating.
OutageNo replicas are ready.The database is restarting repeatedly, or it has failed.
MaintenanceThe app is stopped or is being removed.The database is stopped.
No dataOrchard has no cluster data for the app, or the app no longer exists.The state is not known, or the database no longer exists.

The banner at the top of the page shows the worst status of all components:

BannerCondition
All systems operationalNo component is degraded or down.
Partial outageAt least one component is degraded.
Major outageAt least one component is down.

Each component shows bars for the last 30 days and an uptime percentage.

For apps, a crashing or failed pod opens an incident. The next ready pod closes the incident. Orchard merges incidents that are less than five minutes apart.

For databases, the page shows only the current incident. Past database incidents do not appear in the history.

The page lists up to 20 incidents. Replica shortages and firing alerts change a component’s status, but they do not create incidents.

A host serves the page at <host>.<your instance domain>. When you save a host, Orchard creates an Ingress and requests a certificate through cert-manager.

DNS for the host must point to your cluster. If you use a wildcard DNS record for your instance domain, no other DNS change is needed. The issuer and Service that these hosts use are set in Base domain.

To remove a host from the CLI, run the following command:

orchard status-page update <pageId> --no-subdomain

In the dashboard, clear the Host field and select Save.

To hide a page, turn off Public. Visitors to a hidden page see There is no status page here.

From the CLI, run the following command:

orchard status-page update <pageId> --private

To show the page again, turn on Public or use --public.

Deleting a page removes its host and its component list. The page stops loading for all visitors.

  1. Go to Organization settings > Status page.
  2. On the page, select the delete icon.
  3. Select Delete page.