-
Notifications
You must be signed in to change notification settings - Fork 3
/
index.html.md.erb
115 lines (85 loc) · 3.99 KB
/
index.html.md.erb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
---
title: YOUR-PRODUCT-NAME (Beta)
owner: Partners
---
<p class="note warning">
<strong>WARNING! </strong>
The PRODUCT-NAME for PCF tile is currently in beta and is intended for evaluation and test purposes only.
Do not use this product in a PCF production environment.
</p>
**This topic begins with a brief description of what the product tile (e.g. Apigee Edge Service Broker for PCF) does,
whereas the Overview section below describes what the service itself (e.g. Apigee Edge) does. See below for an example.**
This documentation describes the Apigee Edge Service Broker for Pivotal Cloud Foundry (PCF). The Apigee Edge Service
Broker for PCF enables developers to manage APIs for their PCF apps through the Apigee Edge management console.
**Note**: This description will appear under **OVERVIEW** in the tile's listing on
[Pivotal Network](http://network.pivotal.io).
## <a id='overview'></a>Overview
**The overview describes the service that your product offers to PCF developers.
Make sure to overview the features of the integration.
Don't focus only on the overview of your product that is being integrated.
See below for an example.**
The Apigee Edge Service Broker for PCF registers a service broker with PCF and exposes its service plans on the
Marketplace. Developers can then create service plan instances using Apps Manager or the Cloud Foundry Command
Line Interface (cf CLI) and bind them to their apps.
Creating an Apigee Edge for PCF service instance and binding it to an app creates an Apigee Edge API proxy that
handles requests for the app. This lets developers use the Apigee Edge management console to manage API request
handling between clients and the app.
**Note**: This overview will appear under **OVERVIEW**, combined with the description above in the tile's listing on
[Pivotal Network](http://network.pivotal.io).
## <a id='features'></a>Key Features
**Note**: This feature list will appear under **FEATURES** in the tile's listing on
[Pivotal Network](http://network.pivotal.io).
Make sure you list the key features of the tile (the integration).
We cannot accept a list of the key features of your product that we are integrating.
YOUR-PRODUCT-NAME includes the following key features:
* Feature one
* Feature two
* Feature three
## <a id="snapshot"></a>Product Snapshot
The following table provides version and version-support information about PRODUCT-NAME.
<table class="nice">
<th>Element</th>
<th>Details</th>
<tr>
<td>Tile version</td>
<td>vYOUR-VERSION-NUMBER</td>
</tr>
<tr>
<td>Release date</td>
<td>YOUR-RELEASE-DATE (Ex: July 1, 2019)</td>
</tr>
<tr>
<td>Software component version</td>
<td>YOUR-SOFTWARE-COMPONENT-VERSION-NUMBER</td>
</tr>
<tr>
<td>Compatible Ops Manager version(s)</td>
<td>vYOUR-COMPATIBLE-OPS-MAN-VERSION (Ex. 2.2.x, 2.3.x, and 2.4.x)</td>
</tr>
<tr>
<td>Compatible Pivotal Application Service version(s)</td>
<td>vYOUR-COMPATIBLE-PIVOTAL-APPLICATION-SERVICE-VERSION (Ex. 2.2.x, 2.3.x, and 2.4.x)</td>
</tr>
<tr>
<td>IaaS support</td>
<td>AWS?, Azure?, GCP?, OpenStack?, and vSphere?</td>
</tr>
<tr>
<td>IPsec support?</td>
<td>[Yes or No]</td>
</tr>
</table>
## <a id="reqs"></a>Requirements
**Provide any general or specific requirements, prerequisites, or dependencies here.
A general requirement might be something like, "An AppDynamics account."
A specific requirement might be something like, "Packaging Dependencies for Offline Buildpacks."**
YOUR-PRODUCT-NAME has the following requirements:
+ PREREQUISITE-1
+ PREREQUISITE-2
## <a id="limitations"></a>Limitations
**List any known limitations.**
## <a id="feedback"></a>Feedback
If you have a feature request, questions, or information about a bug, please email
[Pivotal Cloud Foundry Feedback](mailto:[email protected]) list or send an email to YOUR-SUPPORT-EMAIL.
## <a id='license'></a>License
**List any license information here.**