Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Image update for IBM GA release #64

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# webMethods API Control Plane
# IBM webMethods API Control Plane

APIs are everywhere. API Management is where APIs are. It’s all distributed and heterogeneous. Management and administration becomes harder. API Management technology should blend in into the rest of the infrastructure and be managed from one place. API Control Plane is a single solution for understanding, managing and controlling the entire API Management landscape, whether it's self-hosted, in private clouds, in a public cloud, or a hybrid combination of any of these. Assets in the API Control Plane are organized across:

Expand All @@ -8,7 +8,7 @@ APIs are everywhere. API Management is where APIs are. It’s all distributed an

![image](/attachments/apicp_dashboard_page.png)

This repository hosts assets documenting how to deploy and run webMethods API Control Plane as a container, articles and tutorials, public API docs and Postman collections. Please see the official documentation for [cloud](https://docs.webmethods.io/apicontrolplane/welcome/home/#gsc.tab=0) or [self-hosted](https://documentation.softwareag.com/wco/11.0.0/en/webhelp/wco-webhelp/) for how to use the product and system requirements.
This repository hosts assets documenting how to deploy and run IBM webMethods API Control Plane as a container, articles and tutorials, public API docs and Postman collections. Please see the official documentation for [cloud](https://docs.webmethods.io/apicontrolplane/welcome/home/#gsc.tab=0) or [self-hosted](https://docs.webmethods.io/on-premises/webmethods-api-control-plane) for how to use the product and system requirements.

## Deploying API Control Plane

Expand Down Expand Up @@ -48,7 +48,7 @@ We also host various articles related to API Control Plane deployment, use, admi

📘 Official Documentation

For the most up-to-date information about the product, see the official documentation for [cloud](https://docs.webmethods.io/apicontrolplane/welcome/home/#gsc.tab=0) or [self-hosted](https://documentation.softwareag.com/wco/11.0.0/en/webhelp/wco-webhelp/)
For the most up-to-date information about the product, see the official documentation for [cloud](https://docs.webmethods.io/saas/webmethods-api-control-plane#gsc.tab=0) or [self-hosted](https://docs.webmethods.io/on-premises/webmethods-api-control-plane/11.1.0/webhelp/index.html)

💻 Explore the Knowledge Base

Expand Down
4 changes: 1 addition & 3 deletions apis/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
API Collections of API Control Plane
==============================================
This folder contains API Control Plane OpenAPI specifications and postman collections.


This folder contains API Control Plane OpenAPI specifications and postman collections.
8 changes: 4 additions & 4 deletions apis/openapi-specifications/license-management.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ paths:
licenseType: TEN
serialNumber: 0000037081
licenseKey: admin
customerName: SoftwareAGInternal
customerName: WebmethodsInternal
expirationDate: 2024-08-18T23:59:59.218+00:00
licenseQuantity: 1000
freeLicenseQuantity: 1000
Expand All @@ -86,7 +86,7 @@ paths:
licenseType: TEN
serialNumber: 0000037345
licenseKey: admin
customerName: SoftwareAGInternal
customerName: WebmethodsInternal
expirationDate: 2024-08-18T23:59:59.218+00:00
licenseQuantity: 1000
freeLicenseQuantity: 1000
Expand Down Expand Up @@ -129,7 +129,7 @@ paths:
licenseType: TEN
serialNumber: 0000037081
licenseKey: admin
customerName: SoftwareAGInternal
customerName: WebmethodsInternal
expirationDate: 2024-08-18T23:59:59.218+00:00
licenseQuantity: 1000
freeLicenseQuantity: 1000
Expand Down Expand Up @@ -228,7 +228,7 @@ components:
customerName:
description: Name of the customer.
type: string
example: SoftwareAGInternal
example: WebmethodsInternal
expirationDate:
description: Date of expiry of license.
type: string
Expand Down
2 changes: 1 addition & 1 deletion apis/openapi-specifications/runtime-management.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -735,7 +735,7 @@ components:
type: string
description: The hostname or IP address of the runtime
pattern: '((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}'
example: softwareag.com
example: ibm.com
icon:
type: string
description: The icon of the runtime.
Expand Down
2 changes: 1 addition & 1 deletion articles/documentation/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Product documentation

Please see the official documentation for [cloud](https://docs.webmethods.io/apicontrolplane/welcome/home/#gsc.tab=0) or [self-hosted](https://documentation.softwareag.com/wco/11.0.0/en/webhelp/wco-webhelp/) for how to use the product and system requirements.
Please see the official documentation for [cloud](https://docs.webmethods.io/saas/webmethods-api-control-plane) or [self-hosted](https://docs.webmethods.io/on-premises/webmethods-api-control-plane) for how to use the product and system requirements.
25 changes: 12 additions & 13 deletions articles/life-cycle/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This section serves as a comprehensive guide for understanding the life cycle of API Control Plane.

1. <b>What is webMethods API Control Plane?</b>
1. <b>What is IBM webMethods API Control Plane?</b>

API Control Plane is a centralized control and monitoring system that oversees and manages multiple runtimes such as <b>API Gateway</b>, <b>Developer Portal</b>, <b>Microgateway</b>, and <b>other runtimes</b> deployed across multiple
regions including cloud and on-premises environments. With API Control Plane, you can achieve comprehensive real-time monitoring, leveraging advanced analytics, and customizable dashboards to gain valuable
Expand Down Expand Up @@ -71,44 +71,43 @@ This section serves as a comprehensive guide for understanding the life cycle of

API Control Plane can be deployed using:

- Docker: For details, see https://documentation.softwareag.com/wco/11.0.0/en/webhelp/wco-webhelp/#page/wco-webhelp%2Fta-deploy_standalone_apicp_docker.html
- Docker: For details, see https://docs.webmethods.io/on-premises/webmethods-api-control-plane/11.1.0/webhelp/index.html

- Helm: For details, see https://documentation.softwareag.com/wco/11.0.0/en/webhelp/wco-webhelp/#page/wco-webhelp%2Fta-deploy_standalone_apicp_helm.html
- Helm: For details, see https://docs.webmethods.io/on-premises/webmethods-api-control-plane/11.1.0/webhelp/index.html#page/wco-webhelp%2Fta-deploy_standalone_apicp_docker.html
<br><br>
14. <b>How to connect API Gateway with API Control Plane?</b>

To connect API Control Plane using API Gateway UI, see https://documentation.softwareag.com/webmethods/api_gateway/yai10-15/webhelp/yai-webhelp/#page/yai-webhelp%2Fgtw_configure_gateway.html%23
To connect API Control Plane using API Gateway, see https://docs.webmethods.io/on-premises/webmethods-api-control-plane/11.1.0/webhelp/index.html#page/wco-webhelp%2Fco-connecting-apigw.html

To connect API Control Plane using properties or YAML file, see https://documentation.softwareag.com/wco/11.0.0/en/webhelp/wco-webhelp/#page/wco-webhelp%2Fco-connecting-apigw.html
<br><br>
15. <b>What are the hardware and product configuration guidelines that are required to deploy API Control Plane to run at an optimal scale?</b>

For details, see https://documentation.softwareag.com/wco/11.0.0/en/webhelp/wco-webhelp/#page/wco-webhelp%2Fre-resourcing_guidelines.html
For details, see https://docs.webmethods.io/on-premises/webmethods-api-control-plane/11.1.0/webhelp/index.html#page/wco-webhelp%2Fre-resourcing_guidelines.html
<br><br>
16. <b>How to manage data backups/snapshot to ensure data resiliency and disaster recovery?</b>

For details, see https://documentation.softwareag.com/wco/11.0.0/en/webhelp/wco-webhelp/#page/wco-webhelp%2Fco-snapshot_management.html
For details, see https://docs.webmethods.io/on-premises/webmethods-api-control-plane/11.1.0/webhelp/index.html#page/wco-webhelp%2Fco-snapshot_management.html
<br><br>
17. <b>Does API Control Plane provide REST endpoints to monitor the health and resource utilization of the microservices and Elastic search?</b>

Yes. For details about how to monitor microservices health and resource utilization, see https://documentation.softwareag.com/wco/11.0.0/en/webhelp/wco-webhelp/#page/wco-webhelp%2Fco-microservices_application_level.html%23
Yes. For details about how to monitor microservices health and resource utilization, see https://docs.webmethods.io/on-premises/webmethods-api-control-plane/11.1.0/webhelp/index.html#page/wco-webhelp%2Fco-microservices_application_level.html

For details about how to monitor Elastic search health and resource utilization, see https://documentation.softwareag.com/wco/11.0.0/en/webhelp/wco-webhelp/#page/wco-webhelp%2Fco-elasticsearch_monitoring.html%23
For details about how to monitor Elastic search health and resource utilization, see https://docs.webmethods.io/on-premises/webmethods-api-control-plane/11.1.0/webhelp/index.html#page/wco-webhelp%2Fco-elasticsearch_monitoring.html
<br><br>
18. <b>List the Prometheus metrics to analyze API Control Plane health.</b>

For details, see https://documentation.softwareag.com/wco/11.0.0/en/webhelp/wco-webhelp/#page/wco-webhelp%2Fco-collect_microservices_metrics.html
For details, see https://docs.webmethods.io/on-premises/webmethods-api-control-plane/11.1.0/webhelp/index.html#page/wco-webhelp%2Fco-collect_microservices_metrics.html
<br><br>
19. <b>Is Open telemetry supported for tracing?</b>

Yes. To deploy API Control Plane enabling Open Telemetry using Jaeger UI with Docker, perform *step 5* mentioned in
https://documentation.softwareag.com/wco/11.0.0/en/webhelp/wco-webhelp/#page/wco-webhelp%2Fta-deploy_standalone_apicp_docker.html
https://docs.webmethods.io/on-premises/webmethods-api-control-plane/11.1.0/webhelp/index.html#page/wco-webhelp%2Fco-collect_microservices_metrics.html
<br><br>
20. <b>How do I report an incident?</b>

You can report an incident through our Service Portal, [JSM](https://getsupport.softwareag.com/)

## References

* Official On-prem documentation link: https://documentation.softwareag.com/wco/11.0.0/en/webhelp/wco-webhelp/#page/wco-webhelp%2Fto-landing_page.html
* Official Cloud documentation link: https://docs.webmethods.io/apicontrolplane/welcome/home/#gsc.tab=0
* Official On-prem documentation link: https://docs.webmethods.io/on-premises/webmethods-api-control-plane
* Official Cloud documentation link: https://docs.webmethods.io/saas/webmethods-api-control-plane
2 changes: 1 addition & 1 deletion deployment/agent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ Runtime communicate with API Control Plane with the help of an Agent. Here, we h
# Agent SDK

We also provide a Java based agent SDK that can be used to develop a Java application that fetches runtime details and metrics
information from any runtime and send to the API Control Plane. A detailed document is available [here](https://documentation.softwareag.com/wco/11.0.0/en/webhelp/wco-webhelp/#page/wco-webhelp%2Fco-agent_sdk.html).
information from any runtime and send to the API Control Plane. A detailed document is available [here](https://docs.webmethods.io/on-premises/webmethods-api-control-plane/11.1.0/webhelp/index.html#page/wco-webhelp%2F_api_cp_webhelp_new.1.138.html).
information from any runtime and send to the API Control Plane. It can be downloaded from Download Components section on [Software AG Empower Portal](https://empower.softwareag.com/).
4 changes: 2 additions & 2 deletions deployment/agent/webmethods-api-gateway/.env
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
GATEWAY_IMAGE=sagcr.azurecr.io/apigateway:10.15.0.11
GATEWAY_IMAGE=cp.icr.io/api-management/apigateway-lean:11.1.0.0.866

GATEWAY_PORT=5555

ELASTICSEARCH_IMAGE= "docker.elastic.co/elasticsearch/elasticsearch:8.2.3"
ELASTICSEARCH_IMAGE= "docker.elastic.co/elasticsearch/elasticsearch:8.12.2"

RUNTIME_NAME=agent-spectre_MyAgent

Expand Down
12 changes: 6 additions & 6 deletions deployment/docker/.env
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ ASSETCATALOG_PUBLISH_PORT=8081
ELASTICSEARCH_PUBLISH_PORT=9200

# Images
INGRESS_IMAGE="sagcr.azurecr.io/controlplane-ingress:11.0"
UI_IMAGE="sagcr.azurecr.io/controlplane-ui:11.0"
ENGINE_IMAGE="sagcr.azurecr.io/controlplane-engine:11.0"
ASSETCATALOG_IMAGE="sagcr.azurecr.io/controlplane-assetcatalog:11.0"
ELASTICSEARCH_IMAGE="docker.elastic.co/elasticsearch/elasticsearch:8.1.1"
INGRESS_IMAGE="cp.icr.io/cp/webmethods/api/api-control-plane-ingress:11.1.2"
UI_IMAGE="cp.icr.io/cp/webmethods/api/api-control-plane-ui:11.1.2"
ENGINE_IMAGE="cp.icr.io/cp/webmethods/api/api-control-plane-engine:11.1.2"
ASSETCATALOG_IMAGE="cp.icr.io/cp/webmethods/api/api-control-plane-assetcatalog:11.1.2"
ELASTICSEARCH_IMAGE="docker.elastic.co/elasticsearch/elasticsearch:8.14.3"

# Elasticsearch config
ELASTICSEARCH_HOST="elasticsearch"
Expand Down Expand Up @@ -40,6 +40,6 @@ SERVER_SSL_KEY_ALIAS=softwareag
SERVER_SSL_KEY_PASSWORD=softwareagkeys
SERVER_SSL_KEY_STORE_PASSWORD=softwareag
SERVER_SSL_KEY_STORE_TYPE=JKS
SERVER_SSL_KEY_STORE=file:/opt/softwareag/certs/softwareag_not_for_production.jks
SERVER_SSL_KEY_STORE=file:/opt/softwareag/certs/webmethods_not_for_production.jks

LICENSE_FILE_NAME=my_cp_license.xml
40 changes: 13 additions & 27 deletions deployment/docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ The standard deployment of API Control plane contains the following 5 microservi

Table of contents
1. [Prerequisite](#Prerequisite)
2. [How to deploy webMethods API Control Plane using docker compose?](#how-to-deploy-webmethods-api-control-plane-using-docker-compose)
3. [How to stop webMethods API Control Plane using docker compose?](#how-to-stop-webmethods-api-control-plane-using-docker-compose)
4. [How to access the newly deployed webMethods API Control Plane?](#how-to-access-the-newly-deployed-webmethods-api-control-plane)
2. [How to deploy IBM webMethods API Control Plane using docker compose?](#how-to-deploy-webmethods-api-control-plane-using-docker-compose)
3. [How to stop IBM webMethods API Control Plane using docker compose?](#how-to-stop-webmethods-api-control-plane-using-docker-compose)
4. [How to access the newly deployed IBM webMethods API Control Plane?](#how-to-access-the-newly-deployed-webmethods-api-control-plane)
5. [Additional deployment flavors](#additional-deployment-flavors)

***
Expand All @@ -30,29 +30,15 @@ The machine needs following to install the control plane using docker.

***

## How to deploy webMethods API Control Plane using docker compose?
## How to deploy IBM webMethods API Control Plane using docker compose?

1. Clone this repository
1. Refer https://docs.webmethods.io/on-premises/webmethods-api-control-plane/en/11.1.0/webhelp/index.html#page/wco-webhelp%2Fco-deploy_standalone_apicp.html to set up docker environment for IBM container registry.

2. Login to https://containers.softwareag.com/

3. Get a Personal Access Token (PAT)

We published docker images for all API Control Plane microservice to https://containers.softwareag.com/ repository. To pull them or have docker compose pull them for you, you need a Personal Access token (PAT). To get a PAT, go to Userprofile > Settings > Generate password. Store Token Password securely.

4. Log in to sagcr.azurecr.io docker repository

Run the following command in your docker environment:

```bash
docker login -u [Your git username] -p [Your PAT] sagcr.azurecr.io
```

5. Configure your deployment
2. Configure your deployment

The `.env` file in [deployment/docker/.env](deployment/docker/.env) allows for configuring different aspects of API Control Plane deployment. To be able to access API Control Plane after it's deployed, you need to edit this file and provide a value for `NGINX_DOMAIN_NAME` that matches the hostname of the machine you're deploying API Control plane on. Make sure this hostname is accessible to whoever will be connecting to API Control Plane.

6. Execute the deployment scripts
3. Execute the deployment scripts

To deploy the API Control Plane with default configuration:

Expand All @@ -73,7 +59,7 @@ The machine needs following to install the control plane using docker.
```bash
[user@somehost docker]$ docker-compose -f control-plane.yaml up -d
[+] Running 8/8
⠿ Network softwareag-api-management Created 0.2s
⠿ Network ibm-webmethods-api-management Created 0.2s
⠿ Container elasticsearch Healthy 22.6s
⠿ Container nginx_setup Started 1.5s
⠿ Container control-plane-asset-catalog Healthy 88.6s
Expand All @@ -83,7 +69,7 @@ The machine needs following to install the control plane using docker.
⠿ Container nginx Started 151.2s
```

7. Verify it's started
4. Verify it's started

It will take a couple of minutes to start. You can monitor that with solutions like Portainer or Docker Dashboard etc. or simply user Docker CLI like this

Expand All @@ -102,11 +88,11 @@ The machine needs following to install the control plane using docker.
nginx Up About a minute (healthy) 0.0.0.0:81->80/tcp, :::81->80/tcp, 0.0.0.0:444->443/tcp, :::444->443/tcp
elasticsearch Up About a minute (healthy) 0.0.0.0:9200->9200/tcp, :::9200->9200/tcp, 9300/tcp
```

>
###### [Back to Top](#api-control-plane-deployment-with-docker-compose)
***

## How to stop webMethods API Control Plane using docker compose?
## How to stop IBM webMethods API Control Plane using docker compose?

To stop and remove the API Control Plane default configuration:

Expand Down Expand Up @@ -134,13 +120,13 @@ If everything goes well, the output should be similar to this
⠿ Container control-plane-engine Removed 10.3s
⠿ Container control-plane-asset-catalog Removed 10.3s
⠿ Container elasticsearch Removed 2.6s
⠿ Network softwareag-api-management Removed 0.3s
⠿ Network ibm-webmethods-api-management Removed 0.3s
```

###### [Back to Top](#api-control-plane-deployment-with-docker-compose)
***

## How to access the newly deployed webMethods API Control Plane?
## How to access the newly deployed IBM webMethods API Control Plane?

1. Open your browser and go to `https://[the-host-you-configured]:8080/`
2. You should see the login screen. Log in using Administrator username and the default password.
Expand Down
2 changes: 1 addition & 1 deletion deployment/docker/asset-catalog/asset-catalog.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ services:
timeout: 10s
retries: 5
networks:
- softwareag-api-management
- ibm-webmethods-api-management
asset-catalog-debug:
<<: *asset-catalog-service
env_file:
Expand Down
4 changes: 2 additions & 2 deletions deployment/docker/control-plane-secure-es.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,6 @@ volumes:


networks:
softwareag-api-management:
name: softwareag-api-management
ibm-webmethods-api-management:
name: ibm-webmethods-api-management
driver: bridge
4 changes: 2 additions & 2 deletions deployment/docker/control-plane.debug.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,6 @@ volumes:
driver: local

networks:
softwareag-api-management:
name: softwareag-api-management
ibm-webmethods-api-management:
name: ibm-webmethods-api-management
driver: bridge
4 changes: 2 additions & 2 deletions deployment/docker/control-plane.gainsight.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,6 @@ volumes:
driver: local

networks:
softwareag-api-management:
name: softwareag-api-management
ibm-webmethods-api-management:
name: ibm-webmethods-api-management
driver: bridge
4 changes: 2 additions & 2 deletions deployment/docker/control-plane.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,6 @@ volumes:
driver: local

networks:
softwareag-api-management:
name: softwareag-api-management
ibm-webmethods-api-management:
name: ibm-webmethods-api-management
driver: bridge
Loading