From 3dee8525d892c10463c8d6ab3328f0f69f297c7c Mon Sep 17 00:00:00 2001 From: Elio Bischof Date: Thu, 13 Oct 2022 10:03:34 +0200 Subject: [PATCH] docs(concepts): describe virtual instances (#4535) * docs(concepts): describe virtual instances * mention scaling virtual instances * Update docs/docs/concepts/structure/instance.mdx Co-authored-by: Florian Forster * Update docs/docs/concepts/structure/instance.mdx Co-authored-by: Florian Forster * Update docs/docs/concepts/structure/instance.mdx Co-authored-by: Florian Forster * Update docs/docs/concepts/structure/instance.mdx Co-authored-by: Florian Forster * Update docs/docs/concepts/structure/instance.mdx Co-authored-by: Florian Forster * remove _instance_description.mdx Co-authored-by: Florian Forster --- .../structure/_instance_description.mdx | 5 ----- docs/docs/concepts/structure/instance.mdx | 21 ++++++++++++++++--- 2 files changed, 18 insertions(+), 8 deletions(-) delete mode 100644 docs/docs/concepts/structure/_instance_description.mdx diff --git a/docs/docs/concepts/structure/_instance_description.mdx b/docs/docs/concepts/structure/_instance_description.mdx deleted file mode 100644 index 4a77099507..0000000000 --- a/docs/docs/concepts/structure/_instance_description.mdx +++ /dev/null @@ -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. diff --git a/docs/docs/concepts/structure/instance.mdx b/docs/docs/concepts/structure/instance.mdx index 718d602506..422b6cfb41 100644 --- a/docs/docs/concepts/structure/instance.mdx +++ b/docs/docs/concepts/structure/instance.mdx @@ -2,8 +2,23 @@ title: Instance --- -import InstanceDescription from './\_instance_description.mdx'; +## Instance Structure - +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). \ No newline at end of file +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.