使用 wiki 維護(hù) AIX 文檔

5Seven

簡(jiǎn)介

與系統(tǒng)管理相關(guān)的最困難的任務(wù)之一是維護(hù)一個(gè)最新的、全面的、涵蓋所有系統(tǒng)的集中式文檔存儲(chǔ)庫(kù)。文檔存儲(chǔ)庫(kù)也是任何業(yè)務(wù)連續(xù)性計(jì)劃的關(guān)鍵部分，它為所有培訓(xùn)、支持、維護(hù)和災(zāi)難恢復(fù)活動(dòng)提供基礎(chǔ)。本文為維護(hù)使用業(yè)務(wù)連續(xù)性概念實(shí)現(xiàn)的、用于 IBM® AIX® 技術(shù)文檔的 wiki 服務(wù)器，提供一種結(jié)構(gòu)、配置和自動(dòng)化方法。

這里討論的 wiki 服務(wù)器基于 MediaWiki 軟件，為編寫和維護(hù)文檔存儲(chǔ)庫(kù)提供一個(gè)協(xié)作環(huán)境。除了協(xié)作功能之外，它還為存儲(chǔ)庫(kù)中的所有文檔創(chuàng)建標(biāo)準(zhǔn)的外觀和感覺。本文中提供的結(jié)構(gòu)為存儲(chǔ)庫(kù)的所有貢獻(xiàn)者提供一個(gè)容易維護(hù)的環(huán)境。

手工與自動(dòng)化文檔

技術(shù)文檔的難題之一是，文檔一編寫好，馬上就會(huì)變得陳舊、過(guò)時(shí)和不可靠。這是因?yàn)楝F(xiàn)代數(shù)據(jù)中心環(huán)境中的大多數(shù)系統(tǒng)是動(dòng)態(tài)的，總是在不斷地升級(jí)、改進(jìn)和調(diào)優(yōu)。由于現(xiàn)代數(shù)據(jù)中心具有動(dòng)態(tài)性，如果手工編寫技術(shù)文檔，文檔就不可能可靠。編寫文檔要花費(fèi)時(shí)間，而大多數(shù)管理員沒時(shí)間及時(shí)地在文檔中完整地記錄對(duì)每個(gè)系統(tǒng)的更改�？偸怯斜雀�新系統(tǒng)文檔更重要、更緊迫的任務(wù)。

本文提出的主要觀點(diǎn)之一是，系統(tǒng)管理員應(yīng)該不再編寫文檔，而是應(yīng)該自動(dòng)地生成文檔并把文檔上傳到集中式文檔服務(wù)器。系統(tǒng)管理員編寫文檔花費(fèi)的時(shí)間實(shí)際上是浪費(fèi)了，因?yàn)槲臋n完成之后馬上就過(guò)時(shí)了。數(shù)據(jù)中心環(huán)境中的所有文檔必須定期地（每小時(shí)、每天、每周或每個(gè)月）自動(dòng)生成。系統(tǒng)管理員應(yīng)該花時(shí)間編寫生成文檔的自動(dòng)化過(guò)程，而不是編寫文檔。按更一般化的說(shuō)法，AIX 系統(tǒng)管理員的工作是把所有任務(wù)都自動(dòng)化，包括文檔。

從手工編寫文檔轉(zhuǎn)換到自動(dòng)生成技術(shù)文檔要求系統(tǒng)管理員編寫自動(dòng)執(zhí)行這些過(guò)程的程序和腳本。手工編寫技術(shù)文檔通常很乏味、無(wú)聊而且很耗時(shí)間。因此，大多數(shù)管理員都盡可能回避它。把這個(gè)任務(wù)由手工編寫變成編程任務(wù)，會(huì)重新喚起管理員的熱情，因?yàn)榫幊逃幸馑级嗔�。讓他們更新和改進(jìn)自動(dòng)化過(guò)程可以保持他們的熱情。結(jié)果是，技術(shù)文檔總是最新且可靠的。

在系統(tǒng)管理方面，相當(dāng)多的精力花費(fèi)在培訓(xùn)和重新培訓(xùn)系統(tǒng)管理員上。通過(guò)提供圍繞業(yè)務(wù)連續(xù)性概念設(shè)計(jì)的標(biāo)準(zhǔn)化自動(dòng)文檔存儲(chǔ)庫(kù)，可以顯著減少這方面的工作量。這種存儲(chǔ)庫(kù)能夠立即提高管理員的生產(chǎn)力和交流水平。

自動(dòng)生成技術(shù)文檔的另一個(gè)好處是減輕管理員的工作負(fù)擔(dān)，這會(huì)降低管理企業(yè)的總成本。

由于現(xiàn)代數(shù)據(jù)中心具有動(dòng)態(tài)性而且管理員的工作負(fù)擔(dān)很重，技術(shù)文檔必須是從系統(tǒng)和應(yīng)用程序生成的，這樣才能確保文檔是最新的、一致的和可靠的。任何業(yè)務(wù)連續(xù)性計(jì)劃都包含自動(dòng)生成技術(shù)文檔的需求。

在這里，“業(yè)務(wù)連續(xù)性” 這個(gè)詞可能會(huì)引起一些讀者的誤解，因?yàn)樵S多組織把業(yè)務(wù)連續(xù)性等同于災(zāi)難恢復(fù)。對(duì)于本文的主題，這兩個(gè)詞的意思并不相同。本文中使用的 “業(yè)務(wù)連續(xù)性” 的定義如下：

“業(yè)務(wù)連續(xù)性由一些每天都要執(zhí)行的活動(dòng)組成，其目的是確保業(yè)務(wù)在當(dāng)前和以后都正常運(yùn)營(yíng)�？梢园褬I(yè)務(wù)連續(xù)性計(jì)劃看作運(yùn)營(yíng)日常業(yè)務(wù)的方法或全企業(yè)范圍的思想觀念。”

用于 AIX 技術(shù)文檔的 wiki 結(jié)構(gòu)

為了輔助生成技術(shù)文檔的自動(dòng)過(guò)程，必須創(chuàng)建一個(gè)集中式文檔存儲(chǔ)庫(kù)，它應(yīng)該允許世界上任何地方的系統(tǒng)創(chuàng)建/上傳/更新相關(guān)的文檔。它還應(yīng)該為文檔提供標(biāo)準(zhǔn)的外觀和感覺以及標(biāo)準(zhǔn)的結(jié)構(gòu)。

當(dāng)前能夠滿足所有需求的最好的解決方案是 "wiki" 服務(wù)器。wiki 提供一個(gè)協(xié)作性的文檔環(huán)境，它維護(hù)文檔歷史、安全性以及外觀和感覺，允許幾乎無(wú)限的定制。有許多種 wiki 服務(wù)器；本文主要關(guān)注 MediaWiki 的開放源碼 wiki 服務(wù)器。

但是，僅僅下載并安裝 wiki 服務(wù)器作為集中式文檔存儲(chǔ)庫(kù)使用是不夠的。必須有與服務(wù)器相關(guān)聯(lián)的結(jié)構(gòu)，從而確保以一致的方式組織文檔。本文討論的結(jié)構(gòu)是一個(gè)業(yè)務(wù)連續(xù)性結(jié)構(gòu)。這種文檔結(jié)構(gòu)完全針對(duì)現(xiàn)代數(shù)據(jù)中心環(huán)境的需求，提供支持任何業(yè)務(wù)場(chǎng)景所需的靈活性。本文為搭建和維護(hù)用于 IBM AIX 技術(shù)文檔的 wiki 服務(wù)器提供一種業(yè)務(wù)連續(xù)性結(jié)構(gòu)、配置和方法。

與維護(hù)集中式文檔存儲(chǔ)庫(kù)相關(guān)的另一個(gè)困難的任務(wù)是，對(duì)存儲(chǔ)庫(kù)中的文檔實(shí)施標(biāo)準(zhǔn)。通過(guò)實(shí)現(xiàn)基于標(biāo)準(zhǔn)業(yè)務(wù)連續(xù)性結(jié)構(gòu)的集中式文檔存儲(chǔ)庫(kù)，實(shí)施標(biāo)準(zhǔn)會(huì)變得容易得多。在把文檔上傳到存儲(chǔ)庫(kù)時(shí)，選擇（而且要求有）預(yù)定義的類別，這樣就可以消除組織存儲(chǔ)庫(kù)中的數(shù)據(jù)時(shí)存在的一些不確定性。另外，從存儲(chǔ)庫(kù)結(jié)構(gòu)形成一套系統(tǒng)管理方法，用來(lái)構(gòu)建、支持和維護(hù)全世界范圍的多數(shù)據(jù)中心的大型 IBM AIX 環(huán)境。這套方法覆蓋 IBM AIX 系統(tǒng)的整個(gè)生命周期，從計(jì)劃和部署直到退役和回收。

wiki 環(huán)境有助于為文檔創(chuàng)建標(biāo)準(zhǔn)的外觀和感覺；但是，搜索并找到想要的文檔很麻煩。本文提供的業(yè)務(wù)連續(xù)性類別結(jié)構(gòu)為存儲(chǔ)庫(kù)的所有貢獻(xiàn)者提供一個(gè)容易維護(hù)的環(huán)境，它包括：

• 用于業(yè)務(wù)連續(xù)性的類別結(jié)構(gòu)
  
  • 策略
  • 方針
  • 標(biāo)準(zhǔn)
  • 過(guò)程
  • 組織結(jié)構(gòu)
  • 資源利用
    
• 用于災(zāi)難恢復(fù)的類別結(jié)構(gòu)
• 業(yè)務(wù)影響分析
• 服務(wù)水平協(xié)議，RPO，RTO
• 威脅和風(fēng)險(xiǎn)
• 緩解和意外情況
• 備份和恢復(fù)過(guò)程
• 恢復(fù)場(chǎng)景
• 恢復(fù)測(cè)試
• 指揮中心
• 用于 shell 腳本的類別結(jié)構(gòu)
• 用于電子商務(wù)的類別結(jié)構(gòu)
  

業(yè)務(wù)連續(xù)性 wiki 結(jié)構(gòu)的目的是，整合并自動(dòng)處理世界各地?cái)?shù)據(jù)中心中的 IBM AIX 系統(tǒng)的技術(shù)文檔。

用于用戶與 wiki 服務(wù)器交互的自動(dòng)腳本

為了自動(dòng)構(gòu)建業(yè)務(wù)連續(xù)性 wiki 結(jié)構(gòu)，本文提供幾個(gè) shell 腳本。這些腳本自動(dòng)地執(zhí)行相關(guān)過(guò)程，包括上傳文件、創(chuàng)建新頁(yè)面、修改現(xiàn)有頁(yè)面、創(chuàng)建/修改類別、創(chuàng)建/修改模板等等。

wikiAutoLoad

wikiAutoLoad 是自動(dòng)的 wiki 內(nèi)容上傳腳本，它為 shell 程序員或系統(tǒng)管理員提供一種把 wiki 內(nèi)容上傳到 MediaWiki 服務(wù)器的自動(dòng)機(jī)制�？梢栽诮M織中的任何系統(tǒng)上運(yùn)行此腳本，把信息自動(dòng)地上傳到集中式 wiki 文檔服務(wù)器。

wikiAutoLoad 提供以下特性：

• 能夠動(dòng)態(tài)地把內(nèi)容上傳到世界上任何地方的任何 MediaWiki 服務(wù)器。
• 根據(jù)包含上傳內(nèi)容的文件的名稱動(dòng)態(tài)地決定頁(yè)面名稱。
• 在上傳內(nèi)容時(shí)，可以給頁(yè)面分配多個(gè) wiki 類別。
• 任何 wiki 用戶都可以使用此腳本上傳內(nèi)容，不要求是管理員。
• 可以大批量上傳任何基于文本的文件的內(nèi)容。
• 在大批量上傳時(shí)，根據(jù)文件名自動(dòng)地生成 wiki 頁(yè)面標(biāo)題。
• 對(duì)于單一文件上傳，用戶可以指定 wiki 頁(yè)面標(biāo)題。
  

wikiAutoLoad shell 腳本假設(shè)要上傳到 wiki 服務(wù)器的內(nèi)容存儲(chǔ)在本地系統(tǒng)上的文件中；每個(gè) wiki 頁(yè)面存儲(chǔ)在單獨(dú)的文件中。這個(gè)腳本使用 wget 命令發(fā)送文件并從 wiki 服務(wù)器接收 cookie。

其他幾個(gè)腳本創(chuàng)建業(yè)務(wù)連續(xù)性 wiki 結(jié)構(gòu)的特定部分。bcupload2wiki_k93 腳本和 mkbcupload_k93 腳本創(chuàng)建本文討論的業(yè)務(wù)連續(xù)性結(jié)構(gòu)。mkbcupload_k93 腳本包含整個(gè)業(yè)務(wù)連續(xù)性結(jié)構(gòu)并生成 bcupload2wiki_k93 腳本。bcupload2wiki_k93 腳本與 wiki 服務(wù)器通信，創(chuàng)建并修改頁(yè)面。用戶可以使用它們修改業(yè)務(wù)連續(xù)性結(jié)構(gòu)以滿足自己的需要，然后重新生成 bcupload2wiki_k93 腳本，最后修改 wiki 服務(wù)器本身。

bcupload2Wiki_k93

使用這個(gè) 腳本 把業(yè)務(wù)連續(xù)性類別結(jié)構(gòu)上傳到 wiki 服務(wù)器，這要用到 wikiAutoLoad 腳本和 wget。

mkbcupload_k93

mkbcupload_k93 腳本使用其中定義的類別列表生成 bcupload2wiki_k93 腳本。很容易定制這個(gè)腳本以滿足自己的需要。

mkdrupload_k93 腳本包含整個(gè)災(zāi)難恢復(fù)結(jié)構(gòu)并生成 drupload2wiki_k93 腳本。drupload2wiki_k93 腳本與 wiki 服務(wù)器通信，創(chuàng)建并修改頁(yè)面。用戶可以使用它們修改災(zāi)難恢復(fù)結(jié)構(gòu)以滿足自己的需要，然后重新生成 drupload2wiki_k93 腳本，最后修改 wiki 服務(wù)器本身。

drupload2Wiki_k93

drupload2Wiki_k93 腳本把災(zāi)難恢復(fù)類別結(jié)構(gòu)上傳到 wiki 服務(wù)器，這要用到 wikiAutoLoad 腳本和 wget。

mkdrupload_k93

mkdrupload_k93 腳本使用其中定義的類別列表生成 drupload2wiki_k93 腳本。可以定制這個(gè)腳本以滿足自己的需要。

mkebupload_k93 腳本包含整個(gè)電子商務(wù)類別結(jié)構(gòu)并生成 ebupload2wiki_k93 腳本。ebupload2wiki_k93 腳本與 wiki 服務(wù)器通信，創(chuàng)建并修改頁(yè)面。用戶可以使用它們修改電子商務(wù)類別結(jié)構(gòu)以滿足自己的需要，然后重新生成 ebupload2wiki_k93 腳本，最后修改 wiki 服務(wù)器本身。

ebupload2Wiki_k93

ebupload2wiki_k93 腳本把電子商務(wù)類別結(jié)構(gòu)上傳到 wiki 服務(wù)器，這要用到 wikiAutoLoad 腳本和 wget。

mkebupload2Wiki_k93

這個(gè) 腳本 使用其中定義的類別列表生成 ebupload2wiki_k93 腳本。很容易定制這個(gè)腳本以滿足自己的需要。

下面的腳本生成 wiki 結(jié)構(gòu)的其他部分，可以根據(jù)自己的需要使用它們。

shupload2Wiki_k93

shupload2Wiki_k93 腳本把 shell 腳本類別結(jié)構(gòu)上傳到 wiki 服務(wù)器，這要用到 wikiAutoLoad 腳本和 wget。

mkshupload_k93

mkshupload_k93 腳本使用其中定義的類別列表生成 shupload2wiki_k93 腳本。很容易定制這個(gè)腳本以滿足自己的需要。

aeupload2Wiki_k93

使用 aeupload2Wiki_k93 腳本把 AIX Expert 網(wǎng)站類別結(jié)構(gòu)上傳到 wiki 服務(wù)器，這要用到 這里 提供的 wikiAutoLoad 腳本和 wget。

mkaeupload_k93

mkaeupload_k93 腳本使用其中定義的類別列表生成 aeupload2wiki_k93 腳本。用戶很容易定制這個(gè)腳本以滿足自己的需要。

結(jié)束語(yǔ)

已經(jīng)使用本文介紹的業(yè)務(wù)連續(xù)性 wiki 結(jié)構(gòu)構(gòu)建了示例網(wǎng)站 AIX Expert。本文提出的主要概念是不應(yīng)該編寫 AIX 技術(shù)文檔；文檔應(yīng)該由系統(tǒng)本身定期地（每小時(shí)、每天、每周或每個(gè)月）自動(dòng)生成并上傳到主/輔集中文檔存儲(chǔ)庫(kù)。

轉(zhuǎn)變觀念

在計(jì)算環(huán)境中使用 AIX 系統(tǒng)的根本目的是自動(dòng)化，從而在多方面節(jié)省成本。如果 AIX 管理員以交互方式部署、管理、支持、維護(hù)和監(jiān)視 AIX 環(huán)境，那么使用 AIX 環(huán)境就沒有意義了。如果您的 AIX 環(huán)境是這種情況，那么需要采取以下措施之一：

• 用真正的 AIX 管理員替代當(dāng)前的管理員（顯然您的管理員只是會(huì)在 google 上搜索 AIX 的桌面管理員）；
• 或者馬上在整個(gè)企業(yè)范圍建立業(yè)務(wù)連續(xù)性和數(shù)據(jù)中心自動(dòng)化意識(shí)。利用這種觀念指導(dǎo)您的組織（和 AIX 管理員）遵從現(xiàn)代數(shù)據(jù)中心管理方法。
  

實(shí)際上，第二種措施應(yīng)該是每個(gè)組織運(yùn)營(yíng)日常業(yè)務(wù)的正常方法。

對(duì)于任何 AIX（或 UNIX®）管理員，自動(dòng)化方面的經(jīng)驗(yàn)規(guī)則是：在第一次執(zhí)行一個(gè)任務(wù)時(shí)，應(yīng)該記錄命令以便以后實(shí)現(xiàn)自動(dòng)化。第二次執(zhí)行任務(wù)時(shí)，管理員應(yīng)該根據(jù)以前記錄的命令為任務(wù)編寫腳本。第三次執(zhí)行任務(wù)時(shí)，管理員應(yīng)該自動(dòng)執(zhí)行并監(jiān)視任務(wù)，以后應(yīng)該一直按調(diào)度計(jì)劃自動(dòng)執(zhí)行此任務(wù)。

但是，這條經(jīng)驗(yàn)規(guī)則并不適用于文檔，因?yàn)槲臋n任務(wù)必須定期執(zhí)行，這是確定無(wú)疑的。因此，從最初部署系統(tǒng)開始，應(yīng)該從每個(gè)系統(tǒng)生成文檔，并在系統(tǒng)的整個(gè)生命周期中一直這么做。

在對(duì)任何任務(wù)進(jìn)行自動(dòng)化時(shí)，過(guò)程應(yīng)該包含生成文檔的步驟，或者編寫標(biāo)準(zhǔn)，讓文檔生成器能夠從過(guò)程創(chuàng)建文檔。

在現(xiàn)實(shí)環(huán)境中，完全自動(dòng)的文檔可能難以實(shí)現(xiàn)，但是應(yīng)該以此為目標(biāo)。至少應(yīng)該把每個(gè)系統(tǒng)上實(shí)現(xiàn)的自動(dòng)腳本和過(guò)程定期上傳到集中式文檔服務(wù)器。應(yīng)該定期這么做，這樣當(dāng)腳本有變動(dòng)時(shí)，文檔存儲(chǔ)庫(kù)會(huì)及時(shí)地反映這些變動(dòng)。通過(guò)使用按業(yè)務(wù)連續(xù)性概念分類的 wiki 服務(wù)器，文檔會(huì)與業(yè)務(wù)連續(xù)性結(jié)構(gòu)相關(guān)聯(lián)，有助于文檔任務(wù)的自動(dòng)化。

關(guān)于作者

French 先生在 IT 行業(yè)中的從業(yè)經(jīng)驗(yàn)已有三十多年，所涉及的行業(yè)也非常之多。他的工作重點(diǎn)主要是業(yè)務(wù)連續(xù)性、災(zāi)難恢復(fù)以及高可用性等領(lǐng)域，并且他設(shè)計(jì)和編寫了許多軟件包，以實(shí)現(xiàn)災(zāi)難恢復(fù)和高可用性過(guò)程的自動(dòng)化。他最大的貢獻(xiàn)是將系統(tǒng)管理作為一項(xiàng)自動(dòng)化的、面向業(yè)務(wù)的過(guò)程（而不是面向系統(tǒng)的、交互的過(guò)程）。他還是 Korn Shell 編程領(lǐng)域的著名專家。

http://www.ibm.com/developerworks/cn/aix/library/au-wiki_structure/index.html