Skip to content
This repository has been archived by the owner on Jan 29, 2024. It is now read-only.

Commit

Permalink
[Planned for January] Update and consolidate support documentation (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
staceysalamon-aiven committed Jan 3, 2024
1 parent 05385d7 commit c81a4ed
Show file tree
Hide file tree
Showing 7 changed files with 116 additions and 62 deletions.
1 change: 1 addition & 0 deletions .github/vale/dicts/aiven.dic
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,7 @@ UDFs
unassign
uncomment
unencrypted
unfollow
United States
Unschedule
untrusted
Expand Down
4 changes: 4 additions & 0 deletions _redirects
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,13 @@
/docs/products/opensearch/howto/list-upgrade /docs/products/opensearch/howto
/docs/products/opensearch/howto/upgrade-to-opensearch /docs/products/opensearch/concepts/opensearch-vs-elasticsearch
/docs/tutorials /docs/integrations
/docs/platform/howto/list-support /docs/platform/howto/project-support-center
/docs/platform/howto/change-support-tier /docs/platform/howto/project-support-center
/docs/platform/concepts/service-level-agreement /docs/platform/howto/project-support-center
/docs/products/postgresql/reference/list-of-advanced-params /docs/products/postgresql/reference/advanced-params
/docs/products/kafka/reference/kstream-data-write-issue https://aiven.io/changelog#06-12-2023


# Moved to https://aiven.io/developer
/docs/tools/terraform/reference/cookbook https://aiven.io/developer/terraform
/docs/tools/terraform/reference/cookbook.html https://aiven.io/developer/terraform
Expand Down
10 changes: 3 additions & 7 deletions _toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ entries:
- file: docs/platform/howto/billing-google-cloud-platform-marketplace-subscription
title: Set up Google Cloud Marketplace subscriptions
- file: docs/tools/aiven-console
- file: docs/platform/concepts/beta_services
- file: docs/platform/howto/feature-preview

# -------- ORGANIZATIONS, UNITS, PROJECTS --------
Expand Down Expand Up @@ -1390,11 +1391,6 @@ entries:
title: Troubleshoot connection issues

# -------- SUPPORT --------
- file: docs/platform/howto/list-support
- file: docs/platform/howto/project-support-center
title: Support
entries:
- file: docs/platform/howto/project-support-center
- file: docs/platform/howto/change-support-tier
title: Upgrade your support tier
- file: docs/platform/concepts/service-level-agreement
- file: docs/platform/concepts/beta_services

6 changes: 0 additions & 6 deletions docs/platform/concepts/service-level-agreement.rst

This file was deleted.

31 changes: 0 additions & 31 deletions docs/platform/howto/change-support-tier.rst

This file was deleted.

6 changes: 0 additions & 6 deletions docs/platform/howto/list-support.rst

This file was deleted.

120 changes: 108 additions & 12 deletions docs/platform/howto/project-support-center.rst
Original file line number Diff line number Diff line change
@@ -1,24 +1,67 @@
Get support in the Aiven Console
=================================
Support
========

Aiven is committed to providing excellent and responsive support to all of our customers. We monitor our services 24/7 and rapidly address any anomalies.
The Basic support tier is provided to all customers on paid service plans. Aiven offers three additional support tiers with faster response times, phone support, and other services. For more information about the tiers, check out the `Aiven support details page <https://aiven.io/support-services>`_ or contact sales@Aiven.io.

The Basic support tier is provided to all customers on paid plans. If you are using a free service, you can ask questions in the Aiven Community Forum.
For other services included in your support tier - such as business reviews or disaster recovery planning - contact the sales team at sales@Aiven.io. If you are using a free service, you can ask questions in the `Aiven Community Forum <https://aiven.io/community/forum/>`_.

In addition to the Basic support tier, we offer three additional tiers that offer faster response times, phone support, and other services. For more information about support plans, please see `Aiven support details page <https://aiven.io/support-services>`_ or contact sales@Aiven.io to discuss the paid support options.
The Aiven service level agreement (SLA) is available on `the SLA page <https://aiven.io/sla>`_. Custom SLAs are available for premium plans. Contact the sales team at sales@Aiven.io for more details.


.. _upgrade-support-tier:

Upgrade your support tier
~~~~~~~~~~~~~~~~~~~~~~~~~~

If you have questions or want to downgrade your support tier, contact your account team.

To upgrade your organization's support tier in the `Aiven Console <https://console.aiven.io/>`_:

#. In the organization, click **Support**.

#. In the **Current support tier** section, click **Upgrade to Enterprise**.

#. Choose the support tier you want to upgrade to and click **Choose tier**.

#. Select a **Start date**.

.. note::
If you select the current month, you will be charged a percentage of the total service spend for the whole month, starting from the 1st.

#. Select a **Billing group**.

.. important::
The support costs for all current and future services in the selected organization and all of its organizational units will be added to the invoice for this billing group.

#. Click **Upgrade tier**.

It typically takes 1-2 business days to set up the new support tier. You can view the status of your request on the support page under **Current support tier**.

You can create and track support tickets in the `Aiven Console <https://console.aiven.io/>`_ following the instructions on this page. For other services included in your support tier - such as business reviews or disaster recovery planning - contact the sales team at sales@Aiven.io.

Create a support ticket
~~~~~~~~~~~~~~~~~~~~~~~~

To create support tickets in the `Aiven Console <https://console.aiven.io/>`_:
#. In the `Aiven Console <https://console.aiven.io/>`_, click **Support**.

#. Click **Support**.
#. Click **Go to Aiven Support Center**.

#. Click **Create ticket**.

#. Enter a **Subject** and detailed **Description** of the issue.
#. Enter email addresses to CC in the support ticket. All new comments and updates will be sent to these emails.

#. Enter a **Subject**.

#. Select a **Severity** level:

* Low: The primary functions are working, but some secondary functionality is not working.
* High: The primary functions are working, but severely limited or slow.
* Critical: The primary functions are not working and it's not possible to find workarounds.

#. Optional: Enter the ID of the affected projects and services.

#. Select the affected **Product** and the reason for creating the ticket.

#. Enter a detailed **Description** of the issue.

.. note::

Expand All @@ -29,10 +72,63 @@ To create support tickets in the `Aiven Console <https://console.aiven.io/>`_:
* Any error messages
* Any languages or frameworks you are using

#. Select the affected project, service, and a severity level.
#. Optional: Upload files such as screenshots, logs, or :ref:`HAR files <create-har-files>`.

.. important::
Aiven support will never ask you to provide sensitive data such as passwords or personal information. Remove or replace sensitive data in files that you attach to a support ticket.

#. Click **Create ticket**.

The new support ticket is sent to our support team for review and you also receive a confirmation email. `Response times <https://aiven.io/support-services>`_ vary by case severity and support tier.
You can track the status of your tickets on the **My tickets** page. `Response times <https://aiven.io/support-services>`_ vary by case severity and support tier. If you are not satisfied with the processing of your ticket, add ``#escalate`` in the comments.


Add participants to a support ticket
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you want to give every organization user access to all support tickets in your organization contact your account team.

To add Aiven users to a support ticket:

#. On the **My tickets** page, open the ticket.

#. Click **Add to conversation**.

#. Add the email addresses in the **CC** field separated by a space. This must be the same email address they use to log in.

#. Enter a comment and click **Submit**.


Get notifications for all support tickets
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Super admin can get notifications for updates on all tickets in their organization.

#. Click **My tickets**.

#. On the **Tickets in my organization** tab, click **Follow all tickets**.

You will get email notifications for all updates on both existing and new tickets. You can unfollow them at any time.


.. _create-har-files:

Create HAR files
~~~~~~~~~~~~~~~~~

The support team may need information about the network requests that are generated in your browser when you experience a problem. Browsers can capture a log of these network requests in a HAR (HTTP Archive) file.

If the support team asks for a HAR file:

#. Use your browser to create the HAR file while you go through the steps to reproduce the problem:

* Follow the `instructions for Internet Explorer/Edge, Firefox, and Chrome <https://toolbox.googleapps.com/apps/har_analyzer/>`_.
* For Safari, make sure you can access the `developer tools <https://support.apple.com/en-ie/guide/safari/sfri20948/mac>`_ and then follow the instructions for `exporting a HAR file <https://webkit.org/web-inspector/network-tab/>`_.

#. Replace sensitive data in the file with placeholders while retaining the JSON structure and format. Examples of sensitive data include:

* Personal identifiers such as email addresses and phone numbers
* Authentication tokens or passwords
* Sensitive URLs
* Sensitive cookies or headers

You can track the status of your tickets from the project support center, but information and updates are sent directly to your email address. You can update your ticket's details and communicate with the support team by replying to these emails. If you are on a paid support tier, your account team is also notified.
#. Send the sanitized file to the support team in your reply to their email or in the ticket's comments.

0 comments on commit c81a4ed

Please sign in to comment.