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.
Prerequisites
Section titled “Prerequisites”- For the dashboard, the Owner role in the organization.
- For the CLI, the Owner or Admin role in the organization.
- For a host,
BASE_DOMAINset on your instance.
Create a page
Section titled “Create a page”- Go to Organization settings > Status page.
- Select New page.
- In Title, enter the page title.
- In Slug, enter the path for the page. The page is served at
/status/<slug>. - (Optional) In Host, enter a subdomain of your instance domain.
- (Optional) In Description, enter a line of text to show below the title.
- In Components, select Add an app or database, then select a resource. Repeat this step for each resource.
- (Optional) Change the name of a component. Use the arrows to change the order.
- Keep Public turned on.
- Select Create page.
The page appears in the Status pages list with its URL.
To list the apps and databases that a page can show, run the following command:
orchard status-page optionsTo create the page, run the following command:
orchard status-page create --title "Acme status" --slug acme --component deployment:<id> --component database:<id>Components appear in the order you list them.
Limits
Section titled “Limits”| Item | Limit |
|---|---|
| Pages | 10 for each organization |
| Components | 40 for each page |
| Title | 1 to 120 characters |
| Description | 500 characters |
| Slug | 3 to 64 characters: lowercase letters, digits, and hyphens |
| Host | 3 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.
Component status
Section titled “Component status”| Status | App | Database |
|---|---|---|
| Operational | All replicas are ready and no alert is firing. | The database is ready. |
| Degraded | Some replicas are not ready or are crashing, or an alert is firing. | The database is restoring, creating, starting, scaling, or updating. |
| Outage | No replicas are ready. | The database is restarting repeatedly, or it has failed. |
| Maintenance | The app is stopped or is being removed. | The database is stopped. |
| No data | Orchard 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:
| Banner | Condition |
|---|---|
| All systems operational | No component is degraded or down. |
| Partial outage | At least one component is degraded. |
| Major outage | At least one component is down. |
Uptime and incidents
Section titled “Uptime and incidents”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.
Add a host
Section titled “Add a host”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-subdomainIn the dashboard, clear the Host field and select Save.
Hide a page
Section titled “Hide a page”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> --privateTo show the page again, turn on Public or use --public.
Delete a page
Section titled “Delete a page”Deleting a page removes its host and its component list. The page stops loading for all visitors.
- Go to Organization settings > Status page.
- On the page, select the delete icon.
- Select Delete page.
orchard status-page delete <pageId>Related resources
Section titled “Related resources”- Create alert rules - Fire alerts that mark a component Degraded on the status page.
orchard status-pagereference - Everyorchard status-pagecommand and flag.