istio
/
istio.io
mirror of https://github.com/istio/istio.io.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fix v1alpha2 docs (#919) 

* doc fix

* nit
This commit is contained in:
Shriram Rajagopalan 2018-02-01 16:23:48 -05:00 committed by GitHub
parent 987e82a7e4
commit 9a0cdae6a9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 12 additions and 2870 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
_about/notes/0.5.md
View File

@ -23,7 +23,6 @@ therefore doesn't work on older versions. The alpha initializer mechanism is no
- **Revised Traffic Rules**. Based on user feedback, we have made significant changes to Istio's traffic management
(routing rules, destination rules, etc.). We would love your continuing feedback while we polish this in the coming weeks.
[Learn more]({{home}}/docs/reference/config/istio.routing.v1alpha2.html)
## Mixer adapters

163
_docs/reference/config/istio.broker.v1.config.html
View File

@ -1,163 +0,0 @@
---
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>

2699
_docs/reference/config/istio.routing.v1alpha2.html
View File

File diff suppressed because it is too large Load Diff

19
scripts/grab_reference_docs.sh
View File

@ -9,9 +9,7 @@
# Additionally, this script also builds Istio components and runs them to extract their command-line docs which it
# copies to _docs/reference/commands.
set -o errexit
set -o nounset
set -o pipefail
#set -e
ISTIO_BASE=$(cd "$(dirname "$0")" ; pwd -P)/..
WORK_DIR=$(mktemp -d)
@ -56,12 +54,19 @@ get_command_doc() {
./$COMMAND collateral -o $COMMAND_DIR --markdown
}
find $WORK_DIR/api -type f -name '*.pb.html' | while read line; do
locate_file $line
# First delete all the current generated files so that any stale files are removed
find _docs/reference -name '*.html' -type f|xargs rm
for f in `find $WORK_DIR/api -type f -name '*.pb.html'`
do
echo "processing $f"
locate_file $f
done
find $WORK_DIR/istio -type f -name '*.pb.html' | while read line; do
locate_file $line
for f in `find $WORK_DIR/istio -type f -name '*.pb.html'`
do
echo "processing $f"
locate_file $f
done
# get_command_doc $WORK_DIR/istio/broker/cmd/brks brks