### Successful Gateway Installation Status Example Source: https://www.ibm.com/docs/en/api-connect/10.0.8_lts?topic=subsystems-installing-gateway-subsystem Example output showing a successful installation of gateway subsystems with READY status True and all services online. ```text NAME READY SUMMARY VERSION RECONCILED VERSION AGE gwv5 True 2/2 7m31s gwv6 True 2/2 7m32s ``` -------------------------------- ### GatewayCluster status example Source: https://www.ibm.com/docs/en/api-connect/10.0.x_cd?topic=openshift-installing-gateway-subsystem-in-shared-namespace Example output of `oc get GatewayCluster` showing a successful installation. ```text NAME READY SUMMARY VERSION RECONCILED VERSION AGE gwv6 True 2/2 7m32s ``` -------------------------------- ### License configuration example Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=subsystems-installing-developer-portal-subsystem Example entry to accept the license for a production system. ```yaml license: accept: true metric: PROCESSOR_VALUE_UNIT use: production license: L-RJON-BZ5LSE ``` -------------------------------- ### Example of listing installed modules Source: https://www.ibm.com/docs/en/api-connect/cloud/reserved_instance?topic=uydpfd9d1-how-find-your-custom-modules-themes-your-developer-portal Example demonstrating the execution of the modules:list command to display details of installed modules. ```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 . . . ``` -------------------------------- ### Example of listing installed themes Source: https://www.ibm.com/docs/en/api-connect/cloud/reserved_instance?topic=uydpfd9d1-how-find-your-custom-modules-themes-your-developer-portal Example demonstrating the execution of the themes:list command to display details of installed themes. ```bash ❯ SERVER=myserver.ibm.com ❯ apic -s $SERVER -m portaladmin themes:list -o ibm -c api-connect-catalog-1 --no-core bootstrap: package: Bootstrap display_name: 'Bootstrap (bootstrap)' status: Enabled version: 8.x-3.27 . . . emerald_theme_css: package: Bootstrap display_name: 'emerald_theme_css (emerald_theme_css)' status: Disabled version: null ruby_theme_scss: package: Bootstrap display_name: 'ruby_theme_scss (ruby_theme_scss)' status: Disabled version: null sapphire_theme_css: package: Bootstrap ``` -------------------------------- ### Example Management Server Hostname Source: https://www.ibm.com/docs/en/api-connect/cloud/10.0.x_saas?topic=cli-getting-started-portal-commands Example of a management server URL from which to extract the hostname. ```text https://platform-api.us-east-1.d-r01.apic.cloud.ibm.com/manager ``` -------------------------------- ### Docker registry example Source: https://www.ibm.com/docs/en/api-connect/10.0.8_lts?topic=subsystems-installing-gateway-subsystem Example of the host name for the Docker Registry where installation images are uploaded. ```yaml my.docker.registry.domain.example.com. ``` -------------------------------- ### Example analytics subsystem status Source: https://www.ibm.com/docs/en/api-connect/software/10.0.x_cd?topic=subsystem-installing-analytics Example output showing a successfully installed analytics subsystem with all services online. ```text NAME READY SUMMARY VERSION RECONCILED VERSION AGE analytics True 5/5 7m39s ``` -------------------------------- ### cert-manager pods status example Source: https://www.ibm.com/docs/en/api-connect/software/10.0.x_cd?topic=iacsidneo-installing-operators Example output showing cert-manager pods are running. ```text NAME READY STATUS RESTARTS AGE cert-manager-bd7fbb9fc-wvbbt 1/1 Running 0 3m39s cert-manager-cainjector-56cc5f9868-7g9z7 1/1 Running 0 4m5s cert-manager-webhook-d4f79d7f7-9dg9w 1/1 Running 0 4m9s ``` -------------------------------- ### Storage volume size example Source: https://www.ibm.com/docs/en/api-connect/software/10.0.x_cd?topic=openshift-installing-analytics-subsystem-in-shared-namespace Example configuration for storage volume size. ```yaml storage: type: shared shared: volumeClaimTemplate: storageClassName: ceph-block volumeSize: 500Gi ``` -------------------------------- ### Complete hostname customization example Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=subsystems-installing-management-subsystem Example of complete hostname customization for cloudManagerEndpoint. ```yaml cloudManagerEndpoint: < ... > hosts: - name: my.cloudmgr.myhost.subnet.example.com secret: cm-endpoint ``` -------------------------------- ### Subdomain customization example Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=subsystems-installing-management-subsystem Example of subdomain customization for API Connect endpoints. ```yaml cloudManagerEndpoint: < ... > hosts: - name: admin.myhost.subnet.example.com secret: cm-endpoint apiManagerEndpoint: < ... > hosts: - name: manager.myhost.subnet.example.com secret: apim-endpoint platformAPIEndpoint: < ... > hosts: - name: api.myhost.subnet.example.com secret: api-endpoint consumerAPIEndpoint: < ... > hosts: - name: consumer.myhost.subnet.example.com secret: consumer-endpoint consumerCatalogEndpoint: < ... > hosts: - name: consumer-catalog.myhost.subnet.example.com secret: consumer-catalog-endpoint ``` -------------------------------- ### Example version number Source: https://www.ibm.com/docs/en/api-connect/software/10.0.x_cd?topic=openshift-installing-management-subsystem-in-shared-namespace An example of a version number for the API Connect application. ```text 10.0.11.0 ``` -------------------------------- ### Example command Source: https://www.ibm.com/docs/en/api-connect/cloud/10.0.x_saas?topic=tool-overview-command-line Example of publishing an app. ```bash apic apps:publish --server mgmnthost.com ``` -------------------------------- ### Example login command with parameters Source: https://www.ibm.com/docs/en/api-connect/cloud/reserved_instance?topic=toolkit-setting-up-v10-reserved An example of the login command with specific values. ```bash apic iam-apikey --apiKey f050b77-896c-4fb8-20f8-1234 --server test.com --tokenendpoint iam.cloud.ibm.com --sync-roles Logged into test.com successfully ``` -------------------------------- ### Example Output of 'kubectl get pods' Source: https://www.ibm.com/docs/en/api-connect/software/10.0.x_cd?topic=portal-troubleshooting-guide-developer This is an example of the output you might see when running 'kubectl -n kube-system get pods', showing various pods including kube-dns. ```bash $ kubectl -n kube-system get pods NAME READY STATUS RESTARTS AGE default-http-backend-5bccfbdc8-mjnnb 1/1 Running 0 4d etcd-minikube 1/1 Running 0 4d kube-addon-manager-minikube 1/1 Running 0 4d kube-apiserver-minikube 1/1 Running 0 4d kube-controller-manager-minikube 1/1 Running 0 4d kube-dns-6f4fd4bdf-7zslq 3/3 Running 0 4d kube-proxy-mddmj 1/1 Running 0 4d kube-registry-proxy-99qml 1/1 Running 0 4d kube-registry-v0-zt8pv 1/1 Running 0 4d kube-scheduler-minikube 1/1 Running 0 4d kubernetes-dashboard-77d8b98585-dczcs 1/1 Running 0 4d nginx-ingress-controller-57bcfc76d6-z775d 1/1 Running 0 4d storage-provisioner 1/1 Running 0 4d tiller-deploy-587df449fb-bpwhq 1/1 Running 0 4d ``` -------------------------------- ### Example of topology spread constraints error Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=kubernetes-troubleshooting-installation This example shows the error message that indicates pods failing to start or schedule due to incorrect topology spread constraints. ```text 0/15 nodes are available: 12 node(s) didn't match pod topology spread constraints (missing required label), 3 node(s) had taint {node-role.kubernetes.io/master: }, that the pod didn't tolerate. ``` -------------------------------- ### Run CLI commands (Windows) Source: https://www.ibm.com/docs/en/api-connect/10.0.x?topic=configuration-installing-toolkit Example commands for running the API Connect CLI on Windows. ```bash apic command_name_and_parameters ``` ```bash apic-slim command_name_and_parameters ``` -------------------------------- ### Example: Get available themes Source: https://www.ibm.com/docs/en/api-connect/cloud/10.0.x_saas?topic=commands-using-drupal-config An example of how to get all available themes using the drupal-config:get command. ```bash apic --mode portaladmin drupal-config:get --server my.management.server.com --org ibm --catalog portal-test --format json --config_name system.theme ``` -------------------------------- ### Create APIs, Product, and Publish to Catalog Source: https://www.ibm.com/docs/en/api-connect/cloud/10.0.x_saas?topic=tool-publishing-apis-applications This example demonstrates how to create APIs, compose them into a Product, and then publish the Product and its APIs to a Catalog using the `apic` CLI. ```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 ``` -------------------------------- ### Example: Get the default theme Source: https://www.ibm.com/docs/en/api-connect/cloud/10.0.x_saas?topic=commands-using-drupal-config An example of how to get the default theme using the drupal-config:get command with a specific key. ```bash apic --mode portaladmin drupal-config:get --server my.management.server.com --org ibm --catalog portal-test --format json --config_name system.theme --config_key default ``` -------------------------------- ### Portal subsystem status example Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=subsystems-installing-developer-portal-subsystem The installation is complete when `STATUS` reports `Running`, `Ready` reports that all services are online (`3/3`), and `MESSAGE` reports "Ready for API Cloud Manager service registration", for example: ```text NAME READY STATUS VERSION RECONCILED VERSION MESSAGE AGE portal 3/3 Running Ready for API Cloud Manager service registration 2h ``` -------------------------------- ### Example of listing identity providers Source: https://www.ibm.com/docs/en/api-connect/cloud/reserved_instance?topic=udp-logging-in-as-consumer-developer-portal-by-using-cli Example output of the identity-providers:list command. ```bash apic identity-providers:list -s consumer.abce-ci-15608-master.abce.ibm.com -m consumer -c sandbox -o org --fields registry_type,realm total_results: 1 results: - registry_type: 'lur' realm: 'consumer:4da2f1b9-05c1-4506-9e2d-951198d19ad3:faa5577d-625c-4fc8-8d19-26077c8aff95/sandbox-idp' ``` -------------------------------- ### Syslog Configuration Example Source: https://www.ibm.com/docs/en/api-connect/10.0.8_lts?topic=subsystems-installing-gateway-subsystem Configuration parameters for enabling and setting up syslog for DataPower. ```yaml enabled: true remoteHost: remotePort: secretName: ``` -------------------------------- ### Example of getting member invitation template variables Source: https://www.ibm.com/docs/en/api-connect/cloud/10.0.x_saas?topic=access-configuring-notifications An example command demonstrating how to get variables for the 'member-invitation' template. ```bash apic notification-templates:get member-invitation --server https://myserver.com --scope org --org myorg --subcollection catalog --fields variables --output - ``` -------------------------------- ### Example response for installed license Source: https://www.ibm.com/docs/en/api-connect/software/10.0.5_lts?topic=utdcd-management-subsystem-two-data-center-upgrade-v10054-previous In the response, the ID statement displays the installed license, for example: ```bash Accepted licenses: ID: Product Version: URL: ``` -------------------------------- ### Example of setting toolkit credentials Source: https://www.ibm.com/docs/en/api-connect/cloud/reserved_instance?topic=toolkit-setting-up-v10-reserved An example of setting toolkit credentials, showing a specific file path. ```bash apic client-creds:set /Users/local_user/credential.json ``` -------------------------------- ### Example: Get twig debugging status Source: https://www.ibm.com/docs/en/api-connect/cloud/reserved_instance?topic=commands-using-twig Example of getting the current state of twig debugging for a portal site. ```bash apic --mode portaladmin twig:debug-status --server my.management.server.com --org ibm --catalog portal-test The current state of twig debugging is true for my.management.server.com/ibm/portal-test. ``` -------------------------------- ### Reinitialize example Source: https://www.ibm.com/docs/en/api-connect/software/10.0.5_lts?topic=connect-troubleshooting-upgrades-vmware An example demonstrating the execution of the patronictl reinit command and the subsequent output, showing the replica's state change. ```bash patronictl reinit fxpk-management-01191b80-postgres fxpk-management-01191b80-postgres-586f899fdf-6s25b + Cluster: fxpk-management-01191b80-postgres (6893134118851096752) --------+--------+--------------+----+-----------+ | Member | Host | Role | State | TL | Lag in MB | +---------------------------------------------------------+----------------+--------+--------------+----+-----------+ | fxpk-management-01191b80-postgres-586f899fdf-6s25b | 172.16.172.244 | | start failed | | unknown | | fxpk-management-01191b80-postgres-rkww-795665698f-4rh4s | 172.16.148.51 | Leader | running | 3 | | | fxpk-management-01191b80-postgres-uvag-9475f7c5f-qr84m | 172.16.53.68 | | running | 3 | 0 | +---------------------------------------------------------+----------------+--------+--------------+----+-----------+ Are you sure you want to reinitialize members fxpk-management-01191b80-postgres-586f899fdf-6s25b? [y/N]: y Success: reinitialize for member fxpk-management-01191b80-postgres-586f899fdf-6s25b ``` -------------------------------- ### Example memcache get command Source: https://www.ibm.com/docs/en/api-connect/cloud/reserved_instance?topic=commands-using-memcache An example of the memcache:get command with specific server, organization, and catalog values. ```bash apic --mode portaladmin --server api.stagingexample.com memcache:get --org ibm --catalog api-connect-catalog-1 ``` -------------------------------- ### Example response indicating the installed version Source: https://www.ibm.com/docs/en/api-connect/software/10.0.5_lts?topic=utdcd-management-subsystem-two-data-center-upgrade-v10054-previous In the response, the - subsystem- statement displays the installed version. In the following example, the response indicates that the installed version is 10.0.5.2: ```bash apic version INFO[0000] Log level: info Control plane: 1.26.0 Appliance base 4.6.0 GitCommitSha:10.0.5.2-55-gb784ac7 Packages: - appliance-base:4.6.0 - appliance-runtime-4.6.0:1.0.0 - appliance-setup-4.6.0:1.0.0 - subsystem-management:1:10.0.5.2 ``` -------------------------------- ### Storage Class Configuration Example Source: https://www.ibm.com/docs/en/api-connect/software/10.0.x_cd?topic=openshift-installing-portal-subsystem-in-shared-namespace Example of configuring storage classes for various volume claims. ```yaml databaseVolumeClaimTemplate: storageClassName: $STORAGE_CLASS volumeSize: 200Gi databaseLogsVolumeClaimTemplate: storageClassName: $STORAGE_CLASS volumeSize: 12Gi webVolumeClaimTemplate: storageClassName: $STORAGE_CLASS volumeSize: 200Gi backupVolumeClaimTemplate: storageClassName: $STORAGE_CLASS volumeSize: 300Gi adminVolumeClaimTemplate: storageClassName: $STORAGE_CLASS volumeSize: 20Gi certVolumeClaimTemplate: storageClassName: $STORAGE_CLASS volumeSize: 4Gi ``` -------------------------------- ### Run CLI commands (macOS/Linux) Source: https://www.ibm.com/docs/en/api-connect/10.0.x?topic=configuration-installing-toolkit Example commands for running the API Connect CLI on macOS or Linux. ```bash ./apic command_name_and_parameters ``` ```bash ./apic-slim command_name_and_parameters ``` -------------------------------- ### Subdomain customization example Source: https://www.ibm.com/docs/en/api-connect/software/10.0.8_lts?topic=subsystems-installing-gateway-subsystem Example of subdomain customization for ingress hostnames. ```yaml gatewayEndpoint: < ... > hosts: - name: rgw.myhost.subnet.example.com secret: gwv6-endpoint gatewayManagerEndpoint: < ... > hosts: - name: rgwd.myhost.subnet.example.com secret: gwv6-manager-endpoint ``` -------------------------------- ### Successful analytics subsystem installation status Source: https://www.ibm.com/docs/en/api-connect/software/10.0.x_cd?topic=openshift-installing-analytics-subsystem-in-shared-namespace Example output showing a successful analytics subsystem installation. ```text NAME READY STATUS VERSION RECONCILED VERSION AGE analytics n/n Running 10.0.11.0 10.0.11.0-1281 86m ``` -------------------------------- ### Start API Designer with temporary credentials on Windows Source: https://www.ibm.com/docs/en/api-connect/10.0.x?topic=configuration-installing-toolkit Command to start API Designer after setting a temporary environment variable for credentials on Windows. ```bash C:\"Program Files\API Designer\API Designer.exe" ```