ワークスペース・デプロイメントのプロパティー

Maximo® Manageのカスタムリソースは、アプリケーションを起動するためのプロパティを提供します。

データベース
次の表では、データベース・プロパティーに使用されるワークスペース・カスタム・リソースのフィールドについて説明しています。
表 1. データベース・プロパティー
フィールド 説明 追加情報
dbSchema Maximo Manageを含むデータベーススキーマ。 必須フィールド。
encryptionSecret 暗号および Cryptox の暗号化に使用される暗号鍵およびアルゴリズム。 以下の鍵がサポートされています。
  • MXE_SECURITY_CRYPTO_ALGORITHM
  • MXE_SECURITY_CRYPTO_KEY
  • MXE_SECURITY_OLD_CRYPTO_KEY
  • MXE_SECURITY_CRYPTO_MODE
  • MXE_SECURITY_CRYPTO_MODULUS
  • MXE_SECURITY_CRYPTO_PADDING
  • MXE_SECURITY_CRYPTO_SPEC
  • MXE_SECURITY_CRYPTOX_ALGORITHM
  • MXE_SECURITY_CRYPTOX_KEY
  • MXE_SECURITY_OLD_CRYPTOX_KEY
  • MXE_SECURITY_CRYPTOX_MODE
  • MXE_SECURITY_CRYPTOX_MODULUS
  • MXE_SECURITY_CRYPTOX_PADDING
  • MXE_SECURITY_CRYPTOX_SPEC
tableSpace データベースの表スペース。 このプロパティーは、データベースの初期デプロイメントでのみ必要になります。 アップグレードでは指定する必要はありません。
indexSpace データベースの索引スペース。 このプロパティーは、データベースの初期デプロイメントでのみ必要になります。 アップグレードでは指定する必要はありません。
demodata データベースの作成時にデモ・データを組み込むかどうかを示します。 デモ・データを組み込むには、この値を true に設定します。 デフォルトは false です。

このプロパティーは、データベースの初期デプロイメントでのみ必要になります。 アップグレードでは指定する必要はありません。

db2Vargraphic データベースで vargraphic データ型を使用するかどうかを示します。 このフィールドは、 IBM® Db2®用に提供されています。 デフォルトは True です。

IBM Db2 を使用していて、基本言語として、または追加言語として英語以外の言語をインストールする予定の場合は、このフィールドの値を trueに設定してください。

bypassUpgradeVersionCheck データベースのインストール時に、アップグレード・バージョン・チェックをバイパスするかどうかを示します。 オプションのフィールド。

デフォルトは false です。

データベースのインストール時に障害が発生する場合は、このプロパティーを true に設定して、データベースのバージョンに関係なく、インストールが完了するようにすることができます。 その後、ログ・ファイルを確認して問題を評価し、必要に応じてインストールの問題を修正することができます。

言語
次の表では、言語プロパティーに使用されるワークスペース・カスタム・リソースのフィールドについて説明しています。
表2. 言語プロパティー
フィールド 説明 追加情報
baseLang アプリケーションの基本言語。 必須フィールド。

デフォルトは英語です。

英語を選択する場合、アプリケーションの再デプロイ時に別の基本言語を指定できます。 ただし、英語以外の言語を指定する場合は、アプリケーションの再デプロイ時にその基本言語を変更することはできません。

secondaryLangs アプリケーションの 2 次言語。 オプションのフィールド。

デフォルトでは、2 次言語は指定されていません。

ワークスペース・カスタム・リソースの YAML ファイルで直接作業する際、言語としてノルウェー語を指定する場合は、引用符を使用する必要があることに注意してください (例えば、'NO')。 引用符を追加しない場合、NO は、ISO 言語コードではなく、ブール値の NO として解釈されます。

生成されたイメージ
次の表では、外部レジストリーへのイメージの生成に使用されるワークスペース・カスタム・リソースのフィールドについて説明しています。
表3. 生成されたイメージのプロパティー
フィールド 説明 追加情報
registryForGeneratedImages:registryPath 外部レジストリーの場所を指す URL。 オプションのフィールド。

registryForGeneratedImages:secretName 外部レジストリーの資格情報用に作成されたシークレットの名前。 オプションのフィールド。
サーバー・バンドル
次の表では、サーバー・バンドル・プロパティーに使用されるワークスペース・カスタム・リソースのフィールドについて説明しています。
表4. サーバー・バンドル・プロパティー
フィールド 説明 追加情報
name サーバー・バンドルのユーザー定義の名前。 必須フィールド。
isDefault デフォルト経路が 「管理」 アプリケーション・ワークスペース内のこのサーバー・バンドルを指すかどうかを示します。 グループ内のいずれかのサーバー・バンドルに必要です。

デフォルトとして設定できるサーバー・バンドルは 1 つのみです。

以下のバンドル・タイプのみに対して、isDefaulttrue に設定できます。
  • すべて
  • ui
サーバー・バンドルを 1 つのみ作成して、isDefault フィールドに値を指定しない場合、そのサーバー・バンドルがデフォルトのサーバー・バンドルとして選択されます。

複数のサーバー・バンドルを指定して、isDefault フィールドに値を指定しない場合、バンドル・タイプ all のサーバー・バンドルがデフォルトとして選択されます。

isUserSyncTarget このサーバー・バンドルが Maximo Application Suite ユーザーを 「管理」と同期するために使用されるかどうかを示します。 1 つのサーバー・バンドルに必要です。

ユーザーの同期に使用できるサーバー・バンドルは 1 つのみです。

以下のバンドル・タイプのみに対して、isUserSyncTarget を true に設定できます。

  • すべて
  • mea
ユーザー同期のターゲットを指定しない場合、デフォルトのサーバー・バンドルが同期に使用されます。
isMobileTarget このサーバー・バンドルを Maximo Mobile アプリケーションに使用できるかどうかを示します。 オプションのフィールド。

このアプリケーションに使用できるサーバー・バンドルは 1 つのみです。

以下のバンドル・タイプのみに対して、isMobileTargettrue に設定できます。
  • すべて
  • ui
replica このサーバー・バンドル用に作成するポッドの数。 値 0 を入力すると、ポッドはデプロイされません。 必須フィールド。
routeSubDomain サーバー・バンドルのサブドメイン。 このサブドメインは、メイン・ドメインの接頭部として追加されます。 例えば、サブドメインとして maximoui を指定する場合、完全なドメインは maximoui.workspaceid.manage.domain.com になります。 タイプ ui または all のバンドルが複数ある場合、バンドルへのアクセス権限をユーザーに付与するために、各バンドルのサブドメインを指定する必要があります。
bundleLevelProperties 特定のサーバー・バンドルにのみ適用する 「管理」 システム・プロパティー。 オプションのフィールド。
additionalServerConfig.secretName Liberty アプリケーション・サーバーに適用される追加の server.xml ファイルを含む秘密。 オプションのフィールド。
jvmOptions サーバー・バンドルの Liberty アプリケーション・サーバーの JVM オプションを指定します。

このフィールドの値は、以下の例に示す形式で指定する必要があります。

-Xms4m\n-Xmx488m\n-XX:MaxPermSize=256m.

オプションのフィールド。
カスタマイズ
次の表では、カスタマイズ・プロパティーに使用されるワークスペース・カスタム・リソースのフィールドについて説明しています。
表 5. カスタマイズ・プロパティー
フィールド 説明 追加情報
customizationArchive カスタマイズ・アーカイブの場所を指す URL。 オプションのフィールド。
以下の URL プロトコルがサポートされています。
  • HTTP
  • HTTPS
  • FTP
  • FTPS
customizationArchiveCredentials カスタマイズ・アーカイブにアクセスするために必要な資格情報。 オプションのフィールド。
サーバー・モード
次の表では、サーバー・デプロイメントのモード・プロパティーに使用されるワークスペース・カスタム・リソースのフィールドについて説明しています。
表 6. サーバー・モード・プロパティー
フィールド 説明 追加情報
mode Maximo Manageの展開状況。 以下の値を使用できます。
  • up - Maximo Manage が稼働中です。
  • ダウン - Maximo Manage が稼働していません。
必須フィールド。

デフォルト値は up です。

永続ボリューム
次の表では、永続ボリューム・プロパティーに使用されるワークスペース・カスタム・リソースのフィールドについて説明しています。
表 7. 永続ボリューム・プロパティー
フィールド 説明 追加情報
pvcName ストレージを要求する永続ボリューム要求の名前。  
volumeName 管理者が作成したストレージ・ボリュームの名前。  
size ボリューム・ストレージから要求するストレージの量。  
mountPath Maximo Manage内のストレージボリュームのマウントパス。  
storageClassName 管理者がボリュームに定義したストレージ・クラス。  
ビルド・タグ
次の表では、ビルド・タグ・プロパティーに使用されるワークスペース・カスタム・リソースのフィールドについて説明しています。
表 8. ビルド・タグ・プロパティー
フィールド 説明 追加情報
buildTag デプロイメントに使用されているビルド。 デフォルトでは、アプリケーションのデプロイ時に最新のビルドが使用されます。 ただし、最新のビルドをデプロイしない場合は、それより前のビルドを指定できます。 必須フィールド。

デフォルトは latest です。

次の例に示すように、ビルド・イメージにはタイム・スタンプのタグが付けられます。
buildtag: 202011092887843
インポート済みの証明書
次の表では、インポート済みの証明書に使用されるワークスペース・カスタム・リソースのフィールドについて説明しています。
表 9. インポート済みの証明書プロパティー
フィールド 説明 追加情報
alias 証明書の代替名。 別名は、ワークスペース内で固有でなければなりません。 別名および証明書のリストは、ホストのトラスト・チェーン全体を表します。 証明書が必要になるのは、 Maximo Application Suiteによってまだ信頼されていない認証局によって署名された証明書をホストが提示する場合のみです。
crt PEM 形式で提供される単一の証明書。  

サンプル 管理 ワークスペース・カスタム・リソース (CR)

spec:
  bindings: 
    jdbccfg: workspace-application # Manage-workspace level, required. 
    #jdbcfg expects connection string, jdbc options, use SSL flag, username, password, certificate

  components: #?where do we provide the descrption of the component and get it translated? What displayed to the
              #end user are supposed to be desciption of the component, not necessarily the actual identifier on the CR
    managebase: # The components. It is a variable list. Value come from a predefined list. Some componnet have additional configuration
                # should it be a list or like that originall on the playbook
      version: 8.0.0
    nuclear:
      version: 8.0.0
    acm:
      version: 8.0.0
      bindings: #
        bdi: workspace-application # we expect bdi configuration is needed for acm and aviation.
                                   # how do we specify it is needed?
        version: latest # If latest, operator will choose the default version of the component. Where would be a possible list comfrom
                      # Manage operator maintains a supporte version of add ons based on the manage base version in the admission
                      # webhook.


  settings:
    lanaguges:
      baseLang: EN #optional base language
      secondaryLangs: #optional list of language codes, default empty
        - FR #?a code, a two leter standard? The list coming from the schema validation
        - IT
    customization:
      customizationArchive: https://company.com/customization.zip #optional customization archive that wget can obtained, no security
      customizationArchiveCredential: secretname #optional secret name and password for wget
                 #only support http, https, ftp, ftps with password authentication for now. Additonal method may be provided in the
                 #future.

    db: 
      dbSchema: maximo #optional, default to maximo, but typically need input ?should it be in jdbccfg?
      encryptionSecret: <workspaceid>-encryption-secret #?how to indicate this is a secret and have to be certain name? User enter properties, if not exist, generate default, should we use fixed name or allow user to specify secret?
      maxinst: # optional but typically the databata need to input. Cannot change after deploymet ?How to tell MAS about it?
        tableSpace: maxdata # only used when instantiate the DB, for a new database, customer has to specify it
        indexSpace: maxdata  # only used when instantiate the DB, for a new database, customer has to specify it
        installDemoData: false # default no, n/a after DB initialized
        demodata: true # whether the demo data will be installed. Default false
        db2Vargraphic: true # option when db is installed, n/a after DB initialized, only applies if the DB is db2

    deployment: 
      buildTag: 202011092887843 # actual build number or "latest" as default. Specifying the actual build number most likely a modification after
                                # intial deployment to prevent accidental change
      mode: up # up, down or adminmode
      persistentVolumes: # list of volumes
        - pvcName: forattachdoc the actual pvcname generated will be environment-workspaceid-pvcName, pass the generated name to ManageServerBundle CR
          volumeName: actual_volume_customer_created1 the valume customer created
          storageClass: nfs
          size: 50G
          mountPath: /dir #pass on to ManageServerBundle CR
        - pvcName: dropzone
          volumeName: actual_volume_customer_created2
          storageClass: nfs
          size: 10G
          mountPath: /dir2
      serverBundles:
      - name: "generic1" #name of the server, user input, no default ?required
        isDefault: true # default bundle, pointed from the luanch point of Manage.
                        # There are some criteria that isDefault has to be set to a bundle with a certain type.
        isUserSyncTarget: true #There are some criteria that isDefault has to be set to a bundle with a certain type.
        relica: 3
        bundleType: all # one of the predefined types ui, all, report, etc
        routeSubDomain: generic1 # subdomain that prefix manage.workspaceid.mange.domain.com
        bundlelevelproperties:  # let us know if a configmap or a section of properties . We just need to eventually produce a
                                # content of a java properties file formated configmap
          prop1: value1
          prop2: value2
        #bundleLevelProperties: bundlepropertiesconfigmap # optional configmap to specify bundle level maximo properties key value pair
        additionalServerConfig: serverxmlconfigmap # optional include secondary server.xml file
                                                   # need ui for user to enter a freeform text, either recorded here or become a configmap
      - name: "mycronservers"
        replica: 2
        bundletype: cron
      - name: "reportonly"
        replica: 1
        bundleType: report
        route: dataloadserver

#service binding expected for instanceid, workspaceid, ImageRegistry, registry pull secret
#oauth client registration

# BDI CR spec