### Example Calculation Parameters Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=planning-estimating-storage-requirements Input variables used for the storage estimation example. ```text Copies of data = 3 API event data retention = 45 days API summary data retention = 366 days Activity log bytes per call = 1500 bytes Header log bytes per call = 15000 bytes Payload log bytes per call = 30500 bytes % of Activity log = 70% % of Header log = 20% % of Payload log = 10% Calls per day = 100000 ``` -------------------------------- ### Example product version check Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=uac-upgrading-2dcdr-deployment-kubernetes-red-hat-openshift-cloud-pak-integration-10086-later Example output showing the product version for multiple www pods. ```bash root@apicdev2074:~# kubectl get pod rtp-2dcha--e58885f2-site2-www-2 -o yaml | grep -i productversion productVersion: 10.0.8.6-4046 root@apicdev2074:~# kubectl get pod rtp-2dcha--e58885f2-site2-www-1 -o yaml | grep -i productversion productVersion: 10.0.8.4-3237 root@apicdev2074:~# kubectl get pod rtp-2dcha--e58885f2-site2-www-0 -o yaml | grep -i productversion productVersion: 10.0.8.4-3237 ``` -------------------------------- ### Example KUBECONFIG path Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=ccdik-generating-custom-certificates-using-cert-manager-in-two-data-center-deployment Example of a typical path for a KUBECONFIG file. ```text /Users/user/.kube/clusters//kube-config-.yaml ``` -------------------------------- ### Example portal database backup configuration Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=subsystem-configuring-portal-database-backups A comprehensive example of setting various backup parameters for a portal subsystem. ```bash apicup subsys set ptl site-backup-host=mybackuphost.com apicup subsys set ptl site-backup-port=22 apicup subsys set ptl site-backup-auth-user=mybackupauthusername apicup subsys set ptl site-backup-auth-pass=mybackupauthpassword apicup subsys set ptl site-backup-path=/site-backups apicup subsys set ptl site-backup-protocol=sftp apicup subsys set ptl site-backup-certs= apicup subsys set ptl site-backup-s3-uri-style= apicup subsys set ptl site-backup-schedule="0 2 * * *" apicup subsys set ptl site-priority-list=portal.a1.example.com/test-1/spacecatalog,portal.a1.example.com/test-4/cat3,portal.a1.example.com/test-3/cat1 apicup certs set site-backup-auth-ssh-key ``` -------------------------------- ### Restore Status Output Examples Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=portal-restoring-from-database-backup Example output showing the status of 'all' and 'system' type restores. ```text NAME TYPE TASK ID STATUS MESSAGE AGE portal-restore-2xsgl all t3wz85rxz61jam92 Running Sites Restored: 2, Sites Failed: 0, Sites Pending: 1 ``` ```text NAME TYPE TASK ID STATUS MESSAGE CLUSTER AGE portal-restore-xtjjt system yrwtcw5ult08p786 Ready Please describe the CR to see the full message. portal 72s ``` -------------------------------- ### Example pod deletion Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=uac-upgrading-2dcdr-deployment-kubernetes-red-hat-openshift-cloud-pak-integration-10086-later Example output showing the deletion of non-upgraded pods. ```bash root@apicdev2074:~# kubectl delete pod rtp-2dcha--e58885f2-site2-www-1 -n default pod "rtp-2dcha--e58885f2-site2-www-1" deleted from default namespace root@apicdev2074:~# kubectl delete pod rtp-2dcha--e58885f2-site2-www-0 -n default pod "rtp-2dcha--e58885f2-site2-www-0" deleted from default namespace ``` -------------------------------- ### Example backup path Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=subsystem-troubleshooting-management-database-backup-restore A concrete example of a full backup path on an S3-compatible object store. ```text s3bucket1/folder2/mgmt-db-2023-12-25T00:00:00Z/base/20231225T094400 ``` -------------------------------- ### Identity Provider Realm Response Example Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=data-setting-environment-variables-config-sync Example output showing available realms for a deployment. ```yaml apic identity-providers:list --scope provider --server --fields title,realm total_results: 2 results: - title: 'API Manager User Registry' realm: 'provider/default-idp-2' - title: 'Common Services User Registry' realm: 'provider/common-services' ``` -------------------------------- ### Example of Catalogs Extension Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=specification-catalogs A practical example showing how to assign a specific ID value to a property within the Sandbox catalog. ```yaml catalogs: Sandbox: properties: ID: 5678 ``` -------------------------------- ### Example management subsystem restore command Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=burms-restoring-from-management-database-backup A concrete example of the restore command using an S3 object store path. ```bash apicup subsys restore boaz-ova2-management --id 20230725T162548 --host s3.eu-gb.cloud-object-storage.appdomain.cloud/eu-gb --username 'a05e7aace2ab43b5941326429c8c071c' --password '3e510a1d9b06189b57334d064badf6abc39ab5a51d9bdcf7' --path upgrade-test/boaz-ova1-management-22/management-site1-db-2023-11-16T12:30:02Z ``` -------------------------------- ### GraphQL GET Request URL Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=execute-parse Example of a GraphQL query passed through a URL query parameter in a GET request. ```text https://myapi/graphql?query={me{name}} ``` -------------------------------- ### View CLI help for product creation Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=cli-creating-product-definition-file Displays available options and usage details for the create:product command. ```bash apic create:product --help ``` -------------------------------- ### Management Subsystem Error State Example Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=integration-recovering-from-disaster-openshift Example output showing backup and stanza-create job pods in an Error state during management subsystem installation. ```text m1-82b290a2-postgres-stanza-create-4zcgz 0/1 Error 0 35m m1-82b290a2-postgres-full-sch-backup-2g9hm 0/1 Error 0 20m ``` -------------------------------- ### Define Parameter in API Definition Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=assist-data-generation-rules Example of a query parameter definition for a GET request. ```yaml paths: /movies: get: parameters: - name: limit in: query description: Sets an upper bound on the number of movies returned schema: type: integer ``` -------------------------------- ### Create and Publish Initial Product Version Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=tool-managing-api-products Generates an API definition and a Product file, then publishes the Product to the catalog. ```bash apic create:api --title Routes --version 1.0.0 --filename routes100.yaml apic create:product --title "Climb On" --version 1.0.0 --apis routes100.yaml --filename climbon100.yaml apic products:publish climbon100.yaml ``` -------------------------------- ### Execute Token Revocation Request Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=tokens-token-revocation Example of a GET request to the revocation URL with necessary headers. ```HTTP GET HTTP/1.1 access-token: AAETb2F1dGgtcmV2b2tlLWN1c3RvbfZaRlVbnPSc1 client-id: 760d75a2-44b1-4485-8c6f-0d264fcf7398 resource-owner: alice ``` -------------------------------- ### Create the PortalBackup CR Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=portal-running-demand-backup-database Apply the configuration file to initiate the backup process. ```bash kubectl -n create -f portalbackup_cr.yaml ``` -------------------------------- ### Start API Designer in Spanish Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=designer-setting-locale-api Example command to launch the macOS application with the Spanish locale. ```bash open "API Designer.app" --args --lang=es ``` -------------------------------- ### Example upgrade output Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=kubernetes-upgrading-portal-subsystem Sample output showing the portal subsystem status during and after the upgrade process. ```text NAME READY STATUS VERSION RECONCILED VERSION MESSAGE AGE portalcluster.portal.apiconnect.ibm.com/portal 3/3 Running Site Upgrades Executing:(1) Queued(5) Failed(0) Success(0) 22h ``` ```text NAME READY STATUS VERSION RECONCILED VERSION MESSAGE AGE portal 3/3 Running Serving 2 sites 22h ``` -------------------------------- ### GET Request with OAuth Token Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=connect-scope Example of an API request requiring an access token with valid scopes. ```http GET /getaccount HTTP/1.1 Host: server.example.com X-IBM-Client-Id: 8888-8888-8888 Authorization: Bearer AAEkNjVkOWIyYjgtOWY5ZS00YWQwLWIyYzktZ ``` -------------------------------- ### Complete Plans section example Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=file-describing-plans-in-your-product A comprehensive example demonstrating multiple plans, including default settings, burst limits, and nested operation-level rate limits. ```yaml plans: default: title: Default Plan description: Default Plan approval: false rate-limits: default: value: 100/hour hard-limit: false my-plan: title: my_plan rate-limits: Default rate-limit: value: 50/1hour hard-limit: false burst-limits: Default burst-limit: value: 10/1second apis: api21.0.0: operations: - operation: get path: /path2 api31.0.0: operations: - operation: get path: /path3 rate-limits: limit3: value: 10/1second hard-limit: true limit4: value: 100/1hour hard-limit: true api11.0.0: {} ``` -------------------------------- ### API request with Authorization header Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=t-refresh-tokens Example of an HTTP GET request including an Authorization header with a Bearer token. ```http GET /bankingApi/accountSummary?client_id=32427ce5-bb7c-48a7-9de3-4bb629091103 HTTP/1.1 Accept: application/json Host: api.ibm.com Authorization: Bearer AAEFYy1hbGxlhdS5nVX4x6iTL2sb3ymBivQb... ``` -------------------------------- ### Create APIs and reference them in a new Product Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=tool-creating-apis-applications Generate individual API definitions first, then reference them by file path when creating a Product. ```bash apic create:api --title Routes apic create:api --title Ascents apic create:product --title "Climb On" --apis "routes.yaml ascents.yaml" ``` -------------------------------- ### Analytics Cluster Status Output Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=subsystem-installing-analytics Example output showing a successful installation where the READY status is True and all services are online. ```text NAME READY SUMMARY VERSION RECONCILED VERSION AGE analytics True 5/5 7m39s ``` -------------------------------- ### Get Event Endpoint Management instance name Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=connect-removing-api-openshift-cloud-pak-integration Use this command to identify the name of the Event Endpoint Management instance if it is installed. ```bash oc get eem -n ``` -------------------------------- ### Example output of subsystem settings Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=vmware-preparing-analytics-subsystem-deployment Sample output showing the structure of subsystem configuration settings. ```text Appliance settings ================== Name Value Description ---- ----- ------ additional-cloud-init-file (Optional) Path to additional cloud-init yml file ... ``` -------------------------------- ### Gateway Token Verification Requests Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=tokens-token-revocation Examples of GET requests used by the Gateway to verify bearer or refresh tokens via the revocation URL. ```http GET HTTP/1.1 access-token: AAETb2F1dGgtcmV2b2tlLWN1c3RvbfZaRlVbnPSc1 client-id: 760d75a2-44b1-4485-8c6f-0d264fcf7398 resource-owner: alice ``` ```http GET GET HTTP/1.1 refresh-token: AAETb2F1dGgtcmV2b2tlLWN1c3RvbfZaRlVbnPSc1 client-id: 760d75a2-44b1-4485-8c6f-0d264fcf7398 resource-owner: alice ``` -------------------------------- ### Example GET request with introspection headers Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=connect-oauth-introspection-third-party-oauth-providers Shows an incoming request to an API protected by a third-party OAuth provider, including custom x-Introspect headers. ```http GET /petstore/pet/123 HTTP/1.1 Host: apiconnect.com x-Introspect-type: dog x-Introspect-name: simon x-custom-apic: petstore123 Authorization: Bearer tGzv3JOkF0XG5Qx2TlKWIA x-IBM-Client-Id: xxx-xxx ``` -------------------------------- ### Complete APIs section example Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=file-referencing-apis-your-product A sample configuration showing multiple APIs defined within the APIs section of a Product. ```yaml apis: api11.0.0: name: 'api1:1.0.0' api21.0.0: name: 'api2:1.0.0' api31.0.0: name: 'api3:1.0.0' ``` -------------------------------- ### APIConnectCluster Custom Resource Configuration Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=vms-installing-target-system-kubernetes-openshift-cloud-pak-integration Example of the top-level APIConnectCluster CR required for target system installation, populated with configuration properties from the source system. ```yaml apiVersion: apiconnect.ibm.com/v1beta1 kind: APIConnectCluster metadata: labels: app.kubernetes.io/instance: apiconnect app.kubernetes.io/managed-by: ibm-apiconnect app.kubernetes.io/name: apiconnect-minimum name: c1 namespace: test1 spec: analytics: storage: enabled: true type: unique license: accept: true license: SOME_KEY use: nonproduction management: customApplicationCredentials: - name: atm-cred secretName: management-atm-cred - name: ccli-cred secretName: management-ccli-cred - name: cui-cred secretName: management-cui-cred - name: dsgr-cred secretName: management-dsgr-cred - name: juhu-cred secretName: management-juhu-cred - name: cli-cred secretName: management-cli-cred - name: ui-cred secretName: management-ui-cred databaseBackup: credentials: ftp-mgmt-backup-secret host: SFTP_SERVER_HOST path: /root/backup/v10_management port: 22 protocol: sftp restartDB: accept: false encryptionSecret: secretName: management-enc-key name: management originalUID: d435b534-ce93-463a-9005-692c2af94df7 siteName: be023200 portal: encryptionSecret: secretName: portal1-enc-key originalUID: 1adc672a-0e77-4890-b476-c41fcedb0b64 portalBackup: credentials: ftp-mgmt-backup-secret host: 1.2.3.4 path: /root/backup/portal1 port: 22 protocol: sftp siteName: cb06099f profile: n1xc7.m48 storageClassName: rook-ceph-block version: 10.0.8.0 ``` -------------------------------- ### GET /users Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=reference-api-product-definition-template-examples Get a list of users. ```APIDOC ## GET /users ### Description Get a list of users. ### Method GET ### Endpoint /users ### Response #### Success Response (200) - **UserList** (object) - Success ``` -------------------------------- ### Monitor Promotion Readiness Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=deployment-failing-over-warm-standby Example output showing the status when ready for promotion. ```text Status: Blocked - HA Mode: ReadyForPromotion - Ha Status: ReadyForPromotion ``` -------------------------------- ### Example registration output Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=eictsc-exporting-importing-custom-themes-site-configuration-by-using-portal-admin-api Sample output showing a successful application registration. ```text app1 [state: enabled] https://api.stagingexample.com/api/cloud/registrations/d2b7572f-3406-42a7-bdcc-85f177860df7 ``` -------------------------------- ### Example portalUIEndpoint output Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=pdrcpi-preparing-portal-subsystem-disaster-recovery-cloud-pak-integration Example output for the portalUIEndpoint route. ```text dr-ptl-portal-web-apic.apps.vlxocp-1556.cp.fyre.ibm.com ``` -------------------------------- ### Example portalAdminEndpoint output Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=pdrcpi-preparing-portal-subsystem-disaster-recovery-cloud-pak-integration Example output for the portalAdminEndpoint route. ```text dr-ptl-portal-director-apic.apps.vlxocp-1556.cp.fyre.ibm.com ``` -------------------------------- ### Example user registry settings output Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=manager-using-cli-configure-shared-ldap-user-registry Sample output showing the structure of current user registry settings. ```yaml type: user_registry_setting api_version: 2.0.0 name: user-registry-setting admin_user_registry_default_url: >- https://server.com/api/user-registries/xxxxx/xxxxx-1234 admin_user_registry_urls: - >- https://server.com/api/user-registries/xxxxx/xxxxx-1234 provider_user_registry_default_url: >- https://https://server.com/api/user-registries/xxxxx/xxxxx-5678 provider_user_registry_urls: - >- https://https://server.com/api/user-registries/xxxxx/xxxxx-5678 created_at: '2019-09-30T12:22:19.467Z' updated_at: '2019-10-17T10:05:37.867Z' url: 'https://server.com/api/cloud/settings/user-registries' ``` -------------------------------- ### View script parameters Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=steps-preparing-source-system Displays the help menu for the configuration script. ```bash python3 save_v10_source_configuration.py --help ``` -------------------------------- ### List installed themes Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=portal-method-2-developer-toolkit-cli List all installed themes to check their status. ```bash apic themes:list --mode portaladmin [flags] ``` -------------------------------- ### Create the portal subsystem Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=steps-installing-target-system-vmware Initializes the portal subsystem with the specified name. ```bash apicup subsys create portal ``` -------------------------------- ### List installed modules Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=portal-method-2-developer-toolkit-cli List all installed modules to check their status. ```bash apic modules:list --mode portaladmin [flags] ``` ```bash ❯ SERVER=myserver.ibm.com ❯ apic -s $SERVER -m portaladmin modules:list -o ibm -c api-connect-catalog-1 --no-core . . . chosen: package: 'User interface' display_name: 'Chosen (chosen)' status: Disabled version: 3.0.5 google_tag: package: Statistics display_name: 'Google Tag Manager (google_tag)' status: Enabled version: 8.x-1.6 snowflakes: package: 'User interface' display_name: 'Snowflakes (snowflakes)' status: Enabled version: 2.0.1 . . . ``` -------------------------------- ### Configure site-backup-host for object storage and SFTP Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=subsystem-configuring-portal-database-backups Examples of setting the backup host for different storage types. ```bash apicup subsys set ptl site-backup-host=s3.eu-gb.cloud-object-storage.appdomain.cloud ``` ```bash apicup subsys set ptl site-backup-host=s3.cloud-object-storage.appdomain.cloud/eu-gb ``` ```bash apicup subsys set ptl site-backup-host=my.sftp.backup.domain.example.com ``` -------------------------------- ### Create API and Product definitions simultaneously Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=tool-creating-apis-applications Combine API and Product creation in a single command execution. ```bash apic create:api --title Routes --product "Climb On" apic create:api --wsdl globalweather.wsdl --product "Weather Forecasting" ``` -------------------------------- ### Initialize API Connect project directory Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=connect-preparing-install-api-in-vmware Creates a new project directory and an empty apiconnect-up-v10.yml configuration file. ```bash apicup init ``` -------------------------------- ### CORS Response Example Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=api-calling-by-using-cors An example of the response returned by the gateway to a CORS request. ```http HTTP/1.1 200 OK X-Backside-Transport: FAIL FAIL Connection: Keep-Alive Transfer-Encoding: chunked Access-Control-Allow-Origin: https://example.com Access-Control-Allow-Credentials: true Access-Control-Allow-Headers:accept, accept-language, content-type, x-ibm-client-id Access-Control-Allow-Methods: methods allowed on the resource Vary: Origin ``` -------------------------------- ### Example Query Parameter URL Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=components-creating-parameter An example of how a query parameter is appended to a URL path. ```text url_path?myparam=myvalue ``` -------------------------------- ### Example output of list-backups Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=burms-restoring-from-management-database-backup Sample output showing the details of available management database backups. ```text NAME AGE CLUSTER METHOD PHASE ERROR mgmt-backup-rnvx8 15m stv3-management-site1-db ObjectStore completed stv3-management-20240617010000 7h46m stv3-management-site1-db ObjectStore completed ``` -------------------------------- ### Example ManagementRestore configuration Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=backup-restoring-management-database-id A concrete example of a ManagementRestore CR configured for an object-store backup. ```yaml apiVersion: management.apiconnect.ibm.com/v1beta1 kind: ManagementRestore metadata: generateName: management- spec: subsystemName: management backup: protocol: objstore host: s3.ibm.com/us-west path: pic-mgmt-backups/impr-restore/m1-65288d1d-db-2023-09-14T01:30:40Z credentials: mgmt-backup-secret backupId: 20230914T013040 ``` -------------------------------- ### Publish an API Product to a Catalog Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=tool-publishing-apis-applications Create APIs, bundle them into a product, authenticate with the management server, and publish the product to a specified catalog. ```bash apic create:api --title Routes apic create:api --title Ascents apic create:product --title "Climb On" --apis "routes.yaml ascents.yaml" apic config:set catalog=https://platform-api.myserver.com/api/catalogs/climbon/sandbox apic login --username some-user --password some-password --server platform-api.myserver.com --realm provider/default-idp-2 apic products publish climb-on.yaml ``` -------------------------------- ### Prepare for Ubuntu upgrade Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=connect-planning-your-api-upgrade-vmware Execute the command to prepare the subsystem for an Ubuntu upgrade. ```bash apicup subsys prepare-ubuntu-upgrade ``` -------------------------------- ### Install mkpasswd on macOS Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=vmware-preparing-management-subsystem-deployment Use RubyGems to install the mkpasswd utility on macOS systems. ```bash gem install mkpasswd ``` -------------------------------- ### Verify Portal Installation Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=subsystems-installing-developer-portal-subsystem Commands to check the status of the PortalCluster and verify the installation output. ```bash kubectl get PortalCluster -n ``` ```bash NAME READY STATUS VERSION RECONCILED VERSION MESSAGE AGE portal 3/3 Running Ready for API Cloud Manager service registration 2h ``` -------------------------------- ### Example status output Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=integration-upgrading-api-connect-openshift Reference output for verifying cluster readiness. ```text message: management CR is not tracking status, please change CR spec.version as soon as possible. Refer https://shortlink.url for details reason: DatabaseSwitchMode ``` ```text NAME READY STATUS VERSION RECONCILED VERSION MESSAGE AGE apic-ocp n/n Ready 10.0.8.x 10.0.8.x-258 API Connect cluster is ready 56d ``` ```text oc get PortalCluster NAME READY STATUS VERSION RECONCILED VERSION AGE portal n/n Running 10.0.8.10 10.0.8.10-95 57m ``` -------------------------------- ### Install Analytics Subsystem Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=subsystem-api-connect-vmware Execute the installation command for the analytics subsystem after configuring the certificates. ```bash apicup subsys install ``` -------------------------------- ### Create Backup CR Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=subsystem-running-demand-backup-management-database Apply the Backup configuration file to start the backup process. ```bash kubectl -n create -f mgmtbackup_cr.yaml ``` -------------------------------- ### Install PyYAML module Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=factor-v10-migration-requirements Install the required PyYAML module for running migration scripts. ```bash pip3 install pyyaml ``` -------------------------------- ### Start management database backup Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=burms-running-demand-backup-management-database Initiate the backup process for the specified management subsystem. ```bash apicup subsys backup ``` -------------------------------- ### Create the custom integration Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=overview-configuring-shared-custom-user-registry Use the CLI to register the custom integration document. ```bash apic integrations:create --server mgmt_endpoint_url --subcollection user-registry integration_file.yaml ``` -------------------------------- ### List installed CRs Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=environment-custom-resources-custom-resource-definitions Command to list all installed Custom Resources for a specific CRD. ```bash kubectl get ``` -------------------------------- ### Failover interaction example Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=topics-management-subsystem-postgres-failover-steps-v10060 Example of the interactive prompt and resulting topology change during a failover operation. ```text Candidate ['m1-33253de3-postgres-dbd7966db-ltfhq', 'm1-33253de3-postgres-dxxx-c54776d87-wldgb'] []: m1-33253de3-postgres-dbd7966db-ltfhq Current cluster topology +--------------------------------------------+-----------------+---------+---------+----+-----------+ | Member | Host | Role | State | TL | Lag in MB | + Cluster: m1-33253de3-postgres (7039951359768572098) ---------+---------+---------+----+-----------+ | m1-33253de3-postgres-dbd7966db-ltfhq | 192.168.51.112 | Replica | running | 8 | 0 | | m1-33253de3-postgres-dxxx-c54776d87-wldgb | 192.168.112.17 | Replica | running | 8 | 0 | | m1-33253de3-postgres-xwjf-8577b6c669-9chcp | 192.168.117.219 | Leader | running | 8 | | +--------------------------------------------+-----------------+---------+---------+----+-----------+ Are you sure you want to failover cluster m1-33253de3-postgres, demoting current master m1-33253de3-postgres-xwjf-8577b6c669-9chcp? [y/N]: y 2021-12-10 22:07:02.15154 Successfully failed over to "m1-33253de3-postgres-dbd7966db-ltfhq" +--------------------------------------------+-----------------+---------+---------+----+-----------+ | Member | Host | Role | State | TL | Lag in MB | + Cluster: m1-33253de3-postgres (7039951359768572098) ---------+---------+---------+----+-----------+ | m1-33253de3-postgres-dbd7966db-ltfhq | 192.168.51.112 | Leader | running | 8 | | | m1-33253de3-postgres-dxxx-c54776d87-wldgb | 192.168.112.17 | Replica | running | 8 | 0 | | m1-33253de3-postgres-xwjf-8577b6c669-9chcp | 192.168.117.219 | Replica | stopped | | unknown | +--------------------------------------------+-----------------+---------+---------+----+-----------+ ``` -------------------------------- ### Apply portal subsystem overrides Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=vmware-enabling-developer-portal-feature-flags Install the configuration changes to the portal subsystem. ```bash apicup subsys install ``` -------------------------------- ### Create application registration Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=eictsc-exporting-importing-custom-themes-site-configuration-by-using-portal-admin-api Register an application using the configuration file. ```bash apic registrations:create --server management_server app1.json ``` ```bash apic registrations:create --server api.stagingexample.com app1.json ``` -------------------------------- ### Initialize Analytics Subsystem Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=vmware-configuring-api-connect-subsystems-in-cluster Create the analytics subsystem and set the deployment profile. ```bash apicup subsys create analyt analytics ``` ```bash apicup subsys set analyt deployment-profile=n3xc4.m16 ``` -------------------------------- ### JSON structure conversion example Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=policies-json-xml Example of a non-BadgerFish JSON structure that the policy converts into XML. ```json { "a" : "hello" } ``` ```xml hello ```