2. Helm chart (Kubernetes)¶
2.1. 目的¶
2.2. 特徴¶
2.3. 前提条件¶
クライアント要件
動作確認が取れているクライアントアプリケーションのバージョンは下記のとおりです。¶ アプリケーション
バージョン
Helm
v3.9.x
kubectl
1.23
デプロイ環境
動作確認が取れているコンテナ環境の最小要求リソースとバージョンは下記のとおりです。¶ リソース種別
要求リソース
CPU
2 Cores (3.0 GHz)
Memory
4GB
Storage (Container image size)
10GB
Kubernetes
1.23 以上
警告
要求リソースは Exastro IT Automation のコア機能に対する値です。同一クラスタ上に Keycloak や MariaDB などの外部ツールをデプロイする場合は、その分のリソースが別途必要となります。データベースおよびファイルの永続化のために、別途ストレージ領域を用意する必要があります。Storage サイズには、Exastro IT Automation が使用する入出力データのファイルは含まれていないため、利用状況に応じて容量を見積もる必要があります。通信要件
クライアントからデプロイ先のコンテナ環境にアクセスできる必要があります。
Platform 管理者用と一般ユーザー用の2つ通信ポートが使用となります。
コンテナ環境からコンテナイメージの取得のために、Docker Hub に接続できる必要があります。
外部コンポーネント
MariaDB、もしくは、MySQL サーバ
GitLab リポジトリ、および、アカウントの払い出しが可能なこと
警告
GitLab 環境を同一クラスタに構築する場合は、GitLab のシステム要件に対応する最小要件を追加で容易する必要があります。Database 環境を同一クラスタに構築する場合は、使用する Database のシステム要件に対応する最小要件を定義する必要があります
2.4. インストールの準備¶
2.4.1. Helm リポジトリの登録¶
共通基盤 (Exastro Platform)
Exastro IT Automation
リポジトリ |
---|
1# Exastro システムの Helm リポジトリを登録
2helm repo add exastro https://exastro-suite.github.io/exastro-helm/ -n exastro
3# リポジトリ情報の更新
4helm repo update
2.4.2. デフォルト設定値の取得¶
helm show values exastro/exastro > exastro.yaml
exastro.yaml
1# Default values for Exastro.
2# This is a YAML-formatted file.
3# Declare variables to be passed into your templates.
4global:
5 itaGlobalDefinition:
6 name: ita-global
7 enabled: true
8 image:
9 registry: "docker.io"
10 organization: exastro
11 package: exastro-it-automation
12 config:
13 DEFAULT_LANGUAGE: "ja"
14 LANGUAGE: "en"
15 CONTAINER_BASE: "kubernetes"
16 TZ: "Asia/Tokyo"
17 STORAGEPATH: "/storage/"
18 secret:
19 ENCRYPT_KEY: ""
20 persistence:
21 enabled: true
22 accessMode: ReadWriteMany
23 size: 10Gi
24 volumeType: hostPath # e.g.) hostPath or AKS
25 storageClass: "-" # e.g.) azurefile or - (None)
26 # matchLabels:
27 # release: "stable"
28 # matchExpressions:
29 # - {key: environment, operator: In, values: [dev]}
30 gitlabDefinition:
31 name: gitlab
32 enabled: true
33 config:
34 GITLAB_PROTOCOL: "http"
35 GITLAB_HOST: "gitlab"
36 GITLAB_PORT: "80"
37 secret:
38 GITLAB_ROOT_TOKEN: ""
39 itaDatabaseDefinition:
40 name: ita-database
41 enabled: true
42 config:
43 DB_VENDOR: "mariadb"
44 DB_HOST: "mariadb"
45 DB_PORT: "3306"
46 DB_DATABASE: "ITA_DB"
47 secret:
48 DB_ADMIN_USER: ""
49 DB_ADMIN_PASSWORD: ""
50 DB_USER: ""
51 DB_PASSWORD: ""
52 pfGlobalDefinition:
53 name: pf-global
54 enabled: true
55 image:
56 registry: "docker.io"
57 organization: exastro
58 package: exastro-platform
59 config:
60 DEFAULT_LANGUAGE: "ja"
61 LANGUAGE: "en"
62 TZ: "Asia/Tokyo"
63 PYTHONIOENCODING: utf-8
64 PLATFORM_API_PROTOCOL: "http"
65 PLATFORM_API_HOST: "platform-api"
66 PLATFORM_API_PORT: "8000"
67 PLATFORM_WEB_PROTOCOL: "http"
68 PLATFORM_WEB_HOST: "platform-web"
69 PLATFORM_WEB_PORT: "8000"
70 secret:
71 ENCRYPT_KEY: ""
72 persistence:
73 enabled: true
74 accessMode: ReadWriteMany
75 size: 10Gi
76 volumeType: hostPath # e.g.) hostPath or AKS
77 storageClass: "-" # e.g.) azurefile or - (None)
78 # matchLabels:
79 # release: "stable"
80 # matchExpressions:
81 # - {key: environment, operator: In, values: [dev]}
82 keycloakDefinition:
83 name: keycloak
84 enabled: true
85 config:
86 API_KEYCLOAK_PROTOCOL: "http"
87 API_KEYCLOAK_HOST: "keycloak"
88 API_KEYCLOAK_PORT: "8080"
89 KEYCLOAK_PROTOCOL: "http"
90 KEYCLOAK_HOST: "keycloak"
91 KEYCLOAK_PORT: "8080"
92 KEYCLOAK_MASTER_REALM: "master"
93 KEYCLOAK_DB_DATABASE: "keycloak"
94 secret:
95 KEYCLOAK_USER: ""
96 KEYCLOAK_PASSWORD: ""
97 KEYCLOAK_DB_USER: ""
98 KEYCLOAK_DB_PASSWORD: ""
99 itaDefinition:
100 name: ita
101 enabled: true
102 config:
103 ITA_WEB_PROTOCOL: "http"
104 ITA_WEB_HOST: "ita-web-server"
105 ITA_WEB_PORT: "8000"
106 ITA_API_PROTOCOL: "http"
107 ITA_API_HOST: "ita-api-organization"
108 ITA_API_PORT: "8080"
109 ITA_API_ADMIN_PROTOCOL: "http"
110 ITA_API_ADMIN_HOST: "ita-api-admin"
111 ITA_API_ADMIN_PORT: "8080"
112 pfDatabaseDefinition:
113 name: pf-database
114 enabled: true
115 config:
116 DB_VENDOR: "mariadb"
117 DB_HOST: "mariadb"
118 DB_PORT: "3306"
119 DB_DATABASE: "platform"
120 secret:
121 DB_ADMIN_USER: ""
122 DB_ADMIN_PASSWORD: ""
123 DB_USER: ""
124 DB_PASSWORD: ""
125 databaseDefinition:
126 name: mariadb
127 enabled: true
128 secret:
129 MARIADB_ROOT_PASSWORD: ""
130 persistence:
131 enabled: true
132 reinstall: false
133 accessMode: ReadWriteOnce
134 size: 20Gi
135 volumeType: hostPath # e.g.) hostPath or AKS
136 storageClass: "-" # e.g.) azurefile or - (None)
137 # matchLabels:
138 # release: "stable"
139 # matchExpressions:
140 # - {key: environment, operator: In, values: [dev]}
141
142exastro-it-automation:
143 ita-api-admin:
144 replicaCount: 1
145 image:
146 repository: "exastro/exastro-it-automation-api-admin"
147 tag: ""
148 pullPolicy: IfNotPresent
149 extraEnv:
150 PLATFORM_API_HOST: "platform-api"
151 PLATFORM_API_PORT: "8000"
152
153 ita-api-organization:
154 replicaCount: 1
155 image:
156 repository: "exastro/exastro-it-automation-api-organization"
157 tag: ""
158 pullPolicy: IfNotPresent
159 extraEnv:
160 PLATFORM_API_HOST: "platform-api"
161 PLATFORM_API_PORT: "8000"
162
163 ita-by-ansible-execute:
164 replicaCount: 1
165 image:
166 repository: "exastro/exastro-it-automation-by-ansible-execute"
167 tag: ""
168 pullPolicy: IfNotPresent
169 extraEnv:
170 EXECUTE_INTERVAL: "10"
171 ANSIBLE_AGENT_IMAGE: "exastro/exastro-it-automation-by-ansible-agent"
172 ANSIBLE_AGENT_IMAGE_TAG: ""
173 PLATFORM_API_HOST: "platform-api"
174 PLATFORM_API_PORT: "8000"
175 serviceAccount:
176 create: false
177 name: "ita-by-ansible-execute-sa"
178
179 ita-by-ansible-legacy-role-vars-listup:
180 replicaCount: 1
181 extraEnv:
182 EXECUTE_INTERVAL: "10"
183 PLATFORM_API_HOST: "platform-api"
184 PLATFORM_API_PORT: "8000"
185 image:
186 repository: "exastro/exastro-it-automation-by-ansible-legacy-role-vars-listup"
187 tag: ""
188 pullPolicy: IfNotPresent
189
190 ita-by-ansible-legacy-vars-listup:
191 replicaCount: 1
192 extraEnv:
193 EXECUTE_INTERVAL: "10"
194 PLATFORM_API_HOST: "platform-api"
195 PLATFORM_API_PORT: "8000"
196 image:
197 repository: "exastro/exastro-it-automation-by-ansible-legacy-vars-listup"
198 tag: ""
199 pullPolicy: IfNotPresent
200
201 ita-by-ansible-pioneer-vars-listup:
202 replicaCount: 1
203 extraEnv:
204 EXECUTE_INTERVAL: "10"
205 PLATFORM_API_HOST: "platform-api"
206 PLATFORM_API_PORT: "8000"
207 image:
208 repository: "exastro/exastro-it-automation-by-ansible-pioneer-vars-listup"
209 tag: ""
210 pullPolicy: IfNotPresent
211
212 ita-by-ansible-towermaster-sync:
213 replicaCount: 1
214 extraEnv:
215 EXECUTE_INTERVAL: "10"
216 PLATFORM_API_HOST: "platform-api"
217 PLATFORM_API_PORT: "8000"
218 image:
219 repository: "exastro/exastro-it-automation-by-ansible-towermaster-sync"
220 tag: ""
221 pullPolicy: IfNotPresent
222
223 ita-by-cicd-for-iac:
224 replicaCount: 1
225 extraEnv:
226 EXECUTE_INTERVAL: "10"
227 PLATFORM_API_HOST: "platform-api"
228 PLATFORM_API_PORT: "8000"
229 image:
230 repository: "exastro/exastro-it-automation-by-cicd-for-iac"
231 tag: ""
232 pullPolicy: IfNotPresent
233
234 ita-by-collector:
235 replicaCount: 1
236 extraEnv:
237 EXECUTE_INTERVAL: "10"
238 PLATFORM_API_HOST: "platform-api"
239 PLATFORM_API_PORT: "8000"
240 image:
241 repository: "exastro/exastro-it-automation-by-collector"
242 tag: ""
243 pullPolicy: IfNotPresent
244
245 ita-by-conductor-regularly:
246 replicaCount: 1
247 extraEnv:
248 EXECUTE_INTERVAL: "10"
249 PLATFORM_API_HOST: "platform-api"
250 PLATFORM_API_PORT: "8000"
251 image:
252 repository: "exastro/exastro-it-automation-by-conductor-regularly"
253 tag: ""
254 pullPolicy: IfNotPresent
255
256 ita-by-conductor-synchronize:
257 replicaCount: 1
258 extraEnv:
259 EXECUTE_INTERVAL: "10"
260 PLATFORM_API_HOST: "platform-api"
261 PLATFORM_API_PORT: "8000"
262 image:
263 repository: "exastro/exastro-it-automation-by-conductor-synchronize"
264 tag: ""
265 pullPolicy: IfNotPresent
266
267 ita-by-excel-export-import:
268 replicaCount: 1
269 extraEnv:
270 EXECUTE_INTERVAL: "10"
271 PLATFORM_API_HOST: "platform-api"
272 PLATFORM_API_PORT: "8000"
273 image:
274 repository: "exastro/exastro-it-automation-by-excel-export-import"
275 tag: ""
276 pullPolicy: IfNotPresent
277
278 ita-by-execinstance-dataautoclean:
279 replicaCount: 1
280 extraEnv:
281 EXECUTE_INTERVAL: "10"
282 PLATFORM_API_HOST: "platform-api"
283 PLATFORM_API_PORT: "8000"
284 image:
285 repository: "exastro/exastro-it-automation-by-execinstance-dataautoclean"
286 tag: ""
287 pullPolicy: IfNotPresent
288
289 ita-by-file-autoclean:
290 replicaCount: 1
291 extraEnv:
292 EXECUTE_INTERVAL: "10"
293 PLATFORM_API_HOST: "platform-api"
294 PLATFORM_API_PORT: "8000"
295 image:
296 repository: "exastro/exastro-it-automation-by-file-autoclean"
297 tag: ""
298 pullPolicy: IfNotPresent
299
300 ita-by-hostgroup-split:
301 replicaCount: 1
302 extraEnv:
303 EXECUTE_INTERVAL: "10"
304 PLATFORM_API_HOST: "platform-api"
305 PLATFORM_API_PORT: "8000"
306 image:
307 repository: "exastro/exastro-it-automation-by-hostgroup-split"
308 tag: ""
309 pullPolicy: IfNotPresent
310
311 ita-by-menu-create:
312 replicaCount: 1
313 extraEnv:
314 EXECUTE_INTERVAL: "10"
315 PLATFORM_API_HOST: "platform-api"
316 PLATFORM_API_PORT: "8000"
317 image:
318 repository: "exastro/exastro-it-automation-by-menu-create"
319 tag: ""
320 pullPolicy: IfNotPresent
321
322 ita-by-menu-export-import:
323 replicaCount: 1
324 extraEnv:
325 EXECUTE_INTERVAL: "10"
326 PLATFORM_API_HOST: "platform-api"
327 PLATFORM_API_PORT: "8000"
328 image:
329 repository: "exastro/exastro-it-automation-by-menu-export-import"
330 tag: ""
331 pullPolicy: IfNotPresent
332
333 ita-by-terraform-cli-execute:
334 replicaCount: 1
335 extraEnv:
336 EXECUTE_INTERVAL: "10"
337 PLATFORM_API_HOST: "platform-api"
338 PLATFORM_API_PORT: "8000"
339 image:
340 repository: "exastro/exastro-it-automation-by-terraform-cli-execute"
341 tag: ""
342 pullPolicy: IfNotPresent
343
344 ita-by-terraform-cli-vars-listup:
345 replicaCount: 1
346 extraEnv:
347 EXECUTE_INTERVAL: "10"
348 PLATFORM_API_HOST: "platform-api"
349 PLATFORM_API_PORT: "8000"
350 image:
351 repository: "exastro/exastro-it-automation-by-terraform-cli-vars-listup"
352 tag: ""
353 pullPolicy: IfNotPresent
354
355 ita-by-terraform-cloud-ep-execute:
356 replicaCount: 1
357 extraEnv:
358 EXECUTE_INTERVAL: "10"
359 PLATFORM_API_HOST: "platform-api"
360 PLATFORM_API_PORT: "8000"
361 image:
362 repository: "exastro/exastro-it-automation-by-terraform-cloud-ep-execute"
363 tag: ""
364 pullPolicy: IfNotPresent
365
366 ita-by-terraform-cloud-ep-vars-listup:
367 replicaCount: 1
368 extraEnv:
369 EXECUTE_INTERVAL: "10"
370 PLATFORM_API_HOST: "platform-api"
371 PLATFORM_API_PORT: "8000"
372 image:
373 repository: "exastro/exastro-it-automation-by-terraform-cloud-ep-vars-listup"
374 tag: ""
375 pullPolicy: IfNotPresent
376
377 ita-database-setup-job:
378 image:
379 repository: ""
380 tag: ""
381 pullPolicy: IfNotPresent
382
383 ita-web-server:
384 replicaCount: 1
385 image:
386 repository: "exastro/exastro-it-automation-web-server"
387 tag: ""
388 pullPolicy: IfNotPresent
389
390 ita-migration:
391 extraEnv:
392 PLATFORM_API_HOST: "platform-api"
393 PLATFORM_API_PORT: "8000"
394 image:
395 repository: "exastro/exastro-it-automation-migration"
396 tag: ""
397 pullPolicy: IfNotPresent
398
399exastro-platform:
400 platform-api:
401 image:
402 repository: "exastro/exastro-platform-api"
403 tag: ""
404
405 platform-auth:
406 extraEnv:
407 # Please set the URL to access
408 EXTERNAL_URL: ""
409 EXTERNAL_URL_MNG: ""
410 ingress:
411 enabled: true
412 hosts:
413 - host: exastro-suite.example.local
414 paths:
415 - path: /
416 pathType: Prefix
417 backend: "http"
418 - host: exastro-suite-mng.example.local
419 paths:
420 - path: /
421 pathType: Prefix
422 backend: "httpMng"
423 service:
424 type: ClusterIP
425 # http:
426 # nodePort: 30080
427 # httpMng:
428 # nodePort: 30081
429 image:
430 repository: "exastro/exastro-platform-auth"
431 tag: ""
432
433 platform-migration:
434 image:
435 repository: "exastro/exastro-platform-migration"
436 tag: ""
437
438 platform-web:
439 image:
440 repository: "exastro/exastro-platform-web"
441 tag: ""
442
443 mariadb:
444 enabled: true
445 image:
446 repository: "mariadb"
447 tag: "10.9"
448 pullPolicy: IfNotPresent
449 resources:
450 requests:
451 memory: "256Mi"
452 cpu: "1m"
453 limits:
454 memory: "2Gi"
455 cpu: "4"
456
457 keycloak:
458 enabled: true
459 image:
460 repository: "exastro/keycloak"
461 tag: ""
462 pullPolicy: IfNotPresent
463 resources:
464 requests:
465 memory: "256Mi"
466 cpu: "1m"
467 limits:
468 memory: "2Gi"
469 cpu: "4"
exastro.yaml
に対してインストールに必要なパラメータを設定してきいます。2.4.3. サービス公開の設定¶
Ingress
LoadBalancer
NodePort
注釈
パラメータ¶
パラメータ |
説明 |
変更 |
デフォルト値・選択可能な設定値 |
---|---|---|---|
exastro-platform.platform-auth.extraEnv.EXTERNAL_URL |
Exastro Platform エンドポイントの公開URL。
リバースプロキシや PAT(Port Address Transport) などにより、Exastro のエンドポイントと公開時の URL に齟齬が発生することで、サービス接続に失敗する場合に設定をする必要があります。
|
可 |
公開用エンドポイントのURL
(http[s]://your-exastro.domain:port)
|
exastro-platform.platform-auth.extraEnv.EXTERNAL_URL_MNG |
Exastro Platform 管理コンソールのエンドポイントの公開URL。
リバースプロキシや PAT(Port Address Transport) などにより、Exastro のエンドポイントと公開時の URL に齟齬が発生することで、サービス接続に失敗する場合に設定をする必要があります。
|
可 |
公開用エンドポイントのURL
(http[s]://your-exastro.domain:port)
|
exastro-platform.platform-auth.ingress.enabled |
Exastro Platform における Ingress 利用の要否 |
可 |
true (デフォルト): Exastro Platform にアクセスするための Ingress Controller をデプロイします。
false : Ingress Controller をデプロイしません。
|
exastro-platform.platform-auth.ingress.hosts[0].host |
Exastro Platform 管理コンソールエンドポイントのホスト名、もしくは、FQDN
別途、DNSへのレコード登録が必要です。
|
可 (Ingress利用時) |
"exastro-suite.example.local" |
exastro-platform.platform-auth.ingress.hosts[0].paths[0].path |
Exastro Platform 管理コンソールエンドポイントのパスのルール |
不可 |
"/" |
exastro-platform.platform-auth.ingress.hosts[0].paths[0].pathType |
Exastro Platform 管理コンソールエンドポイントのパスの一致条件 |
不可 |
"Prefix" |
exastro-platform.platform-auth.ingress.hosts[0].paths[0].backend |
Exastro Platform 管理コンソールのサービス名 |
不可 |
"http" |
exastro-platform.platform-auth.ingress.hosts[1].host |
Exastro Platform エンドポイントのホスト名、もしくは、FQDN
別途、DNSへのレコード登録が必要です。
|
可 (Ingress利用時) |
"exastro-suite-mng.example.local" |
exastro-platform.platform-auth.ingress.hosts[1].paths[0].path |
Exastro Platform エンドポイントのパスのルール |
不可 |
"/" |
exastro-platform.platform-auth.ingress.hosts[1].paths[0].pathType |
Exastro Platform エンドポイントのパスの一致条件 |
不可 |
"Prefix" |
exastro-platform.platform-auth.ingress.hosts[1].paths[0].backend |
Exastro Platform エンドポイントのエンドポイントのサービス名 |
不可 |
"httpMng" |
exastro-platform.platform-auth.service.type |
Exastro Platform のサービスタイプ |
可 |
ClusterIP (デフォルト): Ingress Controller を利用する場合などに選択
LoadBalancer : LoadBalancer を利用する場合に選択
NodePort : NodePort を利用する場合に選択
|
exastro-platform.platform-auth.service.http.nodePort |
Exastro Platform のサービス用公開ポート番号
|
可 (NodePort利用時) |
"30080" |
exastro-platform.platform-auth.service.httpMng.nodePort |
Exastro Platform のシステム管理用公開ポート番号
|
可 (NodePort利用時) |
"30081" |
exastro-platform.platform-auth.image.repository |
コンテナイメージのリポジトリ名 |
不可 |
"exastro/exastro-platform-auth" |
exastro-platform.platform-auth.image.tag |
コンテナイメージのタグ |
不可 |
"" |
設定例¶
特徴
設定例
232 platform-auth:
233 extraEnv:
234 # Please set the URL to access
235- EXTERNAL_URL: ""
236- EXTERNAL_URL_MNG: ""
237+ EXTERNAL_URL: "http://exastro-suite.xxxxxxxxxxxxxxxxxx.japaneast.aksapp.io"
238+ EXTERNAL_URL_MNG: "http://exastro-suite-mng.xxxxxxxxxxxxxxxxxx.japaneast.aksapp.io"
239 ingress:
240 enabled: true
241+ annotations:
242+ kubernetes.io/ingress.class: addon-http-application-routing
243+ nginx.ingress.kubernetes.io/proxy-body-size: 100m
244+ nginx.ingress.kubernetes.io/proxy-buffer-size: 256k
245+ nginx.ingress.kubernetes.io/server-snippet: |
246+ client_header_buffer_size 100k;
247+ large_client_header_buffers 4 100k;
248 hosts:
249- - host: exastro-suite.example.local
250+ - host: exastro-suite.xxxxxxxxxxxxxxxxxx.japaneast.aksapp.io
251 paths:
252 - path: /
253 pathType: Prefix
254 backend: "http"
255- - host: exastro-suite-mng.example.local
256+ - host: exastro-suite-mng.xxxxxxxxxxxxxxxxxx.japaneast.aksapp.io
257 paths:
258 - path: /
259 pathType: Prefix
260 backend: "httpMng"
特徴
設定例
232 platform-auth:
233 extraEnv:
234 # Please set the URL to access
235- EXTERNAL_URL: ""
236- EXTERNAL_URL_MNG: ""
237+ EXTERNAL_URL: "https://your-exastro.domain"
238+ EXTERNAL_URL_MNG: "https://your-exastro-mng.domain"
239 ingress:
240- enabled: true
241+ enabled: false
242 hosts:
243 - host: exastro-suite.example.local
244 paths:
245 - path: /
246 pathType: Prefix
247 backend: "http"
248 - host: exastro-suite-mng.example.local
249 paths:
250 - path: /
251 pathType: Prefix
252 backend: "httpMng"
253 service:
254- type: ClusterIP
255+ type: LoadBalancer
256 # http:
257 # nodePort: 30080
258 # httpMng:
259 # nodePort: 30081
特徴
設定例
232 platform-auth:
233 extraEnv:
234 # Please set the URL to access
235 - EXTERNAL_URL: ""
236 - EXTERNAL_URL_MNG: ""
237 + EXTERNAL_URL: "http://10.10.10.10:30080"
238 + EXTERNAL_URL_MNG: "http://10.10.10.10:30081"
239 ingress:
240- enabled: true
241+ enabled: false
242 hosts:
243 - host: exastro-suite.example.local
244 paths:
245 - path: /
246 pathType: Prefix
247 backend: "http"
248 - host: exastro-suite-mng.example.local
249 paths:
250 - path: /
251 pathType: Prefix
252 backend: "httpMng"
253 service:
254- type: ClusterIP
255- # http:
256- # nodePort: 30080
257- # httpMng:
258- # nodePort: 30081
259+ type: NodePort
260+ http:
261+ nodePort: 30080
262+ httpMng:
263+ nodePort: 30081
2.4.4. データベース連携¶
外部データベース
データベースコンテナ
特徴
警告
設定例
警告
警告
Exastro IT Automation 用データベースの設定
データベースの接続情報を設定します。¶ パラメータ
説明
変更
デフォルト値・選択可能な設定値
global.itaDatabaseDefinition.name
Exastro IT Automation 用データベースの定義名
不可
"ita-database"
global.itaDatabaseDefinition.enabled
Exastro IT Automation 用データベースの定義の利用有無
不可
true
global.itaDatabaseDefinition.config.DB_VENDOR
Exastro IT Automation 用データベースで使用するデータベース
可 (外部データベース利用時)
"mariadb" (デフォルト): MariaDB を利用"mysql": MySQL を利用global.itaDatabaseDefinition.config.DB_HOST
Exastro IT Automation 用データベース利用するDBデフォルト状態では、同一の Kubernetes クラスタ内にデプロイされるコンテナを指定しています。クラスタ外部の DB を利用する場合には設定が必要となります。可 (外部データベース利用時)
"mariadb"
global.itaDatabaseDefinition.config.DB_PORT
Exastro IT Automation 用データベースで利用するポート番号(TCP)
可 (外部データベース利用時)
"3306"
global.itaDatabaseDefinition.config.DB_DATABASE
Exastro IT Automation 用データベースで利用するデータベース名
可 (外部データベース利用時)
"platform"
global.itaDatabaseDefinition.secret.DB_ADMIN_USER
Exastro IT Automation 用データベースで利用する管理権限を持つDBユーザ名
必須
管理権限を持つDBユーザ名
global.itaDatabaseDefinition.secret.DB_ADMIN_PASSWORD
Exastro IT Automation 用データベースで利用する管理権限を持つDBユーザのパスワード(エンコードなし)
必須
管理権限を持つDBユーザ名のパスワード
global.itaDatabaseDefinition.secret.DB_USER
Exastro IT Automation 用データベースに作成するDBユーザ名。指定した DB ユーザが作成される。必須
任意の文字列
global.itaDatabaseDefinition.secret.DB_PASSWORD
Exastro IT Automation 用データベースに作成するDBユーザのパスワード(エンコードなし)
必須
任意の文字列
39 itaDatabaseDefinition: 40 name: ita-database 41 enabled: true 42 config: 43- DB_VENDOR: "mariadb" 44- DB_HOST: "mariadb" 45- DB_PORT: "3306" 46+ DB_VENDOR: "mariadb" # mariadb or mysql 47+ DB_HOST: "your.database.endpoint" # データベースのエンドポイント 48+ DB_PORT: "3306" # データベース接続ポート 49 DB_DATABASE: "ITA_DB" # 変更不要 50 secret: 51- DB_ADMIN_USER: "" 52- DB_ADMIN_PASSWORD: ""s 53+ DB_ADMIN_USER: "your-admin-account" # データベースの管理権限を持つユーザ 54+ DB_ADMIN_PASSWORD: "your-admin-password" # データベースの管理権限を持つユーザのパスワード 55 DB_USER: "" 56 DB_PASSWORD: ""
Exastro 共通基盤用データベースの設定
データベースの接続情報を設定します。¶ パラメータ
説明
変更
デフォルト値・選択可能な設定値
global.pfDatabaseDefinition.name
認証機能用データベースの定義名
不可
"pf-database"
global.pfDatabaseDefinition.enabled
認証機能用データベースの定義の有効有無
不可
true
global.pfDatabaseDefinition.config.DB_VENDOR
認証機能用データベースで使用するデータベース
可 (外部データベース利用時)
"mariadb" (デフォルト): MariaDB を利用"mysql": MySQL を利用global.pfDatabaseDefinition.config.DB_HOST
認証機能用データベース利用するDBデフォルト状態では、同一の Kubernetes クラスタ内にデプロイされるコンテナを指定しています。クラスタ外部の DB を利用する場合には設定が必要となります。可 (外部データベース利用時)
"mariadb"
global.pfDatabaseDefinition.config.DB_PORT
認証機能用データベースで利用するポート番号(TCP)
可 (外部データベース利用時)
"3306"
global.pfDatabaseDefinition.config.DB_DATABASE
認証機能用データベースで利用するデータベース名
可 (外部データベース利用時)
"platform"
global.pfDatabaseDefinition.secret.DB_ADMIN_USER
認証機能用データベースで利用する管理権限を持つDBユーザ名
必須
管理権限を持つDBユーザ名
global.pfDatabaseDefinition.secret.DB_ADMIN_PASSWORD
認証機能用データベースで利用する管理権限を持つDBユーザのパスワード(エンコードなし)
必須
管理権限を持つDBユーザ名のパスワード
global.pfDatabaseDefinition.secret.DB_USER
認証機能用データベースに作成するDBユーザ名。指定した DB ユーザが作成される。必須
任意の文字列
global.pfDatabaseDefinition.secret.DB_PASSWORD
認証機能用データベースに作成するDBユーザのパスワード(エンコードなし)
必須
任意の文字列
112 pfDatabaseDefinition: 113 name: auth-database 114 enabled: true 115 config: 116- DB_VENDOR: "mariadb" 117- DB_HOST: "mariadb" 118- DB_PORT: "3306" 119+ DB_VENDOR: "mariadb" # mariadb or mysql 120+ DB_HOST: "your.database.endpoint" # データベースのエンドポイント 121+ DB_PORT: "3306" # データベース接続ポート 122 DB_DATABASE: "platform" # 変更不要 123 secret: 124- DB_ADMIN_USER: "" 125- DB_ADMIN_PASSWORD: "" 126+ DB_ADMIN_USER: "your-admin-account" # データベースの管理者ユーザ 127+ DB_ADMIN_PASSWORD: "your-admin-password" # データベースの管理者ユーザのパスワード 128 DB_USER: "" 129 DB_PASSWORD: ""
データベースコンテナの無効化
データベースコンテナが起動しないように設定します。¶ パラメータ
説明
変更
デフォルト値・選択可能な設定値
global.databaseDefinition.name
Exastro 共用データベースの定義名
不可
"mariadb"
global.databaseDefinition.enabled
Exastro 共用データベースの定義の利用有無
不可
true
global.databaseDefinition.secret.MARIADB_ROOT_PASSWORD
Exastro 共用データベースの root アカウントに設定するパスワード(エンコードなし)
必須
任意の文字列
global.databaseDefinition.persistence.enabled
Exastro 共用データベースのデータ永続化の有効フラグ
可
"true" (デフォルト): データを永続化する"false": データを永続化しないglobal.databaseDefinition.persistence.reinstall
再インストール時にデータ領域の初期化の要否
可 (データ永続化時)
"true" (デフォルト): データを初期化(削除)する"false": データを初期化(削除)しないglobal.databaseDefinition.persistence.accessMode
永続ボリュームのアクセスモードの指定。
不可
"ReadWriteOnce"
global.databaseDefinition.persistence.size
永続ボリュームのディスク容量
可 (データ永続化時)
"20Gi"
global.databaseDefinition.persistence.volumeType
永続ボリュームのボリュームタイプ
可 (現在無効)
"hostPath" (デフォルト): Kubernetes クラスタのノード上にデータを保存(非推奨)"AKS": AKS のストレージクラスを利用global.databaseDefinition.persistence.storageClass
永続ボリュームにストレージクラスを利用する場合のクラスを指定
可 (データ永続化時)
"-" (デフォルト): ストレージクラスを指定しない。ストレージクラス名: クラウドプロバイダなどから提供されるストレージクラス名を指定。270 mariadb: 271- enabled: true 272+ enabled: false
特徴
設定例
警告
警告
データベースコンテナの設定
データベースコンテナの root パスワードを設定します。また、データベースのデータを永続化するために利用するストレージを指定します。¶ パラメータ
説明
変更
デフォルト値・選択可能な設定値
global.databaseDefinition.name
Exastro 共用データベースの定義名
不可
"mariadb"
global.databaseDefinition.enabled
Exastro 共用データベースの定義の利用有無
不可
true
global.databaseDefinition.secret.MARIADB_ROOT_PASSWORD
Exastro 共用データベースの root アカウントに設定するパスワード(エンコードなし)
必須
任意の文字列
global.databaseDefinition.persistence.enabled
Exastro 共用データベースのデータ永続化の有効フラグ
可
"true" (デフォルト): データを永続化する"false": データを永続化しないglobal.databaseDefinition.persistence.reinstall
再インストール時にデータ領域の初期化の要否
可 (データ永続化時)
"true" (デフォルト): データを初期化(削除)する"false": データを初期化(削除)しないglobal.databaseDefinition.persistence.accessMode
永続ボリュームのアクセスモードの指定。
不可
"ReadWriteOnce"
global.databaseDefinition.persistence.size
永続ボリュームのディスク容量
可 (データ永続化時)
"20Gi"
global.databaseDefinition.persistence.volumeType
永続ボリュームのボリュームタイプ
可 (現在無効)
"hostPath" (デフォルト): Kubernetes クラスタのノード上にデータを保存(非推奨)"AKS": AKS のストレージクラスを利用global.databaseDefinition.persistence.storageClass
永続ボリュームにストレージクラスを利用する場合のクラスを指定
可 (データ永続化時)
"-" (デフォルト): ストレージクラスを指定しない。ストレージクラス名: クラウドプロバイダなどから提供されるストレージクラス名を指定。125 databaseDefinition: 126 name: mariadb 127 enabled: true 128 secret: 129- MARIADB_ROOT_PASSWORD: "" 130+ MARIADB_ROOT_PASSWORD: "root-password" # データベースコンテナの root のパスワード 131 persistence: 132 enabled: true 133 reinstall: false 134 accessMode: ReadWriteOnce 135- size: 20Gi 136- volumeType: hostPath # e.g.) hostPath or AKS 137- storageClass: "-" # e.g.) azurefile or - (None) 138+ size: XXGi # 必要な容量に変更 139+ volumeType: AKS # AKS を選択 140+ storageClass: "exastro-suite-azurefile-csi-nfs" # 利用する Storage Class を指定
125 databaseDefinition: 126 name: mariadb 127 enabled: true 128 secret: 129- MARIADB_ROOT_PASSWORD: "" 130+ MARIADB_ROOT_PASSWORD: "root-password" # コンテナデータベースの root のパスワード 131 persistence: 132 enabled: true 133 reinstall: false 134 accessMode: ReadWriteOnce 135- size: 20Gi 136- volumeType: hostPath # e.g.) hostPath or AKS 137+ size: XXGi # 必要な容量に変更 138+ volumeType: hostPath # AKS を選択 139 storageClass: "-" # e.g.) azurefile or - (None)
Exastro IT Automation 用データベースの設定
Exastro IT Automation コンテナがデータベースに接続できるようにするために、データベース連携 で作成した root アカウントのパスワードを設定します。¶ パラメータ
説明
変更
デフォルト値・選択可能な設定値
global.itaDatabaseDefinition.name
Exastro IT Automation 用データベースの定義名
不可
"ita-database"
global.itaDatabaseDefinition.enabled
Exastro IT Automation 用データベースの定義の利用有無
不可
true
global.itaDatabaseDefinition.config.DB_VENDOR
Exastro IT Automation 用データベースで使用するデータベース
可 (外部データベース利用時)
"mariadb" (デフォルト): MariaDB を利用"mysql": MySQL を利用global.itaDatabaseDefinition.config.DB_HOST
Exastro IT Automation 用データベース利用するDBデフォルト状態では、同一の Kubernetes クラスタ内にデプロイされるコンテナを指定しています。クラスタ外部の DB を利用する場合には設定が必要となります。可 (外部データベース利用時)
"mariadb"
global.itaDatabaseDefinition.config.DB_PORT
Exastro IT Automation 用データベースで利用するポート番号(TCP)
可 (外部データベース利用時)
"3306"
global.itaDatabaseDefinition.config.DB_DATABASE
Exastro IT Automation 用データベースで利用するデータベース名
可 (外部データベース利用時)
"platform"
global.itaDatabaseDefinition.secret.DB_ADMIN_USER
Exastro IT Automation 用データベースで利用する管理権限を持つDBユーザ名
必須
管理権限を持つDBユーザ名
global.itaDatabaseDefinition.secret.DB_ADMIN_PASSWORD
Exastro IT Automation 用データベースで利用する管理権限を持つDBユーザのパスワード(エンコードなし)
必須
管理権限を持つDBユーザ名のパスワード
global.itaDatabaseDefinition.secret.DB_USER
Exastro IT Automation 用データベースに作成するDBユーザ名。指定した DB ユーザが作成される。必須
任意の文字列
global.itaDatabaseDefinition.secret.DB_PASSWORD
Exastro IT Automation 用データベースに作成するDBユーザのパスワード(エンコードなし)
必須
任意の文字列
39 itaDatabaseDefinition: 40 name: ita-database 41 enabled: true 42 config: 43 DB_VENDOR: "mariadb" 44 DB_HOST: "mariadb" 45 DB_PORT: "3306" 46 DB_DATABASE: "ITA_DB" 47 secret: 48- DB_ADMIN_USER: "" 49- DB_ADMIN_PASSWORD: "" 50+ DB_ADMIN_USER: "root" # root を指定 51+ DB_ADMIN_PASSWORD: "your-admin-password" # 「1. データベースコンテナの設定」で設定したコンテナデータベースの root のパスワード 52 DB_USER: "" 53 DB_PASSWORD: ""
Exastro 共通基盤用データベースの設定
Exastro 共通基盤のコンテナがデータベースに接続できるようにするために、「1. データベースコンテナの設定」で作成した root アカウントのパスワードを設定します。¶ パラメータ
説明
変更
デフォルト値・選択可能な設定値
global.pfDatabaseDefinition.name
認証機能用データベースの定義名
不可
"pf-database"
global.pfDatabaseDefinition.enabled
認証機能用データベースの定義の有効有無
不可
true
global.pfDatabaseDefinition.config.DB_VENDOR
認証機能用データベースで使用するデータベース
可 (外部データベース利用時)
"mariadb" (デフォルト): MariaDB を利用"mysql": MySQL を利用global.pfDatabaseDefinition.config.DB_HOST
認証機能用データベース利用するDBデフォルト状態では、同一の Kubernetes クラスタ内にデプロイされるコンテナを指定しています。クラスタ外部の DB を利用する場合には設定が必要となります。可 (外部データベース利用時)
"mariadb"
global.pfDatabaseDefinition.config.DB_PORT
認証機能用データベースで利用するポート番号(TCP)
可 (外部データベース利用時)
"3306"
global.pfDatabaseDefinition.config.DB_DATABASE
認証機能用データベースで利用するデータベース名
可 (外部データベース利用時)
"platform"
global.pfDatabaseDefinition.secret.DB_ADMIN_USER
認証機能用データベースで利用する管理権限を持つDBユーザ名
必須
管理権限を持つDBユーザ名
global.pfDatabaseDefinition.secret.DB_ADMIN_PASSWORD
認証機能用データベースで利用する管理権限を持つDBユーザのパスワード(エンコードなし)
必須
管理権限を持つDBユーザ名のパスワード
global.pfDatabaseDefinition.secret.DB_USER
認証機能用データベースに作成するDBユーザ名。指定した DB ユーザが作成される。必須
任意の文字列
global.pfDatabaseDefinition.secret.DB_PASSWORD
認証機能用データベースに作成するDBユーザのパスワード(エンコードなし)
必須
任意の文字列
112 pfDatabaseDefinition: 113 name: auth-database 114 enabled: true 115 config: 116 DB_VENDOR: "mariadb" 117 DB_HOST: "mariadb" 118 DB_PORT: "3306" 119 DB_DATABASE: "platform" 120 secret: 121- DB_ADMIN_USER: "" 122- DB_ADMIN_PASSWORD: "" 123+ DB_ADMIN_USER: "root" # root を指定 124+ DB_ADMIN_PASSWORD: "your-admin-password" # 「1. データベースコンテナの設定」で設定したコンテナデータベースの root のパスワード 125 DB_USER: "" 126 DB_PASSWORD: ""
2.4.5. アプリケーションの DB ユーザ設定¶
設定例¶
Exastro IT Automation
Exastro 共通基盤
Keycloak
警告
Exastro IT Automation 用データベースの設定
アプリケーションが利用・作成する DB ユーザを設定します。¶ パラメータ
説明
変更
デフォルト値・選択可能な設定値
global.itaDatabaseDefinition.name
Exastro IT Automation 用データベースの定義名
不可
"ita-database"
global.itaDatabaseDefinition.enabled
Exastro IT Automation 用データベースの定義の利用有無
不可
true
global.itaDatabaseDefinition.config.DB_VENDOR
Exastro IT Automation 用データベースで使用するデータベース
可 (外部データベース利用時)
"mariadb" (デフォルト): MariaDB を利用"mysql": MySQL を利用global.itaDatabaseDefinition.config.DB_HOST
Exastro IT Automation 用データベース利用するDBデフォルト状態では、同一の Kubernetes クラスタ内にデプロイされるコンテナを指定しています。クラスタ外部の DB を利用する場合には設定が必要となります。可 (外部データベース利用時)
"mariadb"
global.itaDatabaseDefinition.config.DB_PORT
Exastro IT Automation 用データベースで利用するポート番号(TCP)
可 (外部データベース利用時)
"3306"
global.itaDatabaseDefinition.config.DB_DATABASE
Exastro IT Automation 用データベースで利用するデータベース名
可 (外部データベース利用時)
"platform"
global.itaDatabaseDefinition.secret.DB_ADMIN_USER
Exastro IT Automation 用データベースで利用する管理権限を持つDBユーザ名
必須
管理権限を持つDBユーザ名
global.itaDatabaseDefinition.secret.DB_ADMIN_PASSWORD
Exastro IT Automation 用データベースで利用する管理権限を持つDBユーザのパスワード(エンコードなし)
必須
管理権限を持つDBユーザ名のパスワード
global.itaDatabaseDefinition.secret.DB_USER
Exastro IT Automation 用データベースに作成するDBユーザ名。指定した DB ユーザが作成される。必須
任意の文字列
global.itaDatabaseDefinition.secret.DB_PASSWORD
Exastro IT Automation 用データベースに作成するDBユーザのパスワード(エンコードなし)
必須
任意の文字列
39 itaDatabaseDefinition: 40 name: ita-database 41 enabled: true 42 config: 43 DB_VENDOR: "mariadb" 44 DB_HOST: "mariadb" 45 DB_PORT: "3306" 46 DB_DATABASE: "ITA_DB" 47 secret: 48 DB_ADMIN_USER: "" 49 DB_ADMIN_PASSWORD: "" 50- DB_USER: "" 51- DB_PASSWORD: "" 52+ DB_USER: "ita-db-user" # Exastro IT Automation のアプリが使うDBユーザ 53+ DB_PASSWORD: "ita-db-user-password" # Exastro IT Automation のアプリが使うDBユーザのパスワード
Keycloak 用データベースの設定
アプリケーションが利用・作成する DB ユーザを設定します。¶ パラメータ
説明
変更
デフォルト値・選択可能な設定値
global.keycloakDefinition.name
Keycloak の定義名
不可
"keycloak"
global.keycloakDefinition.enabled
Keycloak の定義の利用有無
不可
true
global.keycloakDefinition.config.API_KEYCLOAK_PROTOCOL
Keycloak API エンドポイントのプロトコル
可 (外部Keycloak利用時)
"http”
global.keycloakDefinition.config.API_KEYCLOAK_HOST
Keycloak API エンドポイントのホスト名、もしくは、FQDN
可 (外部Keycloak利用時)
"keycloak"
global.keycloakDefinition.config.API_KEYCLOAK_PORT
Keycloak API エンドポイントのポート番号
可 (外部Keycloak利用時)
"8080"
global.keycloakDefinition.config.KEYCLOAK_PROTOCOL
Keycloak エンドポイントのプロトコル
可 (外部Keycloak利用時)
"http"
global.keycloakDefinition.config.KEYCLOAK_HOST
Keycloak エンドポイントのホスト名、もしくは、FQDN
可 (外部Keycloak利用時)
"keycloak"
global.keycloakDefinition.config.KEYCLOAK_PORT
Keycloak API エンドポイントのポート番号
可 (外部Keycloak利用時)
"8080"
global.keycloakDefinition.config.KEYCLOAK_MASTER_REALM
Keycloak のマスターレルム名
可
"master"
global.keycloakDefinition.config.KEYCLOAK_DB_DATABASE
Keycloak が利用するデータベース名
可
"keycloak"
global.keycloakDefinition.secret.KEYCLOAK_USER
Keycloak のマスターレルムにおける管理権限を持ったユーザ名を指定。指定した Keycloak ユーザが作成される。必須
任意の文字列
global.keycloakDefinition.secret.KEYCLOAK_PASSWORD
Keycloak のマスターレルムにおける管理権限を持ったユーザに設定するパスワード(エンコードなし)
必須
任意の文字列
global.keycloakDefinition.secret.KEYCLOAK_DB_USER
Keycloak が使用するデータベースユーザ。指定した DB ユーザが作成される。必須
任意の文字列
global.keycloakDefinition.secret.KEYCLOAK_DB_PASSWORD
Keycloak が使用するデータベースユーザのパスワード(エンコードなし)
必須
任意の文字列
82 keycloakDefinition: 83 name: keycloak 84 enabled: true 85 config: 86 API_KEYCLOAK_PROTOCOL: "http" 87 API_KEYCLOAK_HOST: "keycloak" 88 API_KEYCLOAK_PORT: "8080" 89 KEYCLOAK_PROTOCOL: "http" 90 KEYCLOAK_HOST: "keycloak" 91 KEYCLOAK_PORT: "8080" 92 KEYCLOAK_MASTER_REALM: "master" 93 KEYCLOAK_DB_DATABASE: "keycloak" 94 secret: 95 KEYCLOAK_USER: "" 96 KEYCLOAK_PASSWORD: "" 97- KEYCLOAK_DB_USER: "" 98- KEYCLOAK_DB_PASSWORD: "" 99+ KEYCLOAK_DB_USER: "keycloak-db-user" # Keycloak が使うDBユーザ 100+ KEYCLOAK_DB_PASSWORD: "keycloak-db-user-password" # Keycloak が使うDBユーザのパスワード
Exastro 共通基盤用データベースの設定
アプリケーションが利用・作成する DB ユーザを設定します。¶ パラメータ
説明
変更
デフォルト値・選択可能な設定値
global.pfDatabaseDefinition.name
認証機能用データベースの定義名
不可
"pf-database"
global.pfDatabaseDefinition.enabled
認証機能用データベースの定義の有効有無
不可
true
global.pfDatabaseDefinition.config.DB_VENDOR
認証機能用データベースで使用するデータベース
可 (外部データベース利用時)
"mariadb" (デフォルト): MariaDB を利用"mysql": MySQL を利用global.pfDatabaseDefinition.config.DB_HOST
認証機能用データベース利用するDBデフォルト状態では、同一の Kubernetes クラスタ内にデプロイされるコンテナを指定しています。クラスタ外部の DB を利用する場合には設定が必要となります。可 (外部データベース利用時)
"mariadb"
global.pfDatabaseDefinition.config.DB_PORT
認証機能用データベースで利用するポート番号(TCP)
可 (外部データベース利用時)
"3306"
global.pfDatabaseDefinition.config.DB_DATABASE
認証機能用データベースで利用するデータベース名
可 (外部データベース利用時)
"platform"
global.pfDatabaseDefinition.secret.DB_ADMIN_USER
認証機能用データベースで利用する管理権限を持つDBユーザ名
必須
管理権限を持つDBユーザ名
global.pfDatabaseDefinition.secret.DB_ADMIN_PASSWORD
認証機能用データベースで利用する管理権限を持つDBユーザのパスワード(エンコードなし)
必須
管理権限を持つDBユーザ名のパスワード
global.pfDatabaseDefinition.secret.DB_USER
認証機能用データベースに作成するDBユーザ名。指定した DB ユーザが作成される。必須
任意の文字列
global.pfDatabaseDefinition.secret.DB_PASSWORD
認証機能用データベースに作成するDBユーザのパスワード(エンコードなし)
必須
任意の文字列
112 pfDatabaseDefinition: 113 name: auth-database 114 enabled: true 115 config: 116 DB_VENDOR: "mariadb" 117 DB_HOST: "mariadb" 118 DB_PORT: "3306" 119 DB_DATABASE: "platform" 120 secret: 121 DB_ADMIN_USER: "" 122 DB_ADMIN_PASSWORD: "" 123- DB_USER: "" 124- DB_PASSWORD: "" 125+ DB_USER: "pf-db-user" # Exastro 共通基盤が使うDBユーザ 126+ DB_PASSWORD: "pf-db-password" # Exastro 共通基盤が使うDBユーザのパスワード
2.4.6. GitLab 連携設定¶
パラメータ |
説明 |
変更 |
デフォルト値・選択可能な設定値 |
---|---|---|---|
global.gitlabDefinition.name |
GitLab の定義名 |
不可 |
gitlab |
global.gitlabDefinition.enabled |
GitLab の定義の利用有無 |
不可 |
true |
global.gitlabDefinition.config.GITLAB_PROTOCOL |
GitLab エンドポイントのプロトコル |
可 |
http |
global.gitlabDefinition.config.GITLAB_HOST |
GitLab エンドポイントへのホスト名、もしくは、FQDN |
可 |
gitlab |
global.gitlabDefinition.config.GITLAB_PORT |
GitLab エンドポイントのポート番号 |
可 |
80 |
global.gitlabDefinition.secret.GITLAB_ROOT_TOKEN |
GitLab の root 権限アカウントのアクセストークン |
必須 |
アクセエストークン(平文) |
警告
30 gitlabDefinition:
31 name: gitlab
32 enabled: true
33 config:
34 - GITLAB_PROTOCOL: "http"
35 - GITLAB_HOST: "gitlab"
36 - GITLAB_PORT: "80"
37 + GITLAB_PROTOCOL: "接続プロトコル http or https"
38 + GITLAB_HOST: "接続先"
39 + GITLAB_PORT: "接続ポート"
40 secret:
41 - GITLAB_ROOT_TOKEN: ""
42 + GITLAB_ROOT_TOKEN: "GitLabのRoot権限を持ったトークン"
2.4.7. Exastro システム管理者の作成¶
パラメータ |
説明 |
変更 |
デフォルト値・選択可能な設定値 |
---|---|---|---|
global.keycloakDefinition.name |
Keycloak の定義名 |
不可 |
"keycloak" |
global.keycloakDefinition.enabled |
Keycloak の定義の利用有無 |
不可 |
true |
global.keycloakDefinition.config.API_KEYCLOAK_PROTOCOL |
Keycloak API エンドポイントのプロトコル |
可 (外部Keycloak利用時) |
"http” |
global.keycloakDefinition.config.API_KEYCLOAK_HOST |
Keycloak API エンドポイントのホスト名、もしくは、FQDN |
可 (外部Keycloak利用時) |
"keycloak" |
global.keycloakDefinition.config.API_KEYCLOAK_PORT |
Keycloak API エンドポイントのポート番号 |
可 (外部Keycloak利用時) |
"8080" |
global.keycloakDefinition.config.KEYCLOAK_PROTOCOL |
Keycloak エンドポイントのプロトコル |
可 (外部Keycloak利用時) |
"http" |
global.keycloakDefinition.config.KEYCLOAK_HOST |
Keycloak エンドポイントのホスト名、もしくは、FQDN |
可 (外部Keycloak利用時) |
"keycloak" |
global.keycloakDefinition.config.KEYCLOAK_PORT |
Keycloak API エンドポイントのポート番号 |
可 (外部Keycloak利用時) |
"8080" |
global.keycloakDefinition.config.KEYCLOAK_MASTER_REALM |
Keycloak のマスターレルム名 |
可 |
"master" |
global.keycloakDefinition.config.KEYCLOAK_DB_DATABASE |
Keycloak が利用するデータベース名 |
可 |
"keycloak" |
global.keycloakDefinition.secret.KEYCLOAK_USER |
Keycloak のマスターレルムにおける管理権限を持ったユーザ名を指定。
指定した Keycloak ユーザが作成される。
|
必須 |
任意の文字列 |
global.keycloakDefinition.secret.KEYCLOAK_PASSWORD |
Keycloak のマスターレルムにおける管理権限を持ったユーザに設定するパスワード(エンコードなし) |
必須 |
任意の文字列 |
global.keycloakDefinition.secret.KEYCLOAK_DB_USER |
Keycloak が使用するデータベースユーザ。
指定した DB ユーザが作成される。
|
必須 |
任意の文字列 |
global.keycloakDefinition.secret.KEYCLOAK_DB_PASSWORD |
Keycloak が使用するデータベースユーザのパスワード(エンコードなし) |
必須 |
任意の文字列 |
82 keycloakDefinition:
83 name: keycloak
84 enabled: true
85 config:
86 API_KEYCLOAK_PROTOCOL: "http"
87 API_KEYCLOAK_HOST: "keycloak"
88 API_KEYCLOAK_PORT: "8080"
89 KEYCLOAK_PROTOCOL: "http"
90 KEYCLOAK_HOST: "keycloak"
91 KEYCLOAK_PORT: "8080"
92 KEYCLOAK_MASTER_REALM: "master"
93 KEYCLOAK_DB_DATABASE: "keycloak"
94 secret:
95- KEYCLOAK_USER: ""
96- KEYCLOAK_PASSWORD: ""
97+ KEYCLOAK_USER: "admin" # Exastro システムの管理者
98+ KEYCLOAK_PASSWORD: "admin-password" # Exastro システムの管理者のパスワード
99 KEYCLOAK_DB_USER: ""
100 KEYCLOAK_DB_PASSWORD: ""
2.4.8. 永続ボリュームの設定¶
マネージドディスク
Kubernetes ノードのディレクトリ
特徴
設定例
1apiVersion: storage.k8s.io/v1
2kind: StorageClass
3metadata:
4 name: exastro-suite-azurefile-csi-nfs
5provisioner: file.csi.azure.com
6allowVolumeExpansion: true
7parameters:
8 protocol: nfs
9mountOptions:
10 - nconnect=8
5 itaGlobalDefinition:
6 persistence:
7 enabled: true
8 accessMode: ReadWriteMany
9 size: 10Gi
10 volumeType: hostPath # e.g.) hostPath or AKS
11- storageClass: "-" # e.g.) azurefile or - (None)
12+ storageClass: "azurefile" # e.g.) azurefile or - (None)
39 databaseDefinition:
40 persistence:
41 enabled: true
42 reinstall: false
43 accessMode: ReadWriteOnce
44 size: 20Gi
45 volumeType: hostPath # e.g.) hostPath or AKS
46- storageClass: "-" # e.g.) azurefile or - (None)
47+ storageClass: "exastro-suite-azurefile-csi-nfs" # e.g.) azurefile or - (None)
特徴
危険
利用例
1# pv-database.yaml
2apiVersion: v1
3kind: PersistentVolume
4metadata:
5 name: pv-database
6spec:
7 capacity:
8 storage: 20Gi
9 accessModes:
10 - ReadWriteOnce
11 persistentVolumeReclaimPolicy: Retain
12 hostPath:
13 path: /var/data/exastro-suite/exastro-platform/database
14 type: DirectoryOrCreate
1# pv-ita-common.yaml
2apiVersion: v1
3kind: PersistentVolume
4metadata:
5 name: pv-ita-common
6spec:
7 capacity:
8 storage: 10Gi
9 accessModes:
10 - ReadWriteMany
11 persistentVolumeReclaimPolicy: Retain
12 hostPath:
13 path: /var/data/exastro-suite/exastro-it-automation/ita-common
14 type: DirectoryOrCreate
2.5. インストール¶
2.5.1. 永続ボリュームの作成¶
# pv-database.yaml
kubectl apply -f pv-database.yaml
# pv-ita-common.yaml
kubectl apply -f pv-ita-common.yaml
# 確認
kubectl get pv
NAME CAPACITY ACCESS MODES RECLAIM POLICY STATUS CLAIM STORAGECLASS REASON AGE
pv-database 20Gi RWO Retain Available 19s
pv-ita-common 10Gi RWX Retain Available 9s
2.5.2. インストール¶
Chart Version |
Exastro Version |
Exastro IT Automation |
Exastro Platform |
リリースシナリオ |
---|---|---|---|---|
1.0.2 |
2.1.0 |
2.0.3 |
1.4.0 |
Exastro IT Automation Version 2.0 GA リリース |
... |
... |
... |
... |
... |
1.1.x |
2.2.x |
2.1.x |
1.x.0 |
Exastro IT Automation Version 2.1 GA リリース(予定) |
Helm コマンドを使い Kubernetes 環境にインストールを行います。
helm install exastro exastro/exastro \ --namespace exastro --create-namespace \ --values exastro.yaml
NAME: exastro LAST DEPLOYED: Sat Jan 28 15:00:02 2023 NAMESPACE: exastro STATUS: deployed REVISION: 1 TEST SUITE: None NOTES: Exastro install completion! 1. Execute the following command and wait until the pod becomes "Running" or "Completed": # NOTE: You can also append "-w" to the command or wait until the state changes with "watch command" kubectl get pods --namespace exastro 2. Get the ENCRYPT_KEY by running these commands: # Exastro IT Automation ENCRYPT_KEY kubectl get secret ita-secret-ita-global -n exastro -o jsonpath='{.data.ENCRYPT_KEY}' | base64 -d # Exastro Platform ENCRYPT_KEY kubectl get secret platform-secret-pf-global -n exastro -o jsonpath='{.data.ENCRYPT_KEY}' | base64 -d !!! Please save the output ENCRYPT_KEY carefully. !!! 3. Run the following command to get the application URL and go to the URL or go to the displayed URL: ************************* * Service Console * ************************* http://exastro-suite.example.local/ ************************* * Administrator Console * ************************* http://exastro-suite-mng.example.local/auth/ # Note: You can display this note again by executing the following command.
以下、上記の出力結果に従って操作をします。- インストール状況確認
# Pod の一覧を取得
kubectl get po -n exastro
| 正常に起動している場合は、ita-migration-xxxとplatform-migration-xxxが “Completed” 、その他すべてが “Running” となります。
| ※正常に起動するまで数分かかる場合があります。
NAME READY STATUS RESTARTS AGE
ita-api-admin-64657656c6-r4s2l 1/1 Running 0 30m
ita-api-organization-75ff9d599c-gthvl 1/1 Running 0 30m
ita-by-ansible-execute-fdd8dfc57-7676h 1/1 Running 0 30m
ita-by-ansible-legacy-role-vars-listup-6cd558d78b-xxl6x 1/1 Running 0 30m
ita-by-ansible-legacy-vars-listup-5db44d54d8-zxqj7 1/1 Running 0 30m
ita-by-ansible-pioneer-vars-listup-6bf744f5b6-k8ctx 1/1 Running 0 30m
ita-by-ansible-towermaster-sync-59594b5d84-phbg7 1/1 Running 0 30m
ita-by-cicd-for-iac-f6855c588-r6w4k 1/1 Running 0 30m
ita-by-collector-6fc8c7b4d4-hjwck 1/1 Running 0 30m
ita-by-conductor-regularly-5897dcb9f6-4npz7 1/1 Running 0 30m
ita-by-conductor-synchronize-6fd6dcd5f4-qgdhx 1/1 Running 0 30m
ita-by-excel-export-import-df76d77c4-ms4j2 1/1 Running 0 30m
ita-by-hostgroup-split-86746f758-b796k 1/1 Running 0 30m
ita-by-menu-create-8588c9747d-66xwn 1/1 Running 0 30m
ita-by-menu-export-import-6b8498f476-zwml7 1/1 Running 0 30m
ita-by-terraform-cli-execute-8478554d8d-qztbv 1/1 Running 0 30m
ita-by-terraform-cli-vars-listup-bf688659d-zgh8d 1/1 Running 0 30m
ita-by-terraform-cloud-ep-execute-5dbbb599b-qh8rc 1/1 Running 0 30m
ita-by-terraform-cloud-ep-vars-listup-5564fcb5b-nphm7 1/1 Running 0 30m
ita-migration-1.0.4-0wdt 0/1 Completed 0 30m
ita-web-server-854bcdbbf4-s7fdb 1/1 Running 0 30m
keycloak-56d8b4556c-tndnv 1/1 Running 0 30m
platform-api-bddb446db-s9zjh 1/1 Running 0 30m
platform-auth-799f57fb6c-wlbtf 1/1 Running 0 30m
platform-migration-1.4.2-6sks 0/1 Completed 0 30m
platform-web-88db7c489-wkmn9 1/1 Running 0 30m
暗号化キーのバックアップ
Exastro システムのパスワードや認証情報といった機密情報はすべて暗号化されています。必ず、下記で取得した暗号化キーをバックアップして、適切に保管してください。危険
暗号化キーを紛失した場合、バックアップデータからシステムを復旧した際にデータの復号ができなくなります。# Exastro IT Automation ENCRYPT_KEY kubectl get secret ita-secret-ita-global -n exastro -o jsonpath='{.data.ENCRYPT_KEY}' | base64 -d
JnIoXzJtPic2MXFqRl1yI1chMj8hWzQrNypmVn41Pk8=
# Exastro Platform ENCRYPT_KEY kubectl get secret platform-secret-pf-global -n exastro -o jsonpath='{.data.ENCRYPT_KEY}' | base64 -d
bHFZe2VEVVM2PmFeQDMqNG4oZT4lTlglLjJJekxBTHE=
接続確認
出力結果に従って、の URL にアクセスします。下記は、実行例のため サービス公開の設定 で設定したホスト名に読み替えてください。************************* * Service Console * ************************* http://exastro-suite.example.local/ ************************* * Administrator Console * ************************* http://exastro-suite-mng.example.local/auth/
¶ 管理コンソール
Helm コマンドを使い Kubernetes 環境にインストールを行います。
helm install exastro exastro/exastro \ --namespace exastro --create-namespace \ --values exastro.yaml
NAME: exastro LAST DEPLOYED: Sat Jan 28 15:00:02 2023 NAMESPACE: exastro STATUS: deployed REVISION: 1 TEST SUITE: None NOTES: Exastro install completion! 1. Execute the following command and wait until the pod becomes "Running" or "Completed": # NOTE: You can also append "-w" to the command or wait until the state changes with "watch command" kubectl get pods --namespace exastro 2. Get the ENCRYPT_KEY by running these commands: # Exastro IT Automation ENCRYPT_KEY kubectl get secret ita-secret-ita-global -n exastro -o jsonpath='{.data.ENCRYPT_KEY}' | base64 -d # Exastro Platform ENCRYPT_KEY kubectl get secret platform-secret-pf-global -n exastro -o jsonpath='{.data.ENCRYPT_KEY}' | base64 -d !!! Please save the output ENCRYPT_KEY carefully. !!! 3. Run the following command to get the application URL and go to the URL or go to the displayed URL: # NOTE: It may take a few minutes for the LoadBalancer IP to be available. # You can watch the status of by running 'kubectl get --namespace exastro svc -w platform-auth' export NODE_SVC_PORT=$(kubectl get services platform-auth --namespace exastro -o jsonpath="{.spec.ports[0].nodePort}") export NODE_MGT_PORT=$(kubectl get services platform-auth --namespace exastro -o jsonpath="{.spec.ports[1].nodePort}") export NODE_IP=$(kubectl get services platform-auth --namespace exastro -o jsonpath="{.status.loadBalancer.ingress[0].ip}") # ************************* # * Administrator Console * # ************************* echo http://$NODE_IP:$NODE_MGT_PORT/auth/ # ************************* # * Service Console * # ************************* echo http://$NODE_IP:$NODE_SVC_PORT # Note: You can display this note again by executing the following command.
以下、上記の出力結果に従って操作をします。- インストール状況確認
# Pod の一覧を取得
kubectl get po -n exastro
| 正常に起動している場合は、ita-migration-xxxとplatform-migration-xxxが “Completed” 、その他すべてが “Running” となります。
| ※正常に起動するまで数分かかる場合があります。
NAME READY STATUS RESTARTS AGE
ita-api-admin-64657656c6-r4s2l 1/1 Running 0 30m
ita-api-organization-75ff9d599c-gthvl 1/1 Running 0 30m
ita-by-ansible-execute-fdd8dfc57-7676h 1/1 Running 0 30m
ita-by-ansible-legacy-role-vars-listup-6cd558d78b-xxl6x 1/1 Running 0 30m
ita-by-ansible-legacy-vars-listup-5db44d54d8-zxqj7 1/1 Running 0 30m
ita-by-ansible-pioneer-vars-listup-6bf744f5b6-k8ctx 1/1 Running 0 30m
ita-by-ansible-towermaster-sync-59594b5d84-phbg7 1/1 Running 0 30m
ita-by-cicd-for-iac-f6855c588-r6w4k 1/1 Running 0 30m
ita-by-collector-6fc8c7b4d4-hjwck 1/1 Running 0 30m
ita-by-conductor-regularly-5897dcb9f6-4npz7 1/1 Running 0 30m
ita-by-conductor-synchronize-6fd6dcd5f4-qgdhx 1/1 Running 0 30m
ita-by-excel-export-import-df76d77c4-ms4j2 1/1 Running 0 30m
ita-by-hostgroup-split-86746f758-b796k 1/1 Running 0 30m
ita-by-menu-create-8588c9747d-66xwn 1/1 Running 0 30m
ita-by-menu-export-import-6b8498f476-zwml7 1/1 Running 0 30m
ita-by-terraform-cli-execute-8478554d8d-qztbv 1/1 Running 0 30m
ita-by-terraform-cli-vars-listup-bf688659d-zgh8d 1/1 Running 0 30m
ita-by-terraform-cloud-ep-execute-5dbbb599b-qh8rc 1/1 Running 0 30m
ita-by-terraform-cloud-ep-vars-listup-5564fcb5b-nphm7 1/1 Running 0 30m
ita-migration-1.0.4-0wdt 0/1 Completed 0 30m
ita-web-server-854bcdbbf4-s7fdb 1/1 Running 0 30m
keycloak-56d8b4556c-tndnv 1/1 Running 0 30m
platform-api-bddb446db-s9zjh 1/1 Running 0 30m
platform-auth-799f57fb6c-wlbtf 1/1 Running 0 30m
platform-migration-1.4.2-6sks 0/1 Completed 0 30m
platform-web-88db7c489-wkmn9 1/1 Running 0 30m
暗号化キーのバックアップ
Exastro システムのパスワードや認証情報といった機密情報はすべて暗号化されています。必ず、下記で取得した暗号化キーをバックアップして、適切に保管してください。危険
暗号化キーを紛失した場合、バックアップデータからシステムを復旧した際にデータの復号ができなくなります。# Exastro IT Automation ENCRYPT_KEY kubectl get secret ita-secret-ita-global -n exastro -o jsonpath='{.data.ENCRYPT_KEY}' | base64 -d
JnIoXzJtPic2MXFqRl1yI1chMj8hWzQrNypmVn41Pk8=
# Exastro Platform ENCRYPT_KEY kubectl get secret platform-secret-pf-global -n exastro -o jsonpath='{.data.ENCRYPT_KEY}' | base64 -d
bHFZe2VEVVM2PmFeQDMqNG4oZT4lTlglLjJJekxBTHE=
接続確認
1. で実行した helm install の出力結果のコマンドをコンソール上に貼り付けて実行します。# helm install コマンドの実行結果を貼り付けて実行 export NODE_SVC_PORT=$(kubectl get services platform-auth --namespace exastro -o jsonpath="{.spec.ports[0].nodePort}") export NODE_MGT_PORT=$(kubectl get services platform-auth --namespace exastro -o jsonpath="{.spec.ports[1].nodePort}") export NODE_IP=$(kubectl get services platform-auth --namespace exastro -o jsonpath="{.status.loadBalancer.ingress[0].ip}") # ************************* # * Administrator Console * # ************************* echo http://$NODE_IP:$NODE_MGT_PORT/auth/ # ************************* # * Service Console * # ************************* echo http://$NODE_IP:$NODE_SVC_PORT
出力結果に従って、の URL にアクセスします。下記は、実行例のため実際のコマンド実行結果に読み替えてください。************************* * Administrator Console * ************************* http://172.16.20.XXX:32031/auth/ ************************* * Service Console * ************************* http://172.16.20.XXX:31798
¶ 管理コンソール
Helm コマンドを使い Kubernetes 環境にインストールを行います。
helm install exastro exastro/exastro \ --namespace exastro --create-namespace \ --values exastro.yaml
NAME: exastro LAST DEPLOYED: Sun Jan 29 12:18:02 2023 NAMESPACE: exastro STATUS: deployed REVISION: 1 TEST SUITE: None NOTES: Exastro install completion! 1. Execute the following command and wait until the pod becomes "Running" or "Completed": # NOTE: You can also append "-w" to the command or wait until the state changes with "watch command" kubectl get pods --namespace exastro 2. Get the ENCRYPT_KEY by running these commands: # Exastro IT Automation ENCRYPT_KEY kubectl get secret ita-secret-ita-global -n exastro -o jsonpath='{.data.ENCRYPT_KEY}' | base64 -d # Exastro Platform ENCRYPT_KEY kubectl get secret platform-secret-pf-global -n exastro -o jsonpath='{.data.ENCRYPT_KEY}' | base64 -d !!! Please save the output ENCRYPT_KEY carefully. !!! 3. Run the following command to get the application URL and go to the URL or go to the displayed URL: export NODE_SVC_PORT=$(kubectl get services platform-auth --namespace exastro -o jsonpath="{.spec.ports[0].nodePort}") export NODE_MGT_PORT=$(kubectl get services platform-auth --namespace exastro -o jsonpath="{.spec.ports[1].nodePort}") export NODE_IP=$(kubectl get nodes --namespace exastro -o jsonpath="{.items[0].status.addresses[0].address}") # ************************* # * Administrator Console * # ************************* echo http://$NODE_IP:$NODE_MGT_PORT/auth/ # ************************* # * Service Console * # ************************* echo http://$NODE_IP:$NODE_SVC_PORT # Note: You can display this note again by executing the following command.
以下、上記の出力結果に従って操作をします。- インストール状況確認
# Pod の一覧を取得
kubectl get po -n exastro
| 正常に起動している場合は、ita-migration-xxxとplatform-migration-xxxが “Completed” 、その他すべてが “Running” となります。
| ※正常に起動するまで数分かかる場合があります。
NAME READY STATUS RESTARTS AGE
ita-api-admin-64657656c6-r4s2l 1/1 Running 0 30m
ita-api-organization-75ff9d599c-gthvl 1/1 Running 0 30m
ita-by-ansible-execute-fdd8dfc57-7676h 1/1 Running 0 30m
ita-by-ansible-legacy-role-vars-listup-6cd558d78b-xxl6x 1/1 Running 0 30m
ita-by-ansible-legacy-vars-listup-5db44d54d8-zxqj7 1/1 Running 0 30m
ita-by-ansible-pioneer-vars-listup-6bf744f5b6-k8ctx 1/1 Running 0 30m
ita-by-ansible-towermaster-sync-59594b5d84-phbg7 1/1 Running 0 30m
ita-by-cicd-for-iac-f6855c588-r6w4k 1/1 Running 0 30m
ita-by-collector-6fc8c7b4d4-hjwck 1/1 Running 0 30m
ita-by-conductor-regularly-5897dcb9f6-4npz7 1/1 Running 0 30m
ita-by-conductor-synchronize-6fd6dcd5f4-qgdhx 1/1 Running 0 30m
ita-by-excel-export-import-df76d77c4-ms4j2 1/1 Running 0 30m
ita-by-hostgroup-split-86746f758-b796k 1/1 Running 0 30m
ita-by-menu-create-8588c9747d-66xwn 1/1 Running 0 30m
ita-by-menu-export-import-6b8498f476-zwml7 1/1 Running 0 30m
ita-by-terraform-cli-execute-8478554d8d-qztbv 1/1 Running 0 30m
ita-by-terraform-cli-vars-listup-bf688659d-zgh8d 1/1 Running 0 30m
ita-by-terraform-cloud-ep-execute-5dbbb599b-qh8rc 1/1 Running 0 30m
ita-by-terraform-cloud-ep-vars-listup-5564fcb5b-nphm7 1/1 Running 0 30m
ita-migration-1.0.4-0wdt 0/1 Completed 0 30m
ita-web-server-854bcdbbf4-s7fdb 1/1 Running 0 30m
keycloak-56d8b4556c-tndnv 1/1 Running 0 30m
platform-api-bddb446db-s9zjh 1/1 Running 0 30m
platform-auth-799f57fb6c-wlbtf 1/1 Running 0 30m
platform-migration-1.4.2-6sks 0/1 Completed 0 30m
platform-web-88db7c489-wkmn9 1/1 Running 0 30m
暗号化キーのバックアップ
Exastro システムのパスワードや認証情報といった機密情報はすべて暗号化されています。必ず、下記で取得した暗号化キーをバックアップして、適切に保管してください。危険
暗号化キーを紛失した場合、バックアップデータからシステムを復旧した際にデータの復号ができなくなります。# Exastro IT Automation ENCRYPT_KEY kubectl get secret ita-secret-ita-global -n exastro -o jsonpath='{.data.ENCRYPT_KEY}' | base64 -d
JnIoXzJtPic2MXFqRl1yI1chMj8hWzQrNypmVn41Pk8=
# Exastro Platform ENCRYPT_KEY kubectl get secret platform-secret-pf-global -n exastro -o jsonpath='{.data.ENCRYPT_KEY}' | base64 -d
bHFZe2VEVVM2PmFeQDMqNG4oZT4lTlglLjJJekxBTHE=
接続確認
1. で実行した helm install の出力結果のコマンドをコンソール上に貼り付けて実行します。export NODE_SVC_PORT=$(kubectl get services platform-auth --namespace exastro -o jsonpath="{.spec.ports[0].nodePort}") export NODE_MGT_PORT=$(kubectl get services platform-auth --namespace exastro -o jsonpath="{.spec.ports[1].nodePort}") export NODE_IP=$(kubectl get nodes --namespace exastro -o jsonpath="{.items[0].status.addresses[0].address}") # ************************* # * Administrator Console * # ************************* echo http://$NODE_IP:$NODE_MGT_PORT/auth/ # ************************* # * Service Console * # ************************* echo http://$NODE_IP:$NODE_SVC_PORT
出力結果に従って、の URL にアクセスします。下記は、実行例のため実際のコマンド実行結果に読み替えてください。************************* * Administrator Console * ************************* http://172.16.20.xxx:30081/auth/ ************************* * Service Console * ************************* http://172.16.20.xxx:30080
¶ 管理コンソール
2.5.3. 管理コンソールへのログイン¶
2.6. アップグレード¶
2.6.1. アップグレードの準備¶
警告
Helm リポジトリの更新¶
1# リポジトリ情報の確認
2helm search repo exastro
1helm search repo exastro
2NAME CHART VERSION APP VERSION DESCRIPTION
3exastro/exastro 1.0.0 2.0.3 A Helm chart for Exastro. Exastro is an Open So...
4exastro/exastro-it-automation 1.2.0 2.0.3 A Helm chart for Exastro IT Automation. Exastro...
5exastro/exastro-platform 1.5.0 1.4.0 A Helm chart for Exastro Platform. Exastro Plat...
1# リポジトリ情報の更新
2helm repo update
1# リポジトリ情報の確認
2helm search repo exastro
1helm search repo exastro
2NAME CHART VERSION APP VERSION DESCRIPTION
3exastro/exastro 1.0.1 2.1.0 A Helm chart for Exastro. Exastro is an Open So...
4exastro/exastro-it-automation 1.2.0 2.0.3 A Helm chart for Exastro IT Automation. Exastro...
5exastro/exastro-platform 1.5.0 1.4.0 A Helm chart for Exastro Platform. Exastro Plat...
デフォルト設定値の更新の確認¶
exastro.yaml
とアップグレード後の設定ファイルを比較します。diff exastro.yaml <(helm show values exastro/exastro)
exastro-platform:
platform-api:
image:
repository: "exastro/exastro-platform-api"
tag: ""
platform-auth:
+ extraEnv:
+ # Please set the URL to access
+ EXTERNAL_URL: ""
+ EXTERNAL_URL_MNG: ""
ingress:
enabled: true
hosts:
- host: exastro-suite.example.local
paths:
設定値の更新¶
exastro.yaml
に項目と設定値を追加します。exastro-platform:
platform-api:
image:
repository: "exastro/exastro-platform-api"
tag: ""
platform-auth:
+ extraEnv:
+ # Please set the URL to access
+ EXTERNAL_URL: ""
+ EXTERNAL_URL_MNG: ""
ingress:
enabled: true
hosts:
- host: exastro-suite.example.local
paths:
2.6.2. アップグレード¶
サービス停止¶
Pod 起動数の確認
作業前の Pod 起動数の確認をし、状態を記録します。RS_AE=`kubectl get deploy ita-by-ansible-execute -o jsonpath='{@.spec.replicas}{"\n"}' -n exastro` RS_ALRV=`kubectl get deploy ita-by-ansible-legacy-role-vars-listup -o jsonpath='{@.spec.replicas}{"\n"}' -n exastro` RS_ATS=`kubectl get deploy ita-by-ansible-towermaster-sync -o jsonpath='{@.spec.replicas}{"\n"}' -n exastro` RS_CS=`kubectl get deploy ita-by-conductor-synchronize -o jsonpath='{@.spec.replicas}{"\n"}' -n exastro` RS_MC=`kubectl get deploy ita-by-menu-create -o jsonpath='{@.spec.replicas}{"\n"}' -n exastro` RS_PA=`kubectl get deploy platform-auth -o jsonpath='{@.spec.replicas}{"\n"}' -n exastro`
以下はITA2.1.0以降からITA2.1.1以降にバージョンアップする際に実行してください。RS_ALV=`kubectl get deploy ita-by-ansible-legacy-vars-listup -o jsonpath='{@.spec.replicas}{"\n"}' -n exastro` RS_APV=`kubectl get deploy ita-by-ansible-pioneer-vars-listup -o jsonpath='{@.spec.replicas}{"\n"}' -n exastro` RS_CFI=`kubectl get deploy ita-by-cicd-for-iac -o jsonpath='{@.spec.replicas}{"\n"}' -n exastro` RS_CR=`kubectl get deploy ita-by-conductor-regularly -o jsonpath='{@.spec.replicas}{"\n"}' -n exastro` RS_COL=`kubectl get deploy ita-by-collector -o jsonpath='{@.spec.replicas}{"\n"}' -n exastro` RS_EEI=`kubectl get deploy ita-by-excel-export-import -o jsonpath='{@.spec.replicas}{"\n"}' -n exastro` RS_HS=`kubectl get deploy ita-by-hostgroup-split -o jsonpath='{@.spec.replicas}{"\n"}' -n exastro` RS_MEI=`kubectl get deploy ita-by-menu-export-import -o jsonpath='{@.spec.replicas}{"\n"}' -n exastro` RS_TCE=`kubectl get deploy ita-by-terraform-cli-execute -o jsonpath='{@.spec.replicas}{"\n"}' -n exastro` RS_TCV=`kubectl get deploy ita-by-terraform-cli-vars-listup -o jsonpath='{@.spec.replicas}{"\n"}' -n exastro` RS_TCEE=`kubectl get deploy ita-by-terraform-cloud-ep-execute -o jsonpath='{@.spec.replicas}{"\n"}' -n exastro` RS_TCEV=`kubectl get deploy ita-by-terraform-cloud-ep-vars-listup -o jsonpath='{@.spec.replicas}{"\n"}' -n exastro`
リバースプロキシの停止
リバースプロキシ (platform-auth) の Pod 起動数を 0 に変更し、エンドユーザーからのアクセスを制限します。kubectl scale deployment platform-auth -n exastro --replicas=0
バックヤード処理の停止
バックヤード処理 (ita-by-***) の Pod 起動数を 0 に変更し、データベースの更新を停止します。kubectl scale deployment ita-by-ansible-execute -n exastro --replicas=0 kubectl scale deployment ita-by-ansible-legacy-role-vars-listup -n exastro --replicas=0 kubectl scale deployment ita-by-ansible-towermaster-sync -n exastro --replicas=0 kubectl scale deployment ita-by-conductor-synchronize -n exastro --replicas=0 kubectl scale deployment ita-by-menu-create -n exastro --replicas=0
以下はITA2.1.0以降からITA2.1.1以降にバージョンアップする際に実行してください。kubectl scale deployment ita-by-ansible-legacy-vars-listup -n exastro --replicas=0 kubectl scale deployment ita-by-ansible-pioneer-vars-listup -n exastro --replicas=0 kubectl scale deployment ita-by-cicd-for-iac -n exastro --replicas=0 kubectl scale deployment ita-by-collector -n exastro --replicas=0 kubectl scale deployment ita-by-conductor-regularly -n exastro --replicas=0 kubectl scale deployment ita-by-excel-export-import -n exastro --replicas=0 kubectl scale deployment ita-by-hostgroup-split -n exastro --replicas=0 kubectl scale deployment ita-by-menu-export-import -n exastro --replicas=0 kubectl scale deployment ita-by-terraform-cli-execute -n exastro --replicas=0 kubectl scale deployment ita-by-terraform-cli-vars-listup -n exastro --replicas=0 kubectl scale deployment ita-by-terraform-cloud-ep-execute -n exastro --replicas=0 kubectl scale deployment ita-by-terraform-cloud-ep-vars-listup -n exastro --replicas=0
Pod 起動数の確認
上記で停止した対象の Pod 数が 0 になっていることを確認kubectl get deployment -n exastro
NAME READY UP-TO-DATE AVAILABLE AGE mariadb 1/1 1 1 3h41m ita-web-server 1/1 1 1 3h41m platform-web 1/1 1 1 3h41m ita-api-admin 1/1 1 1 3h41m ita-api-organization 1/1 1 1 3h41m platform-api 1/1 1 1 3h41m keycloak 1/1 1 1 3h41m ita-by-menu-create 0/0 0 0 3h41m ita-by-ansible-execute 0/0 0 0 3h41m ita-by-ansible-legacy-role-vars-listup 0/0 0 0 3h41m ita-by-ansible-towermaster-sync 0/0 0 0 3h41m ita-by-conductor-synchronize 0/0 0 0 3h41m platform-auth 0/0 0 0 3h41m
以下はITA2.1.0以降からITA2.1.1以降にバージョンアップする際に確認してください。NAME READY UP-TO-DATE AVAILABLE AGE ita-by-ansible-legacy-vars-listup 0/0 0 0 3h41m ita-by-ansible-pioneer-vars-listup 0/0 0 0 3h41m ita-by-cicd-for-iac 0/0 0 0 3h41m ita-by-collector 0/0 0 0 3h41m ita-by-conductor-regularly 0/0 0 0 3h41m ita-by-excel-export-import 0/0 0 0 3h41m ita-by-hostgroup-split 0/0 0 0 3h41m ita-by-menu-export-import 0/0 0 0 3h41m ita-by-terraform-cli-execute 0/0 0 0 3h41m ita-by-terraform-cli-vars-listup 0/0 0 0 3h41m ita-by-terraform-cloud-ep-execute 0/0 0 0 3h41m ita-by-terraform-cloud-ep-vars-listup 0/0 0 0 3h41m
アップグレード実施¶
helm upgrade exastro exastro/exastro \
--namespace exastro \
--values exastro.yaml
NAME: exastro
LAST DEPLOYED: Sat Jan 28 15:00:02 2023
NAMESPACE: exastro
STATUS: deployed
REVISION: 2
TEST SUITE: None
NOTES:
Exastro install completion!
1. Execute the following command and wait until the pod becomes "Running" or "Completed":
# NOTE: You can also append "-w" to the command or wait until the state changes with "watch command"
kubectl get pods --namespace exastro
2. Get the ENCRYPT_KEY by running these commands:
# Exastro IT Automation ENCRYPT_KEY
kubectl get secret ita-secret-ita-global -n exastro -o jsonpath='{.data.ENCRYPT_KEY}' | base64 -d
# Exastro Platform ENCRYPT_KEY
kubectl get secret platform-secret-pf-global -n exastro -o jsonpath='{.data.ENCRYPT_KEY}' | base64 -d
!!! Please save the output ENCRYPT_KEY carefully. !!!
3. Run the following command to get the application URL and go to the URL or go to the displayed URL:
*************************
* Service Console *
*************************
http://exastro-suite.example.local/
*************************
* Administrator Console *
*************************
http://exastro-suite-mng.example.local/auth/
# Note: You can display this note again by executing the following command.
サービス再開¶
サービス再開
サービス停止時に取得した各 Deployment の Pod 起動数を元に戻します。kubectl scale deployment ita-by-ansible-execute -n exastro --replicas=${RS_AE} kubectl scale deployment ita-by-ansible-legacy-role-vars-listup -n exastro --replicas=${RS_ALRV} kubectl scale deployment ita-by-ansible-towermaster-sync -n exastro --replicas=${RS_ATS} kubectl scale deployment ita-by-conductor-synchronize -n exastro --replicas=${RS_CS} kubectl scale deployment ita-by-menu-create -n exastro --replicas=${RS_MC} kubectl scale deployment platform-auth -n exastro --replicas=${RS_PA}
以下はITA2.1.0以降からITA2.1.1以降にバージョンアップする際に実行してください。kubectl scale deployment ita-by-ansible-legacy-vars-listup -n exastro --replicas=${RS_ALV} kubectl scale deployment ita-by-ansible-pioneer-vars-listup -n exastro --replicas=${RS_APV} kubectl scale deployment ita-by-cicd-for-iac -n exastro --replicas=${RS_CFI} kubectl scale deployment ita-by-conductor-regularly -n exastro --replicas=${RS_CR} kubectl scale deployment ita-by-collector -n exastro --replicas=${RS_COL} kubectl scale deployment ita-by-excel-export-import -n exastro --replicas=${RS_EEI} kubectl scale deployment ita-by-hostgroup-split -n exastro --replicas=${RS_HS} kubectl scale deployment ita-by-menu-export-import -n exastro --replicas=${RS_MEI} kubectl scale deployment ita-by-terraform-cli-execute -n exastro --replicas=${RS_TCE} kubectl scale deployment ita-by-terraform-cli-vars-listup -n exastro --replicas=${RS_TCV} kubectl scale deployment ita-by-terraform-cloud-ep-execute -n exastro --replicas=${RS_TCEE} kubectl scale deployment ita-by-terraform-cloud-ep-vars-listup -n exastro --replicas=${RS_TCEV}
Pod 起動数の確認
上記で起動した対象の Pod 数が元に戻りすべて READY になっていることを確認kubectl get deployment -n exastro
NAME READY UP-TO-DATE AVAILABLE AGE ita-api-admin-7c78cc475-xt8kh 1/1 Running 0 47m ita-api-organization-f4bccc5c4-8txpj 1/1 Running 0 47m ita-by-ansible-execute-666d5bdf86-bt94w 1/1 Running 0 47m ita-by-ansible-legacy-role-vars-listup-79c5cfdf7c-wntg5 1/1 Running 0 47m ita-by-ansible-legacy-vars-listup-7b7f5fb88c-nqzrd 1/1 Running 0 47m ita-by-ansible-pioneer-vars-listup-5d5f5b589-d4hn9 1/1 Running 0 47m ita-by-ansible-towermaster-sync-548bd8c867-2vp9z 1/1 Running 0 47m ita-by-cicd-for-iac-558986b4c5-fk7bh 1/1 Running 0 47m ita-by-collector-59ff796d8c-xc4dx 1/1 Running 0 47m ita-by-conductor-regularly-b5c5dd6dc-7t8km 1/1 Running 0 47m ita-by-conductor-synchronize-787f9fd8f7-mxsw6 1/1 Running 0 47m ita-by-excel-export-import-66db589589-xv5zz 1/1 Running 0 47m ita-by-hostgroup-split-8459fb48fc-ltrtb 1/1 Running 0 47m ita-by-menu-create-5bc6849cd5-xkm6r 1/1 Running 0 47m ita-by-menu-export-import-84ccc5467-9fnb8 1/1 Running 0 47m ita-by-terraform-cli-execute-695ffbd4c-pqkwj 1/1 Running 0 47m ita-by-terraform-cli-vars-listup-6dcccf9585-nxbkj 1/1 Running 0 47m ita-by-terraform-cloud-ep-execute-7bbfcd6f6c-fkqpd 1/1 Running 0 47m ita-by-terraform-cloud-ep-vars-listup-5d4c7c94ff-7gmsk 1/1 Running 0 47m ita-migration-1.0.5-iql5 0/1 Completed 0 47m ita-web-server-75f8c85f7c-vvkp5 1/1 Running 0 47m keycloak-9d464565b-zwq6b 1/1 Running 0 47m platform-api-57bff76cc-fmdcn 1/1 Running 0 47m platform-auth-54c7f8bcc8-lmgv6 1/1 Running 0 47m platform-migration-1.4.3-gs4x 0/1 Completed 0 47m platform-web-7d74bb98d-srtdp 1/1 Running 0 47m
アップグレード状況確認¶
# Pod の一覧を取得
kubectl get po -n exastro
NAME READY STATUS RESTARTS AGE
ita-api-admin-64657656c6-r4s2l 1/1 Running 0 30m
ita-api-organization-75ff9d599c-gthvl 1/1 Running 0 30m
ita-by-ansible-execute-fdd8dfc57-7676h 1/1 Running 0 30m
ita-by-ansible-legacy-role-vars-listup-6cd558d78b-xxl6x 1/1 Running 0 30m
ita-by-ansible-legacy-vars-listup-5db44d54d8-zxqj7 1/1 Running 0 30m
ita-by-ansible-pioneer-vars-listup-6bf744f5b6-k8ctx 1/1 Running 0 30m
ita-by-ansible-towermaster-sync-59594b5d84-phbg7 1/1 Running 0 30m
ita-by-cicd-for-iac-f6855c588-r6w4k 1/1 Running 0 30m
ita-by-collector-6fc8c7b4d4-hjwck 1/1 Running 0 30m
ita-by-conductor-regularly-5897dcb9f6-4npz7 1/1 Running 0 30m
ita-by-conductor-synchronize-6fd6dcd5f4-qgdhx 1/1 Running 0 30m
ita-by-excel-export-import-df76d77c4-ms4j2 1/1 Running 0 30m
ita-by-hostgroup-split-86746f758-b796k 1/1 Running 0 30m
ita-by-menu-create-8588c9747d-66xwn 1/1 Running 0 30m
ita-by-menu-export-import-6b8498f476-zwml7 1/1 Running 0 30m
ita-by-terraform-cli-execute-8478554d8d-qztbv 1/1 Running 0 30m
ita-by-terraform-cli-vars-listup-bf688659d-zgh8d 1/1 Running 0 30m
ita-by-terraform-cloud-ep-execute-5dbbb599b-qh8rc 1/1 Running 0 30m
ita-by-terraform-cloud-ep-vars-listup-5564fcb5b-nphm7 1/1 Running 0 30m
ita-migration-1.0.4-0wdt 0/1 Completed 0 30m
ita-web-server-854bcdbbf4-s7fdb 1/1 Running 0 30m
keycloak-56d8b4556c-tndnv 1/1 Running 0 30m
platform-api-bddb446db-s9zjh 1/1 Running 0 30m
platform-auth-799f57fb6c-wlbtf 1/1 Running 0 30m
platform-migration-1.4.2-6sks 0/1 Completed 0 30m
platform-web-88db7c489-wkmn9 1/1 Running 0 30m
2.7. アンインストール¶
2.7.1. アンインストールの準備¶
警告
2.7.2. アンインストール¶
アンインストール実施¶
helm uninstall exastro --namespace exastro
release "exastro" uninstalled
データベースのデータの削除¶
kubectl delete pv pv-database
persistentvolume "pv-database" deleted
/var/data/exastro-suite/exastro-platform/database
を指定した場合の例です。# 永続データがあるコントロールノードにログイン
ssh user@contol.node.example
# 永続データの削除
sudo rm -rf /var/data/exastro-suite/exastro-platform/database
ファイルデータの削除¶
kubectl delete pv pv-ita-common
persistentvolume "pv-ita-common" deleted
/var/data/exastro-suite/exastro-it-automation/ita-common
を指定した場合の例です。# 永続データがあるコントロールノードにログイン
ssh user@contol.node.example
# 永続データの削除
sudo rm -rf /var/data/exastro-suite/exastro-it-automation/ita-common