Skip to content
This repository was archived by the owner on Oct 17, 2024. It is now read-only.

Commit 33adf58

Browse files
author
Rathna
committed
Docs update
1 parent 6828166 commit 33adf58

File tree

1 file changed

+36
-21
lines changed

1 file changed

+36
-21
lines changed

README.md

Lines changed: 36 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,10 @@
33
- Axway Service Broker for Pivotal Cloud Foundry based on [Fully brokered Architecture](https://docs.pivotal.io/pivotalcf/1-12/services/route-services.html#fully-brokered)
44

55

6-
## API Management Version Compatibilty
7-
This artefact was successfully tested for the following versions:
8-
- Axway AMPLIFY API Management 7.6.2 SP3 and 7.7
6+
## API Management Version Compatibility
7+
This artifact successfully tested with following versions:
8+
- Axway AMPLIFY API Management 7.6.2 SP3 and v7.7.20200330
9+
- cf 2.8.1
910

1011

1112
## Prerequisites
@@ -33,7 +34,18 @@ This artefact was successfully tested for the following versions:
3334
service_instance_id:{
3435
label: 'Service Instance Id'
3536
}
37+
},
38+
api: {
39+
cfBindingId:{
40+
label: 'Cloud Foundry Binding Id',
41+
permissions: {
42+
admin: { read: true, write: true, visible:true },
43+
oadmin: { read: true, write: false, visible:true },
44+
user: { read: true, write: false, visible:true }
45+
}
46+
}
3647
}
48+
3749
}
3850
```
3951

@@ -46,12 +58,12 @@ This artefact was successfully tested for the following versions:
4658
```
4759
Build the project (output from `cf push` command provides fully qualified URL as output)
4860
```bash
49-
$mvn clean install
61+
$mvn clean package
5062
```
5163

5264
or you can use the following command if you want to skip testing step:
5365
```bash
54-
$mvn clean install -Dmaven.test.skip=true
66+
$mvn clean package -Dmaven.test.skip=true
5567
```
5668
Now, you can push your app to PCF:
5769
```bash
@@ -111,10 +123,9 @@ This artefact was successfully tested for the following versions:
111123

112124
$cf set-env axway-apim-service-broker cf_admin_username admin@axway.com
113125
$cf set-env axway-apim-service-broker cf_admin_password changme
114-
$cf set-env axway-apim-service-broker login_host https://login.sys.pie-25.cfplatformeng.com/oauth/token
115-
$cf set-env axway-apim-service-broker cc_host https://api.sys.pie-25.cfplatformeng.com
126+
$cf set-env axway-apim-service-broker api_host uaa.sys.industry.cf-app.com
116127

117-
$cf set-env axway-apim-service-broker TRUST_CERTS login.sys.pie-25.cfplatformeng.com,api.sys.pie-25.cfplatformeng.com //If your PCF instance uses self-signed certs, you may need to use this environment variable to prevent some security errors
128+
$cf set-env axway-apim-service-broker TRUST_CERTS uaa.sys.industry.cf-app.com //If your PCF instance uses self-signed certs, you may need to use this environment variable to prevent some security errors
118129
```
119130

120131
- Refresh Service Broker Instance to read the new environment variable
@@ -165,10 +176,10 @@ $cf push
165176

166177
```json
167178
{
168-
"apiname": "pcftest",
169-
"type":": "swagger",
170-
"uri": "/v2/api-docs"
171-
}
179+
"apiname": "pcftest",
180+
"type": "swagger",
181+
"uri": "/v2/api-docs"
182+
}
172183

173184
```
174185
`apiName` is optional. If `apiName` is not specified, Service broker fetch the API Name and from swagger or WSDL.
@@ -185,34 +196,38 @@ $cf push
185196

186197
- Test the Pivotal Application
187198

188-
Try to access your apps endpoint. To verify that the request goes through API Gateway, open Axway API Gateway Manager and look at the traffic tab. You should see two entries:
189-
- One that comes from GoRouter (PCF)
190-
- The second one comes as a riderect from API Gateway itself
199+
Try to access your PCF application endpoint. To verify that the request goes through API Gateway, open Axway API Gateway Manager and look at the traffic tab. You should see two entries:
200+
- One comes from GoRouter (PCF) to API Gateway
201+
- The second one comes as a redirect from API Gateway itself
191202

192-
- Un-bind Application from Axway Service broker
203+
204+
205+
206+
## Axway Service Broker uninstallation
207+
208+
- Unbind Route - Un-bind Application from Axway Service broker
193209

194210
```bash
195211
$cf unbind-route-service cfapps.pie-25.cfplatformeng.com AxwayAPIM --hostname greeting-app-tournois-postresurrection
196212
```
197213

198214
The route unbinding command invokes Axway Service Broker and Service Broker does the following:
199215
1. If API is in Published state, it will throw an error.
200-
2. If API is in un-published state, delete frontend, backend API.
201-
216+
2. If API is in un-published state, delete front end API, backend API.
202217

203-
## Axway Service Broker uninstallation
204-
218+
- Delete Service
205219
```bash
206220
$cf delete-service AxwayAPIM
207221
```
208222

209-
The delete service command does the following:
223+
Cloud Foundry delete service command does the following:
210224
1. If the service has binded application or routes, it throws an error.
211225
2. Delete Frontend and Backend APIs
212226
3. Delete applications
213227
4. Delete User
214228
5. Delete Organization
215229

230+
- Delete Service Broker
216231
```bash
217232
$cf delete-service-broker axway-apim-service-broker
218233
```

0 commit comments

Comments
 (0)