12 factor with Docker - panupongth148/Project-SW-DEV-TOOLS-AND-ENV-Group4 GitHub Wiki

12-factor with Docker

เป็น Checklist หรือ แนวคิด ที่ใช้สำหรับการพัฒนา application ของเราโดยพูดถึง microservice, container devops จะมีเรื่อง 12 factor เข้ามาเสมอ โดยทั้ง docker และ kubernetes

1. Codebase

• คือโค้ดควรอยู่ที่เดียวกัน version เดียวกัน โดย control version ที่ git, sub version โดย 1 โปรเจคควรมีแค่ที่เดียว ถึงแม้ว่าจะทำ microservice ที่มีหลายๆ service ก็ควรอยู่ที่ repository เดียวกัน การใช้โปรเจ็คร่วมกันเพื่อลดปัญหาการ comunication กันภายใน ก่อนที่จะแยก repo ควรทำแบบที่รวม repo กัน แล้วทำงานให้ได้ก่อน แล้วเมื่อทำงานได้แล้วจะแยกแต่ละ service ออกจากกันที่หลังก็ได้
  • Ex : กลุ่มเราได้มีการออกแบบให้อยุ่ที่ repository เดียวกันโดยใช้เป็น รูปแบบ version control

2. Dependencies

• Dependencies มักจะไม่ประกาศในโปรเจคตรงๆ แต่จะเป็นแค่การประกาศเพียงแค่ว่าเราจะใช้ library ตัวไหน version อะไรบ้าง
  • Ex : Dependencies กำหนดเพียงแค่ version ใน package.json

3. Config

• configuration ที่ดีไม่ควรอยู่ใน Application ควรจะต้องถูกแยกออกมาอยู่ใน System environment, configuration server หรือ remote configuration เพื่อที่จะสามารถแก้ไขได้ โดยที่จะไม่กระทบกับ code ใน application นอกจากนี้ไม่ควรเก็บ configuration ไว้ที่ Database เพียงเพื่อจะทำให้สามารถแก้ไขได้ โดยการ reload configuration ใหม่

4. Backing services

• ระบบการทำงานต้องมีความง่ายต่อการ deploy สามารถเปลี่ยนได้ง่าย ยกตัวอย่าง ถ้าหากต้องการเปลี่ยน Database หรือ File system ของ service ก็สามารถเปลี่ยนได้ โดยมี Downtime ให้น้อยที่สุด

5. Build, release, run

• ควรแยก process ในการ Build, Release, Run แยกออกจากกัน การ build คือการเอา source code ทุกอย่างมาทำ software test จากนั้นก็ ค่อย release แล้ว run ให้จบไปเป็น step step ไป จะไม่รวมกันเป็น step เดียว เพราะว่า ถ้ามีการผิดพลาดในแต่ละขั้นตอนแล้ว เราจะสามารถแก้ไขได้ง่าย และรู้ได้ว่าเกิดข้อผิดพลาดจากตรงไหนได้ง่ายขึ้น
  • Ex : ใช้ jenkins ในการ cicd โดยมีการแบ่ง process ตามแต่ละ stage

6. Processes

• ทุกๆ service ควรทำให้เป็น stateless process / Service ต่างๆ ไม่ควรจะเป็นข้อมูลอะไรไว้ใน service ของตัวเอง เพราะถ้าหากต้องการจะย้ายข้อมูลจะลำบาก ควรให้ server ทำตามแค่หน้าที่ตาม Business logic เท่านั้น ยกตัวอย่าง พวกไฟล์รูป ควรเก็บอยู่ใน Nas storage ไม่ควรเก็บอยู่ที่ข้อมูล ใน contrainner เพราะถ้าหากต้องการย้าย หรือเปลี่ยนข้อมูล ไฟล์รูปต่างๆ ก็จะต้องถูกขนย้ายออกมาด้วย

7. Port binding

• เป็นเรื่องของ contrainner ปกติคือ สามารถที่จะรัน port เดียวกันได้ หลายตัวบนเครื่องเดียวกัน โดยหากต้องการใช้ port ก็ expose port ออกมา ก็จะสามารถเรียกใช้งานได้ ทำให้ไม่ต้องแก้ port เพื่อให้ service ต่างๆทำงานได้

8. Concurrency

• เป็น model ในการ scale ตามแต่ละ service ถ้า service ไหนที่การใช้งานเยอะ ก็ scale เฉพาะ service นั้นให้มีจำนวนเครื่องที่ใช้ให้เหมาะสมตามการใช้งานของ service

9. Disposability

• ระบบงานต้อง start ได้เร็วและจบลงได้สวย เพื่อลด Downtime ยกตัวอย่าง java spring boot ใน contrainner. contrainner start ขึ้นมาเสร็จแล้ว แต่ตัว spring ยัง start ยังไม่เสร็จ หมายความว่า service จะยังไม่พร้อมใช้งานจนกว่า spring boot จะ start เสร็จ ซึ่งจะทำให้เกิด Downtime ของ service นั้นเพิ่มขึ้น

10. Dev/prod parity

• ควรทำให้ environment ให้เหมือนกันที่สุดเท่าที่จะทำได้ เหมือนกันในที่นี้หมายถึงโครงสร้างของ environment ยกตัวอย่าง หาก production มี load balance ที่ dev ก็ควรจะมี load balance ด้วย เพือทำให้ environment เหมือนกันมากที่สุด หรือ หาก database ที่ production เป็นแบบ multi master ที่ dev ก็ควรจะเป็นเหมือนกัน

11. Logs

• ทำ centralized log พยายามคิดว่า log ต่างๆ เป็น steam โดยที่อยากจะเก็บอะไรก็ค่อยเอา tool ต่างๆมาเก็บข้อมูลที่เราอยากจะเก็บ

12. Admin processes

• พยายามทำให้ทุกๆ เครื่องเหมือนกับ admin task ของแต่ละ service ถ้า admin ต้องการจะทำอะไรควรทำผ่านช่องทางหรือชุดคำสั่งที่กำหนดไว้ให้ ไม่ควรทำเองโดยไม่่ผ่านชุดคำสั่ง ในของแต่ละ service นั้นๆ เพื่อลดปัญหาในการเปลี่ยนแปลงที่จะไม่เหมือนกันในแต่ environment