mirror of https://github.com/istio/istio.io.git
284 lines
7.9 KiB
HTML
284 lines
7.9 KiB
HTML
---
|
|
WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE 'https://github.com/apigee/istio-mixer-adapter' REPO
|
|
source_repo: https://github.com/apigee/istio-mixer-adapter
|
|
title: Apigee
|
|
description: Adapter for Apigee's distributed policy checks and analytics.
|
|
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/apigee.html
|
|
layout: partner-component
|
|
generator: protoc-gen-docs
|
|
provider: Apigee
|
|
contact_email:
|
|
support_link: https://apigee.com/about/support/portal
|
|
source_link: https://github.com/apigee/istio-mixer-adapter
|
|
latest_release_link: https://github.com/apigee/istio-mixer-adapter/releases
|
|
helm_chart_link:
|
|
istio_versions: "1.1.x, 1.2.x, 1.3.x"
|
|
supported_templates: authorization, analytics
|
|
number_of_entries: 4
|
|
---
|
|
<p>The Apigee Mixer adapter provides Apigee’s distributed authentication and quota policy checks
|
|
as well as the ingestion of Istio telemetry for analysis and reporting.</p>
|
|
|
|
<p>Important: The adapter is provided in an enhanced Mixer image. The default Mixer image must be replaced and the
|
|
proper CRDs must be applied in order to use these features. Complete Apigee documentation on the concepts and usage
|
|
of this adapter is available on the <a href="https://docs.apigee.com/api-platform/istio-adapter/concepts">Apigee Adapter for Istio</a>
|
|
site. For more information and product support, please <a href="https://apigee.com/about/support/portal">contact Apigee support</a>.</p>
|
|
|
|
<p>This adapter supports the <a href="/zh/docs/reference/config/policy-and-telemetry/templates/authorization/">authorization template</a>
|
|
and Apigee’s <a href="/zh/docs/reference/config/policy-and-telemetry/templates/analytics/">analytics template</a>.</p>
|
|
|
|
<p>Example config:</p>
|
|
|
|
<pre><code class="language-yaml">apiVersion: config.istio.io/v1alpha2
|
|
kind: apigee
|
|
metadata:
|
|
name: apigee-handler
|
|
namespace: istio-system
|
|
spec:
|
|
apigee_base: https://istioservices.apigee.net/edgemicro
|
|
customer_base: https://myorg-test.apigee.net/istio-auth
|
|
org_name: myorg
|
|
env_name: test
|
|
key: mykey
|
|
secret: mysecret
|
|
temp_dir: "/tmp/apigee-istio"
|
|
client_timeout: 30s
|
|
allowUnverifiedSSLCert: false
|
|
products:
|
|
refresh_rate: 2m
|
|
analytics:
|
|
legacy_endpoint: false
|
|
file_limit: 1024
|
|
auth:
|
|
api_key_claim:
|
|
api_key_cache_duration: 30m
|
|
</code></pre>
|
|
|
|
<h2 id="Params">Params</h2>
|
|
<section>
|
|
<p>The Configuration for the Apigee adapter provides information on how the adapter should contact
|
|
the Apigee proxies and how it should operate. Running the <code>apigee-istio provision</code> CLI command
|
|
will ensure that all proxies are installed into your Apigee environment and generate this file
|
|
with all required settings for you.
|
|
For additional information on this adapter or support please contact anchor-prega-support@google.com.</p>
|
|
|
|
<table class="message-fields">
|
|
<thead>
|
|
<tr>
|
|
<th>Field</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr id="Params-apigee_base">
|
|
<td><code>apigeeBase</code></td>
|
|
<td><code>string</code></td>
|
|
<td>
|
|
<p>Apigee Base is the URI for a shared proxy on Apigee.
|
|
Required.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr id="Params-customer_base">
|
|
<td><code>customerBase</code></td>
|
|
<td><code>string</code></td>
|
|
<td>
|
|
<p>Customer Base is the URI for an organization-specific proxy on Apigee.
|
|
Required.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr id="Params-org_name">
|
|
<td><code>orgName</code></td>
|
|
<td><code>string</code></td>
|
|
<td>
|
|
<p>Org Name is the name of the organization on Apigee.
|
|
Required.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr id="Params-env_name">
|
|
<td><code>envName</code></td>
|
|
<td><code>string</code></td>
|
|
<td>
|
|
<p>Env Name is the name of the environment on Apigee.
|
|
Required.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr id="Params-key">
|
|
<td><code>key</code></td>
|
|
<td><code>string</code></td>
|
|
<td>
|
|
<p>Key is used to authenticate to the Apigee proxy endpoints, generated during provisioning.
|
|
Required.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr id="Params-secret">
|
|
<td><code>secret</code></td>
|
|
<td><code>string</code></td>
|
|
<td>
|
|
<p>Secret is used to authenticate to the Apigee proxy endpoints, generated during provisioning.
|
|
Required.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr id="Params-temp_dir">
|
|
<td><code>tempDir</code></td>
|
|
<td><code>string</code></td>
|
|
<td>
|
|
<p>The local directory to be used by the adapter for temporary files.
|
|
Optional. Default: “/tmp/apigee-istio”.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr id="Params-client_timeout">
|
|
<td><code>clientTimeout</code></td>
|
|
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">google.protobuf.Duration</a></code></td>
|
|
<td>
|
|
<p>The timeout to be used for adapter requests to Apigee servers.
|
|
Optional. Default: “30s” (30 seconds).</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr id="Params-allowUnverifiedSSLCert">
|
|
<td><code>allowUnverifiedSSLCert</code></td>
|
|
<td><code>bool</code></td>
|
|
<td>
|
|
<p>Set to true to allow an unknown server SSL Certificate (eg. self-signed)
|
|
Optional. Default: false.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr id="Params-products">
|
|
<td><code>products</code></td>
|
|
<td><code><a href="#Params-product_options">Params.product_options</a></code></td>
|
|
<td>
|
|
<p>Options specific to to products handling.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr id="Params-analytics">
|
|
<td><code>analytics</code></td>
|
|
<td><code><a href="#Params-analytics_options">Params.analytics_options</a></code></td>
|
|
<td>
|
|
<p>Options specific to to analytics handling.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr id="Params-auth">
|
|
<td><code>auth</code></td>
|
|
<td><code><a href="#Params-auth_options">Params.auth_options</a></code></td>
|
|
<td>
|
|
<p>Options specific to to products handling.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</section>
|
|
<h2 id="Params-analytics_options">Params.analytics_options</h2>
|
|
<section>
|
|
<p>Options specific to to analytics handling.</p>
|
|
|
|
<table class="message-fields">
|
|
<thead>
|
|
<tr>
|
|
<th>Field</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr id="Params-analytics_options-legacy_endpoint">
|
|
<td><code>legacyEndpoint</code></td>
|
|
<td><code>bool</code></td>
|
|
<td>
|
|
<p>If true, use legacy direct communication analytics protocol instead of buffering. Must be true for OPDK.
|
|
Optional. Default: false.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr id="Params-analytics_options-file_limit">
|
|
<td><code>fileLimit</code></td>
|
|
<td><code>int64</code></td>
|
|
<td>
|
|
<p>The number of analytics files that can be buffered before oldest files are dropped.
|
|
Optional. Default: 1024.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr id="Params-analytics_options-send_channel_size">
|
|
<td><code>sendChannelSize</code></td>
|
|
<td><code>int64</code></td>
|
|
<td>
|
|
<p>The size of the channel used to buffer record sends in memory.
|
|
Optional. Default: 10.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</section>
|
|
<h2 id="Params-auth_options">Params.auth_options</h2>
|
|
<section>
|
|
<p>Options specific to to auth handling.</p>
|
|
|
|
<table class="message-fields">
|
|
<thead>
|
|
<tr>
|
|
<th>Field</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr id="Params-auth_options-api_key_cache_duration">
|
|
<td><code>apiKeyCacheDuration</code></td>
|
|
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">google.protobuf.Duration</a></code></td>
|
|
<td>
|
|
<p>The length of time API Keys are valid in the cache.
|
|
Optional. Default: “30m” (30 minutes).</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr id="Params-auth_options-api_key_claim">
|
|
<td><code>apiKeyClaim</code></td>
|
|
<td><code>string</code></td>
|
|
<td>
|
|
<p>The name of a JWT claim from which to look for an api_key.
|
|
Optional. Default: none.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</section>
|
|
<h2 id="Params-product_options">Params.product_options</h2>
|
|
<section>
|
|
<p>Options specific to to products handling.</p>
|
|
|
|
<table class="message-fields">
|
|
<thead>
|
|
<tr>
|
|
<th>Field</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr id="Params-product_options-refresh_rate">
|
|
<td><code>refreshRate</code></td>
|
|
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">google.protobuf.Duration</a></code></td>
|
|
<td>
|
|
<p>The rate at which the list of products is refreshed from Apigee.
|
|
Optional. Default: “2m” (2 minutes).</p>
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</section>
|