서버 문서가 실제 설정과 동기화되지 않도록하려면 어떻게해야합니까?


8

우리는 최근에 다른 사람이 30 분 이내에 전체 설정을 처음부터 다시 만들 수있게 해주는 환경 (AsciiDoc 형식)에 대한 적절한 문서를 가지고 있습니다.
그러나 초기 설정 후 시스템에 대한 작은 변경 사항 (예 : inetd가 비활성화되고 IMAP 서버가 ManageSieve 연결을 위해 추가 포트에서 수신하고 새 라우터가 exim 구성에 추가됨)이 쉽게 발생한다는 것을 알았습니다. 문서에 즉시 들어 가지 마십시오 (아직도).

이 넣을 수 있습니다 구현하는 한 가지 방법 - 내 생각은 구성 파일 중 문서와 그 안에 주석 생성 (? 부분)에 의해이 문제를 방지하는 것이었다 /etc/usr/local/etc(말 - 자식) 일부 소스 코드 관리 시스템에를 다음을 실행 모든 커밋마다 문서를 재생성하는 스크립트. 그러나 그것이 과도하거나 너무 어려워서 잘 모르겠습니다 (결국 문서에 소스 파일의 완전한 사본을 원하지 않고 단지 차이점 만 있습니다).

다른 사람들이 서버 문서의 구식을 피하는 방법-자동으로 동기화하는 좋은 방법이 있습니까, 아니면 시스템을 수정할 때 문서를 업데이트 할 수있는 원칙이 있습니까?


이 질문은 많은 중소 규모 상점에 적용될 수 있다고 생각합니다. 비슷한 문제가 있다는 것을 알고 있습니다. 나는 훈련과 작업 추정에 문서를 포함시키는 것이 지루하지만 간단한 해결책이라고 생각합니다
Rqomey

답변:


5

당신은 결코 어떤 문서에서 벗어나지 않을 것입니다. 그러나 당신이 예상 한대로 많은 것을 다루기 위해 변경 프로세스에 통합 될 수있는 시스템이 있습니다.

  • 구성 관리 도구 (예 : 꼭두각시 또는 chef )를 사용하십시오.
  • 구성을 변경 제어 방식으로 저장하십시오. ( git 또는 SVN 등 )
  • 사람이 구성을 읽거나 액세스 할 수 있는지 확인하십시오 (예 : 일반 텍스트, 검색 가능한 DB).

이런 식으로 우리가 일반적으로 놓치거나 방해하지 않는 하위 레벨 문서는 변경하는 시스템의 일부로 구성 항목 또는 코드에 배치 정보를 저장하여 적용됩니다. 또한 향후 반복되는 프로세스의 추가 보너스도 있습니다.

외부 문서는 여전히 업데이트해야하지만 긴 명령 / 파일 목록 대신 "deploy x"또는 "deploy y"에 대한 포인터를 통해 매우 높은 수준이됩니다. 이로 인해 문서 변경이 덜 빈번하고 쉬워 지므로 완료 될 가능성도 높아집니다.

또한 집에서 양조하기 전에 꼭두각시와 함께 누군가가 이미 원하는 것을 관리하기 위해 무언가를 작성 했을 것입니다 .


1
퍼펫 키우기 +1 한 번에 전체 호스트 세트에 변경 사항을 적용하는 데에만 사용되었다고 생각했지만 단일 시스템에 대해 변경 사항을 문서화하는 데 유용 할 수는 없었습니다.
Frerich Raabe

6

하나 또는 두 개의 작은 시스템 만 관리하는 경우 꼭두각시 나 요리사와 같은 큰 구성 관리 시스템을 설정하는 것은 과도한 것으로 보입니다. (하지만 앞으로 더 많은 시스템을 보유 할 계획이라면 지금하십시오!)

이와 같은 작은 설정의 경우 저장소 etckeeper/etc넣고 git패키지를 설치, 업그레이드 또는 제거 할 때마다 자동 커밋을 수행하는 것과 같은 유용한 기능을 제공하는 프로그램 과 같은 것을 사용하는 것이 좋습니다 .


재미있는, etckeeper작은 개조하면 되겠 잊어되지 않도록 방지하는 데 유용합니다 들린다.
Frerich Raabe

5

시스템을 변경할 때마다 문서를 업데이트하면됩니다. 일명 Change Management.

대부분의 회사가 변경 관리를 우스꽝스러운 방식으로 구현하여 기본 개념의 유용성을 떨어 뜨리거나 올바르게 수행하지 못하게해서는 안됩니다.

나는 html모든 설정을 추적하기 위해 일종의 위키를 사용했습니다 . 이제 ( shudder ) SharePoint 를 사용하여 Windows 상점에서 일하고 있으므로 이제는 모든 문서 및 구성 변경 사항을 추적하기 위해 만든 Word 문서 "서식 파일"을 사용합니다. 시스템은 다른 문서의 쿠키 커터 사본 일 뿐이며, 모두 같은 문서로 묶을 수 있습니다. (그리고 나는 모든 물건 문서의 로컬 사본을 내 하드 드라이브를 실제로 합리적인 방식으로 조직하고 다른 사람의 SharePoint 사이트 인 구성되지 않은 힙에 버리는 것 외에도 보관합니다.)

가장 큰 과제는 실제로 문서를 작성하는 시간을 만드는 것입니다. 문서 작성 시간을 변경 시간의 일부로 추가하여 수행합니다. 그래서, 그렇게 열심히하지 마십시오. 특히 약간의 엉덩이를 가지고 있고 현재 사람들이 너무 바빠서 사람들이 조여서 줄을 서서 기다리는 것을 신경 쓰지 않는다면 특히 그렇습니다.


Sharepoint가 구성되어 있지 않으면 제대로 작동하지 않는 것입니다. 우리는 기본 문서화 방법으로 사용하고 있으며 자동 버전 관리를 통해 유지 관리가 매우 간단합니다.
adaptor

1
+1 : '변경 관리'라는 용어를 삭제 해 주셔서 감사합니다.
Frerich Raabe 8

@adaptr 소규모 비즈니스 공간을 넘어서는 조직과 유용성으로 구현 된 것을 아직 보지 못했습니다. 따라서 현재 회사의 대주주가 좋은 일을하고 있지는 않지만 SharePoint 및 그 밖의 조직에서는 매우 보편적 인 문제입니다. 특정 크기.
HopelessN00b
당사 사이트를 사용함과 동시에 당사의 쿠키 정책개인정보 보호정책을 읽고 이해하였음을 인정하는 것으로 간주합니다.
Licensed under cc by-sa 3.0 with attribution required.