availability

Prints availability tables for the regional availability page. (Use the av shortcode if you want to use the same glyphs as in the regional availability tables somewhere else.)

{{< availability <product> >}}
{{< availability <product> <another product> <a third product> >}}

This data is based on the human-written YAML files in data/availability:

  • data/availability/locations.yaml lists our datacenters (e.g. NYC1, NYC3) and our regions (e.g. NYC, AMS, SFO). These are used for the column titles in availability tables.

  • data/availability/keys.yaml defines the glyphs for full, limited, and soon.

  • The data/availability/<product>.yaml files define availability for each product in the following format:

    columnTitle: "Example Plans"
    plans:
        - "Example Plan"
        - "Example Plan 2"
        - "Example Plan 3"
    Example Plan:
        nyc3: full
        ams3: limited The largest plan is unavailable.
        blr1: soon Planned for 2050.
    Example Plan 2:
        nyc3: full
        blr1: soon Planned for 2050.
    Example Plan 3:
        nyc3: full
        blr1: soon Planned for 2050.
    
    • columnTitle: This is the title of the first column, like “Droplet Plans” or “Database Engines”.

    • plans: A list of plans for the product. These are the values in the first column.

      For products without plans, like Spaces, plans should list the product name.

    • location: Optional, defaults to datacenters. Either datacenters (e.g. NYC1, NYC3, AMS3) or regions (e.g. NYC, AMS). These are the titles of each column after the first column.

    • Each plan in plans must have a corresponding top level entry with the same name. Nested underneath the top-level entry, list every datacenter or region (matching the list in locations.yaml) with availability (full, limited, or soon). Any text after the first word (full, limited, or soon) is used as hover text on the glyph.

    For products without plans, like Spaces, there should be one top-level entry using the product name.

    Omit unavailable datacenters/regions from the list. If a plan isn’t yet available in any datacenter, like is the case with some DBaaS plans, use none: none to list the plan in the table with no entries.

Examples

Single product availability

{{< availability postgresql >}}

Renders to:

PostgreSQL Machine TypeNYC1NYC3AMS3SFO2SFO3SGP1LON1FRA1TOR1BLR1SYD1
Shared CPU
General Purpose
Storage-Optimized
Memory-Optimized

Multiple product availability

{{< availability kubernetes load-balancers volumes >}}

Renders to:

ProductNYC1NYC3AMS3SFO2SFO3SGP1LON1FRA1TOR1BLR1SYD1
Kubernetes
Load Balancers
Volumes