Làm thế nào để bạn tránh tài liệu máy chủ không đồng bộ với thiết lập thực tế?

Chúng tôi có tài liệu hợp lý tốt cho môi trường của chúng tôi (ở định dạng AsciiDoc) gần đây cho phép người khác tạo lại toàn bộ thiết lập từ đầu trong vòng chưa đầy 30 phút.
Tuy nhiên, tôi nhận thấy rằng sau khi thiết lập ban đầu, có thể dễ dàng xảy ra những thay đổi nhỏ được thực hiện đối với hệ thống (giả sử: inetd bị hỏng, máy chủ IMAP của tôi lắng nghe một cổng bổ sung cho các kết nối ManageSieve, một bộ định tuyến mới được thêm vào cấu hình exim) Tôi sẽ kết thúc tài liệu ngay lập tức (nếu có).

Ý tưởng của tôi là để tránh vấn đề này bằng cách (một phần?) Tạo ra các tài liệu ra khỏi các tập tin cấu hình và các ý kiến trong đó - một cách để thực hiện điều này có thể đặt /etcvà /usr/local/etcvào một số hệ thống quản lý mã nguồn (nói - git) và sau đó chạy một kịch bản mà tái tạo tài liệu trên mỗi cam kết. Tuy nhiên, tôi không chắc liệu điều đó có quá mức cần thiết và / hoặc quá khó để có được quyền hay không (sau tất cả, tôi không muốn có bản sao đầy đủ của các tệp nguồn trong tài liệu của mình mà chỉ là các khác biệt).

Làm thế nào để người khác tránh rằng tài liệu máy chủ bị lỗi thời - có cách nào tốt để giữ chúng tự động đồng bộ hóa hay bạn chỉ có kỷ luật để cập nhật tài liệu cùng lúc bạn sửa đổi hệ thống?

Bạn sẽ không bao giờ thoát khỏi một số tài liệu nhưng khi bạn bắt đầu, có những hệ thống có thể được tích hợp vào quá trình thay đổi của bạn để bao quát rất nhiều tài liệu.

• Sử dụng một công cụ quản lý cấu hình (như con rối hoặc đầu bếp ).
• Lưu cấu hình của bạn một cách kiểm soát thay đổi. (như git hoặc SVN )
• Đảm bảo rằng cấu hình có thể đọc / truy cập được bởi con người (ví dụ: văn bản thuần túy, db có thể tìm kiếm)

Bằng cách này, tài liệu cấp thấp hơn mà tất cả chúng ta thường bỏ lỡ (hoặc không bận tâm) được thi hành bằng cách lưu trữ thông tin triển khai đó trong các mục cấu hình hoặc mã như một phần của hệ thống mà bạn thực hiện thay đổi. Điều này cũng có một phần thưởng bổ sung của quá trình trở nên lặp lại nhiều hơn trong tương lai.

Tài liệu bên ngoài vẫn cần phải được cập nhật nhưng nó trở nên rất cao với các con trỏ để "triển khai x" hoặc "triển khai y" thay vì danh sách lệnh / tệp dài. Điều này cũng làm cho tài liệu thay đổi cả ít thường xuyên hơn và dễ dàng hơn cũng có nghĩa là nó sẽ có nhiều khả năng được thực hiện.

Ngoài ra trước khi bạn về nhà pha chế, với con rối có lẽ ai đó đã viết một cái gì đó để quản lý những gì bạn muốn.

Nếu bạn chỉ quản trị một hoặc hai hệ thống nhỏ, việc thiết lập một hệ thống quản lý cấu hình lớn như con rối hoặc đầu bếp có vẻ như quá mức cần thiết. (Mặc dù, nếu bạn có kế hoạch có nhiều hệ thống hơn trong tương lai, hãy thực hiện ngay bây giờ!)

Đối với một thiết lập nhỏ như thế này, tôi khuyên bạn nên sử dụng một cái gì đó như etckeeper, một chương trình đưa /etcvào gitkho lưu trữ và cung cấp một vài chức năng hữu ích, như thực hiện một cam kết tự động bất cứ khi nào bạn cài đặt, nâng cấp hoặc gỡ bỏ gói.

Bạn chỉ cần cập nhật tài liệu của mình mỗi khi bạn thực hiện thay đổi trên hệ thống. AKA Change Management.

Thực tế là hầu hết các công ty thực hiện quản lý thay đổi theo cách vô lý như vậy để làm cho nó tồi tệ hơn không có gì không nên làm mất đi tiện ích của khái niệm cơ bản hoặc ngăn bạn làm điều đó đúng.

Tôi đã từng sử dụng htmlhoặc một số loại wiki để theo dõi tất cả các cấu hình của tôi. Bây giờ tôi làm việc trong một cửa hàng Windows với ( shudder ) SharePoint, vì vậy bây giờ tôi sử dụng "mẫu" tài liệu Word mà tôi đã tạo để theo dõi mọi hệ thống tôi có và mọi thay đổi cấu hình tôi thực hiện, không tệ như âm thanh, với nhiều các hệ thống chỉ là bản sao cookie-cut của những cái khác mà tất cả có thể được gộp lại với nhau trong cùng một tài liệu. (Và tôi giữ các bản sao cục bộ của tất cả các tài liệu của tôi, ổ cứng của tôi, thực sự được tổ chức theo kiểu hợp lý, ngoài việc ném chúng vào đống không có tổ chức là trang SharePoint của bất kỳ ai.)

Thách thức lớn nhất là thực sự dành thời gian để làm tài liệu, điều mà tôi làm bằng cách thêm thời gian tài liệu như một phần thời gian để thực hiện thay đổi. Vì vậy, thực sự không khó lắm, đặc biệt là nếu bạn là một người khờ khạo và không ngại bảo mọi người bỏ cuộc và chờ đợi vì bạn quá bận rộn cho vấn đề của họ vào lúc này.