TheArchive/zitadel
1
0
Fork 0
mirror of https://github.com/zitadel/zitadel.git synced 2024-12-12 02:54:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(concepts): describe virtual instances (#4535)

Browse Source 
* docs(concepts): describe virtual instances

* mention scaling virtual instances

* Update docs/docs/concepts/structure/instance.mdx

Co-authored-by: Florian Forster <florian@zitadel.com>

* Update docs/docs/concepts/structure/instance.mdx

Co-authored-by: Florian Forster <florian@zitadel.com>

* Update docs/docs/concepts/structure/instance.mdx

Co-authored-by: Florian Forster <florian@zitadel.com>

* Update docs/docs/concepts/structure/instance.mdx

Co-authored-by: Florian Forster <florian@zitadel.com>

* Update docs/docs/concepts/structure/instance.mdx

Co-authored-by: Florian Forster <florian@zitadel.com>

* remove _instance_description.mdx

Co-authored-by: Florian Forster <florian@zitadel.com>
This commit is contained in:
Elio Bischof 2022-10-13 10:03:34 +02:00 committed by GitHub
parent c15658ea8c
commit 3dee8525d8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 18 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/docs/concepts/structure/_instance_description.mdx
View File

@ -1,5 +0,0 @@
An instance is the top hierarchy in the ZITADEL.
Within an instance all the default [settings](/docs/concepts/structure/policies), such as branding, login policy, password policy, etc. for the system can be configured.
One instance normally runs on one domain and has one issuer. (e.g login.customer.com)
One instance can contain multiple [organizations](/docs/concepts/structure/organizations). Which can represent the own company or the customers.

21
docs/docs/concepts/structure/instance.mdx
View File

@ -2,8 +2,23 @@
title: Instance
---
import InstanceDescription from './\_instance_description.mdx';
## Instance Structure
<InstanceDescription name="InstanceDescription" />
An instance is the top node in ZITADEL's data hierarchy.
Within an instance all the default [settings](/docs/concepts/structure/policies),
such as branding, login policy, password policy, etc. for the system can be configured.
One instance normally runs on one domain and represents one issuer (e.g login.customer.com).
More about how to configure your instance read our [instance guide](../../guides/manage/console/instance-settings).
One instance can contain multiple [organizations](/docs/concepts/structure/organizations),
which in turn can represent your own company (e.g. departments), your business customers or a consumer organization.
Read more about how to configure your instance in our [instance guide](/docs/guides/manage/console/instance-settings).
## Multiple Virtual Instances
ZITADEL has the concept of virtual instances.
When installing ZITADEL from scratch, one instance is always automatically created for you.
Nevertheless, you can add more virtual instances via the [system API](/docs/apis/proto/system#addinstance).
This is useful if you have business customers, which in turn have their business customers with self service and custom domain demands.
By providing a virtual ZITADEL instances, your customers have all the customization options available in ZITADEL.
Scaling ZITADEL instances virtually enables you to easily distribute your limited compute resources to all your customers.