Dự án Jenkins X

Trang này chứa thông tin chi tiết về một dự án viết kỹ thuật được chấp nhận cho Phần Google Tài liệu.

Tóm tắt dự án

Tổ chức nguồn mở:
Jenkins X
Người viết nội dung kỹ thuật:
Nitin
Tên dự án:
Tái cấu trúc trang web tài liệu hiện có của Jenkins X và Ma trận khả năng của Jenkins X
Thời lượng dự án:
Thời gian tiêu chuẩn (3 tháng)

Mô tả dự án

Mục tiêu chính của dự án này là tái cấu trúc tài liệu của Jenkins X hiện có, đồng thời khắc phục các vấn đề liên quan đến tài liệu, cũng như chuẩn bị ma trận chức năng của Jenkins X mới cập nhật cùng với tài liệu người dùng về cách sử dụng Jenkins X trên nhà cung cấp dịch vụ đám mây dành cho doanh nghiệp. Ngoài ra, dự án này cũng hợp tác với Daniel để phát triển cơ sở hạ tầng môi trường xem trước của Jenkins X dựa trên OpenShift.

Là một phần của việc tái cấu trúc tài liệu Jenkins X hiện có, một số vấn đề mà tôi sẽ xử lý bao gồm:

  • Khởi động trong tài nguyên EKS: Sự cố
  • Vault không hoạt động trong EKS khi khởi động: Sự cố
  • Envars tài liệu cho jx khởi động: Vấn đề
  • Tài liệu cần thiết để thiết lập Vault: Vấn đề
  • Không nâng cấp được khởi động từ cục bộ lên Vault: Sự cố
  • Mối quan hệ giữa "create" và "install jx" so với "boot" và "import": Vấn đề
  • Tài liệu về Helm ở mọi nơi: Vấn đề
  • Cải thiện tài liệu về lý do tại sao Chartđề, Monocular và Docker Registry không được thay thế bằng vấn đề về Nexus
  • Không thay đổi được Docker Registry khi dùng Boot + GKE: Sự cố
  • Không thay đổi được miền từ nip.io thành miền tuỳ chỉnh: Vấn đề

Đối với Ma trận chức năng của Jenkins X, công việc này liên quan đến (như đề cập dưới đây) đối với các dịch vụ Kubernetes dành cho doanh nghiệp do từng nhà cung cấp dịch vụ Đám mây cung cấp, chẳng hạn như Google Cloud (GKE), Amazon Web Services (AWS EKS) và Azure Cloud (AKS).

  • Cài đặt Jenkins X trên đám mây qua tập lệnh terraform và jx boot
  • Đang kiểm tra khả năng tương thích của các phiên bản Kubernetes với Jenkins X trên các dịch vụ kubernetes của nhà cung cấp dịch vụ đám mây này.
  • Mọi Khả năng khác (Lưu trữ Vault cho thông tin bí mật, các phiên bản Kiểm soát nguồn hoặc các Khả năng khác) sẽ được thảo luận với Deane và các thành viên cộng đồng Jenkins X.

Liên quan đến việc thiết lập cơ sở hạ tầng môi trường xem trước của Jenkins X dựa trên OpenShift, bao gồm:

  • Tài liệu thiết kế trên cơ sở hạ tầng môi trường xem trước Jenkins X trên nền tảng OpenShift
  • Tự động tạo môi trường xem trước Jenkins X trong OpenShift
  • Cập nhật tài liệu cho Jenkins X trên môi trường xem trước

Thành phẩm của dự án:

  • Khắc phục thông qua PR đối với các vấn đề về tài liệu đã đề cập ở trên, có cân nhắc đến việc tái cấu trúc tài liệu Jenkins X hiện có.
  • Cập nhật Ma trận khả năng của Jenkins X cùng với tài liệu dành cho người dùng về cách sử dụng Jenkins X với nhiều nhà cung cấp dịch vụ đám mây (các dịch vụ của Kubernetes chủ yếu là AKS, EKS và GKE).
  • Tự động thiết lập môi trường xem trước Jenkins X Cơ sở hạ tầng dựa trên OpenShift, cộng tác với Daniel.

Tiến trình dự kiến (cùng với các nhiệm vụ) được đề xuất:

Gắn kết cộng đồng (17/8 – 13/9)

  • Thiết lập môi trường phát triển cho các tài liệu kỹ thuật cũng như truy cập vào cơ sở hạ tầng đám mây để thực hiện các nhiệm vụ của dự án.
  • Thảo luận với cố vấn dự án về tiến trình dự kiến được đề xuất, sản phẩm của dự án cũng như các nhiệm vụ (cùng với ưu tiên của họ).
  • Tìm hiểu và trang bị đầy đủ thông tin về quy trình làm việc của tổ chức, quy trình đánh giá PR và tham gia cộng đồng.
  • Xem lại trạng thái tài liệu hiện tại của Jenkins X.

Tuần 1 (14/9 – 20/9)

  • Tìm hiểu hướng dẫn thiết lập Jenkins X trên đám mây, trạng thái hiện tại và tài liệu.
  • Thảo luận với Deane về các chức năng hiện tại của Jenkins X (cần được xác minh trên các nhà cung cấp dịch vụ đám mây khác nhau).
  • Thảo luận với Daniel về trạng thái hiện tại của cơ sở hạ tầng môi trường xem trước Jenkins X dựa trên OpenShift.
  • Làm việc (cộng tác với Daniel) để thiết kế kiến trúc cho cơ sở hạ tầng môi trường xem trước của Jenkins X trên OpenShift.

Tuần 2 (21/9 – 27/9)

  • Xây dựng ma trận chức năng Jenkins X cho đám mây GKE: cài đặt Jenkins X và chuẩn bị bản nháp ghi chú cho người dùng.
  • Khắc phục một trong các vấn đề về tài liệu để cải thiện tài liệu Jenkins X hiện có.

Tuần 3 (28/9 – 4/10)

  • Xây dựng ma trận chức năng Jenkins X cho đám mây GKE: cài đặt Jenkins X và chuẩn bị bản nháp ghi chú cho người dùng.
  • Khắc phục một trong các vấn đề về tài liệu để cải thiện tài liệu Jenkins X hiện có.
  • Làm việc trên cơ sở hạ tầng môi trường xem trước của Jenkins X dựa trên OpenShift.

Tuần 4 (5/10 – 11/10)

  • Hoàn tất tài liệu người dùng cho Jenkins X trên GKE.
  • Khắc phục một trong các vấn đề về tài liệu để cải thiện tài liệu Jenkins X hiện có.

Tuần 5 (12/10 – 18/10)

  • Thao tác trên ma trận chức năng Jenkins X cho đám mây Azure (AKS): cài đặt Jenkins X và chuẩn bị bản nháp ghi chú cho người dùng.
  • Khắc phục một trong các vấn đề về tài liệu để cải thiện tài liệu Jenkins X hiện có.
  • Hoàn tất tài liệu thiết kế cho cơ sở hạ tầng môi trường xem trước của Jenkins X dựa trên OpenShift sau khi nhận được ý kiến phản hồi của các thành viên trong cộng đồng.

Tuần 6 (19/10 – 25/10)

  • Thao tác trên ma trận chức năng Jenkins X cho đám mây Azure (AKS): cài đặt Jenkins X và chuẩn bị bản nháp ghi chú cho người dùng.
  • Khắc phục một trong các vấn đề về tài liệu để cải thiện tài liệu Jenkins X hiện có.

Tuần 7 (26/10 – 1/11)

  • Thao tác trên ma trận chức năng Jenkins X cho đám mây Azure (AKS): cài đặt Jenkins X và chuẩn bị bản nháp ghi chú cho người dùng.
  • Khắc phục một trong các vấn đề về tài liệu để cải thiện tài liệu Jenkins X hiện có.
  • Thiết lập cơ sở hạ tầng môi trường xem trước của Jenkins X dựa trên OpenShift.

Tuần 8 (2/11 – 8/11)

  • Hoàn tất tài liệu người dùng cho Jenkins X trên AKS.
  • Khắc phục một trong các vấn đề về tài liệu để cải thiện tài liệu Jenkins X hiện có.

Tuần 9 (9/11 – 15/11)

  • Thao tác trên ma trận chức năng Jenkins X cho AWS (EKS): cài đặt Jenkins X và chuẩn bị bản nháp ghi chú cho người dùng.
  • Khắc phục một trong các vấn đề về tài liệu để cải thiện tài liệu Jenkins X hiện có.
  • Thiết lập cơ sở hạ tầng môi trường xem trước của Jenkins X dựa trên OpenShift.

Tuần 10 (16/11 – 22/11)

  • Thao tác trên ma trận chức năng Jenkins X cho AWS (EKS): cài đặt Jenkins X và chuẩn bị bản nháp ghi chú cho người dùng.
  • Khắc phục một trong các vấn đề về tài liệu để cải thiện tài liệu Jenkins X hiện có.

Tuần 11 (23/11 – 29/11)

  • Hoàn tất tài liệu người dùng cho Jenkins X trên EKS.
  • Khắc phục một trong các vấn đề về tài liệu để cải thiện tài liệu Jenkins X hiện có.
  • Hoàn tất tài liệu về cơ sở hạ tầng môi trường xem trước của Jenkins X trên trang web tài liệu của Jenkins X.

Tuần 12 (30/11 – 5/12)

  • Hoàn thiện các sản phẩm trong dự án và tái cấu trúc mã (nếu có) dựa trên ý kiến phản hồi.
  • Kiểm tra hoạt động của trang web tài liệu của Jenkins X, bao gồm các đường liên kết, hình ảnh, siêu liên kết và các nội dung khác.
  • Kiểm tra để tìm chế độ điều khiển và thao tác do người dùng xác định trên trang web tài liệu của Jenkins X.
  • Kiểm tra bản trình bày hoàn thiện của ma trận Jenkins X Capabilites.

Trước ngày 10 tháng 12 năm 2020 Cả Người viết kỹ thuật và Người cố vấn đều gửi ý kiến đánh giá dự án.

Dự án đề xuất mang lại những lợi ích gì cho Jenkins X và cộng đồng của Jenkins? Dự án này sẽ giúp cộng đồng Jenkins X cải thiện tài liệu cho người dùng cuối cũng như nhà phát triển để tham khảo về cấu trúc kỹ thuật, khả năng tương thích, cách sử dụng và tích hợp của Jenkins X. Sau khi dự án đề xuất này hoàn thành, sẽ có một tài liệu hoàn chỉnh, được xác định rõ ràng và xác minh về mặt kỹ thuật về người dùng của Jenkins X cùng với Ma trận chức năng của Jenkins X về khả năng tương thích với các nhà cung cấp dịch vụ đám mây khác nhau.

Bạn dự định sẽ tạo ra những lợi ích nào trong tương lai với Jenkins X? Sau khi kết thúc chương trình Phần Tài liệu năm 2020 trên Google, tôi dự định trở thành người đóng góp lâu dài cho dự án Jenkins X với tư cách là một thành viên tích cực của cộng đồng. Tôi sẽ luôn sẵn sàng trợ giúp người khác (người mới) và khuyến khích họ tham gia vào cộng đồng Jenkins X. Tôi luôn sẵn sàng thực hiện các ý tưởng khác về dự án Jenkins X.

Sau đây là một số lý do khiến tôi phù hợp nhất để làm việc trong dự án này:

  • Tôi làm việc rất có phương pháp và có tổ chức. Tôi rất hy vọng có thể tiếp tục cung cấp thông tin về tiến độ của dự án cho cả cố vấn dự án và cộng đồng của tổ chức qua bài đăng trên blog mỗi tuần một lần, lên lịch họp hằng tuần về tài liệu SIG và qua email.
  • Sẽ thường xuyên tìm kiếm hướng dẫn cũng như ý kiến phản hồi từ những người cố vấn và các thành viên trong cộng đồng để tiến hành các nhiệm vụ và đảm bảo mọi người cùng hiểu rõ nhau (bao gồm cả những khó khăn và/hoặc những vấn đề gặp phải).
  • Thường xuyên cam kết tất cả các mã nguồn được viết để người cố vấn, cộng tác viên đánh giá mã nguồn và ghi lại công việc đã hoàn thành để các thành viên trong cộng đồng tham khảo.
  • Tôi có tất cả các kỹ năng kỹ thuật cần thiết để thực hiện ý tưởng của dự án này và đã thảo luận về đề xuất dự án với các cố vấn của Deane, Kara và Daniel. Tôi đã hiểu rõ về đề xuất dự án và các thành phần có thể thực hiện.
  • Tôi có kinh nghiệm làm việc với các kỹ năng kỹ thuật (Google Cloud, Azure Cloud, AWS, Kubernetes, OpenShift, Hugo và các kỹ năng cần thiết khác) cần thiết để cung cấp một tài liệu hoàn chỉnh cũng như giải quyết hầu hết các vấn đề hiện tại liên quan đến tài liệu. Tôi có thái độ tích cực để có thể hoàn thành dự án đúng hạn mà không cần phải giám sát nhiều.