Database Descriptor

Skip to examples

The fluid descriptor for provisioning a Database.

Specification

JSON Schema

1
2
# database
# The fluid descriptor for provisioning a Database.

apiVersion: "v1alpha1"          # [required] [enum] The current version of this resource | Choose one of either: v1alpha1
id: "id"                        # [required] [database-ari] A unique identifier for the database being described
name: "name"                    # [required] [non-empty string] The name of the database
summary: "summary"              # [required] [non-empty string] Short description about the resource being described
documentation: "documentation"  # [optional] [uri] URL link to documentation about the resource being described
status: "Archived"              # [optional] [enum] Lifecyle status of the resource being described | Choose one of either: Archived, Available, Decommissioned, Deleted, Deprecated, Development, Preview
managed: "full"                 # [optional] [enum] Indicates if the resource is fully managed (full, or if omitted) or metadata managed (metadata) | Choose one of either: full, metadata
contacts:                       # [optional] Contact objects for the resource being described
  # Any of:
  author:                       # [optional] [non-empty array] List of Slack channels and/or emails to contact for questions about the descriptor
    ## One of:
    - email: "email"            # [optional] [email contact] A contact email address
    ## OR
    - slack: "slack"            # [optional] [non-empty slack contact] Slack channel for contacting or alerting purposes
    ## End one of
  # OR
  support:                      # [optional] [non-empty array] List of Slack channels and/or emails to contact for help about the descriptor
    ## One of:
    - email: "email"            # [optional] [email contact] A contact email address
    ## OR
    - slack: "slack"            # [optional] [non-empty slack contact] Slack channel for contacting or alerting purposes
    ## End one of
  # OR
  operations:                   # [optional] [non-empty array] List of Slack channels and/or on-call schedules to send alerts and notifications related to the descriptor
    ## One of:
    - slack: "slack"            # [optional] [non-empty slack contact] Slack channel for contacting or alerting purposes
    ## OR
    - opsgenie: "opsgenie"      # [optional] [non-empty opsgenie contact] Name of your Opsgenie schedule. Can be found here https://atlassian.app.opsgenie.com/schedule/whoIsOnCall
    ## End one of
  # End any of
product: "product"              # [required] [product-ari] Data product this database belongs to
version:                        # [optional] Version object
  major: 1                      # [required] [integer] The MAJOR version as an integer (min: 1)
  minor: 0                      # [optional] [integer] The MINOR version as an integer (min: 0)
previous: "previous"            # [optional] [database-ari] Identifier of the previous database version
layer: "Consume"                # [required] [enum] Database layer | Choose one of either: Consume, Export, Source, Transform
policies:                       # [optional] [non-empty array] Policies that apply to this database
  "policies"                    # [optional] [policy-ari] The ARI of a data policy

Examples

full-database

1
2
apiVersion: v1alpha1
id: ari:cloud:data-lake::descriptor/database/64e3b877-2d50-442e-b640-382d8d0dda91
name: full_database
summary: A fully defined database descriptor for testing purposes.
documentation: https://developer.atlassian.com/
status: Available
contacts:
  author:
    - email: "pperson16@atlassian.com"
    - slack: "socrates-vnext"
  support:
    - email: "pperson17@atlassian.com"
    - slack: "socrates-vnext"
  operations:
    - opsgenie: "Vaporeon - Example Roster UNPAID"
    - slack: "socrates-vnext"
product: ari:cloud:data-lake::descriptor/product/719d7e21-63ba-4bc5-a9b0-8ce1d2c4a288
version:
  major: 1
previous: ari:cloud:data-lake::descriptor/database/d8dbbc45-6c76-4299-8bc5-81d74450f4cc
layer: Consume
policies:
  - ari:cloud:data-lake::descriptor/policy/cf1d9c1e-d721-4469-a6be-1815407c3683

simple-database

1
2
apiVersion: v1alpha1
id: ari:cloud:data-lake::descriptor/database/3a9d51f4-1462-435e-b5e3-1de7ed847558
name: zone_ape
summary: Analytics Platform Engineering Zone
layer: Consume
product: ari:cloud:data-lake::descriptor/product/dbc950e1-343f-46b6-8706-c58fc390a8a7