mirror of
https://github.com/zitadel/zitadel.git
synced 2025-04-16 11:01:30 +00:00
docs: added setup options to docs (#2127)
* docs: added setup options to docs * docs: added setup options to docs * docs: added setup options to docs * docs: added setup options to docs * docs: added setup options to docs * docs: added setup options to docs * docs: added setup options to docs * docs: add suggestions Co-authored-by: Florian Forster <florian@caos.ch> Co-authored-by: Florian Forster <florian@caos.ch>
This commit is contained in:
parent
961cd4bff6
commit
4cd12f453d
38
docs/docs/guides/installation/checkup.md
Normal file
38
docs/docs/guides/installation/checkup.md
Normal file
@ -0,0 +1,38 @@
|
|||||||
|
---
|
||||||
|
title: ZITADEL Checkup
|
||||||
|
---
|
||||||
|
|
||||||
|
We provide services to check the setup of our ZITADEL with the operators also provided by us.
|
||||||
|
|
||||||
|
### In Scope
|
||||||
|
|
||||||
|
- Check prerequisites and architecture
|
||||||
|
- Check configuration for ZITADEL and ORBOS
|
||||||
|
- Functional testing of the ZITADEL instance
|
||||||
|
|
||||||
|
### Out of Scope
|
||||||
|
|
||||||
|
- Integration of external S3-storage or other types of storage
|
||||||
|
- Integration into internal monitoring and alerting
|
||||||
|
- Changes for specific environments
|
||||||
|
- Performance testing
|
||||||
|
- Application-side coding, configuration, or tuning
|
||||||
|
- Changes or configuration on assets used in ZITADEL
|
||||||
|
- Setting up or maintaining backup storage
|
||||||
|
|
||||||
|
### Prerequisites
|
||||||
|
|
||||||
|
- Access to relevant Kubernetes cluster or physical/virtual nodes
|
||||||
|
- Access to relevant asset, backup and provisioned storage
|
||||||
|
- Environment to test and check (should not be in productive use)
|
||||||
|
- Access to used configuration
|
||||||
|
- Access to relevant monitoring
|
||||||
|
- Access to relevant system and application logs
|
||||||
|
|
||||||
|
### Deliverable
|
||||||
|
|
||||||
|
- Document detailing findings and description of the suggested configuration changes
|
||||||
|
|
||||||
|
### Time Estimate
|
||||||
|
|
||||||
|
10 hours
|
43
docs/docs/guides/installation/setup-orbos.md
Normal file
43
docs/docs/guides/installation/setup-orbos.md
Normal file
@ -0,0 +1,43 @@
|
|||||||
|
---
|
||||||
|
title: ZITADEL setup with ORBOS
|
||||||
|
---
|
||||||
|
|
||||||
|
We provide services to setup our ORBOS and ZITADEL with the operators also provided by us.
|
||||||
|
|
||||||
|
### In Scope
|
||||||
|
|
||||||
|
- Check prerequisites and architecture
|
||||||
|
- Setup of VMs, Loadbalancing and Kubernetes with [ORBOS](https://github.com/caos/orbos)
|
||||||
|
- Setup of in-cluster toolset with ORBOS, which includes monitoring and an API gateway (Ambassador)
|
||||||
|
- Installation and configuration of ZITADEL with the ZITADEL-operator
|
||||||
|
- Installation and configuration of CockroachDB with the Database-operator
|
||||||
|
- Functional testing of the ZITADEL instance
|
||||||
|
|
||||||
|
### Out of Scope
|
||||||
|
- Integration of external S3-storage or other types of storage
|
||||||
|
- Integration into internal monitoring and alerting
|
||||||
|
- Multi-cluster architecture deployments
|
||||||
|
- Changes for specific environments
|
||||||
|
- Performance testing
|
||||||
|
- Production deployment
|
||||||
|
- Application-side coding, configuration, or tuning
|
||||||
|
- Changes or configuration on assets used in ZITADEL
|
||||||
|
- Setting up or maintaining backup storage
|
||||||
|
|
||||||
|
### Prerequisites
|
||||||
|
|
||||||
|
- S3-storage for assets in ZITADEL
|
||||||
|
- S3-storage or Google Cloud Bucket for backups of the database
|
||||||
|
- [Prerequisites listed for a managed instance](/docs/guides/installation/managed-dedicated-instance)
|
||||||
|
|
||||||
|
### Deliverable
|
||||||
|
|
||||||
|
- Running Kubernetes
|
||||||
|
- Running toolset for monitoring and alerting
|
||||||
|
- Running CockroachDB
|
||||||
|
- Running ZITADEL
|
||||||
|
- Running backups for ZITADEL
|
||||||
|
|
||||||
|
### Time Estimate
|
||||||
|
|
||||||
|
12 hours
|
45
docs/docs/guides/installation/setup.md
Normal file
45
docs/docs/guides/installation/setup.md
Normal file
@ -0,0 +1,45 @@
|
|||||||
|
---
|
||||||
|
title: ZITADEL setup
|
||||||
|
---
|
||||||
|
|
||||||
|
We provide services to setup our ZITADEL with the operators also provided by us.
|
||||||
|
|
||||||
|
### In Scope
|
||||||
|
|
||||||
|
- Check prerequisites and architecture
|
||||||
|
- Installation and configuration of ZITADEL with the ZITADEL-operator
|
||||||
|
- Installation and configuration of CockroachDB with the Database-operator
|
||||||
|
- Functional testing of the ZITADEL instance
|
||||||
|
|
||||||
|
### Out of Scope
|
||||||
|
|
||||||
|
- Running multiple ZITADEL instances on the same cluster
|
||||||
|
- Integration into internal monitoring and alerting
|
||||||
|
- Multi-cluster architecture deployments
|
||||||
|
- DNS, Network and Firewall configuration
|
||||||
|
- Kubernetes configuration
|
||||||
|
- Changes for specific environments
|
||||||
|
- Performance testing
|
||||||
|
- Production deployment
|
||||||
|
- Application-side coding, configuration, or tuning
|
||||||
|
- Changes or configuration on assets used in ZITADEL
|
||||||
|
- Setting up or maintaining backup storage
|
||||||
|
|
||||||
|
### Prerequisites
|
||||||
|
|
||||||
|
- Running Kubernetes with possibility to deploy to namespaces caos-system and caos-zitadel
|
||||||
|
- Volume provisioner for Kubernetes to fill Persistent Volume Claims
|
||||||
|
- S3-storage for assets in ZITADEL
|
||||||
|
- S3-storage or Google Cloud Bucket for backups of the database
|
||||||
|
- Inbound and outbound gRPC-Web traffic possible(for example not natively supported by nginx)
|
||||||
|
- [Prerequisites listed for a managed instance, limited to functionality for ZITADEL](/docs/guides/installation/managed-dedicated-instance)
|
||||||
|
|
||||||
|
### Deliverable
|
||||||
|
|
||||||
|
- Running CockroachDB
|
||||||
|
- Running ZITADEL
|
||||||
|
- Running backups for ZITADEL
|
||||||
|
|
||||||
|
### Time Estimate
|
||||||
|
|
||||||
|
8 hours
|
@ -71,6 +71,16 @@ module.exports = {
|
|||||||
'guides/installation/managed-dedicated-instance'
|
'guides/installation/managed-dedicated-instance'
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
type: 'category',
|
||||||
|
label: 'CAOS Service Packages',
|
||||||
|
collapsed: true,
|
||||||
|
items: [
|
||||||
|
'guides/installation/setup',
|
||||||
|
'guides/installation/setup-orbos',
|
||||||
|
'guides/installation/checkup'
|
||||||
|
],
|
||||||
|
},
|
||||||
{
|
{
|
||||||
type: 'category',
|
type: 'category',
|
||||||
label: 'Self Managed',
|
label: 'Self Managed',
|
||||||
|
Loading…
x
Reference in New Issue
Block a user