diff --git a/dictionaries/custom.txt b/dictionaries/custom.txt index 980ac6b1e01..14c8b03d73f 100644 --- a/dictionaries/custom.txt +++ b/dictionaries/custom.txt @@ -1,5 +1,7 @@ ACK backend +balancer +Bookinfo CIDR DNS FQDN @@ -8,6 +10,7 @@ HTTP HTTP2 Istio jitter +JSON JWT Kubernetes MCP @@ -16,6 +19,7 @@ NACK namespace namespaces OIDC +programmatically RBAC RPC runtime @@ -27,8 +31,7 @@ TCP TLS UDP undiscriminated -unresolved +unmanaged unterminated URI URL - diff --git a/mesh/v1alpha1/config.pb.go b/mesh/v1alpha1/config.pb.go index 19ae37cb2c2..b8950e80436 100644 --- a/mesh/v1alpha1/config.pb.go +++ b/mesh/v1alpha1/config.pb.go @@ -34,7 +34,7 @@ const ( // contain any annotation or whose annotations match the value // specified in the ingress_class parameter described earlier. Use this // mode if Istio ingress controller will be the default ingress - // controller for the entire kubernetes cluster. + // controller for the entireKubernetes cluster. MeshConfig_DEFAULT MeshConfig_IngressControllerMode = 1 // Istio ingress controller will only act on ingress resources whose // annotations match the value specified in the ingress_class parameter @@ -156,8 +156,8 @@ func (MeshConfig_OutboundTrafficPolicy_Mode) EnumDescriptor() ([]byte, []int) { type MeshConfig struct { // Address of the server that will be used by the proxies for policy // check calls. By using different names for mixerCheckServer and - // mixerReportServer, it is possible to have one set of mixer servers handle - // policy check calls while another set of mixer servers handle telemetry + // mixerReportServer, it is possible to have one set of Mixer servers handle + // policy check calls while another set of Mixer servers handle telemetry // calls. // // NOTE: Omitting mixerCheckServer while specifying mixerReportServer is @@ -166,15 +166,15 @@ type MeshConfig struct { // Address of the server that will be used by the proxies for policy report // calls. MixerReportServer string `protobuf:"bytes,2,opt,name=mixer_report_server,json=mixerReportServer,proto3" json:"mixer_report_server,omitempty"` - // Disable policy checks by the mixer service. Default - // is false, i.e. mixer policy check is enabled by default. + // Disable policy checks by the Mixer service. Default + // is false, i.e. Mixer policy check is enabled by default. DisablePolicyChecks bool `protobuf:"varint,3,opt,name=disable_policy_checks,json=disablePolicyChecks,proto3" json:"disable_policy_checks,omitempty"` - // Allow all traffic in cases when the mixer policy service cannot be reached. + // Allow all traffic in cases when the Mixer policy service cannot be reached. // Default is false which means the traffic is denied when the client is unable // to connect to Mixer. PolicyCheckFailOpen bool `protobuf:"varint,25,opt,name=policy_check_fail_open,json=policyCheckFailOpen,proto3" json:"policy_check_fail_open,omitempty"` - // Enable session affinity for envoy mixer reports so that calls from a proxy will - // always target the same mixer instance. + // Enable session affinity for Envoy Mixer reports so that calls from a proxy will + // always target the same Mixer instance. SidecarToTelemetrySessionAffinity bool `protobuf:"varint,30,opt,name=sidecar_to_telemetry_session_affinity,json=sidecarToTelemetrySessionAffinity,proto3" json:"sidecar_to_telemetry_session_affinity,omitempty"` // Port on which Envoy should listen for incoming connections from // other services. @@ -189,7 +189,7 @@ type MeshConfig struct { // controller. This corresponds to the value of // "kubernetes.io/ingress.class" annotation. IngressClass string `protobuf:"bytes,7,opt,name=ingress_class,json=ingressClass,proto3" json:"ingress_class,omitempty"` - // Name of the kubernetes service used for the istio ingress controller. + // Name of theKubernetes service used for the istio ingress controller. IngressService string `protobuf:"bytes,8,opt,name=ingress_service,json=ingressService,proto3" json:"ingress_service,omitempty"` // Defines whether to use Istio ingress controller for annotated or all ingress resources. IngressControllerMode MeshConfig_IngressControllerMode `protobuf:"varint,9,opt,name=ingress_controller_mode,json=ingressControllerMode,proto3,enum=istio.mesh.v1alpha1.MeshConfig_IngressControllerMode" json:"ingress_controller_mode,omitempty"` @@ -228,7 +228,7 @@ type MeshConfig struct { OutboundTrafficPolicy *MeshConfig_OutboundTrafficPolicy `protobuf:"bytes,17,opt,name=outbound_traffic_policy,json=outboundTrafficPolicy,proto3" json:"outbound_traffic_policy,omitempty"` // Enables clide side policy checks. EnableClientSidePolicyCheck bool `protobuf:"varint,19,opt,name=enable_client_side_policy_check,json=enableClientSidePolicyCheck,proto3" json:"enable_client_side_policy_check,omitempty"` - // Unix Domain Socket through which envoy communicates with NodeAgent SDS to get key/cert for mTLS. + // Unix Domain Socket through which Envoy communicates with NodeAgent SDS to get key/cert for mTLS. // Use secret-mount files instead of SDS if set to empty. SdsUdsPath string `protobuf:"bytes,20,opt,name=sds_uds_path,json=sdsUdsPath,proto3" json:"sds_uds_path,omitempty"` // $hide_from_docs @@ -240,13 +240,13 @@ type MeshConfig struct { // $hide_from_docs // This flag is used by secret discovery service(SDS). // If set to true(prerequisite: https://kubernetes.io/docs/concepts/storage/volumes/#projected), Istio will inject volumes mount - // for k8s service account trustworthy JWT(which is avaialbe for k8s 1.12 or higher), so that K8s API server - // mounts k8s service account trustworthy JWT to envoy container, which will be used to request key/cert eventually. - // This isn't supported for non-k8s case. + // for Kubernetes service account trustworthy JWT(which is available with Kubernetes 1.12 or higher), so that the Kubernetes API server + // mounts Kubernetes service account trustworthy JWT to the Envoy container, which will be used to request key/cert eventually. + // This isn't supported for non-Kubernetes cases. EnableSdsTokenMount bool `protobuf:"varint,23,opt,name=enable_sds_token_mount,json=enableSdsTokenMount,proto3" json:"enable_sds_token_mount,omitempty"` // $hide_from_docs // This flag is used by secret discovery service(SDS). - // If set to true, envoy will fetch normal k8s service account JWT from '/var/run/secrets/kubernetes.io/serviceaccount/token' + // If set to true, Envoy will fetch a normal Kubernetes service account JWT from '/var/run/secrets/kubernetes.io/serviceaccount/token' // (https://kubernetes.io/docs/tasks/access-application-cluster/access-cluster/#accessing-the-api-from-a-pod) // and pass to sds server, which will be used to request key/cert eventually. // If both enable_sds_token_mount and sds_use_k8s_sa_jwt are set to true, enable_sds_token_mount(trustworthy jwt) takes precedence. @@ -643,7 +643,7 @@ type ConfigSource struct { // Use fs:/// to specify a file-based backend with absolute path to the directory. Address string `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"` // Use the tls_settings to specify the tls mode to use. If the MCP server - // uses Istio MTLS and shares the root CA with Pilot, specify the TLS + // uses Istio mutual TLS and shares the root CA with Pilot, specify the TLS // mode as ISTIO_MUTUAL. TlsSettings *v1alpha3.TLSSettings `protobuf:"bytes,2,opt,name=tls_settings,json=tlsSettings,proto3" json:"tls_settings,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` diff --git a/mesh/v1alpha1/config.proto b/mesh/v1alpha1/config.proto index b5eb7a02aeb..f31c0d2c523 100644 --- a/mesh/v1alpha1/config.proto +++ b/mesh/v1alpha1/config.proto @@ -39,8 +39,8 @@ option go_package="istio.io/api/mesh/v1alpha1"; message MeshConfig { // Address of the server that will be used by the proxies for policy // check calls. By using different names for mixerCheckServer and - // mixerReportServer, it is possible to have one set of mixer servers handle - // policy check calls while another set of mixer servers handle telemetry + // mixerReportServer, it is possible to have one set of Mixer servers handle + // policy check calls while another set of Mixer servers handle telemetry // calls. // // NOTE: Omitting mixerCheckServer while specifying mixerReportServer is @@ -51,17 +51,17 @@ message MeshConfig { // calls. string mixer_report_server = 2; - // Disable policy checks by the mixer service. Default - // is false, i.e. mixer policy check is enabled by default. + // Disable policy checks by the Mixer service. Default + // is false, i.e. Mixer policy check is enabled by default. bool disable_policy_checks = 3; - // Allow all traffic in cases when the mixer policy service cannot be reached. + // Allow all traffic in cases when the Mixer policy service cannot be reached. // Default is false which means the traffic is denied when the client is unable // to connect to Mixer. bool policy_check_fail_open = 25; - // Enable session affinity for envoy mixer reports so that calls from a proxy will - // always target the same mixer instance. + // Enable session affinity for Envoy Mixer reports so that calls from a proxy will + // always target the same Mixer instance. bool sidecar_to_telemetry_session_affinity = 30; // Port on which Envoy should listen for incoming connections from @@ -82,7 +82,7 @@ message MeshConfig { // "kubernetes.io/ingress.class" annotation. string ingress_class = 7; - // Name of the kubernetes service used for the istio ingress controller. + // Name of theKubernetes service used for the istio ingress controller. string ingress_service = 8; enum IngressControllerMode { @@ -93,7 +93,7 @@ message MeshConfig { // contain any annotation or whose annotations match the value // specified in the ingress_class parameter described earlier. Use this // mode if Istio ingress controller will be the default ingress - // controller for the entire kubernetes cluster. + // controller for the entireKubernetes cluster. DEFAULT = 1; // Istio ingress controller will only act on ingress resources whose @@ -182,7 +182,7 @@ message MeshConfig { // Enables clide side policy checks. bool enable_client_side_policy_check = 19; - // Unix Domain Socket through which envoy communicates with NodeAgent SDS to get key/cert for mTLS. + // Unix Domain Socket through which Envoy communicates with NodeAgent SDS to get key/cert for mTLS. // Use secret-mount files instead of SDS if set to empty. string sds_uds_path = 20; @@ -197,14 +197,14 @@ message MeshConfig { // $hide_from_docs // This flag is used by secret discovery service(SDS). // If set to true(prerequisite: https://kubernetes.io/docs/concepts/storage/volumes/#projected), Istio will inject volumes mount - // for k8s service account trustworthy JWT(which is avaialbe for k8s 1.12 or higher), so that K8s API server - // mounts k8s service account trustworthy JWT to envoy container, which will be used to request key/cert eventually. - // This isn't supported for non-k8s case. + // for Kubernetes service account trustworthy JWT(which is available with Kubernetes 1.12 or higher), so that the Kubernetes API server + // mounts Kubernetes service account trustworthy JWT to the Envoy container, which will be used to request key/cert eventually. + // This isn't supported for non-Kubernetes cases. bool enable_sds_token_mount = 23; // $hide_from_docs // This flag is used by secret discovery service(SDS). - // If set to true, envoy will fetch normal k8s service account JWT from '/var/run/secrets/kubernetes.io/serviceaccount/token' + // If set to true, Envoy will fetch a normal Kubernetes service account JWT from '/var/run/secrets/kubernetes.io/serviceaccount/token' // (https://kubernetes.io/docs/tasks/access-application-cluster/access-cluster/#accessing-the-api-from-a-pod) // and pass to sds server, which will be used to request key/cert eventually. // If both enable_sds_token_mount and sds_use_k8s_sa_jwt are set to true, enable_sds_token_mount(trustworthy jwt) takes precedence. @@ -294,7 +294,7 @@ message ConfigSource { string address = 1; // Use the tls_settings to specify the tls mode to use. If the MCP server - // uses Istio MTLS and shares the root CA with Pilot, specify the TLS + // uses Istio mutual TLS and shares the root CA with Pilot, specify the TLS // mode as ISTIO_MUTUAL. istio.networking.v1alpha3.TLSSettings tls_settings = 2; } diff --git a/mesh/v1alpha1/istio.mesh.v1alpha1.pb.html b/mesh/v1alpha1/istio.mesh.v1alpha1.pb.html index 9eb2845c92f..9be1af96825 100644 --- a/mesh/v1alpha1/istio.mesh.v1alpha1.pb.html +++ b/mesh/v1alpha1/istio.mesh.v1alpha1.pb.html @@ -78,7 +78,7 @@

ConfigSource

istio.networking.v1alpha3.TLSSettings

Use the tlssettings to specify the tls mode to use. If the MCP server -uses Istio MTLS and shares the root CA with Pilot, specify the TLS +uses Istio mutual TLS and shares the root CA with Pilot, specify the TLS mode as ISTIOMUTUAL.

@@ -275,8 +275,8 @@

MeshConfig

Address of the server that will be used by the proxies for policy check calls. By using different names for mixerCheckServer and -mixerReportServer, it is possible to have one set of mixer servers handle -policy check calls while another set of mixer servers handle telemetry +mixerReportServer, it is possible to have one set of Mixer servers handle +policy check calls while another set of Mixer servers handle telemetry calls.

NOTE: Omitting mixerCheckServer while specifying mixerReportServer is @@ -297,8 +297,8 @@

MeshConfig

disablePolicyChecks bool -

Disable policy checks by the mixer service. Default -is false, i.e. mixer policy check is enabled by default.

+

Disable policy checks by the Mixer service. Default +is false, i.e. Mixer policy check is enabled by default.

@@ -306,7 +306,7 @@

MeshConfig

policyCheckFailOpen bool -

Allow all traffic in cases when the mixer policy service cannot be reached. +

Allow all traffic in cases when the Mixer policy service cannot be reached. Default is false which means the traffic is denied when the client is unable to connect to Mixer.

@@ -316,8 +316,8 @@

MeshConfig

sidecarToTelemetrySessionAffinity bool -

Enable session affinity for envoy mixer reports so that calls from a proxy will -always target the same mixer instance.

+

Enable session affinity for Envoy Mixer reports so that calls from a proxy will +always target the same Mixer instance.

@@ -368,7 +368,7 @@

MeshConfig

ingressService string -

Name of the kubernetes service used for the istio ingress controller.

+

Name of theKubernetes service used for the istio ingress controller.

@@ -455,7 +455,7 @@

MeshConfig

sdsUdsPath string -

Unix Domain Socket through which envoy communicates with NodeAgent SDS to get key/cert for mTLS. +

Unix Domain Socket through which Envoy communicates with NodeAgent SDS to get key/cert for mTLS. Use secret-mount files instead of SDS if set to empty.

@@ -538,7 +538,7 @@

MeshConfig.IngressControllerMode

contain any annotation or whose annotations match the value specified in the ingress_class parameter described earlier. Use this mode if Istio ingress controller will be the default ingress -controller for the entire kubernetes cluster.

+controller for the entireKubernetes cluster.

@@ -614,7 +614,7 @@

MeshNetworks

networks: - network1: - endpoints: - - fromRegistry: registry1 #must match secret name in kubernetes + - fromRegistry: registry1 #must match secret name inKubernetes - fromCidr: 192.168.100.0/22 #a VM network for example gateways: - registryServiceName: istio-ingressgateway.istio-system.svc.cluster.local diff --git a/mesh/v1alpha1/network.pb.go b/mesh/v1alpha1/network.pb.go index d29f114fd78..078d6a26104 100644 --- a/mesh/v1alpha1/network.pb.go +++ b/mesh/v1alpha1/network.pb.go @@ -425,7 +425,7 @@ func _Network_IstioNetworkGateway_OneofSizer(msg proto.Message) (n int) { // networks: // - network1: // - endpoints: -// - fromRegistry: registry1 #must match secret name in kubernetes +// - fromRegistry: registry1 #must match secret name inKubernetes // - fromCidr: 192.168.100.0/22 #a VM network for example // gateways: // - registryServiceName: istio-ingressgateway.istio-system.svc.cluster.local diff --git a/mesh/v1alpha1/network.proto b/mesh/v1alpha1/network.proto index 1fed56778e3..a55c416cfe5 100644 --- a/mesh/v1alpha1/network.proto +++ b/mesh/v1alpha1/network.proto @@ -99,7 +99,7 @@ message Network { // networks: // - network1: // - endpoints: -// - fromRegistry: registry1 #must match secret name in kubernetes +// - fromRegistry: registry1 #must match secret name inKubernetes // - fromCidr: 192.168.100.0/22 #a VM network for example // gateways: // - registryServiceName: istio-ingressgateway.istio-system.svc.cluster.local diff --git a/mixer/adapter/model/v1beta1/istio.mixer.adapter.model.v1beta1.pb.html b/mixer/adapter/model/v1beta1/istio.mixer.adapter.model.v1beta1.pb.html index 8ab59eb324a..2686c2826cc 100644 --- a/mixer/adapter/model/v1beta1/istio.mixer.adapter.model.v1beta1.pb.html +++ b/mixer/adapter/model/v1beta1/istio.mixer.adapter.model.v1beta1.pb.html @@ -407,7 +407,7 @@

ReportResult

Template

-

Template provides the details of a mixer template.

+

Template provides the details of a Mixer template.

diff --git a/mixer/adapter/model/v1beta1/template.pb.go b/mixer/adapter/model/v1beta1/template.pb.go index 1e5424cd0d6..ac853940e78 100644 --- a/mixer/adapter/model/v1beta1/template.pb.go +++ b/mixer/adapter/model/v1beta1/template.pb.go @@ -23,7 +23,7 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion2 // please upgrade the proto package -// Template provides the details of a mixer template. +// Template provides the details of a Mixer template. type Template struct { // Base64 encoded proto descriptor of the template. Descriptor_ string `protobuf:"bytes,1,opt,name=descriptor,proto3" json:"descriptor,omitempty"` diff --git a/mixer/adapter/model/v1beta1/template.proto b/mixer/adapter/model/v1beta1/template.proto index 59d2b7381dc..935e232b028 100644 --- a/mixer/adapter/model/v1beta1/template.proto +++ b/mixer/adapter/model/v1beta1/template.proto @@ -18,7 +18,7 @@ package istio.mixer.adapter.model.v1beta1; option go_package="istio.io/api/mixer/adapter/model/v1beta1"; -// Template provides the details of a mixer template. +// Template provides the details of a Mixer template. message Template { // Base64 encoded proto descriptor of the template. string descriptor = 1; diff --git a/mixer/v1/config/client/client_config.pb.go b/mixer/v1/config/client/client_config.pb.go index b6b85b74966..85f5b24cd49 100644 --- a/mixer/v1/config/client/client_config.pb.go +++ b/mixer/v1/config/client/client_config.pb.go @@ -176,13 +176,13 @@ type TransportConfig struct { // Specifies the behavior when the client is unable to connect to Mixer. // This is the mesh level policy. The default value for policy is FAIL_OPEN. NetworkFailPolicy *NetworkFailPolicy `protobuf:"bytes,4,opt,name=network_fail_policy,json=networkFailPolicy,proto3" json:"network_fail_policy,omitempty"` - // Specify refresh interval to write mixer client statistics to Envoy share + // Specify refresh interval to write Mixer client statistics to Envoy share // memory. If not specified, the interval is 10 seconds. StatsUpdateInterval *types.Duration `protobuf:"bytes,5,opt,name=stats_update_interval,json=statsUpdateInterval,proto3" json:"stats_update_interval,omitempty"` // Name of the cluster that will forward check calls to a pool of mixer // servers. Defaults to "mixer_server". By using different names for // checkCluster and reportCluster, it is possible to have one set of - // mixer servers handle check calls, while another set of mixer servers + // Mixer servers handle check calls, while another set of Mixer servers // handle report calls. // // NOTE: Any value other than the default "mixer_server" will require the @@ -191,13 +191,13 @@ type TransportConfig struct { // Name of the cluster that will forward report calls to a pool of mixer // servers. Defaults to "mixer_server". By using different names for // checkCluster and reportCluster, it is possible to have one set of - // mixer servers handle check calls, while another set of mixer servers + // Mixer servers handle check calls, while another set of Mixer servers // handle report calls. // // NOTE: Any value other than the default "mixer_server" will require the // Istio Grafana dashboards to be reconfigured to use the new name. ReportCluster string `protobuf:"bytes,7,opt,name=report_cluster,json=reportCluster,proto3" json:"report_cluster,omitempty"` - // Default attributes to forward to mixer upstream. This typically + // Default attributes to forward to Mixer upstream. This typically // includes the "source.ip" and "source.uid" attributes. These // attributes are consumed by the proxy in front of mixer. AttributesForMixerProxy *v1.Attributes `protobuf:"bytes,8,opt,name=attributes_for_mixer_proxy,json=attributesForMixerProxy,proto3" json:"attributes_for_mixer_proxy,omitempty"` @@ -295,9 +295,9 @@ type TcpClientConfig struct { // Report. This typically includes "destination.ip" and // "destination.uid" attributes. MixerAttributes *v1.Attributes `protobuf:"bytes,2,opt,name=mixer_attributes,json=mixerAttributes,proto3" json:"mixer_attributes,omitempty"` - // If set to true, disables mixer check calls. + // If set to true, disables Mixer check calls. DisableCheckCalls bool `protobuf:"varint,3,opt,name=disable_check_calls,json=disableCheckCalls,proto3" json:"disable_check_calls,omitempty"` - // If set to true, disables mixer check calls. + // If set to true, disables Mixer check calls. DisableReportCalls bool `protobuf:"varint,4,opt,name=disable_report_calls,json=disableReportCalls,proto3" json:"disable_report_calls,omitempty"` // Quota specifications to generate quota requirements. // It applies on the new TCP connections. diff --git a/mixer/v1/config/client/client_config.proto b/mixer/v1/config/client/client_config.proto index d5f0c603a98..27568888f20 100644 --- a/mixer/v1/config/client/client_config.proto +++ b/mixer/v1/config/client/client_config.proto @@ -114,14 +114,14 @@ message TransportConfig { // This is the mesh level policy. The default value for policy is FAIL_OPEN. NetworkFailPolicy network_fail_policy = 4; - // Specify refresh interval to write mixer client statistics to Envoy share + // Specify refresh interval to write Mixer client statistics to Envoy share // memory. If not specified, the interval is 10 seconds. google.protobuf.Duration stats_update_interval = 5; // Name of the cluster that will forward check calls to a pool of mixer // servers. Defaults to "mixer_server". By using different names for // checkCluster and reportCluster, it is possible to have one set of - // mixer servers handle check calls, while another set of mixer servers + // Mixer servers handle check calls, while another set of Mixer servers // handle report calls. // // NOTE: Any value other than the default "mixer_server" will require the @@ -131,14 +131,14 @@ message TransportConfig { // Name of the cluster that will forward report calls to a pool of mixer // servers. Defaults to "mixer_server". By using different names for // checkCluster and reportCluster, it is possible to have one set of - // mixer servers handle check calls, while another set of mixer servers + // Mixer servers handle check calls, while another set of Mixer servers // handle report calls. // // NOTE: Any value other than the default "mixer_server" will require the // Istio Grafana dashboards to be reconfigured to use the new name. string report_cluster = 7; - // Default attributes to forward to mixer upstream. This typically + // Default attributes to forward to Mixer upstream. This typically // includes the "source.ip" and "source.uid" attributes. These // attributes are consumed by the proxy in front of mixer. Attributes attributes_for_mixer_proxy = 8; @@ -178,10 +178,10 @@ message TcpClientConfig { // "destination.uid" attributes. Attributes mixer_attributes = 2; - // If set to true, disables mixer check calls. + // If set to true, disables Mixer check calls. bool disable_check_calls = 3; - // If set to true, disables mixer check calls. + // If set to true, disables Mixer check calls. bool disable_report_calls = 4; // Quota specifications to generate quota requirements. diff --git a/mixer/v1/config/client/istio.mixer.v1.config.client.pb.html b/mixer/v1/config/client/istio.mixer.v1.config.client.pb.html index adaa67a067d..90fdffac767 100644 --- a/mixer/v1/config/client/istio.mixer.v1.config.client.pb.html +++ b/mixer/v1/config/client/istio.mixer.v1.config.client.pb.html @@ -902,7 +902,7 @@

TcpClientConfig

@@ -910,7 +910,7 @@

TcpClientConfig

@@ -986,7 +986,7 @@

TransportConfig

@@ -998,7 +998,7 @@

TransportConfig

Name of the cluster that will forward check calls to a pool of mixer servers. Defaults to “mixer_server”. By using different names for checkCluster and reportCluster, it is possible to have one set of -mixer servers handle check calls, while another set of mixer servers +Mixer servers handle check calls, while another set of Mixer servers handle report calls.

NOTE: Any value other than the default “mixer_server” will require the @@ -1013,7 +1013,7 @@

TransportConfig

Name of the cluster that will forward report calls to a pool of mixer servers. Defaults to “mixer_server”. By using different names for checkCluster and reportCluster, it is possible to have one set of -mixer servers handle check calls, while another set of mixer servers +Mixer servers handle check calls, while another set of Mixer servers handle report calls.

NOTE: Any value other than the default “mixer_server” will require the @@ -1025,7 +1025,7 @@

TransportConfig

@@ -332,9 +332,9 @@

Server

diff --git a/networking/v1alpha3/gateway.proto b/networking/v1alpha3/gateway.proto index 4a5877cb952..04c81cf2c50 100644 --- a/networking/v1alpha3/gateway.proto +++ b/networking/v1alpha3/gateway.proto @@ -232,13 +232,13 @@ message Gateway { // ``` message Server { // REQUIRED: The Port on which the proxy should listen for incoming - // connections. If using unix domain socket, use 0 as the port number, + // connections. If using Unix domain socket, use 0 as the port number, // with a valid protocol and port name, along with the bind parameter. Port port = 1; // $hide_from_docs - // The ip or the unix domain socket to which the listener should be bound - // to. Format: x.x.x.x or unix:///path/to/uds or unix://@foobar (Linux + // The ip or the Unix domain socket to which the listener should be bound + // to. Format: `x.x.x.x` or `unix:///path/to/uds` or `unix://@foobar` (Linux // abstract namespace). string bind = 4; @@ -361,9 +361,9 @@ message Server { // https, and the TLS modes to use. TLSOptions tls = 3; - // The loopback IP endpoint or unix domain socket to which traffic should - // be forwarded to by default. Format should be 127.0.0.1:PORT or - // unix:///path/to/socket or unix://@foobar (Linux abstract namespace). + // The loopback IP endpoint or Unix domain socket to which traffic should + // be forwarded to by default. Format should be `127.0.0.1:PORT` or + // `unix:///path/to/socket` or `unix://@foobar` (Linux abstract namespace). string default_endpoint = 5; } diff --git a/networking/v1alpha3/service_entry.pb.go b/networking/v1alpha3/service_entry.pb.go index 12464c95134..b1f3d9d3a9f 100644 --- a/networking/v1alpha3/service_entry.pb.go +++ b/networking/v1alpha3/service_entry.pb.go @@ -441,7 +441,7 @@ type ServiceEntry struct { // addresses are not supported in this field. Addresses []string `protobuf:"bytes,2,rep,name=addresses,proto3" json:"addresses,omitempty"` // REQUIRED. The ports associated with the external service. If the - // Endpoints are unix domain socket addresses, there must be exactly one + // Endpoints are Unix domain socket addresses, there must be exactly one // port. Ports []*Port `protobuf:"bytes,3,rep,name=ports,proto3" json:"ports,omitempty"` // Specify whether the service should be considered external to the mesh @@ -580,7 +580,7 @@ type ServiceEntry_Endpoint struct { // REQUIRED: Address associated with the network endpoint without the // port. Domain names can be used if and only if the resolution is set // to DNS, and must be fully-qualified without wildcards. Use the form - // unix:///absolute/path/to/socket for unix domain socket endpoints. + // unix:///absolute/path/to/socket for Unix domain socket endpoints. Address string `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"` // Set of ports associated with the endpoint. The ports must be // associated with a port name that was declared as part of the diff --git a/networking/v1alpha3/service_entry.pb.html b/networking/v1alpha3/service_entry.pb.html index 3846c14e82d..486603eafa3 100644 --- a/networking/v1alpha3/service_entry.pb.html +++ b/networking/v1alpha3/service_entry.pb.html @@ -351,7 +351,7 @@

ServiceEntry

@@ -446,7 +446,7 @@

ServiceEntry.Endpoint

REQUIRED: Address associated with the network endpoint without the port. Domain names can be used if and only if the resolution is set to DNS, and must be fully-qualified without wildcards. Use the form -unix:///absolute/path/to/socket for unix domain socket endpoints.

+unix:///absolute/path/to/socket for Unix domain socket endpoints.

diff --git a/networking/v1alpha3/service_entry.proto b/networking/v1alpha3/service_entry.proto index 13510f3c3ea..a9de02c6067 100644 --- a/networking/v1alpha3/service_entry.proto +++ b/networking/v1alpha3/service_entry.proto @@ -356,7 +356,7 @@ message ServiceEntry { repeated string addresses = 2; // REQUIRED. The ports associated with the external service. If the - // Endpoints are unix domain socket addresses, there must be exactly one + // Endpoints are Unix domain socket addresses, there must be exactly one // port. repeated Port ports = 3; @@ -426,7 +426,7 @@ message ServiceEntry { // REQUIRED: Address associated with the network endpoint without the // port. Domain names can be used if and only if the resolution is set // to DNS, and must be fully-qualified without wildcards. Use the form - // unix:///absolute/path/to/socket for unix domain socket endpoints. + // unix:///absolute/path/to/socket for Unix domain socket endpoints. string address = 1; // Set of ports associated with the endpoint. The ports must be diff --git a/networking/v1alpha3/sidecar.pb.go b/networking/v1alpha3/sidecar.pb.go index e520774c021..a098aa94e49 100644 --- a/networking/v1alpha3/sidecar.pb.go +++ b/networking/v1alpha3/sidecar.pb.go @@ -49,7 +49,7 @@ // // The example below declares a Sidecar resource in the prod-us1 namespace // that accepts inbound HTTP traffic on port 9080 and forwards -// it to the attached workload listening on a unix domain socket. In the +// it to the attached workload listening on a Unix domain socket. In the // egress direction, in addition to the istio-system namespace, the sidecar // proxies only HTTP traffic bound for port 9080 for services in the // prod-us1 namespace. @@ -144,13 +144,13 @@ type Sidecar struct { WorkloadSelector *WorkloadSelector `protobuf:"bytes,1,opt,name=workload_selector,json=workloadSelector,proto3" json:"workload_selector,omitempty"` // Ingress specifies the configuration of the sidecar for processing // inbound traffic to the attached workload. If omitted, Istio will - // autoconfigure the sidecar based on the information about the workload + // automatically configure the sidecar based on the information about the workload // obtained from the orchestration platform (e.g., exposed ports, services, // etc.). Ingress []*IstioIngressListener `protobuf:"bytes,2,rep,name=ingress,proto3" json:"ingress,omitempty"` // Egress specifies the configuration of the sidecar for processing // outbound traffic from the attached workload to other services in the - // mesh. If omitted, Istio will autoconfigure the sidecar to be able to + // mesh. If omitted, Istio will automatically configure the sidecar to be able to // reach every service in the mesh that is visible to this namespace. Egress []*IstioEgressListener `protobuf:"bytes,3,rep,name=egress,proto3" json:"egress,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` @@ -216,23 +216,23 @@ func (m *Sidecar) GetEgress() []*IstioEgressListener { // traffic listener on the sidecar proxy attached to a workload. type IstioIngressListener struct { // REQUIRED. The port associated with the listener. If using - // unix domain socket, use 0 as the port number, with a valid + // Unix domain socket, use 0 as the port number, with a valid // protocol. Port *Port `protobuf:"bytes,1,opt,name=port,proto3" json:"port,omitempty"` - // The ip or the unix domain socket to which the listener should be bound - // to. Format: x.x.x.x or unix:///path/to/uds or unix://@foobar (Linux - // abstract namespace). If omitted, Istio will autoconfigure the defaults + // The ip or the Unix domain socket to which the listener should be bound + // to. Format: `x.x.x.x` or `unix:///path/to/uds` or `unix://@foobar` (Linux + // abstract namespace). If omitted, Istio will automatically configure the defaults // based on imported services and the workload to which this // configuration is applied to. Bind string `protobuf:"bytes,2,opt,name=bind,proto3" json:"bind,omitempty"` // When the bind address is an IP, the captureMode option dictates // how traffic to the listener is expected to be captured (or not). - // captureMode must be DEFAULT or NONE for unix domain socket binds. + // captureMode must be DEFAULT or NONE for Unix domain socket binds. CaptureMode CaptureMode `protobuf:"varint,3,opt,name=capture_mode,json=captureMode,proto3,enum=istio.networking.v1alpha3.CaptureMode" json:"capture_mode,omitempty"` - // REQUIRED: The loopback IP endpoint or unix domain socket to which + // REQUIRED: The loopback IP endpoint or Unix domain socket to which // traffic should be forwarded to. This configuration can be used to // redirect traffic arriving at the bind point on the sidecar to a port - // or unix domain socket where the application workload is listening for + // or Unix domain socket where the application workload is listening for // connections. Format should be 127.0.0.1:PORT or unix:///path/to/socket DefaultEndpoint string `protobuf:"bytes,4,opt,name=default_endpoint,json=defaultEndpoint,proto3" json:"default_endpoint,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` @@ -304,7 +304,7 @@ func (m *IstioIngressListener) GetDefaultEndpoint() string { // IstioEgressListener specifies the properties of an outbound traffic // listener on the sidecar proxy attached to a workload. type IstioEgressListener struct { - // The port associated with the listener. If using unix domain socket, + // The port associated with the listener. If using Unix domain socket, // use 0 as the port number, with a valid protocol. The port if // specified, will be used as the default destination port associated // with the imported hosts. If the port is omitted, Istio will infer the @@ -314,23 +314,23 @@ type IstioEgressListener struct { // listener port will be based on the listener with the most specific // port. Port *Port `protobuf:"bytes,1,opt,name=port,proto3" json:"port,omitempty"` - // The ip or the unix domain socket to which the listener should be bound - // to. Port MUST be specified if bind is not empty. Format: x.x.x.x or - // unix:///path/to/uds or unix://@foobar (Linux abstract namespace). If - // omitted, Istio will autoconfigure the defaults based on imported + // The ip or the Unix domain socket to which the listener should be bound + // to. Port MUST be specified if bind is not empty. Format: `x.x.x.x` or + // `unix:///path/to/uds` or `unix://@foobar` (Linux abstract namespace). If + // omitted, Istio will automatically configure the defaults based on imported // services, the workload to which this configuration is applied to and // the captureMode. If captureMode is NONE, bind will default to // 127.0.0.1. Bind string `protobuf:"bytes,2,opt,name=bind,proto3" json:"bind,omitempty"` // When the bind address is an IP, the captureMode option dictates // how traffic to the listener is expected to be captured (or not). - // captureMode must be DEFAULT or NONE for unix domain socket binds. + // captureMode must be DEFAULT or NONE for Unix domain socket binds. CaptureMode CaptureMode `protobuf:"varint,3,opt,name=capture_mode,json=captureMode,proto3,enum=istio.networking.v1alpha3.CaptureMode" json:"capture_mode,omitempty"` // REQUIRED: One or more services/virtualServices exposed by the listener // in namespace/dnsName format. Publicly scoped services and // VirtualServices from remote namespaces corresponding to the specified // hosts will be imported. The service in a namespace can be a service in - // the service registry (e.g., a kubernetes or cloud foundry service) or + // the service registry (e.g., a Kubernetes or cloud foundry service) or // a service specified via ServiceEntry configuration. In addition, any // publicly scoped DestinationRule associated with the imported services // will also be imported. diff --git a/networking/v1alpha3/sidecar.pb.html b/networking/v1alpha3/sidecar.pb.html index 172162066fd..6c92d7d1f94 100644 --- a/networking/v1alpha3/sidecar.pb.html +++ b/networking/v1alpha3/sidecar.pb.html @@ -53,7 +53,7 @@

The example below declares a Sidecar resource in the prod-us1 namespace that accepts inbound HTTP traffic on port 9080 and forwards -it to the attached workload listening on a unix domain socket. In the +it to the attached workload listening on a Unix domain socket. In the egress direction, in addition to the istio-system namespace, the sidecar proxies only HTTP traffic bound for port 9080 for services in the prod-us1 namespace.

@@ -140,7 +140,7 @@

IstioEgressListener

@@ -184,7 +184,7 @@

IstioEgressListener

in namespace/dnsName format. Publicly scoped services and VirtualServices from remote namespaces corresponding to the specified hosts will be imported. The service in a namespace can be a service in -the service registry (e.g., a kubernetes or cloud foundry service) or +the service registry (e.g., a Kubernetes or cloud foundry service) or a service specified via ServiceEntry configuration. In addition, any publicly scoped DestinationRule associated with the imported services will also be imported.

@@ -223,7 +223,7 @@

IstioIngressListener

@@ -232,9 +232,9 @@

IstioIngressListener

@@ -254,10 +254,10 @@

IstioIngressListener

@@ -293,7 +293,7 @@

Sidecar

diff --git a/networking/v1alpha3/sidecar.proto b/networking/v1alpha3/sidecar.proto index 2db96f12a93..3fd1d7da743 100644 --- a/networking/v1alpha3/sidecar.proto +++ b/networking/v1alpha3/sidecar.proto @@ -68,7 +68,7 @@ import "networking/v1alpha3/gateway.proto"; // // The example below declares a Sidecar resource in the prod-us1 namespace // that accepts inbound HTTP traffic on port 9080 and forwards -// it to the attached workload listening on a unix domain socket. In the +// it to the attached workload listening on a Unix domain socket. In the // egress direction, in addition to the istio-system namespace, the sidecar // proxies only HTTP traffic bound for port 9080 for services in the // prod-us1 namespace. @@ -110,14 +110,14 @@ message Sidecar { // Ingress specifies the configuration of the sidecar for processing // inbound traffic to the attached workload. If omitted, Istio will - // autoconfigure the sidecar based on the information about the workload + // automatically configure the sidecar based on the information about the workload // obtained from the orchestration platform (e.g., exposed ports, services, // etc.). repeated IstioIngressListener ingress = 2; // Egress specifies the configuration of the sidecar for processing // outbound traffic from the attached workload to other services in the - // mesh. If omitted, Istio will autoconfigure the sidecar to be able to + // mesh. If omitted, Istio will automatically configure the sidecar to be able to // reach every service in the mesh that is visible to this namespace. repeated IstioEgressListener egress = 3; } @@ -126,26 +126,26 @@ message Sidecar { // traffic listener on the sidecar proxy attached to a workload. message IstioIngressListener { // REQUIRED. The port associated with the listener. If using - // unix domain socket, use 0 as the port number, with a valid + // Unix domain socket, use 0 as the port number, with a valid // protocol. Port port = 1; - // The ip or the unix domain socket to which the listener should be bound - // to. Format: x.x.x.x or unix:///path/to/uds or unix://@foobar (Linux - // abstract namespace). If omitted, Istio will autoconfigure the defaults + // The ip or the Unix domain socket to which the listener should be bound + // to. Format: `x.x.x.x` or `unix:///path/to/uds` or `unix://@foobar` (Linux + // abstract namespace). If omitted, Istio will automatically configure the defaults // based on imported services and the workload to which this // configuration is applied to. string bind = 2; // When the bind address is an IP, the captureMode option dictates // how traffic to the listener is expected to be captured (or not). - // captureMode must be DEFAULT or NONE for unix domain socket binds. + // captureMode must be DEFAULT or NONE for Unix domain socket binds. CaptureMode capture_mode = 3; - // REQUIRED: The loopback IP endpoint or unix domain socket to which + // REQUIRED: The loopback IP endpoint or Unix domain socket to which // traffic should be forwarded to. This configuration can be used to // redirect traffic arriving at the bind point on the sidecar to a port - // or unix domain socket where the application workload is listening for + // or Unix domain socket where the application workload is listening for // connections. Format should be 127.0.0.1:PORT or unix:///path/to/socket string default_endpoint = 4; } @@ -153,7 +153,7 @@ message IstioIngressListener { // IstioEgressListener specifies the properties of an outbound traffic // listener on the sidecar proxy attached to a workload. message IstioEgressListener { - // The port associated with the listener. If using unix domain socket, + // The port associated with the listener. If using Unix domain socket, // use 0 as the port number, with a valid protocol. The port if // specified, will be used as the default destination port associated // with the imported hosts. If the port is omitted, Istio will infer the @@ -164,10 +164,10 @@ message IstioEgressListener { // port. Port port = 1; - // The ip or the unix domain socket to which the listener should be bound - // to. Port MUST be specified if bind is not empty. Format: x.x.x.x or - // unix:///path/to/uds or unix://@foobar (Linux abstract namespace). If - // omitted, Istio will autoconfigure the defaults based on imported + // The ip or the Unix domain socket to which the listener should be bound + // to. Port MUST be specified if bind is not empty. Format: `x.x.x.x` or + // `unix:///path/to/uds` or `unix://@foobar` (Linux abstract namespace). If + // omitted, Istio will automatically configure the defaults based on imported // services, the workload to which this configuration is applied to and // the captureMode. If captureMode is NONE, bind will default to // 127.0.0.1. @@ -175,14 +175,14 @@ message IstioEgressListener { // When the bind address is an IP, the captureMode option dictates // how traffic to the listener is expected to be captured (or not). - // captureMode must be DEFAULT or NONE for unix domain socket binds. + // captureMode must be DEFAULT or NONE for Unix domain socket binds. CaptureMode capture_mode = 3; // REQUIRED: One or more services/virtualServices exposed by the listener // in namespace/dnsName format. Publicly scoped services and // VirtualServices from remote namespaces corresponding to the specified // hosts will be imported. The service in a namespace can be a service in - // the service registry (e.g., a kubernetes or cloud foundry service) or + // the service registry (e.g., a Kubernetes or cloud foundry service) or // a service specified via ServiceEntry configuration. In addition, any // publicly scoped DestinationRule associated with the imported services // will also be imported. diff --git a/networking/v1alpha3/virtual_service.pb.go b/networking/v1alpha3/virtual_service.pb.go index e8dbbba0fbd..dc79fdf24e0 100644 --- a/networking/v1alpha3/virtual_service.pb.go +++ b/networking/v1alpha3/virtual_service.pb.go @@ -284,7 +284,7 @@ func (m *VirtualService) GetExportTo() []string { // // The following Kubernetes example routes all traffic by default to pods // of the reviews service with label "version: v1" (i.e., subset v1), and -// some to subset v2, in a kubernetes environment. +// some to subset v2, in a Kubernetes environment. // // ```yaml // apiVersion: networking.istio.io/v1alpha3 diff --git a/networking/v1alpha3/virtual_service.pb.html b/networking/v1alpha3/virtual_service.pb.html index ccb2621298e..c55e804f1fd 100644 --- a/networking/v1alpha3/virtual_service.pb.html +++ b/networking/v1alpha3/virtual_service.pb.html @@ -216,7 +216,7 @@

Destination

The following Kubernetes example routes all traffic by default to pods of the reviews service with label “version: v1” (i.e., subset v1), and -some to subset v2, in a kubernetes environment.

+some to subset v2, in a Kubernetes environment.

apiVersion: networking.istio.io/v1alpha3
 kind: VirtualService
diff --git a/networking/v1alpha3/virtual_service.proto b/networking/v1alpha3/virtual_service.proto
index a05b190e76b..dadf6fe195f 100644
--- a/networking/v1alpha3/virtual_service.proto
+++ b/networking/v1alpha3/virtual_service.proto
@@ -212,7 +212,7 @@ message VirtualService {
 //
 // The following Kubernetes example routes all traffic by default to pods
 // of the reviews service with label "version: v1" (i.e., subset v1), and
-// some to subset v2, in a kubernetes environment.
+// some to subset v2, in a Kubernetes environment.
 //
 // ```yaml
 // apiVersion: networking.istio.io/v1alpha3
diff --git a/policy/v1beta1/cfg.pb.go b/policy/v1beta1/cfg.pb.go
index 331e46b523c..1feea86699b 100644
--- a/policy/v1beta1/cfg.pb.go
+++ b/policy/v1beta1/cfg.pb.go
@@ -672,7 +672,7 @@ func (m *Instance) GetAttributeBindings() map[string]string {
 // Each adapter implementation defines its own `params` proto.
 //
 // In the following example we define a `metrics` handler for the `prometheus` adapter.
-// The example is in the form of a kubernetes resource:
+// The example is in the form of a Kubernetes resource:
 // * The `metadata.name` is the name of the handler
 // * The `kind` refers to the adapter name
 // * The `spec` block represents adapter-specific configuration as well as the connection information
@@ -720,7 +720,7 @@ func (m *Instance) GetAttributeBindings() map[string]string {
 // ---
 // ```
 type Handler struct {
-	// Required. Must be unique in the entire mixer configuration. Used by [Actions][istio.policy.v1beta1.Action.handler]
+	// Required. Must be unique in the entire Mixer configuration. Used by [Actions][istio.policy.v1beta1.Action.handler]
 	// to refer to this handler.
 	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
 	// Required. The name of the compiled in adapter this handler instantiates. For referencing non compiled-in
@@ -1625,17 +1625,17 @@ func (m *OAuth) GetEndpointParams() map[string]string {
 	return nil
 }
 
-// Mutual let operator specify tls config for mixer as client if mtls is used to
+// Mutual let operator specify TLS configuration for Mixer as client if mutual TLS is used to
 // secure connection to adapter backend.
 type Mutual struct {
-	// The path to the file holding the private key for mtls. If omitted, the
-	// default mixer private key will be used.
+	// The path to the file holding the private key for mutual TLS. If omitted, the
+	// default Mixer private key will be used.
 	PrivateKey string `protobuf:"bytes,1,opt,name=private_key,json=privateKey,proto3" json:"private_key,omitempty"`
-	// The path to the file holding client certificate for mtls. If omitted, the
-	// default mixer certificates will be used.
+	// The path to the file holding client certificate for mutual TLS. If omitted, the
+	// default Mixer certificates will be used.
 	ClientCertificate string `protobuf:"bytes,2,opt,name=client_certificate,json=clientCertificate,proto3" json:"client_certificate,omitempty"`
 	// The path to the file holding additional CA certificates that are needed to
-	// verify the presented adapter certificates. By default mixer should already
+	// verify the presented adapter certificates. By default Mixer should already
 	// include Istio CA certificates and system certificates in cert pool.
 	CaCertificates string `protobuf:"bytes,3,opt,name=ca_certificates,json=caCertificates,proto3" json:"ca_certificates,omitempty"`
 	// Indicates the name of adapter backend server which is useful for routing with
diff --git a/policy/v1beta1/cfg.proto b/policy/v1beta1/cfg.proto
index f3ee542ee31..a32277c9eea 100644
--- a/policy/v1beta1/cfg.proto
+++ b/policy/v1beta1/cfg.proto
@@ -270,7 +270,7 @@ message Instance {
 // Each adapter implementation defines its own `params` proto.
 //
 // In the following example we define a `metrics` handler for the `prometheus` adapter.
-// The example is in the form of a kubernetes resource:
+// The example is in the form of a Kubernetes resource:
 // * The `metadata.name` is the name of the handler
 // * The `kind` refers to the adapter name
 // * The `spec` block represents adapter-specific configuration as well as the connection information
@@ -318,7 +318,7 @@ message Instance {
 // ---
 // ```
 message Handler {
-  // Required. Must be unique in the entire mixer configuration. Used by [Actions][istio.policy.v1beta1.Action.handler]
+  // Required. Must be unique in the entire Mixer configuration. Used by [Actions][istio.policy.v1beta1.Action.handler]
   // to refer to this handler.
   string name = 1;
 
@@ -514,19 +514,19 @@ message OAuth {
   map endpoint_params = 5;
 }
 
-// Mutual let operator specify tls config for mixer as client if mtls is used to
+// Mutual let operator specify TLS configuration for Mixer as client if mutual TLS is used to
 // secure connection to adapter backend.
 message Mutual {
-  // The path to the file holding the private key for mtls. If omitted, the
-  // default mixer private key will be used.
+  // The path to the file holding the private key for mutual TLS. If omitted, the
+  // default Mixer private key will be used.
   string private_key = 1;
 
-  // The path to the file holding client certificate for mtls. If omitted, the
-  // default mixer certificates will be used.
+  // The path to the file holding client certificate for mutual TLS. If omitted, the
+  // default Mixer certificates will be used.
   string client_certificate = 2;
 
   // The path to the file holding additional CA certificates that are needed to
-  // verify the presented adapter certificates. By default mixer should already
+  // verify the presented adapter certificates. By default Mixer should already
   // include Istio CA certificates and system certificates in cert pool.
   string ca_certificates = 3;
 
diff --git a/policy/v1beta1/istio.policy.v1beta1.pb.html b/policy/v1beta1/istio.policy.v1beta1.pb.html
index 945156d22ce..b5ad9f807d4 100644
--- a/policy/v1beta1/istio.policy.v1beta1.pb.html
+++ b/policy/v1beta1/istio.policy.v1beta1.pb.html
@@ -267,7 +267,7 @@ 

Connection

DNSName

-

An instance field of type DNSName denotes that the expression for the field must evalaute to +

An instance field of type DNSName denotes that the expression for the field must evaluate to ValueType.DNS_NAME

Objects of type DNSName are also passed to the adapters during request-time for the instance fields of @@ -336,7 +336,7 @@

DirectHttpResponse

Duration

-

An instance field of type Duration denotes that the expression for the field must evalaute to +

An instance field of type Duration denotes that the expression for the field must evaluate to ValueType.DURATION

Objects of type Duration are also passed to the adapters during request-time for the instance fields of @@ -365,7 +365,7 @@

Duration

EmailAddress

DO NOT USE !! Under Development -An instance field of type EmailAddress denotes that the expression for the field must evalaute to +An instance field of type EmailAddress denotes that the expression for the field must evaluate to ValueType.EMAIL_ADDRESS

Objects of type EmailAddress are also passed to the adapters during request-time for the instance fields of @@ -430,7 +430,7 @@

Handler

Each adapter implementation defines its own params proto.

In the following example we define a metrics handler for the prometheus adapter. -The example is in the form of a kubernetes resource: +The example is in the form of a Kubernetes resource: * The metadata.name is the name of the handler * The kind refers to the adapter name * The spec block represents adapter-specific configuration as well as the connection information

@@ -490,7 +490,7 @@

Handler

@@ -845,7 +845,7 @@

HttpStatusCode

IPAddress

-

An instance field of type IPAddress denotes that the expression for the field must evalaute to +

An instance field of type IPAddress denotes that the expression for the field must evaluate to ValueType.IP_ADDRESS

Objects of type IPAddress are also passed to the adapters during request-time for the instance fields of @@ -968,7 +968,7 @@

Instance

Mutual

-

Mutual let operator specify tls config for mixer as client if mtls is used to +

Mutual let operator specify TLS configuration for Mixer as client if mutual TLS is used to secure connection to adapter backend.

disableCheckCalls bool -

If set to true, disables mixer check calls.

+

If set to true, disables Mixer check calls.

disableReportCalls bool -

If set to true, disables mixer check calls.

+

If set to true, disables Mixer check calls.

statsUpdateInterval google.protobuf.Duration -

Specify refresh interval to write mixer client statistics to Envoy share +

Specify refresh interval to write Mixer client statistics to Envoy share memory. If not specified, the interval is 10 seconds.

attributesForMixerProxy istio.mixer.v1.Attributes -

Default attributes to forward to mixer upstream. This typically +

Default attributes to forward to Mixer upstream. This typically includes the “source.ip” and “source.uid” attributes. These attributes are consumed by the proxy in front of mixer.

diff --git a/networking/v1alpha3/envoy_filter.pb.html b/networking/v1alpha3/envoy_filter.pb.html index d9a36cb8523..3144a0d15d2 100644 --- a/networking/v1alpha3/envoy_filter.pb.html +++ b/networking/v1alpha3/envoy_filter.pb.html @@ -1,6 +1,6 @@ --- title: Envoy Filter -description: Configuration affecting insertion of custom envoy filters. +description: Configuration affecting insertion of custom Envoy filters. location: https://istio.io/docs/reference/config/networking/v1alpha3/envoy-filter.html layout: protoc-gen-docs generator: protoc-gen-docs diff --git a/networking/v1alpha3/envoy_filter.proto b/networking/v1alpha3/envoy_filter.proto index 4b9d040c11e..6f271d1f0a9 100644 --- a/networking/v1alpha3/envoy_filter.proto +++ b/networking/v1alpha3/envoy_filter.proto @@ -17,7 +17,7 @@ syntax = "proto3"; import "google/protobuf/struct.proto"; // $title: Envoy Filter -// $description: Configuration affecting insertion of custom envoy filters. +// $description: Configuration affecting insertion of custom Envoy filters. // $location: https://istio.io/docs/reference/config/networking/v1alpha3/envoy-filter.html // `EnvoyFilter` describes Envoy proxy-specific filters that can be used to diff --git a/networking/v1alpha3/gateway.pb.go b/networking/v1alpha3/gateway.pb.go index 77785897fac..b66d6fca1c2 100644 --- a/networking/v1alpha3/gateway.pb.go +++ b/networking/v1alpha3/gateway.pb.go @@ -369,12 +369,12 @@ func (m *Gateway) GetSelector() map[string]string { // ``` type Server struct { // REQUIRED: The Port on which the proxy should listen for incoming - // connections. If using unix domain socket, use 0 as the port number, + // connections. If using Unix domain socket, use 0 as the port number, // with a valid protocol and port name, along with the bind parameter. Port *Port `protobuf:"bytes,1,opt,name=port,proto3" json:"port,omitempty"` // $hide_from_docs - // The ip or the unix domain socket to which the listener should be bound - // to. Format: x.x.x.x or unix:///path/to/uds or unix://@foobar (Linux + // The ip or the Unix domain socket to which the listener should be bound + // to. Format: `x.x.x.x` or `unix:///path/to/uds` or `unix://@foobar` (Linux // abstract namespace). Bind string `protobuf:"bytes,4,opt,name=bind,proto3" json:"bind,omitempty"` // REQUIRED. A list of hosts exposed by this gateway. At least one @@ -396,9 +396,9 @@ type Server struct { // these options to control if all http requests should be redirected to // https, and the TLS modes to use. Tls *Server_TLSOptions `protobuf:"bytes,3,opt,name=tls,proto3" json:"tls,omitempty"` - // The loopback IP endpoint or unix domain socket to which traffic should - // be forwarded to by default. Format should be 127.0.0.1:PORT or - // unix:///path/to/socket or unix://@foobar (Linux abstract namespace). + // The loopback IP endpoint or Unix domain socket to which traffic should + // be forwarded to by default. Format should be `127.0.0.1:PORT` or + // `unix:///path/to/socket` or `unix://@foobar` (Linux abstract namespace). DefaultEndpoint string `protobuf:"bytes,5,opt,name=default_endpoint,json=defaultEndpoint,proto3" json:"default_endpoint,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` diff --git a/networking/v1alpha3/gateway.pb.html b/networking/v1alpha3/gateway.pb.html index b5cc69a3885..a01ff9d04cc 100644 --- a/networking/v1alpha3/gateway.pb.html +++ b/networking/v1alpha3/gateway.pb.html @@ -292,7 +292,7 @@

Server

Port

REQUIRED: The Port on which the proxy should listen for incoming -connections. If using unix domain socket, use 0 as the port number, +connections. If using Unix domain socket, use 0 as the port number, with a valid protocol and port name, along with the bind parameter.

defaultEndpoint string -

The loopback IP endpoint or unix domain socket to which traffic should -be forwarded to by default. Format should be 127.0.0.1:PORT or -unix:///path/to/socket or unix://@foobar (Linux abstract namespace).

+

The loopback IP endpoint or Unix domain socket to which traffic should +be forwarded to by default. Format should be 127.0.0.1:PORT or +unix:///path/to/socket or unix://@foobar (Linux abstract namespace).

Port[]

REQUIRED. The ports associated with the external service. If the -Endpoints are unix domain socket addresses, there must be exactly one +Endpoints are Unix domain socket addresses, there must be exactly one port.

port Port -

The port associated with the listener. If using unix domain socket, +

The port associated with the listener. If using Unix domain socket, use 0 as the port number, with a valid protocol. The port if specified, will be used as the default destination port associated with the imported hosts. If the port is omitted, Istio will infer the @@ -156,10 +156,10 @@

IstioEgressListener

bind string -

The ip or the unix domain socket to which the listener should be bound -to. Port MUST be specified if bind is not empty. Format: x.x.x.x or -unix:///path/to/uds or unix://@foobar (Linux abstract namespace). If -omitted, Istio will autoconfigure the defaults based on imported +

The ip or the Unix domain socket to which the listener should be bound +to. Port MUST be specified if bind is not empty. Format: x.x.x.x or +unix:///path/to/uds or unix://@foobar (Linux abstract namespace). If +omitted, Istio will automatically configure the defaults based on imported services, the workload to which this configuration is applied to and the captureMode. If captureMode is NONE, bind will default to 127.0.0.1.

@@ -172,7 +172,7 @@

IstioEgressListener

When the bind address is an IP, the captureMode option dictates how traffic to the listener is expected to be captured (or not). -captureMode must be DEFAULT or NONE for unix domain socket binds.

+captureMode must be DEFAULT or NONE for Unix domain socket binds.

Port

REQUIRED. The port associated with the listener. If using -unix domain socket, use 0 as the port number, with a valid +Unix domain socket, use 0 as the port number, with a valid protocol.

bind string -

The ip or the unix domain socket to which the listener should be bound -to. Format: x.x.x.x or unix:///path/to/uds or unix://@foobar (Linux -abstract namespace). If omitted, Istio will autoconfigure the defaults +

The ip or the Unix domain socket to which the listener should be bound +to. Format: x.x.x.x or unix:///path/to/uds or unix://@foobar (Linux +abstract namespace). If omitted, Istio will automatically configure the defaults based on imported services and the workload to which this configuration is applied to.

@@ -246,7 +246,7 @@

IstioIngressListener

When the bind address is an IP, the captureMode option dictates how traffic to the listener is expected to be captured (or not). -captureMode must be DEFAULT or NONE for unix domain socket binds.

+captureMode must be DEFAULT or NONE for Unix domain socket binds.

defaultEndpoint string -

REQUIRED: The loopback IP endpoint or unix domain socket to which +

REQUIRED: The loopback IP endpoint or Unix domain socket to which traffic should be forwarded to. This configuration can be used to redirect traffic arriving at the bind point on the sidecar to a port -or unix domain socket where the application workload is listening for +or Unix domain socket where the application workload is listening for connections. Format should be 127.0.0.1:PORT or unix:///path/to/socket

Ingress specifies the configuration of the sidecar for processing inbound traffic to the attached workload. If omitted, Istio will -autoconfigure the sidecar based on the information about the workload +automatically configure the sidecar based on the information about the workload obtained from the orchestration platform (e.g., exposed ports, services, etc.).

@@ -305,7 +305,7 @@

Sidecar

Egress specifies the configuration of the sidecar for processing outbound traffic from the attached workload to other services in the -mesh. If omitted, Istio will autoconfigure the sidecar to be able to +mesh. If omitted, Istio will automatically configure the sidecar to be able to reach every service in the mesh that is visible to this namespace.

name string -

Required. Must be unique in the entire mixer configuration. Used by Actions +

Required. Must be unique in the entire Mixer configuration. Used by Actions to refer to this handler.

@@ -984,8 +984,8 @@

Mutual

@@ -993,8 +993,8 @@

Mutual

@@ -1003,7 +1003,7 @@

Mutual

@@ -1241,7 +1241,7 @@

Rule.HeaderOperationTemplate.Ope

TimeStamp

-

An instance field of type TimeStamp denotes that the expression for the field must evalaute to +

An instance field of type TimeStamp denotes that the expression for the field must evaluate to ValueType.TIMESTAMP

Objects of type TimeStamp are also passed to the adapters during request-time for the instance fields of @@ -1370,7 +1370,7 @@

Tls.AuthHeader

Uri

DO NOT USE !! Under Development -An instance field of type Uri denotes that the expression for the field must evalaute to +An instance field of type Uri denotes that the expression for the field must evaluate to ValueType.URI

Objects of type Uri are also passed to the adapters during request-time for the instance fields of @@ -1398,7 +1398,7 @@

Uri

Value

-

An instance field of type Value denotes that the expression for the field is of dynamic type and can evalaute to any +

An instance field of type Value denotes that the expression for the field is of dynamic type and can evaluate to any ValueType enum values. For example, when authoring an instance configuration for a template that has a field data of type istio.policy.v1beta1.Value, both of the following expressions are valid data: source.ip | ip("0.0.0.0"), data: request.id | ""; diff --git a/policy/v1beta1/type.pb.go b/policy/v1beta1/type.pb.go index 41c9dfa9f84..bf965feec4e 100644 --- a/policy/v1beta1/type.pb.go +++ b/policy/v1beta1/type.pb.go @@ -28,7 +28,7 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.GoGoProtoPackageIsVersion2 // please upgrade the proto package -// An instance field of type Value denotes that the expression for the field is of dynamic type and can evalaute to any +// An instance field of type Value denotes that the expression for the field is of dynamic type and can evaluate to any // [ValueType][istio.policy.v1beta1.ValueType] enum values. For example, when // authoring an instance configuration for a template that has a field `data` of type `istio.policy.v1beta1.Value`, // both of the following expressions are valid `data: source.ip | ip("0.0.0.0")`, `data: request.id | ""`; @@ -421,7 +421,7 @@ func _Value_OneofSizer(msg proto.Message) (n int) { return n } -// An instance field of type IPAddress denotes that the expression for the field must evalaute to +// An instance field of type IPAddress denotes that the expression for the field must evaluate to // [ValueType.IP_ADDRESS][istio.policy.v1beta1.ValueType.IP_ADDRESS] // // Objects of type IPAddress are also passed to the adapters during request-time for the instance fields of @@ -470,7 +470,7 @@ func (m *IPAddress) GetValue() []byte { return nil } -// An instance field of type Duration denotes that the expression for the field must evalaute to +// An instance field of type Duration denotes that the expression for the field must evaluate to // [ValueType.DURATION][istio.policy.v1beta1.ValueType.DURATION] // // Objects of type Duration are also passed to the adapters during request-time for the instance fields of @@ -519,7 +519,7 @@ func (m *Duration) GetValue() *types.Duration { return nil } -// An instance field of type TimeStamp denotes that the expression for the field must evalaute to +// An instance field of type TimeStamp denotes that the expression for the field must evaluate to // [ValueType.TIMESTAMP][istio.policy.v1beta1.ValueType.TIMESTAMP] // // Objects of type TimeStamp are also passed to the adapters during request-time for the instance fields of @@ -568,7 +568,7 @@ func (m *TimeStamp) GetValue() *types.Timestamp { return nil } -// An instance field of type DNSName denotes that the expression for the field must evalaute to +// An instance field of type DNSName denotes that the expression for the field must evaluate to // [ValueType.DNS_NAME][istio.policy.v1beta1.ValueType.DNS_NAME] // // Objects of type DNSName are also passed to the adapters during request-time for the instance fields of @@ -618,7 +618,7 @@ func (m *DNSName) GetValue() string { } // DO NOT USE !! Under Development -// An instance field of type EmailAddress denotes that the expression for the field must evalaute to +// An instance field of type EmailAddress denotes that the expression for the field must evaluate to // [ValueType.EMAIL_ADDRESS][istio.policy.v1beta1.ValueType.EMAIL_ADDRESS] // // Objects of type EmailAddress are also passed to the adapters during request-time for the instance fields of @@ -668,7 +668,7 @@ func (m *EmailAddress) GetValue() string { } // DO NOT USE !! Under Development -// An instance field of type Uri denotes that the expression for the field must evalaute to +// An instance field of type Uri denotes that the expression for the field must evaluate to // [ValueType.URI][istio.policy.v1beta1.ValueType.URI] // // Objects of type Uri are also passed to the adapters during request-time for the instance fields of diff --git a/policy/v1beta1/type.proto b/policy/v1beta1/type.proto index d6027d1ca4d..3f7161eeec7 100644 --- a/policy/v1beta1/type.proto +++ b/policy/v1beta1/type.proto @@ -26,7 +26,7 @@ option go_package="istio.io/api/policy/v1beta1"; import "google/protobuf/duration.proto"; import "google/protobuf/timestamp.proto"; -// An instance field of type Value denotes that the expression for the field is of dynamic type and can evalaute to any +// An instance field of type Value denotes that the expression for the field is of dynamic type and can evaluate to any // [ValueType][istio.policy.v1beta1.ValueType] enum values. For example, when // authoring an instance configuration for a template that has a field `data` of type `istio.policy.v1beta1.Value`, // both of the following expressions are valid `data: source.ip | ip("0.0.0.0")`, `data: request.id | ""`; @@ -69,7 +69,7 @@ message Value { } } -// An instance field of type IPAddress denotes that the expression for the field must evalaute to +// An instance field of type IPAddress denotes that the expression for the field must evaluate to // [ValueType.IP_ADDRESS][istio.policy.v1beta1.ValueType.IP_ADDRESS] // // Objects of type IPAddress are also passed to the adapters during request-time for the instance fields of @@ -79,7 +79,7 @@ message IPAddress { bytes value = 1; } -// An instance field of type Duration denotes that the expression for the field must evalaute to +// An instance field of type Duration denotes that the expression for the field must evaluate to // [ValueType.DURATION][istio.policy.v1beta1.ValueType.DURATION] // // Objects of type Duration are also passed to the adapters during request-time for the instance fields of @@ -89,7 +89,7 @@ message Duration { google.protobuf.Duration value = 1; } -// An instance field of type TimeStamp denotes that the expression for the field must evalaute to +// An instance field of type TimeStamp denotes that the expression for the field must evaluate to // [ValueType.TIMESTAMP][istio.policy.v1beta1.ValueType.TIMESTAMP] // // Objects of type TimeStamp are also passed to the adapters during request-time for the instance fields of @@ -99,7 +99,7 @@ message TimeStamp { google.protobuf.Timestamp value = 1; } -// An instance field of type DNSName denotes that the expression for the field must evalaute to +// An instance field of type DNSName denotes that the expression for the field must evaluate to // [ValueType.DNS_NAME][istio.policy.v1beta1.ValueType.DNS_NAME] // // Objects of type DNSName are also passed to the adapters during request-time for the instance fields of @@ -110,7 +110,7 @@ message DNSName { } // DO NOT USE !! Under Development -// An instance field of type EmailAddress denotes that the expression for the field must evalaute to +// An instance field of type EmailAddress denotes that the expression for the field must evaluate to // [ValueType.EMAIL_ADDRESS][istio.policy.v1beta1.ValueType.EMAIL_ADDRESS] // // Objects of type EmailAddress are also passed to the adapters during request-time for the instance fields of @@ -121,7 +121,7 @@ message EmailAddress { } // DO NOT USE !! Under Development -// An instance field of type Uri denotes that the expression for the field must evalaute to +// An instance field of type Uri denotes that the expression for the field must evaluate to // [ValueType.URI][istio.policy.v1beta1.ValueType.URI] // // Objects of type Uri are also passed to the adapters during request-time for the instance fields of

privateKey string -

The path to the file holding the private key for mtls. If omitted, the -default mixer private key will be used.

+

The path to the file holding the private key for mutual TLS. If omitted, the +default Mixer private key will be used.

clientCertificate string -

The path to the file holding client certificate for mtls. If omitted, the -default mixer certificates will be used.

+

The path to the file holding client certificate for mutual TLS. If omitted, the +default Mixer certificates will be used.

string

The path to the file holding additional CA certificates that are needed to -verify the presented adapter certificates. By default mixer should already +verify the presented adapter certificates. By default Mixer should already include Istio CA certificates and system certificates in cert pool.