Release v20200727

.gitignore

@@ -202,5 +202,6 @@ tags
 
 # exclude docker env files
 docker/.env
+
+# exclude data dump files
 *.dump
-!data/dispatch-sample-data.dump

docker/.env.example

@@ -15,7 +15,7 @@ JWKS_URL=""
 # Incident configuration
 INCIDENT_NOTIFICATION_CONVERSATIONS=""
 INCIDENT_NOTIFICATION_DISTRIBUTION_LISTS=""
-INCIDENT_STORAGE_ARCHIVAL_FOLDER_ID=""
+INCIDENT_STORAGE_FOLDER_ID=""
 INCIDENT_STORAGE_DRIVE_ID_SLUG=""
 
 # Plugin configuration

docs/SUMMARY.md

@@ -15,9 +15,10 @@
   * [App](configuration/app.md)
   * [Plugins](configuration/plugins/README.md)
     * [Configuring G Suite](configuration/plugins/configuring-g-suite.md)
-    * [Configuring Slack](configuration/plugins/configuring-slack.md)
-    * [Configuring PagerDuty](configuration/plugins/configuring-pagerduty.md)
     * [Configuring Jira](configuration/plugins/configuring-jira.md)
+    * [Configuring Opsgenie](configuration/plugins/configuring-opsgenie.md)
+    * [Configuring PagerDuty](configuration/plugins/configuring-pagerduty.md)
+    * [Configuring Slack](configuration/plugins/configuring-slack.md)
     * [Configuring Zoom](configuration/plugins/configuring-zoom.md)
 * [CLI](cli.md)
 * [Contributing](contributing/README.md)

docs/cli.md

@@ -205,6 +205,12 @@ The `upgrade` and `downgrade` commands manage how `alembic` database migrations
 > dispatch database upgrade
 ```
 
+### Restore/Dump
+
+The `restore` and `dump` commands allow you to quickly backup and restore the Dispatch database. They can also be used to load our [example](https://github.com/Netflix/dispatch/blob/develop/data/dispatch-sample-data.dump) data set into your Dispatch installation.
+
+Today, the `.dump` file must be located in `$CWD` and must be named `dispatch-backup.dump`
+
 ## Plugins
 
 The `plugin` command contains all of the logic for dealing with Dispatch's plugins.

docs/configuration/app.md

@@ -193,13 +193,13 @@ Dispatch [calculates](https://github.com/Netflix/dispatch/blob/develop/src/dispa
 
 ### Incident Resource Configuration
 
-#### `INCIDENT_STORAGE_ARCHIVAL_FOLDER_ID`
+#### `INCIDENT_STORAGE_FOLDER_ID`
 
-> Controls the folder where to archive incident information.
+> Top level folder where all incident data is stored. Note: viewing actual incident data is still on a per-sub folder basis.
 
-#### `INCIDENT_STORAGE_RESTRICTED` \[default: 'True'\]
+#### `INCIDENT_STORAGE_OPEN_ON_CLOSE` \[default: 'true'\]
 
-> Controls whether a set of restrictions and capabilities to prevent content sharing need to be applied.
+> After an incident is closed, Netflix as an organization, tries to be transparent and allow others within the organization to view incident data. This is may not desirable in all organizations. This controls whether to open up incident data on incident close.
 
 #### `INCIDENT_NOTIFICATION_CONVERSATIONS` \[default: ''\]
 
@@ -240,3 +240,4 @@ Dispatch [calculates](https://github.com/Netflix/dispatch/blob/develop/src/dispa
 #### `INCIDENT_RESOURCE_INCIDENT_REVIEW_DOCUMENT` \[default: 'google-docs-incident-review-document'\]
 
 > Controls the resource type to use for the incident review document.
+

docs/configuration/plugins/configuring-g-suite.md

@@ -4,41 +4,43 @@ description: Configuration page for all G Suite plugins.
 
 # Configuring G Suite
 
-By default Dispatch ships with several G Suite plugins \(Docs, Groups, Drive, etc.,\). This page documents the available configuration for these plugins and the permissions required to enable them.
+{% hint style="info" %}
+Dispatch ships with several G Suite plugins \(Docs, Groups, Drive, etc.,\). This page documents the available configuration for these plugins and the permissions required to enable them. These plugins are required for core functionality.
+{% endhint %}
 
-### `GOOGLE_DOMAIN`
+### `GOOGLE_DOMAIN` \[Required\]
 
 > Base domain for which this Google Cloud Platform \(GCP\) service account resides.
 
-### `GOOGLE_DEVELOPER_KEY` \[secret: True\]
+### `GOOGLE_DEVELOPER_KEY` \[Required. Secret: True\]
 
 > This is used by the Google API Discovery Service and prevents rate limiting.
 
-### `GOOGLE_SERVICE_ACCOUNT_CLIENT_EMAIL`
+### `GOOGLE_SERVICE_ACCOUNT_CLIENT_EMAIL` \[Required\]
 
 > Client email for the Google Cloud Platform \(GCP\) service account.
 
-### `GOOGLE_SERVICE_ACCOUNT_CLIENT_ID`
+### `GOOGLE_SERVICE_ACCOUNT_CLIENT_ID` \[Required\]
 
 > Client ID for the Google Cloud Platform \(GCP\) service account.
 
-### `GOOGLE_SERVICE_ACCOUNT_DELEGATED_ACCOUNT`
+### `GOOGLE_SERVICE_ACCOUNT_DELEGATED_ACCOUNT` \[Required\]
 
 > Account to delegate to from the Google Cloud Platform \(GCP\) service account.
 
-### `GOOGLE_SERVICE_ACCOUNT_PRIVATE_KEY` \[secret: True\]
+### `GOOGLE_SERVICE_ACCOUNT_PRIVATE_KEY` \[Required. Secret: True\]
 
 > Private key \(PEM format\) for the Google Cloud Platform \(GCP\) service account.
 
-### `GOOGLE_SERVICE_ACCOUNT_PRIVATE_KEY_ID`
+### `GOOGLE_SERVICE_ACCOUNT_PRIVATE_KEY_ID` \[Required\]
 
 > Private key ID for the Google Cloud Platform \(GCP\) service account.
 
-### `GOOGLE_SERVICE_ACCOUNT_PROJECT_ID`
+### `GOOGLE_SERVICE_ACCOUNT_PROJECT_ID` \[Required\]
 
 > Project ID for the Google Cloud Platform \(GCP\) service account.
 
-### `GOOGLE_USER_OVERRIDE` \[default: None\]
+### `GOOGLE_USER_OVERRIDE` \[Optional. Default: None\]
 
 > Used for development to funnel all emails to a specific user.
 
@@ -89,4 +91,3 @@ Then construct this link and click it:
 https://admin.google.com/AdminHome?clientScopeToAdd=https://www.googleapis.com/auth/documents,https://www.googleapis.com/auth/drive,https://mail.google.com/,https://www.googleapis.com/auth/admin.directory.group,https://www.googleapis.com/auth/apps.groups.settings,https://www.googleapis.com/auth/calendar
 &clientNameToAdd=<INSERTCLIENTIDHERE>&chromeless=1#OGX:ManageOauthClients
 ```
-

docs/configuration/plugins/configuring-jira.md

@@ -5,30 +5,30 @@ description: Configuration options for the Jira plugin.
 # Configuring Jira
 
 {% hint style="info" %}
-By default Dispatch ships with Jira support. Each Jira installation is unique, so you will likely want to create a Jira specific plugin for your organization.
+Dispatch ships with Jira support. Each Jira installation is unique, so you will likely want to create a Jira specific plugin for your organization. This plugin is not required for core functionality, however a plugin of type `ticket` must always be enabled.
 {% endhint %}
 
-## `JIRA_BROWSER_URL`
+## `JIRA_BROWSER_URL` \[Required\]
 
 > URL for Jira browser links.
 
-## `JIRA_API_URL`
+## `JIRA_API_URL` \[Required\]
 
 > URL for the Jira API server.
 
-## `JIRA_USERNAME`
+## `JIRA_USERNAME` \[Required\]
 
 > Username for the Jira service account.
 
-## `JIRA_PASSWORD` \[secret: True\]
+## `JIRA_PASSWORD` \[Required. Secret: True\]
 
 > Password for the Jira service account.
 
-## `JIRA_PROJECT_KEY`
+## `JIRA_PROJECT_KEY` \[Required\]
 
 > Key for Jira project.
 
-## `JIRA_ISSUE_TYPE_ID`
+## `JIRA_ISSUE_TYPE_ID` \[Required\]
 
 > Id for Jira issue type.
 

docs/configuration/plugins/configuring-opsgenie.md

@@ -0,0 +1,17 @@
+---
+description: Configuration options for the Opsgenie plugin.
+---
+
+# Configuring Opsgenie
+
+{% hint style="info" %}
+Dispatch ships with support for resolving oncall schedules via the Opsgenie API. Below, is how to configure the Opsgenie plugin to work with `Dispatch`. This plugin is not required for core functionality, however a plugin of type `oncall` must always be enabled.
+{% endhint %}
+
+## `OPSGENIE_API_KEY` \[Required. Secret: True\]
+
+> Opsgenie API key.
+
+## `OPSGENIE_TEAM_ID` \[Required\]
+
+> Id for the Opsgenie team.

docs/configuration/plugins/configuring-pagerduty.md

@@ -1,16 +1,17 @@
 ---
-description: Configuration options for PagerDuty plugin.
+description: Configuration options for the PagerDuty plugin.
 ---
 
 # Configuring PagerDuty
 
-By default Dispatch ships with support for resolving oncall schedules via the PagerDuty API.
+{% hint style="info" %}
+Dispatch ships with support for resolving oncall schedules via the PagerDuty API. Below, is how to configure the PagerDuty plugin to work with `Dispatch`. This plugin is not required for core functionality, however a plugin of type `oncall` must always be enabled.
+{% endhint %}
 
-## `PAGERDUTY_API_KEY` \[secret: True\]
+## `PAGERDUTY_API_KEY` \[Required. Secret: True\]
 
-> PagerDuty API Key.
+> PagerDuty API key.
 
-## `PAGERDUTY_API_FROM_EMAIL`
+## `PAGERDUTY_API_FROM_EMAIL` \[Required\]
 
 > Email to be added to all outgoing incident pages.
-