Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support docs #156

Merged
merged 2 commits into from
Nov 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,6 @@ jobs:
run: |
git config --global user.email "[email protected]"
git config --global user.name "gh-actions"
export DOCUSAURUS_IGNORE_SSG_WARNINGS=true
npm ci
npx docusaurus deploy
9 changes: 5 additions & 4 deletions .github/workflows/testing.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ jobs:
with:
node-version: 18.x

- name: Install dependencies
run: npm ci
- name: Test asset build phase
run: yarn build
- name: NPM Build
run: |
export DOCUSAURUS_IGNORE_SSG_WARNINGS=true
npm ci
npm run build
1 change: 1 addition & 0 deletions .naverc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
18
3 changes: 0 additions & 3 deletions babel.config.js

This file was deleted.

99 changes: 99 additions & 0 deletions docs/terranetes-controller/support.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
---
title: "Support and Maintenance Terms of Service"
sidebar_label: "Commercial Support"
sidebar_position: 4
---

:::info

**Interested in commercial support or consultancy services? Please [get in touch](https://www.appvia.io/contact-us)!**

:::

Appvia offers two [subscription plans](#subscription-plans) for its products:

* Standard
* Enterprise

Customers must have an active subscription to one of these plans to be able to access any support services provided by Appvia.

When a customer activates a product subscription, Appvia will onboard the customer's primary support contact to the [Appvia Support Portal](https://support.appvia.io/). Customers will then be able to provide access to the support portal to additional contacts. This will enable those customer contacts to obtain technical support and guidance on using Appvia products.

<br/>

## Service level agreements (SLAs)

The following are the definitions and priority levels referred to in the SLAs for the Standard and Enterprise subscription plans.

<br/>

### Definitions

| Term | Description |
|----------------------------|---------------------|
| **Response** | The time interval from when a customer raises a new issue, to when an Appvia support agent acknowledges the request and starts work on it |
| **Normal Business Hours** | 9am - 5pm local UK time, Monday to Friday excluding UK Bank Holidays |
| **Enhanced Support Hours** | 24 hours a day, 7 days a week, including UK Bank Holidays |

<br/>

### Priority levels

| Priority Level | Description |
| :-------------------------------------------: |---------- |
| **P1** <br />Production System Unavailable | This relates to an error in, or failure of, Terranetes in a production environment that results in a complete loss of service, such as:<br />- The Terranetes Controller is not running successfully.<br />- Production Cloud Resources cannot be provisioned or modified via the Terranetes Controller. |
| **P2** <br />Production System Critically Impaired | This relates to a system defect in the Terranetes Controller in a production environment. This covers:<br />- A critical error for which a work-around exists<br />- A non-critical error in Terranetes that materially impacts the operations of the customer's business. |
| **P3** <br />System Impaired | This relates to an isolated or minor error in Terranetes that:<br />- Does not significantly affect Terranetes functionality<br />- May disable only certain non-essential functions<br />- Does not materially impact the customer's business |
| **P4** <br />General Issue | This includes questions around the use of Terranetes, feature requests, and general technical support specifically pertaining to the product. |

<br/>

#### When a support ticket is raised

On raising a ticket, customers provides an initial priority level based on their initial understanding. The Appvia Support Team then determines if the ticket has a correct priority level, and may increase or decrease the assigned priority level where appropriate. In the event that the priority level is changed, this will be communicated to the customer on the ticket.

### Subscription plans

The following are response times and business hours for the Standard and Enterprise subscription plans. See [Definitions](#definitions) and [Priority levels](#priority-levels) above for more details.

#### Standard Plan

The following are response times and business hours for the Standard subscription plan.

| Priority Level | Response | Business Hour Definition |
|:--------------:|:--------:|--------------------------|
| P1 | 4 hours | Normal Business Hours |
| P2 | 1 day | Normal Business Hours |
| P3 | 2 days | Normal Business Hours |
| P4 | 5 days | Normal Business Hours |

#### Enterprise Plan

The following are response times and business hours for the Enterprise subscription plan.

| Priority Level | Response | Business Hour Definition |
|:--------------:|:--------:|--------------------------|
| P1 | 1 hour | Enhanced Support Hours |
| P2 | 4 hours | Enhanced Support Hours |
| P3 | 1 day | Normal Business Hours |
| P4 | 2 days | Normal Business Hours |


## Support Scope

### In Scope

The following requests for support are in scope and covered by the Appvia Support Team.

- Installation of the Terranetes Controller
- Configuration of Terranetes (including cloud access, policies, resource plans)
- General use of Terranetes and its native features (including tnctl CLI and interactions via Terranetes CRDs)
- Incidents and bugs directly relating to the use of Terranetes

### Out of Scope

The following requests are out of scope for the Appvia Support Team, however, they can be provided under a Professional Services offering if required.

- Support for incidents caused by the customer due to the misuse of Terranetes or use of unofficial releases (e.g. forks)
- Support outside of Appvia working hours based on the customer's subscription plan
- General support relating to using Kubernetes, OpenTofu or Terraform
11 changes: 10 additions & 1 deletion docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,20 @@ const config: Config = {
favicon: 'img/favicon-docs.svg',
organizationName: 'appvia',
projectName: 'terranetes',
future: {
experimental_faster: {
swcJsLoader: true,
swcJsMinimizer: true,
swcHtmlMinimizer: true,
lightningCssMinimizer: true,
rspackBundler: true,
mdxCrossCompilerCache: true,
},
},
i18n: {
defaultLocale: 'en',
locales: ['en'],
},

themeConfig: {
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
navbar: {
Expand Down
Loading
Loading