Actor Descriptor

Skip to examples

The fluid descriptor for provisioning an Actor. An Actor refers to a platform managed identity that can be assumed by bot entities external to the platform, in order to access data on platform.

Specification

JSON Schema

1
2
# actor
# The fluid descriptor for provisioning an Actor. An Actor refers to a platform managed identity that can be assumed by bot entities external to the platform, in order to access data on platform.

apiVersion: "v1alpha1"          # [required] [enum] The current version of this resource | Choose one of either: v1alpha1
id: "id"                        # [required] [ari] A unique identifier for the resource being described
name: "name"                    # [required] [non-empty string] The name of the actor
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
owner: "owner"                  # [required] [non-empty string] StaffID of the owner of the actor - for asset attribution purposes
organization: "organization"    # [required] [non-empty organization] Cost center/Department that owns the resource for cost attribution purposes. go/stalk/<staffID> for cost center, and go/fpa for more info
identities:                     # [required] [non-empty array] A list of external identities allowed to assume this actor.
  # Any of:
  - asap: "asap"                # [optional] [non-empty string] The ASAP issuer of the actor
  # End any of

Examples

full-actor

1
2
apiVersion: v1alpha1
id: ari:cloud:data-lake::descriptor/actor/c35c0056-654e-4571-b0be-827455fb00f0
name: full_actor
summary: A fully defined actor descriptor for example purposes.
owner: pperson16
organization: Analytics Platform Eng
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"
identities:
  - asap: micros/my-cool-service
  - asap: my-issuer