mirror of https://github.com/istio/istio.io.git
164 lines
3.5 KiB
HTML
164 lines
3.5 KiB
HTML
---
|
|
title: Service Broker
|
|
overview: Configuration affecting the Istio service broker
|
|
location: https://istio.io/docs/reference/config/istio.broker.v1.config.html
|
|
layout: protoc-gen-docs
|
|
---
|
|
<h2 id="CatalogEntry">CatalogEntry</h2>
|
|
<section>
|
|
<p>CatalogEntry defines listing information for this service within the exposed
|
|
catalog. The message is a subset of OSBI service fields defined in
|
|
https://github.com/openservicebrokerapi</p>
|
|
|
|
<table>
|
|
<tr>
|
|
<th>Field</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr id="CatalogEntry.name">
|
|
<td><code>name</code></td>
|
|
<td><code>string</code></td>
|
|
<td>
|
|
<p>Required. Public service name.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr id="CatalogEntry.id">
|
|
<td><code>id</code></td>
|
|
<td><code>string</code></td>
|
|
<td>
|
|
<p>Required. Public unique service guid.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr id="CatalogEntry.description">
|
|
<td><code>description</code></td>
|
|
<td><code>string</code></td>
|
|
<td>
|
|
<p>Required. Public short service description.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</section>
|
|
<h2 id="CatalogPlan">CatalogPlan</h2>
|
|
<section>
|
|
<p>CatalogPlan defines listing information for this service plan within the
|
|
exposed catalog. The message is a subset of OSBI plan fields defined in
|
|
https://github.com/openservicebrokerapi</p>
|
|
|
|
<table>
|
|
<tr>
|
|
<th>Field</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr id="CatalogPlan.name">
|
|
<td><code>name</code></td>
|
|
<td><code>string</code></td>
|
|
<td>
|
|
<p>Required. Public service plan name.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr id="CatalogPlan.id">
|
|
<td><code>id</code></td>
|
|
<td><code>string</code></td>
|
|
<td>
|
|
<p>Required. Public unique service plan guid.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr id="CatalogPlan.description">
|
|
<td><code>description</code></td>
|
|
<td><code>string</code></td>
|
|
<td>
|
|
<p>Required. Public short service plan description.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</section>
|
|
<h2 id="Deployment">Deployment</h2>
|
|
<section>
|
|
<p>Deployment defines how the service instances are deployed.</p>
|
|
|
|
<table>
|
|
<tr>
|
|
<th>Field</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr id="Deployment.instance">
|
|
<td><code>instance</code></td>
|
|
<td><code>string</code></td>
|
|
<td>
|
|
<p>For truely multi-tenant service, the deployed service instance name.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</section>
|
|
<h2 id="ServiceClass">ServiceClass</h2>
|
|
<section>
|
|
<p>ServiceClass defines a service that are exposed to Istio service consumers.
|
|
The service is linked into one or more ServicePlan.</p>
|
|
|
|
<table>
|
|
<tr>
|
|
<th>Field</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr id="ServiceClass.deployment">
|
|
<td><code>deployment</code></td>
|
|
<td><code><a href="#Deployment">Deployment</a></code></td>
|
|
<td>
|
|
<p>Required. Istio deployment spec for the service class.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr id="ServiceClass.entry">
|
|
<td><code>entry</code></td>
|
|
<td><code><a href="#CatalogEntry">CatalogEntry</a></code></td>
|
|
<td>
|
|
<p>Required. Listing information for the public catalog.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</section>
|
|
<h2 id="ServicePlan">ServicePlan</h2>
|
|
<section>
|
|
<p>ServicePlan defines the type of services available to Istio service
|
|
consumers. One or more services are included in a plan. The plan is flexible
|
|
and subject to change along with business requirements.</p>
|
|
|
|
<table>
|
|
<tr>
|
|
<th>Field</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr id="ServicePlan.plan">
|
|
<td><code>plan</code></td>
|
|
<td><code><a href="#CatalogPlan">CatalogPlan</a></code></td>
|
|
<td>
|
|
<p>Required. Public plan information.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr id="ServicePlan.services">
|
|
<td><code>services</code></td>
|
|
<td><code>string[]</code></td>
|
|
<td>
|
|
<p>Required. List of the Keys of serviceclass config instance
|
|
that are included in the plan.
|
|
ServiceClass is a type of CRD resource.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</section>
|