起動パラメータ

SDK Portalの様々な設定を起動時に指定することができます
起動オプションはyaml形式のコンフィグファイルとしても記述可能で、デプロイ環境毎に作成・管理し、ファイル指定で起動時するような利用方法も可能です。

Qmonus-SDK Labをご利用の際は、起動オプションはいずれもGUIから指定することが可能です。

グローバル設定

Site設定

ログイン画面に表示されるタイトルやアイコン、ポータルのテーマなどのカスタマイズを行います

外部認証連携設定

authentication_provider に以下のように複数の外部認証プロバイダ設定を指定することができます。
ログイン画面でそれぞれのプロバイダに対応するアイコンが表示されるので、ユーザがログイン方法を選択することができます。

以下の [provider1] と指定しているキーワードは、任意に指定が可能です。ここで指定したキーワードで、認証連携時のコールバックAPIが生成されます。下記の場合には、https://XXXXX/auth/provider1/callback のようにURLでコールバックパスが指定されます

boot_params
authentication_provider : 
    provider1:
        provider : google
        default_role :
        forced_role : 
        allowed_account : "^[A-Za-z0-9]{1}[A-Za-z0-9_.-]*@ntt.com$"
        use_on : 
            - 8881
        properties : 
    provider2:
        .
        .
        .
       

プロバイダ設定（共通）

boot-params
authentication_provider : 
    provider1:
        strategy : qmonus
        properties :
            base_url : https://XXXXX
            pass_code : **************************
            pass_phrase : *************
            enableSLO : true

boot-params

authentication_provider : 
    provider1:
        strategy : google
        properties :
            project_id : **************************
            client_id : **************************
            client_secret : *************
            callbackProto : https
            role_prefix : "hogefuga_"

boot-params

authentication_provider : 
  azuread:
    provider : azuread
    default_role : guest #SDKのプラグインで定義されたロール名

    properties:
      identityMetadata : "https://login.microsoftonline.com/xxxxxx/.well-known/openid-configuration"
      client_id : "xxxx"
      client_secret : "xxxx"
      redirectUrl: "https://xxxxx/auth/azuread/callback"
      response_type: "id_token code"
      response_mode: "form_post"

boot-params（ロール連動）

authentication_provider : 
  azuread:
    provider : azuread

    # providerロール と Qmonusロールとのマッピングルール
    # azureの場合はユーザには複数グループが設定されている前提。どのロールを適用するか決定するためrole_mapping_rulesの記載順に最初にヒットした１つがQmonusロールとして利用される。
    role_mapping_rules :
      ROLE_E : owner
      ROLE_A : admin
      ROLE_B : member
      ROLE_ALL : member

    default_role : guest  #default_roleと併用することで上記のルールにマッチしない場合のロール指定も可能

    properties:
      identityMetadata : "https://login.microsoftonline.com/xxxxxx/.well-known/openid-configuration"
      client_id : "xxxx"
      client_secret : "xxxx"
      redirectUrl: "https://xxxxx/auth/azuread/callback"
      response_type: "id_token code"
      response_mode: "form_post"

      # Qmonus roleに紐付けるAzureのリソース（現時点ではgroupのみ対応）
      role_bind_resource : group

認証プロキシー設定

ApiFrontや他のSDK Portalから、認証プロバイダとして動作させるための設定です。
利用側のコンフィグで指定する値と、ここで指定する pass_code/pass_phrase は一致させる必要があります。
セキュティを考慮し、ホワイトリストを設定して運用してください。

boot-params
authentication_proxy:
  pass_code: xxxx
  pass_phrase: xxxx
  allowed_uri:
    - "https://[\S]*.hogehoge.com"

ログ保存設定

APIモニターログは、Portalサーバのストレージにファイルとして保存されます。ファイルは自動的にローテートされます。
お使いのストレージの容量に合わせて保存設定を変更できます。デフォルトは 700m(100m*7世代)です。

boot-params

logrotate : 
    monitor:
        size : '100m'
        count : 75

セッション管理

ユーザのログイン状態はセッションストアで管理され、セッション識別用のIDはCookieでブラウザに保存されます。

SDK Core 環境設定

接続先 SDK Coreの環境設定です。SDK Portalから複数環境への接続も可能なため、配列で指定します。複数設定されている場合は、ログインページでログイン環境を選択するプルダウンが表示されます。

boot_params

environments: 
    - name : env1
      enable_push_heartbeat : false
      apikey : XX
      axis_nodes :
        - https://apigw
        - https://scenario
        - https://transaction

boot_params

environments: 
    - name : env1
      apikey : XX
      enable_push_heartbeat : true

boot_params

custom_authorizations:
  - code: 403
    message: アクセス可能な環境ではありません
    script: ( profile , env )=>  env.metadata.tenant !== profile.metadata.tenant

SDK Portal プラグイン設定

カスタムダッシュボードなどのPortalのプラグインを利用する際に設定する項目です。IDEとしてだけ利用する際は特に設定は不要です。

• plugins

  カスタムダッシュボードやカスタムサービスポータル、ウィジェットなど、ポータルのプラグインの設定を行います。
  content_dir で読み込みディレクトリを設定することができます。

  
  +plugins.content_dir=/var/plugins/xxxx
  

• config_dir [非推奨]

  作成したポータルプラグインを編集不可能なビルトイン機能としてバンドルする際に利用します。この機能は非推奨のため、今後のメンテナンスは行われません。

  
  +config_dir=/var/builtins/xxxx
  

• spa_dir

  E2E試験を利用する際に指定するディレクトリです。

• e2e_report_dir

  E2E試験結果を保存するディレクトリを指定します。

• e2e_endpoint

  E2E試験に関するAPIのEndpointを指定します。SDK Labで自動設定するパラメーターのため編集は非推奨です。

• fileshare

  GUIアセット開発に利用する際に指定するディレクトリです。ApiFrontの開発をポータル上で行う際に指定します。SDK Labで自動設定するパラメーターのため編集は非推奨です。

SDK Portal 機能拡張設定（オプション機能）

その他の機能拡張用の設定です。いずれも任意設定です。

• dashboard_provider

  カスタムダッシュボードを別のアプリケーションとして起動する設定です。指定したポート番号でダッシュボード機能のみを起動させることができます。

  
  +dashboard_provider.port=8889
  

• links

  ポータルのDashboard as a Serviceメニューに指定した画面リンクを追加することができます。

  boot_params
  
      links: [
          {
              "id": "任意の文字列",
              "name": "link name",
              "description": "desc of link",
              "url": "http://xxxx"
          }
      ],
  
  

• publication [非推奨]

  メール通知用API（/apis/publication）の設定を行います。この機能は非推奨のため、今後のメンテナンスは行われません。

• httpproxy

• wsproxy

• apiproxy

  SDK Portalサーバーにプロキシ設定を追加することができます。

  boot_params
  
      httpproxy:{
          // port : url
          9991 : "http://hoge"
  
          ## 別ポートでプロキシ起動
      },
      wsproxy:{
          // port : url
          9992 : "http://hoge"
  
          ## 別ポートでプロキシ起動
      },
      apiproxy : {
          // name : url
  	    "path_to_api": "https://xxxx"
  
          ## 起動ポートの /apis/path_to_api/proxy でアクセス可能
      }