LATEST VERSION: 1.8 - CHANGELOG
IPsec Add-On for PCF v1.8

Renewing Expired IPsec Certificates

Page last updated:

This topic describes the basic process that deployers may use to renew any soon-to-be-expiring certificates contained in the IPsec manifest.

About Certificate Expiration

The IPsec Add-on relies upon X.509 certificates to secure the communications between communicating peers.

Like all certificates, the IPsec certificates have a finite lifetime and eventually expire. The certificates generated by the procedure provided in the installation instructions, Generate a Self-Signed Certificate have a default lifetime of one year. Regardless of their specific lifetime, all certificates must eventually be rotated, and so it is important for the operations team to plan accordingly and remember to rotate the IPsec certificates before they actually expire.

IMPORTANT: Rotating the certificates while they are still valid ensures the maximum availability of the Cloud Foundry platform and avoids any unscheduled interruption in service.

Renew Expired IPsec Certificates

To renew expiring IPsec certificates, do the following:

  1. Retrieve the latest runtime config by running one of the following commands:

    • For Ops Manager v1.10 or earlier: bosh runtime-config > PATH-TO-SAVE-THE-RUNTIME-CONFIG
    • For Ops Manager v1.11 or later: bosh2 -e BOSH-ENVIRONMENT runtime-config > PATH-TO-SAVE-THE-RUNTIME-CONFIG
  2. Generate a new set of certificates. For development or test environments, you can use self-signed certificates. For information about self-signed certificates, see Generate a Self-Signed Certificate.

  3. In the runtime config.yml file saved from step 1, update the optional field to true and update the certificate fields with new certificates. For more information about these fields, see the field descriptions under Create the IPsec Manifest.

    properties:
        ipsec:
          optional: true
          instance_certificate: |
            -----BEGIN CERTIFICATE-----
            EXAMPLEAhigAwIBAgIRAIvrBY2TttU/LeRhO+V1t0YwDQYJKoZIhvcNAQELBQAw
            ...
            -----END CERTIFICATE-----
          instance_private_key: |
            -----BEGIN EXAMPLE RSA PRIVATE KEY-----
            EXAMPLExRSAxPRIVATExKEYxDATAxEXAMPLExRSAxPRIVATExKEYxDATA
            ...
            -----END EXAMPLE RSA PRIVATE KEY-----
          ca_certificates:
            - |
              -----BEGIN CERTIFICATE-----
              ExampleAvGgAwIBAgIBATANBgkqhkiG9w0BAQsFADAUMRIwEAYDVQQDEwl0ZXN0
              ...
              -----END CERTIFICATE-----
    

  4. Update the runtime config by running one of the following commands:

    • For Ops Manager v1.10 or earlier: bosh update runtime-config PATH-TO-SAVE-THE-RUNTIME-CONFIG
    • For Ops Manager v1.11 or later: bosh2 -e BOSH-ENVIRONMENT update-runtime-config --name=ipsec PATH-TO-SAVE-THE-RUNTIME-CONFIG
  5. Navigate to your Installation Dashboard in Ops Manager.

  6. Click Apply Changes.

  7. Remove the optional: true set in step 3.

  8. Repeat steps 4 to 6.

Create a pull request or raise an issue on the source for this page in GitHub