# johnwongapi/wikijs-k8s architecture

> Architecture diagram of the GitHub repository johnwongapi/wikijs-k8s, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/johnwongapi/wikijs-k8s
- Repository: https://github.com/johnwongapi/wikijs-k8s

## Overview

##### Main components
- Kubernetes Cluster – Represent the environment in which everything runs.
- Secret – Shown in secret.yaml, it supplies sensitive configuration data (such as credentials or configuration parameters). Show a connection between the Deployment and the Secret, indicating that the deployment consumes these secure settings.

##### Architectural patterns and important details
- That the design follows a standard Kubernetes architecture for deploying an application.
- Although the project is minimal, it clearly delineates between configuration (Secrets), application runtime (Deployment), and network exposure (Service). This separation illustrates good container orchestration practices.
- Mention that Wiki.js is the core application running in pods, and that Kubernetes handles scaling, health checks, and lifecycle management.

##### Relevant technologies and labels
- “Kubernetes Cluster” around the components indicating they are part of the Kubernetes environment.

## Diagram (Mermaid)

```mermaid
flowchart TD
    External["External User/Client"]:::external
    subgraph "Kubernetes Cluster"
        Service["Service (External Access)"]:::k8sObj
        Deployment["Deployment (Wiki.js)"]:::k8sObj
        Secret["Secret (Config/Credentials)"]:::secretObj
    end

    External -->|"HTTP/HTTPS"| Service
    Service -->|"Routes"| Deployment
    Deployment -->|"Uses"| Secret

    click Deployment "https://github.com/johnwongapi/wikijs-k8s/blob/master/deployment.yaml"
    click Secret "https://github.com/johnwongapi/wikijs-k8s/blob/master/secret.yaml"
    click Service "https://github.com/johnwongapi/wikijs-k8s/blob/master/service.yaml"

    classDef k8sObj fill:#B0C4DE,stroke:#000,stroke-width:2px;
    classDef secretObj fill:#F08080,stroke:#000,stroke-width:2px;
    classDef external fill:#90EE90,stroke:#000,stroke-width:2px;
```
