Skip to content

Commit af0d594

Browse files
eakmanrqtreysp
andauthored
feat: add docs for reporting incidents in cloud (#4710)
Co-authored-by: Trey Spiller <1831878+treysp@users.noreply.github.com>
1 parent e748f6f commit af0d594

3 files changed

Lines changed: 47 additions & 0 deletions

File tree

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Incident Reporting
2+
3+
We monitor Tobiko Cloud 24/7 to ensure your projects are running smoothly.
4+
5+
If you encounter any issues, however, you can report incidents directly in Tobiko Cloud itself.
6+
7+
This will notify our support team, who will investigate and resolve the issue as quickly as possible.
8+
9+
### Reporting an incident
10+
11+
Follow these steps to report an incident in Tobiko Cloud:
12+
13+
1. Visit the [Tobiko Cloud Incident Reporting Page](https://incidents.tobikodata.com/)
14+
2. Select one of the three severity levels for your incident
15+
3. Enter the project name the incident is related to
16+
* The project name is displayed after your organization name in the Cloud UI
17+
4. Write a detailed description of the incident
18+
* Include all relevant information that will help our support team understand and resolve the issue
19+
5. Click the `Submit` button to send your incident report
20+
6. You will receive a confirmation message indicating that your incident has been reported successfully
21+
7. You will hear from our support team after submitting the incident report
22+
23+
![Tobiko Cloud incident reporting page](./incident_reporting/incident_reporting.png)
24+
25+
### Reporting an incident when SSO is unavailable
26+
27+
Single Sign-On (SSO) is the default way to log in to Tobiko Cloud. However, SSO could be down or not working when you need to report an incident.
28+
29+
Tobiko Cloud provides a standalone page that doesn't require SSO so you can report an incident when SSO is not working. The page is unique to your organization.
30+
31+
The standalone URL is available in the incident reporting page when you log in with SSO. Because accessing the standalone URL does not require SSO, you should only share it with staff authorized to report incidents.
32+
33+
To store your standalone incident reporting URL:
34+
35+
1. Visit the [Tobiko Cloud Incident Reporting Page](https://incidents.tobikodata.com/)
36+
2. Click the `Copy Standalone URL` button below the incident reporting section
37+
3. Save this URL in an easily accessible location in case you need to report an incident when SSO is not working
38+
39+
!!! note "Don't wait!"
40+
We recommend copying this URL *right now* so your organization is protected from difficulty reporting an incident.
41+
42+
### SSO not enabled for your organization
43+
44+
SSO login is required for accessing the standalone incident reporting URL.
45+
46+
SSO is enabled by default in Tobiko Cloud. If it is not enabled for your organization, contact your solution architect and ask them to provide you with a standalone incident reporting URL.
12.3 KB
Loading

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,7 @@ nav:
125125
- cloud/features/scheduler/dagster.md
126126
- Security:
127127
- "Security Overview": cloud/features/security/security.md
128+
- "Incident Reporting": cloud/features/incident_reporting.md
128129
# - Observability:
129130
# - cloud/features/observability/overview.md
130131
# - cloud/features/observability/model_freshness.md

0 commit comments

Comments
 (0)