Helm値

はじめに

Helm値は、Live Agentアプリとリソースの設定に使用されるすべての変数です。これらは values.yaml というファイルに保存されます。これは、Live Agentの動作を設定するために、必要に応じて編集することができます。以下は、このファイルの例です：

# Defining Ingress host
ingress:
  enabled: false
  annotations:
    kubernetes.io/ingress.class: traefik
  hosts:
    - host: "live-agent-domain.com"
      paths:
        - path: /
          pathType: Prefix
          backend:
            service:
              name: cognigy-live-agent-app

configmap:
  # Comment about a commented variable, it is ignored
  # REST_CLIENT_SSL_VERIFICATION=false
  FORCE_SSL: true

values.yamlファイル内の変数を変更またはコメントする以外に、パラメータは、helm installに-set key=value[,key=value]引数を使用して変更することもできます。

例：

helm install my-release \
  --set configmap.SSL_CA_FILE="/etc/ca.pem"\
    ./cognigy-live-agent

上記コマンドは、Live Agent証明書ファイルのパスを/etc/ca.pemに設定します。詳細はHelmドキュメントの[Template and Values(テンプレートと値)]をご覧ください。

values.yamlファイルを直接修正するのではなく、custom-values.yamlを作成し、オーバーライドの必要があるキー値を追加することをお勧めします。そうすることで、インストールまたはアップグレードコマンドを実行するときに、このように最後に引数を使うだけで容易になります：

helm install cognigy-live-agent oci://cognigy.azurecr.io/helm/live-agent --version X.X.X --namespace live-agent -f custom-values.yaml

次に、それぞれの値の定義を確認し、どのように変更すればよいかをご理解ください。

特定の構成

特定の数値やロジックについては、以下の専用セクションをご利用ください：

• データベース
• Redis
• ストレージ
• SMTP
• メールテンプレート

画像

Cognigy(コグニジー)

App Platform Token（アプリプラットフォームトークン）

Cognigy.AIは、Live Agent APIを使用して、データ（受信トレイやアカウントなど）の同期や作成などの操作を実行するためにApp Platform Tokenを使用します。このため、Live AgentとCognigy.AIには、シークレットが一致する値に設定されている必要があります。

Live Agent シークレット

Live Agentネームスペースの下に新しいシークレットを作成し、Helm値でそれを参照することをお勧めします。そうしない場合、自動的にlive-agent-cognigy-live-agent-cognigy-platform-app-tokenというシークレットがランダムな値で作成されます（このシークレットは永続化され、将来のHelmのアップグレードでも変更されません）。

Cognigy.AIシークレット

以下のHelm値を設定する必要があります：

cognigyLiveAgent:
  ## Existing secret with live-agent credentials. The secret must have the following key:
  ##   "cognigy-live-agent-platform-token": The token for cognigy live agent
  existingSecret: ""

トラブルシューティング

シークレットが同じ値であるにもかかわらず、統合が機能していない場合（例えば、ハンドオーバーや事前に設定されたLive Agentが機能していない場合）、以下を実行してください：

1. Live Agentネームスペースのlive-agent-cognigy-live-agent-XXXアプリポッドを再起動します。
2. Cognigy.AI ネームスペースの以下の Cognigy.AI ポッドを再起動します：
3. service-handover
4. service-security
5. service-api
6. service-resources
7. service-ui

OAuth

これらは、Live AgentでCognigy認証を有効にするために使用される値です。これにより、Cognigyユーザは同じ認証情報でLive Agentにログインすることができます。

OAuthクライアントシークレットは、Live Agentネームスペースにシークレットを作成し、以下の値を設定します：

Cognigy.AI

以下のHelm値を設定する必要があります：

cognigyEnv:
  ...
  COGNIGY_LIVE_AGENT_API_BASE_URL_WITH_PROTOCOL: <live-agent-url>"
  CLIENT_ID_COGNIGY_LIVE_AGENT: "cognigy-live-agent"
  CLIENT_SECRET_COGNIGY_LIVE_AGENT: "<secret-value>"
  REDIRECT_URI_COGNIGY_LIVE_AGENT: "<live-agent-url>/omniauth/cognigy/callback"
  COGNIGY_LIVE_AGENT_UI_BASE_URL_WITH_PROTOCOL: "<live-agent-url>"
  FEATURE_USE_COGNIGY_LIVE_AGENT: "true"

トラブルシューティング

secretsとconfigmapsが同じ値であるにもかかわらず、統合が機能しない場合（例えば、OAuthの設定エラー “OAuth 設定に問題があります”）、以下を実行してください：

1. Live Agentのネームスペースのcognigy-live-agent-app-XXX アプリポッドを再起動します。
2. Cognigy.AI ネームスペースの以下の Cognigy.AI ポッドを再起動します：
3. service-security
4. service-api
5. service-resources
6. service-ui

Insights（インサイト）

Live AgentからInsightsにトークに関する分析を送信するには、以下のHelm値を設定する必要があります：

シークレットキーの値は、Cognigy.AIネームスペースの「cognigy-insights-collector-api-key」という名前と「Secret」というキーに含まれるシークレットから取得されます。URLは、Insightsサービスコレクターのローカルアドレスを指す必要があります。

トラブルシューティング

これらの値が設定されていない場合、トーク分析データはInsightsに送信されず、Live Agent podの起動時に警告ログが表示されます。

Data will not be sent to Cognigy Insights, as neither of the following environment variables were set: COGNIGY_INSIGHTS_API_KEY and COGNIGY_INSIGHTS_API_BASE_URL_WITH_PROTOCOL

URLs

ウイルス対策ファイルのアップロード

ウイルス対策ファイルのアップロードスキャンを有効にするには、次の値を有効にする必要があります：

アップロードされたファイルをウイルススキャンし、ウイルスが検出された場合はアップロードをブロックします。これは、Live Agent UIやCognigy.AI Webchatからのものを含む、添付ファイルとしてメッセージに含まれてアップロードされたすべてのファイルをスキャンします。

App(アプリ)

Cookieの完全性

Live Agentは、クッキーのサイン用にセキュアストレージされたものを使用します。SECRET_KEY_BASE値は安全な値に設定する必要があります。デフォルト値はランダムな文字列に設定されていますが、安全な値に変更することをお勧めします。

cookiesIntegrity:
  # Uncomment these lines in case there is an existing secret and don't want to create it on install
  # existingSecret: "<secret-name>"
  # existingSecretKey: "<secret-key>"

Rest Client SSL

Live AgentはCognigy.AI APIへのリクエストを実行します。Cognigy.AIのサービスを信頼するCustom Certificate Authority (CA)付きの自己署名証明書で実行している場合、またはSSLを無効にする必要がある場合は、これらの設定が必要です。

証明書の検証

カスタム認証局を使った自己署名証明書

証明書ファイル名（例：cert.pem）をキーとするシークレットを作成します。これは、Live Agentアプリによって信頼されるように、ポッドファイルシステムにマウントされます。この値には、余分なタブ/スペースなしで証明書ファイルの内容を含める必要があります。次に、以下の値を入力します：

値の更新後にポッドが再起動されることをご確認ください。

クライアント証明書

クライアント証明書を使用するには、クライアント証明書、クライアント証明書キー、キーのパスフレーズ（キーにパスフレーズがある場合）を含むシークレットを作成します。次に、以下の値を入力します：

値の更新後にポッドが再起動されることを確認します。

Odata

その他