背景

wiki.js 是非常優(yōu)秀的開源 Wiki 系統(tǒng)，盡管在與 xwiki 功能相比 ，還不算完善，但也在不斷進步。 常用的功能還是比較實用的，如：Wiki 寫 作、分享、權限管理功能還是非常實用的，UI 設計非常的漂亮，精美的界面和直觀的操作體驗，能夠滿足小團隊的基本知識管理需求。

認真閱讀全文，教你怎么領取禮品

我們需要在 PetaExpress KubeSphere 容器平臺中部署 Kubernetes集群

在 Peta Express 中部署 Kubernetes 非常的簡單方便，直接使用 PetaExpress 中內置的 QKE 就可以了，首先我們需要登錄到 PetaExpress 控制臺(登錄地址：https://cn.petaexpress.com )，在產品與服務中找到 AppCenter 控制臺 → 應用中心。

找到 QKE 立即部署即可。

按照提示輸入名稱，選擇集群規(guī)模等關鍵信息，然后提交就可以了。但需要注意集群的配置，如果是開發(fā)測試可以選擇 “基礎型開發(fā)環(huán)境” 或 “企業(yè)型測試環(huán)境”，如果是生產的話則可以選擇 “基礎型生產環(huán)境” 或 “企業(yè)型生產環(huán)境”，也可以自定義集群規(guī)模和HA。

根據(jù)集群的規(guī)模，部署時間大致2分鐘到10分鐘不等，速度還是非常的快的，能在極短的時間內完成。部署完 Kubernetes(K8S)，需要安裝 OpenEBS，完成這一環(huán)節(jié)后就可以安裝 Redis 了。

準備 storageclass

我們使用 OpenEBS 作為存儲，OpenEBS 默認安裝的 Local StorageClass 在 Pod 銷毀后自動刪除，不適合用于我的數(shù)據(jù)存儲，我們在

Local StorageClass 基礎上稍作修改，創(chuàng)建新的 StorageClass，允許 Pod 銷毀后，PV 內容繼續(xù)保留，手動決定怎么處理。

在項目空間的 存儲 → 存儲類型 → 創(chuàng)建 進行storageClass的創(chuàng)建

名稱：localretain

存儲系統(tǒng)：自定義

存儲卷擴容：否

回收機制：Retain

訪問模式：ReadWriteOnce

存儲系統(tǒng)：openebs.io/local

存儲卷延遲綁定：延遲綁定編輯完成后點擊創(chuàng)建，或直接點擊 編輯YAML ，將以下yaml內容粘貼后點擊創(chuàng)建

部署 PostgreSQL 數(shù)據(jù)庫

鑒于我們團隊在多個項目中也需要使用 PostgreSQL, 為了提高 PostgreSQL 數(shù)據(jù)庫的利用率和統(tǒng)一管理，我們獨立部署 PostgreSQL，并在

安裝 wiki.js 時，配置為使用外部數(shù)據(jù)庫。

準備用戶名密碼配置

我們使用 Secret 保存 PostgreSQL 用戶密碼等敏感信息。

在項目空間的 配置 → 保密字典 → 創(chuàng)建 進行保密字典的創(chuàng)建。

1 apiVersion: storage.k8s.io/v1

2 kind: StorageClass

3 metadata:

4annotations:

5cas.openebs.io/config: |

6- name: StorageType

7value: "hostpath"

8- name: BasePath

9value: "/var/openebs/localretain/"

10openebs.io/cas-type: local

11storageclass.beta.kubernetes.io/is-default-class: "false"

12storageclass.kubesphere.io/supported-access-modes: '["ReadWriteOnce"]'

13name: localretain

14 provisioner: openebs.io/local

15 reclaimPolicy: Retain

16 volumeBindingMode: WaitForFirstConsumer

部署 PostgreSQL 數(shù)據(jù)庫

鑒于我們團隊在多個項目中也需要使用 PostgreSQL, 為了提高 PostgreSQL 數(shù)據(jù)庫的利用率和統(tǒng)一管理，我們獨立部署 PostgreSQL，并在

安裝 wiki.js 時，配置為使用外部數(shù)據(jù)庫。

準備用戶名密碼配置

我們使用 Secret 保存 PostgreSQL 用戶密碼等敏感信息。

在項目空間的 配置 → 保密字典 → 創(chuàng)建 進行保密字典的創(chuàng)建。

首先我們定義一個名稱就叫 postgres-prod 點擊下一步，類型保持默認設置即可， 添加鍵值對數(shù)據(jù)。

鍵為 POSTGRES_PASSWORD ，值為 password ( 密碼自行準備修改 )

準備數(shù)據(jù)庫初始化腳本

使用 ConfigMap 保存數(shù)據(jù)庫初始化腳本，在 數(shù)據(jù)庫創(chuàng)建時，將 ConfigMap 中的數(shù)據(jù)庫初始化腳本掛載到 /docker-entrypoint-initdb.d, 容器初 始化時會自動執(zhí)行該腳本。

在項目空間的 配置 → 配置字典 → 創(chuàng)建 進行配置字典的創(chuàng)建。

名稱就叫 wikijs-postgres-init 然后下一步，添加鍵值對數(shù)據(jù)。

鍵為 init.sql ，值為

1CREATE DATABASE wikijs;

2CREATE USER wikijs with password 'password';

3GRANT CONNECT ON DATABASE wikijs to wikijs;

4GRANT USAGE ON SCHEMA public TO wikijs;

5GRANT SELECT,update,INSERT,delete ON ALL TABLES IN SCHEMA public TO wikijs;

6ALTER DEFAULT PRIVILEGES IN SCHEMA public GRANT SELECT ON TABLES TO wikijs;

以上 wikijs 用戶的密碼自行準備，明文保存。

準備存儲

我們使用 OpenEBS 來提供存儲服務。可以通過創(chuàng)建 PVC 來提供持久化存儲。

這里聲明一個 10G 的 PVC。

需按照以下步驟操作

在項目空間的 存儲 → 存儲卷 → 創(chuàng)建 進行PVC的創(chuàng)建。

名稱就叫 postgres-prod-data ，然后下一步，進行存儲設置。

存儲類型： localretain

訪問模式： ReadWriteOnce

存儲卷容量： 10G

高級設置無需修改，點擊創(chuàng)建按鈕即可。

部署 PostgreSQL 數(shù)據(jù)庫

在前面的步驟準備好各種配置信息和存儲后，就可以開始部署 PostgreSQL 服務了。

我們的 Kubernetes 沒有配置存儲陣列，使用的是 OpenEBS 作為存儲，采用 Deployment 方式部署 PostgreSQL。

需按照以下步驟操作

在項目空間的 應用負載 → 工作負載 → 部署 → 創(chuàng)建 進行 PostgreSQL 服務的創(chuàng)建。

基本信息里名稱就叫做 postgres-prod ，然后進行下一步容器組設置

容器組配置

這一步的核心就是配置 postgres 的容器。

容器組副本數(shù)量選擇1，點擊添加容器鏡像選擇 dockerhub 中的 abcfy2/zhparser:12-alpine ，并選擇使用默認端口，容器名稱改為 postgres-prod

勾選 環(huán)境變量 ，點擊 引用配置字典或保密字典 ，資源選擇 postgres-prod 保密字典，資源中的鍵選擇 POSTGRES_PASSWORD ，之后點擊對勾完成容器配置，點擊下一步配置 存儲卷設置

存儲設置

在這一步有兩個操作

掛載存儲卷

掛載配置字典

掛載存儲卷

選擇現(xiàn)有存儲卷 postgres-prod-data ，權限為讀寫，掛載地址為 /var/lib/postgresql/data ，配置好后點擊對勾完成配置

掛載配置字典

選擇配置字典 wikijs-postgres-init ，權限為只讀，掛載地址為 /docker-entrypoint-initdb.d ，配置好后點擊對勾完成配置

配置好后如下圖

點擊下一步進入最后的高級設置

高級設置 里是一些額外配置，可以根據(jù)自己場景選擇調整配置，調整完成后點擊 創(chuàng)建 。創(chuàng)建供其他 Pod 訪問的 Service

在項目空間的 應用負載 → 服務 → 創(chuàng)建 進行服務的創(chuàng)建

名稱就叫 postgres-prod 然后下一步，進入服務設置

內部訪問模式選擇 虛擬IP地址 ，指定工作負載選擇 postgres-prod

端口協(xié)議：TCP

端口名稱：tcp-5432

容器端口：5432

服務端口：5432

點擊下一步進入高級設置

高級設置 里是一些額外配置，可以根據(jù)自己場景選擇調整配置，調整完成后點擊 創(chuàng)建 。

部署 wiki.js

準備用戶名密碼配置

我們使用 Secret 保存 wiki.js 用于連接數(shù)據(jù)庫的用戶名密碼等敏感信息。

在項目空間的 配置 → 保密字典 → 創(chuàng)建 進行保密字典的創(chuàng)建。

名稱就叫 wikijs 然后下一步，類型選擇默認， 添加鍵值對數(shù)據(jù)。

鍵為 DB_USER ，值為 wikijs ( 和上方初始化腳本中的用戶名保持一致 )

鍵為 DB_PASS ，值為 password ( 和上方初始化腳本中的密碼保持一致 )

準備數(shù)據(jù)庫連接配置

我們使用 ConfigMap 保存 wiki.js 的數(shù)據(jù)庫連接信息。

在項目空間的 配置 → 配置字典 → 創(chuàng)建 進行配置字典的創(chuàng)建。

名稱就叫 wikijs 然后下一步，添加鍵值對數(shù)據(jù)。

鍵值對數(shù)據(jù)如下

1DB_TYPE: postgres

2 DB_HOST: postgres-prod

3DB_PORT: 5432

4 DB_NAME: wikijs創(chuàng)建數(shù)據(jù)庫用戶和數(shù)據(jù)庫

如果 PostgreSQL 數(shù)據(jù)庫里沒有創(chuàng)建 wikijs 用戶和數(shù)據(jù) ，需要手工完成一下工作：

通過『數(shù)據(jù)庫工具』連接 PostgreSQL 數(shù)據(jù)庫，執(zhí)行一下 SQL 語句，完成數(shù)據(jù)庫和用戶的創(chuàng)建、授權。

以上 wikijs 的密碼自行修改。

部署 wiki.js

這里我們采用 Deployment 方式部署 wiki.js。

在項目空間的 應用負載 → 工作負載 → 部署 → 創(chuàng)建 進行 wiki.js 服務的創(chuàng)建。

基本信息里名稱就叫做 wikijs ，然后進行下一步容器組設置

容器組配置

這一步的核心就是配置 wikijs 的容器。

容器組副本數(shù)量選擇1，點擊添加容器

5 HA_ACTIVE: true

1 CREATE DATABASE wikijs;

2 CREATE USER wikijs with password 'password';

3 GRANT CONNECT ON DATABASE wikijs to wikijs;

4 GRANT USAGE ON SCHEMA public TO wikijs;

5 GRANT SELECT,update,INSERT,delete ON ALL TABLES IN SCHEMA public TO wikijs;

6 ALTER DEFAULT PRIVILEGES IN SCHEMA public GRANT SELECT ON TABLES TO wikijs;鏡像選擇 dockerhub 中的 requarks/wiki:2 ，并選擇使用默認端口，容器名稱改為 wikijs

勾選 環(huán)境變量 ，點擊 引用配置字典或保密字典 ，先添加剛才創(chuàng)建的保密字典 wikijs ，然后添加配置字典 wikijs ，之后點擊對勾完成容器配置，點擊下一步配置

存儲卷設置存儲卷此處無需設置，點擊下一步進入高級配置

高級設置 里是一些額外配置，可以根據(jù)自己場景選擇調整配置，調整完成后點擊 創(chuàng)建 。

創(chuàng)建訪問 wiki.js 的 Service

在項目空間的 應用負載 → 服務 → 創(chuàng)建 進行服務的創(chuàng)建名稱就叫 wikijs 然后下一步，進入服務設置

內部訪問模式選擇 虛擬IP地址 ，指定工作負載選擇 wikijs

端口協(xié)議：TCP

端口名稱：tcp-3000

容器端口：3000

服務端口：3000點擊下一步進入高級設置，勾選外部訪問，訪問模式選擇NodePort，完成后點擊 創(chuàng)建 。

然后可以使用NodePort的IP + Port進行訪問wikijs。

配置 wiki.js 支持中文全文檢索

wiki.js 的全文檢索支持基于 PostgreSQL 的檢索，也支持 Elasticsearch 等，相對來說, PostgreSQL 比較輕量級，本項目中，我們使用

PostgreSQL 的全文檢索。

但是，因為 PostgreSQL 不支持中文分詞，需要額外安裝插件并配置啟用中文分詞，下面描述了為 wiki.js 啟動基于 PostgreSQL 數(shù)據(jù)庫中文

分詞的全文檢索。

授予 wikijs 用戶臨時超管權限

通過數(shù)據(jù)庫管理工具登錄有超管權限的 PostgreSQL 用戶，臨時授予 wiki.js 用戶臨時超管權限，便于啟動中文分詞功能。

啟用數(shù)據(jù)庫的中文分詞能力

使用數(shù)據(jù)庫管理工具登錄 PostgreSQL 數(shù)據(jù)庫的 wikijs 用戶，執(zhí)行以下命令，啟動數(shù)據(jù)庫的中文分詞功能。

1 ALTER USER wikijs WITH SUPERUSER;

1 CREATE EXTENSION pg_trgm;

2

3 CREATE EXTENSION zhparser;

4 CREATE TEXT SEARCH CONFIGURATION pg_catalog.chinese_zh (PARSER = zhparser);

5 ALTER TEXT SEARCH CONFIGURATION chinese_zh ADD MAPPING FOR n,v,a,i,e,l WITH simple;

6

7 -- 忽略標點影響

8 ALTER ROLE wikijs SET zhparser.punctuation_ignore = ON;

9

-- 短詞復合取消 wikijs 用戶的臨時超管權限

登錄 PostgreSQL 數(shù)據(jù)庫 wikijs 用戶，取消 wikijs 用戶的超管權限。

創(chuàng)建支持中文分詞的配置 ConfigMap

在項目空間的 配置 → 配置字典 → 創(chuàng)建 進行配置字典的創(chuàng)建。

名稱就叫 wikijs-zhparser 然后下一步，添加兩個鍵值對數(shù)據(jù)。

10 ALTER ROLE wikijs SET zhparser.multi_short = ON;

11

12-- 測試一下

13select ts_debug('chinese_zh', '青春是最美好的年歲，青春是最燦爛的日子。每一個人的青春都無比寶貴，寶貴的青春只有與奮斗為伴才最閃光

取消 wikijs 用戶的臨時超管權限

登錄 PostgreSQL 數(shù)據(jù)庫 wikijs 用戶，取消 wikijs 用戶的超管權限。

1 ALTER USER wikijs WITH NOSUPERUSER;

創(chuàng)建支持中文分詞的配置 ConfigMap

在項目空間的 配置 → 配置字典 → 創(chuàng)建 進行配置字典的創(chuàng)建。

名稱就叫 wikijs-zhparser 然后下一步，添加兩個鍵值對數(shù)據(jù)。

1. 鍵為 definition.yml ，值為

1 key: postgres

2 title: Database - PostgreSQL

3 description: Advanced PostgreSQL-based search engine.

4 author: requarks.io

5 logo: https://static.requarks.io/logo/postgresql.svg

6 website: https://www.requarks.io/

7 isAvailable: true

8 props:

9dictLanguage:

10type: String

11title: Dictionary Language

12hint: Language to use when creating and querying text search vectors.2. 鍵為 engine.js ，值為

13default: english

14enum:

15- simple

16- danish

17- dutch

18- english

19- finnish

20- french

21- german

22- hungarian

23- italian

24- norwegian

25- portuguese

26- romanian

27- russian

28- spanish

29- swedish

30- turkish

31- chinese_zh

32order: 1

2. 鍵為 engine.js ，值為

1 const tsquery = require('pg-tsquery')()

2 const stream = require('stream')

3 const Promise = require('bluebird')

4 const pipeline = Promise.promisify(stream.pipeline)

5

6 /* global WIKI */

7

8 module.exports = {

9async activate() {

10if (WIKI.config.db.type !== 'postgres') {

11throw new WIKI.Error.SearchActivationFailed('Must use PostgreSQL database to activate this engine!')

12}

13},

14async deactivate() {

15WIKI.logger.info(`(SEARCH/POSTGRES) Dropping index tables...`)

16await WIKI.models.knex.schema.dropTable('pagesWords')

17await WIKI.models.knex.schema.dropTable('pagesVector')

18WIKI.logger.info(`(SEARCH/POSTGRES) Index tables have been dropped.`)

19},

20/**

21* INIT

22*/

23async init() {

24WIKI.logger.info(`(SEARCH/POSTGRES) Initializing...`)

25

26// -> Create Search Index

27const indexExists = await WIKI.models.knex.schema.hasTable('pagesVector')

28if (!indexExists) {

29WIKI.logger.info(`(SEARCH/POSTGRES) Creating Pages Vector table...`)

30await WIKI.models.knex.schema.createTable('pagesVector', table => {

31table.increments()

32table.string('path')

33table.string('locale')

34table.string('title')

35table.string('description')

36table.specificType('tokens', 'TSVECTOR')

37table.text('content')

38})

39}

40// -> Create Words Index

41const wordsExists = await WIKI.models.knex.schema.hasTable('pagesWords')

42if (!wordsExists) {

43WIKI.logger.info(`(SEARCH/POSTGRES) Creating Words Suggestion Index...`)

44await WIKI.models.knex.raw(`

45CREATE TABLE "pagesWords" AS SELECT word FROM ts_stat(

46'SELECT to_tsvector(''simple'', "title") || to_tsvector(''simple'', "description") || to_tsvector(''s

47)`)

48await WIKI.models.knex.raw('CREATE EXTENSION IF NOT EXISTS pg_trgm')

49await WIKI.models.knex.raw(`CREATE INDEX "pageWords_idx" ON "pagesWords" USING GIN (word gin_trgm_ops)`)

50}

51

52WIKI.logger.info(`(SEARCH/POSTGRES) Initialization completed.`)

53},

54/**

55* QUERY

56*

57* @param {String} q Query

58* @param {Object} opts Additional options

59*/

60async query(q, opts) {

61try {

62let suggestions = []

63let qry = `

64SELECT id, path, locale, title, description

65FROM "pagesVector", to_tsquery(?,?) query

66WHERE (query @@ "tokens" OR path ILIKE ?)

67`

68let qryEnd = `ORDER BY ts_rank(tokens, query) DESC`

69let qryParams = [this.config.dictLanguage, tsquery(q), `%${q.toLowerCase()}%`]

70

71if (opts.locale) {

72qry = `${qry} AND locale = ?`

73qryParams.push(opts.locale)

74}

75if (opts.path) {

76qry = `${qry} AND path ILIKE ?`

77qryParams.push(`%${opts.path}`)

78}

79const results = await WIKI.models.knex.raw(`

80${qry}

81${qryEnd}

82`, qryParams)

83if (results.rows.length < 5) {

84const suggestResults = await WIKI.models.knex.raw(`SELECT word, word <-> ? AS rank FROM "pagesWords" WH

85suggestions = suggestResults.rows.map(r => r.word)

86}

87return {

88results: results.rows,

89suggestions,

90totalHits: results.rows.length

91}

92} catch (err) {

93WIKI.logger.warn('Search Engine Error:')

94WIKI.logger.warn(err)

95}

96},

97/**

98* CREATE

99*

100* @param {Object} page Page to create

101*/

102async created(page) {

103await WIKI.models.knex.raw(`

104INSERT INTO "pagesVector" (path, locale, title, description, "tokens") VALUES (

105?, ?, ?, ?, (setweight(to_tsvector('${this.config.dictLanguage}', ?), 'A') || setweight(to_tsvector('${

106)

107`, [page.path, page.localeCode, page.title, page.description, page.title, page.description, page.safeConten

108},

109/**

110* UPDATE

111*

112* @param {Object} page Page to update

113*/

114async updated(page) {

115await WIKI.models.knex.raw(`

116UPDATE "pagesVector" SET

117title = ?,

118description = ?,

119tokens = (setweight(to_tsvector('${this.config.dictLanguage}', ?), 'A') ||

120setweight(to_tsvector('${this.config.dictLanguage}', ?), 'B') ||

121setweight(to_tsvector('${this.config.dictLanguage}', ?), 'C'))

122WHERE path = ? AND locale = ?

123`, [page.title, page.description, page.title, page.description, page.safeContent, page.path, page.localeCod

124},

125/**

126* DELETE

127*

128* @param {Object} page Page to delete

129*/

130async deleted(page) {

131await WIKI.models.knex('pagesVector').where({

132locale: page.localeCode,

133path: page.path

134}).del().limit(1)

135},

136/**

137* RENAME

138*

139* @param {Object} page Page to rename

140*/

141async renamed(page) {

142await WIKI.models.knex('pagesVector').where({

143locale: page.localeCode,

144path: page.path

145}).update({

146locale: page.destinationLocaleCode,

147path: page.destinationPath

148})

149},

150/**

151* REBUILD INDEX

152

*/更新 wikijs 的 Deployment

wiki.js 的基于 PostgreSQL 的全文檢索引擎配置位于 /wiki/server/modules/search/postgres ，我們將前面配置的 ConfigMap 加載到這個目錄。

在項目空間的 應用負載 → 工作負載 → wikijs 進入 wikijs 工作負載的詳情頁

點擊左側更多操作，選擇編輯設置

點擊 存儲卷 → 掛載配置字典或保密字典

選擇配置字典 wikijs-zhparser ，權限為只讀，掛載地址為 /wiki/server/modules/search/postgres ，配置好后點擊對勾完成配置

點擊確定完成存儲卷的修改

配置 wiki.js ，啟用基于 PostgreSQL 的全文檢索

1. 新的 Deployment 創(chuàng)建完成后

2. 打開 wiki.js 管理3. 點擊搜索引擎

4. 選擇 Database - PostgreSQL

5. 在 Dictionary Language 的下拉菜單里選擇 chinese_zh。

6. 點擊應用，并重建索引。

7. 完成配置。

總結

“K8S學習教程(三):在PetaExpress KubeSphere 容器部署 Wiki 系統(tǒng) wiki.js 并啟用中文全文檢索”重點講解了wiki.js的部署方式，特別強調了其

對中文全文檢索功能的支持。集成了 PostgreSQL 和 zhparser 中文分詞插件。

相對于標準的 wiki.js 安裝部署過程，主要做了以下配置：

1、wiki.js 鏡像外掛了 ConfigMap ，用于修改原 Docker 鏡像里關于 PostgreSQL 搜索引擎配置的信息，以支持 chinese_zh 選項。

2、PostgreSQL 鏡像采用了 abcfy2/zhparser:12-alpine ，這個鏡像自帶 zhparser 中文分詞插件。

憑此文章可以去petaexpress官網(wǎng)發(fā)工單 充值≥1美元送10美元，獎勵數(shù)量有限先到先得。申領步驟：注冊→登錄→充值→發(fā)工單 回復“文章 網(wǎng)址+文章標題+申請獎勵”，

審核編輯 黃宇