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 tài liệu của Google.

Tóm tắt dự án

Tổ chức nguồn mở:
Jenkins X
Tác giả kỹ thuật:
Nitin
Tên dự án:
Tái cấu trúc trang web tài liệu Jenkins X hiện có và Jenkins X Capabilities Matrix
Độ dài dự án:
Thời hạn 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 các chức năng của Jenkins X mới cập nhật cùng với tài liệu của người dùng về việc sử dụng Jenkins X trên các 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 liên quan đến việc phát triển cơ sở hạ tầng môi trường xem trước Jenkins X dựa trên OpenShift, với sự cộng tác của Daniel.

Trong quá trình tái cấu trúc tài liệu Jenkins X hiện có, tôi sẽ xử lý một số vấn đề, bao gồm:

  • Khởi động trong Tài nguyên EKS: Sự cố
  • Vault không thành công trong EKS với Boot: Vấn đề
  • Tài liệu về envars để khởi động jx: Vấn đề
  • Tài liệu cần thiết để thiết lập Vault: Sự cố
  • Không nâng cấp được khởi động từ cục bộ lên kho lưu trữ: Vấn đề
  • Mối quan hệ phản hồi về tài liệu của "tạo" so với "cài đặt jx" so với "khởi động" so với "nhập": Vấn đề
  • Tài liệu Helm ở khắp mọi nơi: Vấn đề
  • Cải thiện tài liệu về lý do ChartMuseum, Monocular và Docker Registry không được thay thế bằng Vấn đề về Nexus
  • Không thể thay đổi Docker Registry khi sử dụng Boot + GKE: Vấn đề
  • 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 bên dướ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, tức là: Google Cloud (GKE), Amazon Web Services (AWS EKS) và Azure Cloud (AKS).

  • Cài đặt Jenkins X trên đám mây thông qua tập lệnh terraform và jx boot
  • 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 các nhà cung cấp đám mây này.
  • Bất kỳ Khả năng nào khác (Bộ nhớ Vault cho thông tin bảo mật, Phiên bản kiểm soát nguồn hoặc các phiên bản khác) sẽ được thảo luận với Deane và các thành viên cộng đồng Jenkins X.

Về công việc thiết lập cơ sở hạ tầng môi trường xem trước Jenkins X dựa trên OpenShift, công việc này 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

Sản phẩm của dự án:

  • Sửa lỗi qua PR cho các vấn đề về tài liệu nêu trên, trong đó xem xét việc tái cấu trúc tài liệu Jenkins X hiện có.
  • Cập nhật Bảng khả năng của Jenkins X cùng với tài liệu hướng dẫn 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ụ Kubernetes chủ yếu là AKS, EKS và GKE).
  • Thiết lập tự động cơ sở hạ tầng môi trường xem trước Jenkins X dựa trên OpenShift, với sự cộng tác của Daniel.

Tiến trình dự kiến (cùng với việc cần làm) được đề xuất:

Kết nối cộng đồng (17/8 – 13/9)

  • Thiết lập môi trường phát triển cho tài liệu kỹ thuật cũng như có quyền truy cập vào cơ sở hạ tầng trên đám mây để thực hiện các nhiệm vụ trong dự án.
  • Thảo luận với người cố vấn dự án về tiến trình dự kiến, sản phẩm dự án cũng như các nhiệm vụ (cùng với mức độ ưu tiên).
  • Tìm hiểu và nắm rõ quy trình làm việc của tổ chức, quy trình xem xét hoạt động quan hệ công chúng 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 tính năng hiện tại của Jenkins X (cần xác minh trên nhiều nhà cung cấp dịch vụ đám mây).
  • 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 (phối hợp với Daniel) để thiết kế kiến trúc cho cơ sở hạ tầng môi trường xem trước Jenkins X trên OpenShift.

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

  • Làm việc trên ma trận chức năng của 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.
  • Làm việc trên 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)

  • Làm việc trên ma trận chức năng của 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.
  • Giải quyết 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 Tài liệu thiết kế cho cơ sở hạ tầng môi trường xem trước 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.
  • Làm việc trên 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)

  • Làm việ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ị ghi chú nháp cho người dùng.
  • Làm việc trên 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 thiện tài liệu thiết kế cho cơ sở hạ tầng môi trường xem trước Jenkins X dựa trên OpenShift, sau khi nhận ý 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)

  • Làm việ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ị ghi chú nháp cho người dùng.
  • Làm việc trên 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)

  • Làm việ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ị ghi chú nháp cho người dùng.
  • Giải quyết 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 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.
  • Làm việc trên 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)

  • Làm việc trên ma trận chức năng của Jenkins X cho AWS (EKS): cài đặt Jenkins X và chuẩn bị ghi chú nháp cho người dùng.
  • Làm việc trên 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 việc thiết lập cơ sở hạ tầng môi trường xem trước Jenkins X dựa trên OpenShift.

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

  • Làm việc trên ma trận chức năng của Jenkins X cho AWS (EKS): cài đặt Jenkins X và chuẩn bị ghi chú người dùng nháp.
  • Làm việc trên 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.
  • Làm việc trên 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 tất các sản phẩm của 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 Jenkins X bao gồm đường liên kết, hình ảnh, siêu liên kết và các thông tin khác.
  • Kiểm tra chế độ điều khiển và điều hướng do người dùng xác định của trang web tài liệu Jenkins X.
  • Xem bản trình bày hoàn thiện về ma trận Khả năng của Jenkins X.

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

Dự án được đề xuất mang đến lợi ích gì cho Jenkins X và cộng đồng của họ? 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. Khi hoàn tất dự án đề xuất này, sẽ có tài liệu người dùng đầy đủ, được xác định rõ ràng và được xác minh kỹ thuật về Jenkins X cùng với Ma trận chức năng của Jenkins X để tương thích với nhiều nhà cung cấp dịch vụ đám mây.

Bạn dự định xây dựng những lợi ích nào trong tương lai với Jenkins X? Sau khi chương trình Google Season of Docs 2020 kết thúc, tôi dự định trở thành một cộng tác viên 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 giúp đỡ những 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 làm việc với các ý tưởng dự án Jenkins X khác.

Một số lý do khiến tôi phù hợp nhất để tham gia 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 mong có thể thông báo thường xuyên về tiến trình của dự án cho cả các cố vấn dự án và cộng đồng tổ chức thông qua các bài đăng trên blog mỗi tuần một lần, các cuộc họp SIG-docs theo lịch hằng tuần 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ừ các cố vấn và thành viên cộng đồng để tiến hành các nhiệm vụ và đảm bảo mọi người đều nắm được thông tin (bao gồm cả việc đề cập đến mọi thách thức và/hoặc điểm tắc nghẽn mà bạn gặp phải).
  • Thường xuyên gửi tất cả mã nguồn đã viết để được cố vấn, cộng tác viên xem xét mã 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 dự án này và đã thảo luận đề xuất dự án với các cố vấn Deane, Kara và Daniel. Tôi hiểu rõ đề xuất dự án và những gì 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 khác) cần thiết để cung cấp tài liệu đầy đủ cũng như giải quyết hầu hết các vấn đề liên quan đến tài liệu hiện tại. Tôi có thái độ tích cực, có thể hoàn thành công việc dự án đúng hạn mà không cần giám sát nhiều.