System Context

Krokup đưa Diagram as Code vào Playground, VS Code, GitLab và các website tài liệu; Confluence được tích hợp qua Forge app. Người dùng tiếp tục soạn thảo và review trong công cụ quen thuộc, còn Krokup tiếp nhận mã sơ đồ và trả kết quả về đúng điểm hiển thị.

Bối cảnh hệ thống

Người dùng có thể lần lượt là tác giả, reviewer hoặc người đọc tùy công việc. Người vận hành quản lý môi trường chạy, cấu hình và secret của rendering service. VS Code, GitLab, Confluence Cloud và website tài liệu là nơi người dùng tạo hoặc xem nội dung; các integration của Krokup đưa source từ những công cụ này tới rendering service và đưa kết quả trở lại màn hình đang sử dụng.

Phạm vi sản phẩm

Người dùng tạo và kiểm tra diagram qua Playground, VS Code Extension, GitLab MR Browser Extension và Confluence Integration. GitLab Markdown Integration cùng MkDocs chuẩn bị nội dung nhúng để diagram xuất hiện trong trang đã publish. Các trải nghiệm này dùng chung Gateway, Java Core và renderer runtime của Krokup.

GitLab có hai integration phục vụ hai công việc khác nhau: Markdown Integration chuẩn hóa fence trước khi GitLab render tài liệu, còn MR Browser Extension đọc thay đổi và so sánh diagram trong merge request. Website tài liệu là static artifact được tạo bởi MkDocs và phát hành độc lập với rendering service.

Confluence integration có mã nguồn, test và manifest riêng. App không nằm trong workflow deploy rendering service lên VPS. Trạng thái hoạt động phải được xác minh trong đúng Forge environment và Confluence site đã deploy, install riêng.

Mã sơ đồ được duy trì tại nơi người dùng làm việc, chẳng hạn workspace, GitLab repository, Confluence. Quyền truy cập và lịch sử thay đổi do các nền tảng này quản lý. Krokup nhận mã sơ đồ để render và trả kết quả; hệ thống không thay thế repository, trình soạn thảo hoặc cơ chế quản lý phiên bản của nền tảng nguồn.

Dữ liệu và quyền truy cập

Preview, export và các backend integration gửi request POST kèm token lấy từ nơi lưu trữ riêng của client hoặc backend. Với sơ đồ nhúng trong GitLab hoặc website tài liệu, browser tải ảnh qua encoded GET. Mã sơ đồ trong URL có thể được khôi phục, vì vậy đường dẫn này chỉ phù hợp với nội dung được phép xuất hiện trong URL và access log.

Các thành phần xử lý request được trình bày trong Component Architecture; hai cách gọi API được mô tả tại Integration Flows.