18.7. PTP ハードウェアの高速イベント通知フレームワーク

手順

1. デフォルトの PTP Operator 設定を変更して、PTP 高速イベントを有効にします。

   1. 次の YAML をptp-operatorconfig.yamlファイルに保存します。

      apiVersion: ptp.openshift.io/v1
      kind: PtpOperatorConfig
      metadata:
        name: default
        namespace: openshift-ptp
      spec:
        daemonNodeSelector:
          node-role.kubernetes.io/worker: ""
        ptpEventConfig:
          enableEventPublisher: true 1

      1

      enableEventPublisher を true に設定して、PTP 高速イベント通知を有効にします。

      注記

      OpenShift Container Platform 4.12 以降では、PTP イベントに HTTP トランスポートを使用するときに、PtpOperatorConfig リソースの spec.ptpEventConfig.transportHost フィールドを設定する必要はありません。PTP イベントに AMQP トランスポートを使用する場合にのみ、transportHost を設定します。

   2. PtpOperatorConfig CR を更新します。

      $ oc apply -f ptp-operatorconfig.yaml

2. PTP 対応インターフェイスの PtpConfig カスタムリソースを作成し、ptpClockThreshold および ptp4lOpts に必要な値を設定します。次の YAML は、PtpConfig CR で設定する必要のある値 (必須) を示しています。

   spec:
     profile:
     - name: "profile1"
       interface: "enp5s0f0"
       ptp4lOpts: "-2 -s --summary_interval -4" 1
       phc2sysOpts: "-a -r -m -n 24 -N 8 -R 16" 2
       ptp4lConf: "" 3
       ptpClockThreshold: 4
         holdOverTimeout: 5
         maxOffsetThreshold: 100
         minOffsetThreshold: -100

   1

   --summary_interval -4を追加して、PTP 高速イベントを使用します。

   2

   phc2sysOpts の値が必要です。-m はメッセージを stdout に出力します。linuxptp-daemon DaemonSet はログを解析し、Prometheus メトリックを生成します。

   3

   デフォルトの /etc/ptp4l.conf ファイルを置き換える設定が含まれる文字列を指定します。デフォルト設定を使用するには、フィールドを空のままにします。

   4

   オプション: ptpClockThreshold スタンザが存在しない場合は、ptpClockThreshold フィールドにデフォルト値が使用されます。スタンザは、デフォルトの ptpClockThreshold 値を示します。ptpClockThreshold 値は、PTP マスタークロックが PTP イベントが発生する前に切断されてからの期間を設定します。holdOverTimeout は、PTP マスタークロックが切断されたときに、PTP クロックイベントの状態が FREERUN に変わるまでの時間値 (秒単位) です。maxOffsetThreshold および minOffsetThreshold 設定は、CLOCK_REALTIME (phc2sys) またはマスターオフセット (ptp4l) の値と比較するナノ秒単位のオフセット値を設定します。ptp4l または phc2sys のオフセット値がこの範囲外の場合、PTP クロックの状態が FREERUN に設定されます。オフセット値がこの範囲内にある場合、PTP クロックの状態が LOCKED に設定されます。

手順

1. HTTP トランスポートを使用するようにイベントコンシューマーアプリケーションを更新します。クラウドイベントサイドカーデプロイメントの http-event-publishers 変数を設定します。

   たとえば、PTP イベントが設定されているクラスターでは、以下の YAML スニペットはクラウドイベントサイドカーデプロイメントを示しています。

   containers:
     - name: cloud-event-sidecar
       image: cloud-event-sidecar
       args:
         - "--metrics-addr=127.0.0.1:9091"
         - "--store-path=/store"
         - "--transport-host=consumer-events-subscription-service.cloud-events.svc.cluster.local:9043"
         - "--http-event-publishers=ptp-event-publisher-service-NODE_NAME.openshift-ptp.svc.cluster.local:9043" 1
         - "--api-port=8089"

   1

   PTP Operator は、PTP イベントを生成するホストに対して NODE_NAME を自動的に解決します。compute-1.example.com はその例です。

   ベアメタルイベントが設定されているクラスターでは、クラウドイベントサイドカーデプロイメント CR で http-event-publishers フィールドを hw-event-publisher-service.openshift-bare-metal-events.svc.cluster.local:9043 に設定します。

2. consumer-events-subscription-service サービスをイベントコンシューマーアプリケーションと併せてデプロイします。以下に例を示します。

   apiVersion: v1
   kind: Service
   metadata:
     annotations:
       prometheus.io/scrape: "true"
       service.alpha.openshift.io/serving-cert-secret-name: sidecar-consumer-secret
     name: consumer-events-subscription-service
     namespace: cloud-events
     labels:
       app: consumer-service
   spec:
     ports:
       - name: sub-port
         port: 9043
     selector:
       app: consumer
     clusterIP: None
     sessionAffinity: None
     type: ClusterIP

検証

1. AMQ Interconnect Operator が利用可能で、必要な Pod が実行していることを確認します。

   $ oc get pods -n amq-interconnect

   出力例

   NAME                                    READY   STATUS    RESTARTS   AGE
   amq-interconnect-645db76c76-k8ghs       1/1     Running   0          23h
   interconnect-operator-5cb5fc7cc-4v7qm   1/1     Running   0          23h

2. 必要な linuxptp-daemon PTP イベントプロデューサー Pod が openshift-ptp namespace で実行していることを確認します。

   $ oc get pods -n openshift-ptp

   出力例

   NAME                     READY   STATUS    RESTARTS       AGE
   linuxptp-daemon-2t78p    3/3     Running   0              12h
   linuxptp-daemon-k8n88    3/3     Running   0              12h

手順

1. linuxptp-daemon が実行されている任意のノードで公開される PTP メトリクスを確認します。たとえば、以下のコマンドを実行します。

   $ curl http://<node_name>:9091/metrics

   出力例

   # HELP openshift_ptp_clock_state 0 = FREERUN, 1 = LOCKED, 2 = HOLDOVER
   # TYPE openshift_ptp_clock_state gauge
   openshift_ptp_clock_state{iface="ens1fx",node="compute-1.example.com",process="ptp4l"} 1
   openshift_ptp_clock_state{iface="ens3fx",node="compute-1.example.com",process="ptp4l"} 1
   openshift_ptp_clock_state{iface="ens5fx",node="compute-1.example.com",process="ptp4l"} 1
   openshift_ptp_clock_state{iface="ens7fx",node="compute-1.example.com",process="ptp4l"} 1
   # HELP openshift_ptp_delay_ns
   # TYPE openshift_ptp_delay_ns gauge
   openshift_ptp_delay_ns{from="master",iface="ens1fx",node="compute-1.example.com",process="ptp4l"} 842
   openshift_ptp_delay_ns{from="master",iface="ens3fx",node="compute-1.example.com",process="ptp4l"} 480
   openshift_ptp_delay_ns{from="master",iface="ens5fx",node="compute-1.example.com",process="ptp4l"} 584
   openshift_ptp_delay_ns{from="master",iface="ens7fx",node="compute-1.example.com",process="ptp4l"} 482
   openshift_ptp_delay_ns{from="phc",iface="CLOCK_REALTIME",node="compute-1.example.com",process="phc2sys"} 547
   # HELP openshift_ptp_offset_ns
   # TYPE openshift_ptp_offset_ns gauge
   openshift_ptp_offset_ns{from="master",iface="ens1fx",node="compute-1.example.com",process="ptp4l"} -2
   openshift_ptp_offset_ns{from="master",iface="ens3fx",node="compute-1.example.com",process="ptp4l"} -44
   openshift_ptp_offset_ns{from="master",iface="ens5fx",node="compute-1.example.com",process="ptp4l"} -8
   openshift_ptp_offset_ns{from="master",iface="ens7fx",node="compute-1.example.com",process="ptp4l"} 3
   openshift_ptp_offset_ns{from="phc",iface="CLOCK_REALTIME",node="compute-1.example.com",process="phc2sys"} 12

2. OpenShift Container Platform Web コンソールで PTP イベントを表示するには、クエリーする PTP メトリクスの名前 (例: openshift_ptp_offset_ns) をコピーします。
3. OpenShift Container Platform Web コンソールで、Observe → Metrics をクリックします。
4. PTP メトリクスを Expression フィールドに貼り付け、Run queries をクリックします。