Policy Descriptor

Skip to examples

The fluid descriptor for provisioning a Policy. Policies are used to manage access control in a given platform.

Specification

JSON Schema

1
2
# policy
# The fluid descriptor for provisioning a Policy. Policies are used to manage access control in a given platform.

apiVersion: "v1alpha1"          # [required] [enum] The current version of this resource | Choose one of either: v1alpha1
id: "id"                        # [required] [policy-ari] A unique identifier for the data policy being described
name: "name"                    # [required] [non-empty string] The name of the data policy
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 data policy - for asset attribution purposes
version:                        # [optional] Data policy version
  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] [policy-ari] Identifier of the previous data policy version
conditions:                     # [required] [non-empty array] Conditions that have to be met (OR semantics) before this data policy applies
  # One of:
  - group: "group"              # [optional] [non-empty string] Group a user must belong to for this data policy to apply
  # OR
  - product: "product"          # [optional] [product-ari] The ARI of a data product
  # OR
  - actor: "actor"              # [optional] [actor-ari] Actor this policy applies to
  # End one of
actions:                        # [required] Actions that are permitted under this data policy (provided the `conditions` are met).
  permissions:                  # [required] [non-empty array] Permissions that are permitted under this data policy (provided the `conditions` are met).
    "Read"                      # [required] [enum] Permissions permitted. Only valid option is Read. Updates should be made via fluid descriptors and flows. | Choose one of either: Read

Examples

full-policy

1
2
apiVersion: v1alpha1
id: ari:cloud:data-lake::descriptor/policy/cf1d9c1e-d721-4469-a6be-1815407c3683
name: consumers
summary: Policy to grant read access to socrates consumers
documentation: https://developer.atlassian.com/platform/fluid/
status: Available
owner: pperson16
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"
version:
  major: 1
previous: ari:cloud:data-lake::descriptor/policy/e493e685-eed9-4865-9c39-6f6b8ea820a9
conditions:
  - group: socrates-consumers
  - actor: ari:cloud:data-lake::descriptor/actor/c35c0056-654e-4571-b0be-827455fb00f0
actions:
  permissions:
    - Read