default2368 commented on code in PR #177:
URL: https://github.com/apache/openserverless/pull/177#discussion_r2478914966
##########
OVERVIEW.md:
##########
@@ -0,0 +1,734 @@
+# System Architecture - Kubectl-Ops Cli Guide
+
+## Table of Contents
+1. [Introduction](#introduction)
+2. [System Architecture](#architecture)
+3. [Components and Tools](#components)
+4. [Installation and Setup](#installation)
+5. [User Management](#user-management)
+6. [Daily Operations](#operations)
+7. [Troubleshooting](#troubleshooting)
+
+---
+
+## 1. Introduction {#introduction}
+
+**OpenServerless** is an open source platform for serverless computing that
offers a flexible and portable alternative to proprietary cloud provider
solutions (AWS Lambda, Azure Functions, Google Cloud Functions).
+
+### Key Features
+- **Fully Open Source**: Completely open and modifiable code
+- **Portability**: Avoids vendor lock-in, deploy anywhere
+- **Kubernetes-Based**: Leverages the cloud-native ecosystem
+- **Self-Hosted**: Complete control over data and infrastructure
+- **Multi-Runtime Compatibility**: Supports multiple programming languages
+
+---
+
+## 2. System Architecture {#architecture}
+
+### Technology Stack
+
+```
+┌─────────────────────────────────────────┐
+│ CLI Tools (ops, kubectl) │
+│ User Interface │
+└─────────────────────────────────────────┘
+ ↓
+┌─────────────────────────────────────────┐
+│ Docker Desktop │
+│ (Container Runtime + Kubernetes) │
+└─────────────────────────────────────────┘
+ ↓
+┌─────────────────────────────────────────┐
+│ Kubernetes Cluster │
+│ • Container Orchestration │
+│ • Resource Management │
+│ • Networking and Storage │
+└─────────────────────────────────────────┘
+ ↓
+┌─────────────────────────────────────────┐
+│ OpenServerless Platform │
+│ • Controller │
+│ • API Gateway │
+│ • Function Runtime │
+│ • Database (CouchDB) │
+│ • Optional: Redis, MongoDB, MinIO │
+└─────────────────────────────────────────┘
+ ↓
+┌─────────────────────────────────────────┐
+│ Exposed Services │
+│ • REST API │
+│ • Web UI │
+│ • Authentication │
+└─────────────────────────────────────────┘
+```
+
+### Dependency Flow
+
+**Without Docker Desktop:**
+- ❌ Kubernetes unavailable
+- ❌ OpenServerless cannot start
+- ❌ REST APIs inaccessible
+- ❌ Web UI not working
+- ✅ Only CLI tools available (local commands)
+
+**With Docker Desktop Active:**
+- ✅ Kubernetes operational
+- ✅ OpenServerless deployed
+- ✅ REST APIs available
+- ✅ Web UI accessible
+- ✅ Authentication working
+
+---
+
+## 3. Components and Tools {#components}
+
+### kubectl
+
+**What it does:**
+- Command-line client for Kubernetes
+- Manages native K8s resources (pods, services, secrets, namespaces)
+- Operates at **low infrastructure level**
+
+**Essential Commands:**
Review Comment:
Hello, this is the quick guide that we spoken some days ago, i'm enzonav
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
