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

docs: kubernetes operations guide #2956

Merged
merged 4 commits into from
Nov 16, 2022
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
20 changes: 17 additions & 3 deletions docs/admin/kubernetes-ops/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,21 @@ tags:

# Overview

Please use the left navigation menu to browse the content of this section while we are still working on developing content for `Overview` page.
This Operation guide helps you learn about the common operations for Janssen on Kubernetes.

!!! Contribute
If you’d like to contribute to this document, get started with the [Contribution Guide](https://docs.jans.io/head/CONTRIBUTING/#contributing-to-the-documentation)

## Prerequisite
- Review the [janssen](../reference/README.md) components and architecture

- Complete the [installation](../install/helm-install/local.md) of janssen on your desired Kubernetes provider.

## Common Operations

- [Scaling](scaling.md)
- [Backup and Restore](backup-restore.md)
- [Certificate Management](cert-management.md)
- [Customization](customization.md)
- [Start Order](start-order.md)
- [Logs](logs.md)
- [Health Check](health-check.md)
- [FAQ](faq.md)
18 changes: 15 additions & 3 deletions docs/admin/reference/kubernetes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,23 @@ tags:
- administration
- reference
- kubernetes
- architecture
- components
---

# Overview

Please use the left navigation menu to browse the content of this section while we are still working on developing content for `Overview` page.
This Reference guide helps you learn about the components and architecture of Janssen.

!!! Contribute
If you’d like to contribute to this document, get started with the [Contribution Guide](https://docs.jans.io/head/CONTRIBUTING/#contributing-to-the-documentation)
## Janssen components

- **auth-server**: The OAuth Authorization Server, the OpenID Connect Provider, the UMA Authorization Server--this is the main Internet facing component of Janssen. It's the service that returns tokens, JWT's and identity assertions. This service must be Internet facing.
- **auth-key-rotation**: Responsible for regenerating auth-keys per x hours.
- **config-api**: The API to configure the auth-server and other components is consolidated in this component. This service should not be Internet-facing.
- **OpenDJ**: A directory server which implements a wide range of Lightweight Directory Access Protocol and related standards, including full compliance with LDAPv3 but also support for Directory Service Markup Language (DSMLv2).Written in Java, OpenDJ offers multi-master replication, access control, and many extensions.
- **Fido**: Provides the server side endpoints to enroll and validate devices that use FIDO. It provides both FIDO U2F (register, authenticate) and FIDO 2 (attestation, assertion) endpoints. This service must be internet facing.
- **SCIM**: a JSON/REST API to manage user data. Use it to add, edit and update user information. This service should not be Internet facing.

## Architectural diagram of Janssen

![svg](../../../assets/jans-arch-diagram.svg)
1 change: 1 addition & 0 deletions docs/assets/jans-arch-diagram.drawio

Large diffs are not rendered by default.

Loading