mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-18 05:52:51 +00:00
## Problem statement - `<Tabs>` were not rendered in docs - Missing steps in README for local dev ## How it was solved - Enhance the README to better describe local development setup and clean up formatting. - Standardize the use of tabs across various components for consistency. ## Additional info To not cause merge conflicts with https://github.com/zitadel/zitadel/pull/11729 changes in `/self-hosting/manage/configure/configure.mdx` were skipped
256 lines
14 KiB
Plaintext
256 lines
14 KiB
Plaintext
---
|
||
title: Support service description for ZITADEL
|
||
description: "Support services, service level agreements, and conditions for service subscriptions"
|
||
sidebar_label: Support service
|
||
custom_edit_url: null
|
||
---
|
||
|
||
Last updated on November 15, 2023
|
||
|
||
This annex of the [Framework Agreement](../terms-of-service) and the [Support Service Terms and Conditions](../annex-support-services) describes the support services offered by us for our Services.
|
||
|
||
Support Services for products and services provided by ZITADEL is offered to customers according to the terms and conditions outlined in this document.
|
||
The customer may purchase support services from ZITADEL (CAOS Ltd.) directly.
|
||
|
||
## Service Level Agreement
|
||
|
||
ZITADEL provides a Service Level Agreement for support of the [services offered](./cloud-service-description#services-offered).
|
||
Depending on your subscription plan you might be eligible to the following support service level agreement.
|
||
|
||
### ZITADEL Cloud
|
||
|
||
Based on your subscription plan you may be eligible for the support services as outlined in this document.
|
||
You may purchase additional premium support plans which replace the default support features.
|
||
|
||
#### Support in subscription plans
|
||
|
||
Support features for ZITADEL Cloud subscriptions are as follows:
|
||
|
||
Subscription Plans | Free | Production | Enterprise Cloud
|
||
--- | --- | --- | ---
|
||
[Support hours](#support-hours) | Business hours | Business hours | bespoke (up to 24x7)
|
||
[Response Time](#slo---initial-response-time) (Severity 1) | n/a | 48 business hours | bespoke (as low as 30min)
|
||
[Community support](#community-support) | yes | yes | yes
|
||
[Professional support](#professional-support) | no | yes | yes
|
||
[Enterprise supported features](https://help.zitadel.com/zitadel-support-states#enterprise) | no | no | yes
|
||
[Technical Account Management](#technical-account-manager) | no | no | bespoke
|
||
|
||
#### Extended support
|
||
|
||
Extended support can be added to ZITADEL Cloud subscription plans.
|
||
The default support features will be replaced as follows:
|
||
|
||
Extended support | Default
|
||
--- | ---
|
||
[Support hours](#support-hours) | [Extended hours](#extended-hours)
|
||
[Response Time](#slo---initial-response-time) (Severity 1) | 1 business hour
|
||
[Community support](#community-support) | yes
|
||
[Professional support](#professional-support) | yes
|
||
[Enterprise supported features](https://help.zitadel.com/zitadel-support-states#enterprise) | no
|
||
[Technical Account Management](#technical-account-manager) | no
|
||
|
||
### ZITADEL Enterprise / self-hostable
|
||
|
||
With ZITADEL Enterprise you become eligible for support plans according to your purchase order for self-hosting ZITADEL.
|
||
Please refer to the [service description](./cloud-service-description#enterprise-license-self-hosted) for an overview of ZITADEL Enterprise.
|
||
|
||
ZITADEL Enterprise self-hostable| Default
|
||
--- | ---
|
||
[Support hours](#support-hours) | bespoke (up to 24x7)
|
||
[Response Time](#slo---initial-response-time) (Severity 1) | bespoke (as low as 30min)
|
||
[Community support](#community-support) | yes
|
||
[Professional support](#professional-support) | yes
|
||
[Enterprise supported features](https://help.zitadel.com/zitadel-support-states#enterprise) | yes
|
||
[Technical Account Management](#technical-account-manager) | bespoke
|
||
|
||
## Description of support services
|
||
|
||
### Support hours
|
||
|
||
#### Business hours
|
||
|
||
Business hours means 08:00-17:00 Monday - Friday Switzerland time (or as per agreement with the customer). All times exclude public holidays in Switzerland / Canton St. Gallen.
|
||
|
||
#### Extended hours
|
||
|
||
Extended hours means 07:00-19:00 Monday - Friday Switzerland time (or as per agreement with the customer). All times exclude public holidays in Switzerland / Canton St. Gallen.
|
||
|
||
### Ticket
|
||
|
||
Ticket means a discrete technical or non-technical issue that was submitted by the customer and exists in the support portal. A ticket includes a record of all communication associated with the issue.
|
||
|
||
### SLO - Initial response time
|
||
|
||
ZITADEL service level objective (SLO) for Support Services is defined in terms of initial response time to a support request, as outlined in the table below per plan.
|
||
ZITADEL will use reasonable efforts to resolve support requests, but does not guarantee a work-around, resolution or resolution time.
|
||
|
||
Subscription Plans | Default | Extended SLA | Custom
|
||
--- | --- | --- | ---
|
||
Severity 1| Best effort | 1 business hour | up to 30min
|
||
Severity 2| Best effort | 2 business hour | 2 business hours
|
||
Severity 3| Best effort | 12 business hour | 12 business hours
|
||
Severity 4| Best effort | 24 business hour | 24 business hours
|
||
|
||
If we fail to provide the initial response time objective, you will be entitled to service credits. For every 15 minutes exceeding the state objective, 1 day will be added as extension to the current term.
|
||
|
||
### Communication
|
||
|
||
#### Community support
|
||
|
||
Community support for ZITADEL is available on our website, our [public chat](https://zitadel.com/chat), and [GitHub](https://github.com/zitadel/).
|
||
|
||
We do only guarantee response times to Tickets reported via [professional support](#professional-support) channels only.
|
||
If you are an eligible customer, please use Tickets for critical or urgent issues.
|
||
|
||
#### Professional support
|
||
|
||
- Support is available in English
|
||
- Default contact: Whenever customers require support, Customers should consult the documentation of the service or product or post a question to our community
|
||
- When Customer is eligible for support services through a Subscription Plan, Customer may contact ZITADEL support via the following channels
|
||
|
||
Support Feature | Contact information
|
||
--- | ---
|
||
Ticket | Submit an issue via the [customer portal](https://zitadel.com/admin/support)
|
||
eMail Support | [email protected]
|
||
Chat Support | Private chat channel between ZITADEL and Customer that is opened when Subscription becomes active
|
||
Phone Support | +41 43 215 27 34
|
||
|
||
- ZITADEL Cloud system status, incidents and maintenance windows will be communicated via [our status page](https://zitadelstatus.com).
|
||
- Questions regarding pricing, billing, and invoicing of our services should be addressed to [email protected]
|
||
- Security related questions and incidents can also be directly addressed to [email protected]
|
||
|
||
### Technical account manager
|
||
|
||
ZITADEL will enhance its support offering by providing eligible clients with a Technical Account Manager (TAM), who will perform the following tasks for up to the agreed amount of time during the term of service:
|
||
|
||
- Provide support and advice regarding best practices on platform, product and settings covered by the applicable Support Services;
|
||
- Participate in review calls every other week at mutually agreed times addressing customer’s operational challenges or complex support requests;
|
||
- Walk-through of new features and customer feedback.
|
||
|
||
We offer TAM services only bundled with specific subscription plans, and the option to add more TAM hours per period to these plans.
|
||
If you require consulting for your projects, please request a quote via our [website](https://zitadel.com/contact).
|
||
|
||
### Onboarding support
|
||
|
||
Our onboarding support should help you, as a new customer, to get a better understanding on how to integrate ZITADEL into your solution, how to tackle the migration, and ensure a highly-available day-to-day operation.
|
||
|
||
Onboarding support services can be offered to customers that enter a ZITADEL Cloud or a ZITADEL Enterprise subscription.
|
||
|
||
If you intend to use the open-source version exclusively then please join our community chat or GitHub.
|
||
Your questions might help other people in the community and will make our project better over time.
|
||
|
||
Please [contact us](https://zitadel.com/contact) for a quote and to get started with onboarding support.
|
||
Below you will find topics covered and scope of the offered services.
|
||
|
||
#### Proof of value
|
||
|
||
Within a short time-frame, f.e. 3 weeks, we can show the value of using our services and have the ability to establish the proof a of working setup for your most critical use cases.
|
||
We may offer to support you during an initial period to evaluate next steps.
|
||
Before the start of the period we may ask you to provide a description of your critical use cases and a high-level overview of your planned integration architecture.
|
||
During this period you should make sure that you have the necessary resources on your side to complete the proof of value.
|
||
|
||
#### Onboarding term
|
||
|
||
With the onboarding support we provide the initial knowledge transfer to configure and operate ZITADEL.
|
||
During the term you will get direct access to our engineering team via [Technical Account Management](#technical-account-manager).
|
||
Duration is typically 3 months but this could vary depending on your requirements.
|
||
|
||
We offer an onboarding term in combination with ZITADEL Enterprise subscriptions.
|
||
|
||
#### Topics covered
|
||
|
||
The scope will be tailored to your requirements.
|
||
Topics of the onboarding term may include
|
||
|
||
- Administration
|
||
- DevOps (Operation)
|
||
- Architecture
|
||
- Integration
|
||
- Migration
|
||
- Security Best Practices & Go-Live Checkup
|
||
|
||
<Tabs groupId="covered-topics" defaultIndex={1} items={['Topics in scope', 'Topics out of scope']}>
|
||
<Tab value="Topics in scope">
|
||
<ul>
|
||
<li>Instance Settings</li>
|
||
<li>Walk-through all features</li>
|
||
<li>Users / Manuals</li>
|
||
<li>Authentication & Management APIs</li>
|
||
<li>Validation of tokens</li>
|
||
<li>Client integration best-practices</li>
|
||
<li>Event types</li>
|
||
<li>Database schemas and compute models</li>
|
||
<li>Accessing database</li>
|
||
<li>Observability (Logs, Errors, Metrics, Tracing)</li>
|
||
<li>Operations best practices (Deployment, Backup, Networking etc.)</li>
|
||
<li>Check prerequisites and architecture</li>
|
||
<li>Troubleshoot installation and configuration of ZITADEL</li>
|
||
<li>Troubleshoot and configuration connectivity to the database</li>
|
||
<li>Functional testing of the ZITADEL instance</li>
|
||
</ul>
|
||
</Tab>
|
||
<Tab value="Topics out of scope">
|
||
<ul>
|
||
<li>Performance testing</li>
|
||
<li>Setting up or maintaining backup storage</li>
|
||
<li>Running multiple ZITADEL instances on the same cluster</li>
|
||
<li>Integration into internal monitoring and alerting</li>
|
||
<li>Multi-cluster architecture deployments</li>
|
||
<li>DNS, Network and Firewall configuration</li>
|
||
<li>Customer-specific Kubernetes configuration needs</li>
|
||
<li>Non-production environments</li>
|
||
<li>Production deployment</li>
|
||
<li>Application-side coding, configuration, or tuning</li>
|
||
</ul>
|
||
</Tab>
|
||
</Tabs>
|
||
|
||
## Support
|
||
|
||
### Support request
|
||
|
||
ZITADEL agrees to handle support incidents in the following scenarios:
|
||
|
||
1. Service, product or settings as provided by ZITADEL contains errors or critical security-related issues
|
||
2. Service or product requires upgrades or changes through the customer
|
||
3. Service or product has incorrect or missing documentation
|
||
|
||
Support features include:
|
||
|
||
- Answer questions regarding usage of specific features or settings
|
||
- Provide high-level suggestions regarding appropriate usage, features or settings
|
||
- Assist in troubleshooting of issues to isolate potential root cause
|
||
- Document and advise alternative solutions for reported defects
|
||
|
||
Excluded are broader consulting & customer-specific engineering requests regarding use of our products and services. Moreover support requests from Customer’s end users must be handled by the Customer directly.
|
||
|
||
### Support service process
|
||
|
||
The customer may submit support requests (“ticket”) through any means of eligible communication channels, consisting of
|
||
|
||
- Single discrete problem, issue, or request
|
||
- Initial severity level and impact statement for assessment
|
||
- Description of the issue and if possible a description of the observed and expected behavior, steps to reproduce the issue, evidence that issue is not caused by connectivity / compute, relevant anonymized log-files etc.
|
||
- All information requested by ZITADEL as we resolve the ticket (e.g. system logs)
|
||
|
||
ZITADEL will review the case information and determine the severity level (see below), working with the customer to assess the urgency of the request and use reasonable efforts to respond to support requests within the initial response time.
|
||
|
||
ZITADEL will use reasonable efforts to resolve support request as defined below, but does not guarantee a workaround, resolution or resolution time.
|
||
|
||
Severity Level | Description
|
||
--- | ---
|
||
**Severity 1**<br/> Critical / Service down| <p>Widespread failure or complete unavailability of ZITADEL Core Services. </p><p> ZITADEL will use continuous effort to provide a workaround or permanent solution. When Core Services are available, the severity will be lowered to the new appropriate level.</p>
|
||
**Severity 2**<br/> Core functionality unavailable or severely degraded| <p>Core Services of ZITADEL software continue to operate in severely restricted fashion, yet long-term productivity may be impacted.</p><p> When Core Services are no longer severely degraded (eg, through a viable workaround or release), the severity level will be lowered to Severity 3.</p>
|
||
**Severity 3**<br/>Standard support request| <p>Partial and non-critical loss of ZITADEL software functionality or major software defect, yet a workaround exists for viable long-term operation.</p><p>ZITADEL will continue to work on developing permanent resolution.</p>
|
||
**Severity 4**<br/>Non-urgent request| Defined as follows: <ul><li>Request for information or general query</li><li>Feature request</li><li>Performance issues and little to none functional impact</li><li>Defects with workarounds and little to low functional impact</li></ul>
|
||
<p>ZITADEL will continue to work on developing permanent resolution and response to general requests. ZITADEL does not provide a timeline or guarantee to include any feature requests.</p>
|
||
|
||
### Escalation
|
||
|
||
The customer may escalate support requests following the escalation process:
|
||
|
||
1. For non-urgent needs, the client may request management escalation within the ticket. A manager will review the request and provide a response within one business day.
|
||
2. For urgent needs, the client may escalate directly by calling +41 71 560 28 06 and emailing to [[email protected]](mailto:[email protected]). A manager will review the request and provide response within two business hours.
|
||
|
||
If we fail to provide a response to the escalation, you will be entitled to service credits. For every 15 minutes exceeding the state objective, 1 day will be added as extension to the current term.
|