Federated API Management subsystem setting

Specify advanced configuration settings for the Federated API Management subsystem .

Table 1. Federated API Management cluster core settings
Field Type Required Description
Version String Yes Specifies the Federated API Management version to deploy. Example: 12.1.0.0.
Profile String Yes Sizing profile for resource allocation. Example: n1xc3.m4.For more information, see Federated API Management component deployment profile limits
Image Registry String No Overrides the default image registry. For example: docker-na.artifactory.swg-devops.com/apic-dev-docker-local.
Image pull secrets String No Name of Kubernetes secret for pulling images from a private registry.
License accept Boolean: true or false Yes Must be set to true to accept the license terms.
License use String Yes Specifies the license type: production or nonproduction.
License key String Yes IBM license entitlement key. Example: L-PDZK-TWDH97.
Analytics reference String Yes Name of the AnalyticsCluster CR that the Federated API Management uses.
Admin endpoint host String No The fully qualified domain name for the admin endpoint. This is options if using in-cluster registration.
UI endpoint host     The fully qualified domain name for the public Federated API Management UI.
Table 2. Storage type, class, and size settings. The following settings are defined in the Analytics CR, and they apply to the storage that is shared across Analytics, DevPortal, Federated API Management, and API Agent, depending on the modes configured in the Analytics CR.
Field Type Required Description
Shared storage class String Yes The storage class used by your Federated API Management storage pods. Local-volume storage is recommended for best performance. If none selected, the default storage class of your cluster is used.
Shared volume size Integer > 0 Yes Size of the persistent volume for Federated API Management data (in Gi). If you do not have the information to estimate your usage, set this to 500Gi. For an installation where you expect to store little or no Federated API Management data, you can set the storage to 50Gi.
Type Boolean: dedicated or shared Yes

Specifies storage type for persistent data. The default storage type is shared.
Table 3. In-cluster registration settings
Field Type Required Description
Admin service endpoint String No Internal service URL for registration: For example, https://<FAM-cr-name>.<namespace>.svc.
Admin client certificate String Yes (if using in-cluster registration) Must be derived from FAM-ca. Used for mTLS authentication.
adminClientSubjectDN String Yes The distinguished name of the admin client certificate. For example, CN=FAM-admin-incluster-client,O=cert-manager.
adminEndpoint Object No If omitted, no ingress/route is created for the admin endpoint; internal service must be used instead.
Note: For mTLS, ensure that the client certificate subject DN adminClientSubjectDN matches the certificate used by the admin client and that the CA is trusted by the admin endpoint.