You're viewing Apigee and Apigee hybrid documentation.
There is no equivalent
Apigee Edge documentation for this topic.
Symptom
An ApigeeIssue
with Reason
AIS_INGRESS_MTLS_CA_CERT_EXPIREY
is shown when viewing resources in the apigee
namespace.
Error messages
After running kubectl -n apigee get apigeeissues
, an error like the following is
displayed:
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
Possible causes
Cause | Description |
---|---|
Ingress mTLS CA certificate is expiring soon | The configured ingress mTLS CA certificate is expiring within 14 days. |
Ingress mTLS CA certificate is expired | The configured ingress mTLS CA certificate is expired. |
Cause: Ingress mTLS CA certificate is expiring soon
The ingress mTLS CA certificate stored in the Kubernetes secret referenced by an
ApigeeRouteConfig
is expiring within the next 14 days.
Diagnosis
Run the following command:
kubectl -n apigee describe apigeeissue ISSUE_NAME
Where ISSUE_NAME is the name of the issue. For example,
ca-cert-expiring-soon-my-org-my-virtualhost
.
The output should look similar to the following:
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
The contents of Spec.Details
explains the name of the
ApigeeRouteConfig
that refers to the Kubernetes secret containing the ingress mTLS
CA certificate which is expiring soon.
Resolution
-
Use
kubectl describe
to display the name of theApigeeRouteConfig
which has the ingress mTLS CA cert which is expiring soon:kubectl -n apigee describe apigeeissue ISSUE_NAME
Where ISSUE_NAME is the name of the issue. For example,
ca-cert-expiring-soon-my-org-my-virtualhost
.In this example, the
ApigeeRouteConfig
my-org-my-virtualhost
is referencing the secretmy-org-my-virtualhost
. -
Determine the
virtualhost
name from theApigeeRouteConfig
.The
ApigeeRouteConfig
's name is in the format:<Apigee organization>-<virtualhost name>
.In this example,
my-org
is the Apigee organization and the virtualhost name ismy-virtualhost
. -
Find the corresponding virtualhost in your
overrides.yaml
.virtualhosts: ... - name: my-virtualhost selector: app: apigee-ingressgateway caCertPath: ./certs/ca.pem sslCertPath: ./certs/vhost.pem sslKeyPath: ./certs/vhost.key ...
-
Update the CA certificate listed in the
caCertPath
file. -
Apply the change to the virtualhost:
helm upgrade ENV_GROUP_NAME apigee-virtualhost/ \ --namespace apigee \ --set envgroup=ENV_GROUP_NAME \ -f overrides.yaml
Cause: Ingress mTLS CA certificate is expired
The ingress mTLS CA certificate stored in the Kubernetes secret referenced by an
ApigeeRouteConfig
has expired.
Diagnosis
Run the following command:
kubectl -n apigee describe apigeeissue ISSUE_NAME
Where ISSUE_NAME is the name of the issue. For example,
ca-cert-expired-my-org-my-virtualhost
.
The output should look similar to the following:
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
The contents of Spec.Details
explains the name of the
ApigeeRouteConfig
that refers to the Kubernetes secret containing the ingress mTLS
CA certificate which has expired.
Resolution
-
Use
kubectl describe
to display the name of theApigeeRouteConfig
which has the expired ingress mTLS CA cert:kubectl -n apigee describe apigeeissue ISSUE_NAME
Where ISSUE_NAME is the name of the issue. For example,
ca-cert-expired-my-org-my-virtualhost
.In this example, the
ApigeeRouteConfig
my-org-my-virtualhost
is referencing the secretmy-org-my-virtualhost
. -
Determine the
virtualhost
name from theApigeeRouteConfig
.The
ApigeeRouteConfig
's name is in the format:<Apigee organization>-<virtualhost name>
.In this example,
my-org
is the Apigee organization and the virtualhost name ismy-virtualhost
. -
Find the corresponding virtualhost in your
overrides.yaml
.virtualhosts: ... - name: my-virtualhost selector: app: apigee-ingressgateway caCertPath: ./certs/ca.pem sslCertPath: ./certs/vhost.pem sslKeyPath: ./certs/vhost.key ...
-
Update the CA certificate listed in the
caCertPath
file. -
Apply the change to the virtualhost:
helm upgrade ENV_GROUP_NAME apigee-virtualhost/ \ --namespace apigee \ --set envgroup=ENV_GROUP_NAME \ -f overrides.yaml
Must gather diagnostic information
If the problem persists even after following the above instructions, gather the following diagnostic information and then contact Google Cloud Customer Care:
- The Google Cloud Project ID.
- The name of the Apigee hybrid organization.
- The
Spec.Details
field of theApigeeIssue
. -
(optional) File referenced by
caCertPath
for the affected virtualhost.