Add support for partner components. (#2704)

Partner components (adapters not controlled by the Istio org) are now
called out as such on their page. Component authors have a chance to put
all sorts of info about their component to make it easy for customers
to find and use their component.

content/docs/reference/commands/mixs/index.html

@@ -252,6 +252,11 @@ nexus for policy evaluation and telemetry reporting.</p>
 <td></td>
 <td>URL of Zipkin collector (example: &#39;http://zipkin:9411/api/v1/spans&#39;).  (default ``)</td>
 </tr>
+<tr>
+<td><code>--useAdapterCRDs</code></td>
+<td></td>
+<td>Whether or not to allow configuration of Mixer via adapter-specific CRDs </td>
+</tr>
 </tbody>
 </table>
 <h2 id="mixs-version">mixs version</h2>

content/docs/reference/commands/pilot-agent/index.html

@@ -64,10 +64,6 @@ number_of_entries: 5
 <td>Ports exposed by the application. Used to determine that Envoy is configured and ready to receive traffic.  (default `[]`)</td>
 </tr>
 <tr>
-<td><code>--availabilityZone &lt;string&gt;</code></td>
-<td>Availability zone  (default ``)</td>
-</tr>
-<tr>
 <td><code>--binaryPath &lt;string&gt;</code></td>
 <td>Path to the proxy binary  (default `/usr/local/bin/envoy`)</td>
 </tr>
@@ -100,10 +96,6 @@ number_of_entries: 5
 <td>Address of the discovery service exposing xDS (e.g. istio-pilot:8080)  (default `istio-pilot:15007`)</td>
 </tr>
 <tr>
-<td><code>--discoveryRefreshDelay &lt;duration&gt;</code></td>
-<td>Polling interval for service discovery (used by EDS, CDS, LDS, but not RDS)  (default `1s`)</td>
-</tr>
-<tr>
 <td><code>--domain &lt;string&gt;</code></td>
 <td>DNS domain suffix. If not provided uses ${POD_NAMESPACE}.svc.cluster.local  (default ``)</td>
 </tr>

content/docs/reference/commands/pilot-discovery/index.html

@@ -124,6 +124,11 @@ number_of_entries: 5
 <td>The IP port to use for the ControlZ introspection facility  (default `9876`)</td>
 </tr>
 <tr>
+<td><code>--disable-install-crds</code></td>
+<td></td>
+<td>Disable discovery service from verifying the existence of CRDs at startup and then installing if not detected.  It is recommended to be disable for highly available setups. </td>
+</tr>
+<tr>
 <td><code>--discoveryCache</code></td>
 <td></td>
 <td>Enable caching discovery service responses </td>

content/docs/reference/config/policy-and-telemetry/adapters/apigee/index.html

@@ -2,7 +2,7 @@
 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: protoc-gen-docs
+layout: partner-component
 generator: protoc-gen-docs
 number_of_entries: 3
 ---

content/docs/reference/config/policy-and-telemetry/adapters/cloudmonitor/index.html

@@ -2,7 +2,7 @@
 title: CloudMonitor
 description: Adapter for cloudmonitor metrics.
 location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/cloudmonitor.html
-layout: protoc-gen-docs
+layout: partner-adapter
 generator: protoc-gen-docs
 aliases:
   - /docs/reference/config/adapters/cloudmonitor.html

content/docs/reference/config/policy-and-telemetry/adapters/wavefront/index.html

@@ -2,7 +2,7 @@
 title: Wavefront by VMware
 description: Adapter to deliver metrics to Wavefront by VMware.
 location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/wavefront.html
-layout: protoc-gen-docs
+layout: partner-adapter
 generator: protoc-gen-docs
 aliases:
   - /docs/reference/config/adapters/wavefront.html

content/docs/reference/config/policy-and-telemetry/templates/analytics/index.html

@@ -2,7 +2,7 @@
 title: Analytics
 description: The Analytics template is used to dispatch runtime telemetry to Apigee.
 location: https://istio.io/docs/reference/config/policy-and-telemetry/templates/analytics.html
-layout: protoc-gen-docs
+layout: partner-adapter
 generator: protoc-gen-docs
 number_of_entries: 1
 ---

i18n/en.toml

@@ -120,3 +120,30 @@ other = "Back to top"
 
 [button_sidenav]
 other = "Toggle the navigation bar"
+
+[partner_component_notice]
+other = "This component was created and is maintained by an Istio partner. Please address support questions to the partner directly."
+
+[partner_component_partner]
+other = "Partner"
+
+[partner_component_contact]
+other = "Contact"
+
+[partner_component_support_site]
+other = "Support Site"
+
+[partner_component_source_code]
+other = "Source Code"
+
+[partner_component_latest_release]
+other = "Latest Release"
+
+[partner_component_helm_chart]
+other = "Helm Chart"
+
+[partner_component_istio_versions]
+other = "Tested by %s with these Istio Versions"
+
+[partner_component_supported_templates]
+other = "Supported Templates"

i18n/zh.toml

@@ -120,3 +120,30 @@ other = "回到顶部"
 
 [button_sidenav]
 other = "折叠导航栏"
+
+[partner_component_notice]
+other = "This component was created and is maintained by an Istio partner. Please address support questions to the partnet directly."
+
+[partner_component_partner]
+other = "Partner"
+
+[partner_component_contact]
+other = "Contact"
+
+[partner_component_support_site]
+other = "Support Site"
+
+[partner_component_source_code]
+other = "Source Code"
+
+[partner_component_latest_release]
+other = "Latest Release"
+
+[partner_component_helm_chart]
+other = "Helm Chart"
+
+[partner_component_istio_versions]
+other = "Tested by %s with these Istio Versions"
+
+[partner_component_supported_templates]
+other = "Supported Templates"

layouts/_default/partner-component.html

@@ -0,0 +1,55 @@
+{{ define "main" }}
+{{ partial "primary-top.html" . }}
+
+<div class="partner-component-notice">
+    <p>
+        {{ i18n "partner_component_notice" }}
+    </p>
+
+    <table>
+        {{ if .Params.provider }}
+            <tr><td>{{ i18n "partner_component_partner" }}</td><td>{{ .Params.provider }}</td>
+        {{ end }}
+
+        {{ if .Params.contact_email }}
+            <tr><td>{{ i18n "partner_component_contact" }}</td><td><a href="mailto:{{ .Params.contact_email}}">{{ .Params.contact_email }}</a></td>
+        {{ end }}
+
+        {{ if .Params.support_link }}
+            <tr><td>{{ i18n "partner_component_support_site" }}</td><td><a href="{{ .Params.support_link}}">{{ .Params.support_link }}</a></td>
+        {{ end }}
+
+        {{ if .Params.source_link }}
+            <tr><td>{{ i18n "partner_component_source_code" }}</td><td><a href="{{ .Params.source_link }}">{{ .Params.source_link }}</a></td>
+        {{ end }}
+
+        {{ if .Params.latest_release_link }}
+            <tr><td>{{ i18n "partner_component_latest_release" }}</td><td><a href="{{ .Params.latest_release_link }}">{{ .Params.latest_release_link }}</a></td>
+        {{ end }}
+
+        {{ if .Params.helm_chart_link }}
+            <tr><td>{{ i18n "partner_component_helm_chart" }}</td><td><a href="{{ .Params.helm_chart_link }}">{{ .Params.helm_chart_link }}</a></td>
+        {{ end }}
+
+        {{ if .Params.istio_versions }}
+            <tr><td>{{ printf (i18n "partner_component_istio_versions") .Params.provider }}</td><td>{{ .Params.istio_versions }}</td>
+        {{ end }}
+
+        {{ if .Params.supported_templates }}
+            {{ $templates := split .Params.supported_templates "," }}
+            <tr><td>{{ i18n "partner_component_supported_templates" }}</td><td>
+
+            {{ $base := .Site.BaseURL }}
+            {{ range $i, $t := $templates }}
+                {{- if ne $i 0 -}},{{- end -}}
+                <a href="{{ $base }}/docs/reference/config/policy-and-telemetry/templates/{{ trim $t " " }}"><code>{{ trim $t " " }}</code></a>
+            {{ end }}
+            </td>
+        {{ end }}
+    </table>
+</div>
+
+{{ .Content }}
+
+{{ partial "primary-bottom.html" . }}
+{{ end }}

scripts/grab_reference_docs.sh

@@ -57,6 +57,15 @@ locate_file() {
     PP=$(echo ${FNP} | rev | cut -d'/' -f2- | rev)
     mkdir -p content/docs${PP}/${FN}
     sed -e 's/href="https:\/\/istio.io/href="/g' ${FILENAME} >content/docs${PP}/${FN}/index.html
+
+    LEN=${#WORK_DIR}
+    REL_PATH=${FILENAME:LEN}
+    REPO=$(echo ${REL_PATH} | cut -d'/' -f2)
+
+    if [ "${REPO}" != "istio" -a "${REPO}" != "api" ]
+    then
+        sed -e 's/layout: protoc-gen-docs/layout: partner-component/g' -i "" content/docs${PP}/${FN}/index.html
+    fi
 }
 
 # Given the path and name to an Istio component, builds the component and then

src/sass/base/_common.scss

@@ -357,7 +357,7 @@ h6 {
 
 .subtitle {
     margin-top: .15rem;
-    margin-bottom: 1rem;
+    margin-bottom: 0;
     padding: 0 0 0 0;
     font-size: 125%;
 }
@@ -511,10 +511,6 @@ blockquote {
     transform: scaleX(-1);
 }
 
-.subtitle {
-    margin-bottom: 0;
-}
-
 .byline {
     margin-top: .15rem;
     margin-bottom: 2rem;
@@ -527,3 +523,21 @@ blockquote {
     font-weight: $blogAttributeWeight;
 }
 
+.partner-component-notice {
+    display: block;
+    margin: 1em 0 1em 2em;
+    @media (min-width: $bp-md) {
+        margin: 1em 3em;
+    }
+
+    padding-left: 1em;
+    padding-right: 1em;
+    background-color: $blockQuoteBackgroundColor;
+    border-radius: 4px 4px 4px 4px;
+
+    table td:first-of-type {
+        color: $textBrandColor;
+        background-color: $secondBrandColor;
+        font-weight: $tableHeaderWeight;
+    }
+}