Ingress mTLS CA 証明書の有効期限切れ

ここに表示されているのは、ApigeeApigee ハイブリッドのドキュメントです。
このトピックに対応する Apigee Edge のドキュメントはありません。

症状

apigee Namespace のリソースを表示したときに、ApigeeIssueReason = AIS_INGRESS_MTLS_CA_CERT_EXPIREY)が表示されます。

エラー メッセージ

kubectl -n apigee get apigeeissues を実行すると、次のようなエラーが表示されます。

NAME                                    SEVERITY   REASON                             DOCUMENTATION                                                                                  AGE
ca-cert-expired-my-org-my-virtualhost   ERROR      AIS_INGRESS_MTLS_CA_CERT_EXPIREY   https://cloud.google.com/apigee/docs/hybrid/troubleshooting/AIS_INGRESS_MTLS_CA_CERT_EXPIREY   5h18m

考えられる原因

原因 説明
Ingress mTLS CA 証明書がまもなく有効期限切れになる 構成された Ingress mTLS CA 証明書の有効期限が 14 日以内に切れます。
Ingress mTLS CA 証明書の有効期限が切れている 構成された Ingress mTLS CA 証明書の有効期限が切れています。

原因: Ingress mTLS CA 証明書がまもなく有効期限切れになる

ApigeeRouteConfig によって参照される Kubernetes Secret に格納されている Ingress mTLS CA 証明書の有効期限が 14 日以内に切れます。

診断

次のコマンドを実行します。

kubectl -n apigee describe apigeeissue ISSUE_NAME

ここで ISSUE_NAME は問題の名前です。例: ca-cert-expiring-soon-my-org-my-virtualhost

出力は次のようになります。

Name:         ca-cert-expiring-soon-my-org-my-virtualhost
Namespace:    apigee
Labels:       ais-reason=AIS_INGRESS_MTLS_CA_CERT_EXPIREY
Annotations:  <none>
API Version:  apigee.cloud.google.com/v1alpha1
Kind:         ApigeeIssue
Metadata:
  Creation Timestamp:  2023-06-12T17:03:43Z
  Generation:          1
  Owner References:
    API Version:     apigee.cloud.google.com/v1alpha2
    Kind:            ApigeeOrganization
    Name:            my-org
    UID:             7e83a52c-ce00-4bed-98be-55835ada1817
  Resource Version:  3281563
  UID:               adc775c2-376d-4bf9-9860-500b2b2b8273
Spec:
  Details:        CA certificate in secret "my-org-my-virtualhost" for ApigeeRouteConfig "my-org-my-virtualhost" is expiring in 5.409373245s at 2024-03-11 19:04:12 +0000 UTC
  Documentation:  https://cloud.google.com/apigee/docs/hybrid/troubleshooting/AIS_INGRESS_MTLS_CA_CERT_EXPIREY
  Reason:         AIS_INGRESS_MTLS_CA_CERT_EXPIREY
  Severity:       WARNING
Events:           <none>
Spec:
  Details:        CA certificate in secret "my-org-my-virtualhost" for ApigeeRouteConfig "my-org-my-virtualhost" is expiring in 5.409373245s at 2024-03-11 19:04:12 +0000 UTC

Spec.Details の内容は、まもなく有効期限が切れる Ingress mTLS CA 証明書を含む Kubernetes Secret を参照する ApigeeRouteConfig の名前について説明しています。

解決策

  1. kubectl describe を使用して、まもなく有効期限が切れる Ingress mTLS CA 証明書を含む ApigeeRouteConfig の名前を表示します。

    kubectl -n apigee describe apigeeissue ISSUE_NAME

    ここで ISSUE_NAME は問題の名前です。例: ca-cert-expiring-soon-my-org-my-virtualhost

    この例では、ApigeeRouteConfig my-org-my-virtualhost が Secret my-org-my-virtualhost を参照しています。

  2. ApigeeRouteConfig から virtualhost の名前を特定します。

    ApigeeRouteConfig の名前は <Apigee organization>-<virtualhost name> の形式になっています。

    この例では、Apigee 組織は my-org で、仮想ホスト名は my-virtualhost です。

  3. overrides.yaml で、対応する仮想ホストを探します。

    virtualhosts:
    ...
    - name: my-virtualhost
      selector:
        app: apigee-ingressgateway
      caCertPath: ./certs/ca.pem
      sslCertPath: ./certs/vhost.pem
      sslKeyPath: ./certs/vhost.key
    ...
  4. caCertPath ファイルに記載されている CA 証明書を更新します。

  5. 変更を仮想ホストに適用します。

    helm upgrade ENV_GROUP_NAME apigee-virtualhost/ \
      --namespace apigee \
      --set envgroup=ENV_GROUP_NAME \
      -f overrides.yaml

原因: Ingress mTLS CA 証明書の有効期限が切れている

ApigeeRouteConfig によって参照される Kubernetes Secret に格納されている Ingress mTLS CA 証明書の有効期限が切れています。

診断

次のコマンドを実行します。

kubectl -n apigee describe apigeeissue ISSUE_NAME

ここで ISSUE_NAME は問題の名前です。例: ca-cert-expired-my-org-my-virtualhost

出力は次のようになります。

Name:         ca-cert-expired-my-org-my-virtualhost
Namespace:    apigee
Labels:       ais-reason=AIS_INGRESS_MTLS_CA_CERT_EXPIREY
Annotations:  <none>
API Version:  apigee.cloud.google.com/v1alpha1
Kind:         ApigeeIssue
Metadata:
  Creation Timestamp:  2023-06-12T17:03:43Z
  Generation:          1
  Owner References:
    API Version:     apigee.cloud.google.com/v1alpha2
    Kind:            ApigeeOrganization
    Name:            my-org
    UID:             7e83a52c-ce00-4bed-98be-55835ada1817
  Resource Version:  3281563
  UID:               adc775c2-376d-4bf9-9860-500b2b2b8273
Spec:
  Details:        CA certificate in secret "my-org-my-virtualhost" for ApigeeRouteConfig "my-org-my-virtualhost" expired at: 2024-03-11 19:12:10 +0000 UTC
  Documentation:  https://cloud.google.com/apigee/docs/hybrid/troubleshooting/AIS_INGRESS_MTLS_CA_CERT_EXPIREY
  Reason:         AIS_INGRESS_MTLS_CA_CERT_EXPIREY
  Severity:       ERROR
Events:           <none>
Spec:
  Details:        CA certificate in secret "my-org-my-virtualhost" for ApigeeRouteConfig "my-org-my-virtualhost" expired at: 2024-03-11 19:12:10 +0000 UTC

Spec.Details の内容は、有効期限が切れた Ingress mTLS CA 証明書を含む Kubernetes Secret を参照する ApigeeRouteConfig の名前について説明しています。

解決策

  1. kubectl describe を使用して、有効期限が切れた Ingress mTLS CA 証明書を含む ApigeeRouteConfig の名前を表示します。

    kubectl -n apigee describe apigeeissue ISSUE_NAME

    ここで ISSUE_NAME は問題の名前です。例: ca-cert-expired-my-org-my-virtualhost

    この例では、ApigeeRouteConfig my-org-my-virtualhost が Secret my-org-my-virtualhost を参照しています。

  2. ApigeeRouteConfig から virtualhost の名前を特定します。

    ApigeeRouteConfig の名前は <Apigee organization>-<virtualhost name> の形式になっています。

    この例では、Apigee 組織は my-org で、仮想ホスト名は my-virtualhost です。

  3. overrides.yaml で、対応する仮想ホストを探します。

    virtualhosts:
    ...
    - name: my-virtualhost
      selector:
        app: apigee-ingressgateway
      caCertPath: ./certs/ca.pem
      sslCertPath: ./certs/vhost.pem
      sslKeyPath: ./certs/vhost.key
    ...
  4. caCertPath ファイルに記載されている CA 証明書を更新します。

  5. 変更を仮想ホストに適用します。

    helm upgrade ENV_GROUP_NAME apigee-virtualhost/ \
      --namespace apigee \
      --set envgroup=ENV_GROUP_NAME \
      -f overrides.yaml

診断情報の収集が必要な場合

前述の手順を踏んでも問題が解決しない場合は、次の診断情報を収集して Google Cloud カスタマーケアにご連絡ください。

  1. Google Cloud プロジェクト ID。
  2. Apigee ハイブリッド組織の名前。
  3. ApigeeIssueSpec.Details フィールド。
  4. (省略可)影響を受ける仮想ホストの caCertPath によって参照されているファイル。