Ver Fonte

docs(readme): add GitLab and Jenkins setup guides

restructure README and add separete setup guides for gitlab and jenkins
yusuf há 18 horas atrás
pai
commit
d5c255e567
3 ficheiros alterados com 174 adições e 18 exclusões
  1. 37 18
      README.MD
  2. 78 0
      docs/setup-gitlab.md
  3. 59 0
      docs/setup-jenkins.md

+ 37 - 18
README.MD

@@ -9,7 +9,7 @@ Projek ini adalah Environment Docker untuk menjalankan stack middleware BTN seca
 
 ---
 
-## Setup
+## Setup Project
 
 ### 1. (Opsional) Fork project
 
@@ -32,42 +32,61 @@ docker login docker.senomas.com
 
 ### 4. Pull image
 
-Download semua image yang dibutuhlan dari registry:
+Download semua image yang dibutuhkan dari registry:
 
 ```bash
 docker compose pull
 ```
 
+### 5. Build image
+
+```bash
+docker compose build
+```
+
+Hanya wajib jika belum pernah build Jenkins, atau ada perubahan pada `jenkins/jenkins/Dockerfile` dan file terkait.
+
+### 6. Setup GitLab
+
+Ikuti panduan lengkap di [Setup GitLab](docs/setup-gitlab.md).
+
+### 7. Setup Jenkins
+
+Ikuti panduan lengkap di [Setup Jenkins](docs/setup-jenkins.md).
+
 ---
 
 ## Menjalankan Project
 
-### 1. (Opsional) Build image
+### 1. Menjalankan GitLab
+
+Menjalankan kontainer gitlab (pastikan gitlab sudah disetup)
 
 ```bash
-docker compose build
+docker compose up -d gitlab
 ```
-Kapan perlu dijalankan?
-- Pertama kali setup (belum pernah build Jenkins)
-- Ada perubahan pada `jenkins/jenkins/Dockerfile` atau file terkait
-
-### 2. Jalankan GitLab dan Jenkins
 
-```bash
-docker compose up -d gitlab jenkins
+Gitlab bisa diakses di
+```
+http://localhost:10806/
 ```
 
-#### 2.1 Pastikan GitLab sudah siap
+### 2. Menjalankan Jenkins
 
-GitLab membutuhkan waktu beberapa menit untuk inisialisasi. Cek status container:
+Menjalankan kontainer jenkins (pastikan jenkins sudah disetup)
 
 ```bash
-docker compose ps gitlab
+docker compose up -d jenkins
+```
+
+Jenkins bisa diakses di
+```
+http://localhost:10808/
 ```
 
-Pastikan kolom STATUS menunjukkan `Up` (bukan `starting` atau `restarting`).
+### 3. Menjalankan ACE (middleware)
 
-### 3. Jalankan ACE (middleware)
+Disarankan menjalankan ACE di tab terminal terpisah:
 
 ```bash
 make ace
@@ -75,7 +94,6 @@ make ace
 
 ---
 
-
 ## Useful Commands
 
 - Hentikan stack ACE (mwconfig, mwlog, btn-middleware):
@@ -94,4 +112,5 @@ make down
 
 ```bash
 docker compose ps
-```
+```
+

+ 78 - 0
docs/setup-gitlab.md

@@ -0,0 +1,78 @@
+# Setup GitLab
+
+Panduan ini menjelaskan cara menjalankan dan mengkonfigurasi GitLab lokal untuk project BTN Middleware.
+
+---
+
+## 1. Jalankan container GitLab
+
+Dari root project, jalankan:
+
+```bash
+docker compose up -d gitlab
+```
+
+---
+
+## 2. Pastikan GitLab healthy
+
+GitLab membutuhkan beberapa menit untuk inisialisasi pertama kali. Cek status container:
+
+```bash
+docker compose ps gitlab
+```
+
+Pastikan kolom **STATUS** menunjukkan `Up (healthy)`.
+
+
+## 3. Buka GitLab di browser
+
+Akses URL berikut:
+
+```
+http://localhost:10806
+```
+
+---
+
+## 4. Login sebagai root
+
+Gunakan kredensial berikut:
+
+| Field      | Nilai  |
+|------------|--------|
+| Username   | `root` |
+| Password   | lihat command di bawah |
+
+Ambil password awal root dengan:
+
+```bash
+docker exec gitlab cat /etc/gitlab/initial_root_password
+```
+
+Cari baris `Password:` — itu password untuk user `root`.
+
+> File password ini hanya valid ~24 jam setelah GitLab pertama kali di-setup, dan hanya jika password belum diubah manual.
+
+---
+
+## 5. Buat user baru
+
+Setelah login sebagai root, buat user baru. Untuk membuat user baru pergi ke halaman `http://localhost:10806/admin/users/new` 
+
+> **Penting:** User yang akan digunakan untuk development adalah **user baru ini**, bukan user `root`/admin. Jangan gunakan akun root untuk aktivitas sehari-hari.
+>
+> Alternatif: user baru juga bisa mendaftar lewat tombol **Register**, namun akun tersebut perlu **disetujui admin (root)** terlebih dahulu sebelum bisa login.
+
+---
+
+## 6. Login dengan user baru & buat group
+
+1. Logout dari akun root, lalu login dengan user baru yang sudah dibuat.
+2. Buat group dengan nama **`btnmw`** atau **`bsnmw`**.
+
+---
+
+Setup GitLab selesai.
+
+[Kembali ke Setup Project](README.MD).

+ 59 - 0
docs/setup-jenkins.md

@@ -0,0 +1,59 @@
+# Setup Jenkins
+
+Panduan ini menjelaskan cara menjalankan dan mengkonfigurasi Jenkins lokal untuk project BTN Middleware.
+
+> **Prasyarat:** Pastikan sudah menjalankan [Build image](../README.MD#1-build-image) di README sebelum setup Jenkins.
+
+---
+
+## 1. Download jenkins-data
+
+Masuk ke folder `jenkins`, lalu unduh dan ekstrak `jenkins-data`:
+
+```bash
+cd jenkins
+wget -c code.senomas.com/file/jenkins-data.20230920.tgz -O - | tar -xz
+```
+
+Command ini akan **mengganti** folder `jenkins-data` yang sudah ada
+
+---
+
+## 2. Jalankan container Jenkins
+
+Kembali ke direktori utama project, lalu nyalakan Jenkins:
+
+```bash
+cd ..
+docker compose up -d jenkins
+```
+
+Cek status container:
+
+```bash
+docker compose ps jenkins
+```
+
+Pastikan kolom **STATUS** menunjukkan `Up`.
+
+---
+
+## 3. Buka Jenkins di browser
+
+Akses URL berikut:
+
+```
+http://localhost:10808/
+```
+
+---
+
+## 4. Login Jenkins
+
+Login menggunakan kredensial yang telah diberikan oleh tim.
+
+---
+
+Setup Jenkins selesai.
+
+[Kembali ke Setup Project](../README.MD).