diff --git a/mesh/v1alpha1/config.pb.go b/mesh/v1alpha1/config.pb.go index 4014566bcc..12c819dd85 100644 --- a/mesh/v1alpha1/config.pb.go +++ b/mesh/v1alpha1/config.pb.go @@ -1094,7 +1094,6 @@ type MeshConfig struct { // // Deprecated: Marked as deprecated in mesh/v1alpha1/config.proto. Certificates []*Certificate `protobuf:"bytes,47,rep,name=certificates,proto3" json:"certificates,omitempty"` - // $hide_from_docs // Settings to be applied to select services. ServiceSettings []*MeshConfig_ServiceSettings `protobuf:"bytes,50,rep,name=service_settings,json=serviceSettings,proto3" json:"service_settings,omitempty"` // Scope to be applied to select services. @@ -2177,7 +2176,6 @@ func (*MeshConfig_CertificateData_Pem) isMeshConfig_CertificateData_CertificateD func (*MeshConfig_CertificateData_SpiffeBundleUrl) isMeshConfig_CertificateData_CertificateData() {} -// $hide_from_docs // Settings to be applied to select services. // // For example, the following configures all services in namespace "foo" as well as the diff --git a/mesh/v1alpha1/config.proto b/mesh/v1alpha1/config.proto index 656eb15b9c..1bdaf67612 100755 --- a/mesh/v1alpha1/config.proto +++ b/mesh/v1alpha1/config.proto @@ -427,7 +427,6 @@ message MeshConfig { reserved 49; reserved "thrift_config"; - // $hide_from_docs // Settings to be applied to select services. // // For example, the following configures all services in namespace "foo" as well as the @@ -482,7 +481,6 @@ message MeshConfig { repeated string hosts = 2; } - // $hide_from_docs // Settings to be applied to select services. repeated ServiceSettings service_settings = 50; diff --git a/mesh/v1alpha1/istio.mesh.v1alpha1.pb.html b/mesh/v1alpha1/istio.mesh.v1alpha1.pb.html index da958290a2..d1d14543ff 100644 --- a/mesh/v1alpha1/istio.mesh.v1alpha1.pb.html +++ b/mesh/v1alpha1/istio.mesh.v1alpha1.pb.html @@ -5,7 +5,7 @@ layout: protoc-gen-docs generator: protoc-gen-docs weight: 20 -number_of_entries: 94 +number_of_entries: 95 ---

Configuration affecting the service mesh as a whole.

@@ -465,6 +465,15 @@

MeshConfig

  • %SERVICE% will use reviews.prod as the stats name.
    • + + + +
    serviceSettings
    +
    ServiceSettings[]
    +
    + +

    Settings to be applied to select services.

    + @@ -815,6 +824,96 @@

    CertificateData

    If only certSigners is set, this trustAnchor is used for these certSigners and all trust domains. If both certSigners and trustDomains is set, this trustAnchor is only used for these signers and trust domains.

    + + + + + +

    ServiceSettings

    +
    +

    Settings to be applied to select services.

    +

    For example, the following configures all services in namespace “foo” as well as the +“bar” service in namespace “baz” to be considered cluster-local:

    +
    serviceSettings:
+  - settings:
+      clusterLocal: true
+    hosts:
+      - "*.foo.svc.cluster.local"
+      - "bar.baz.svc.cluster.local"
+
    +

    When in ambient mode, if ServiceSettings are defined they will be considered in addition to the +ServiceScopeConfigs. If a service is defined by ServiceSetting to be cluster local and matches a +global service scope selector, the service will be considered cluster local. If a service is +considered global by ServiceSettings and does not match a global service scope selector +the serive will be considered local. Local scope takes precedence over global scope. Since +ServiceScopeConfigs is local by default, all services are considered local unless it is considered +global by ServiceSettings AND ServiceScopeConfigs.

    + + + + + + + + + + + + + + + + + + +
    FieldDescription
    settings
    +
    Settings
    +
    		 +

    The settings to apply to the selected services.

    + +
    hosts
    +
    string[]
    +
    		 +

    The services to which the Settings should be applied. Services are selected using the hostname +matching rules used by DestinationRule.

    +

    For example: foo.bar.svc.cluster.local, *.baz.svc.cluster.local

    + +
    +
    +

    Settings

    +
    +

    Settings for the selected services.

    + + + + + + + + + + + + @@ -3095,45 +3194,6 @@

    DefaultTrafficPolicy

    Baseline outlier detection for outbound clusters. A DestinationRule that sets outlierDetection overrides this whole block; otherwise this baseline applies.

    - - - -
    FieldDescription
    clusterLocal
    +
    bool
    +
    		 +

    If true, specifies that the client and service endpoints must reside in the same cluster. +By default, in multi-cluster deployments, the Istio control plane assumes all service +endpoints to be reachable from any client in any of the clusters which are part of the +mesh. This configuration option limits the set of service endpoints visible to a client +to be cluster scoped.

    +

    There are some common scenarios when this can be useful:

    +
      +
    • A service (or group of services) is inherently local to the cluster and has local storage +for that cluster. For example, the kube-system namespace (e.g. the Kube API Server).
      • +
    • A mesh administrator wants to slowly migrate services to Istio. They might start by first +having services cluster-local and then slowly transition them to mesh-wide. They could do +this service-by-service (e.g. mysvc.myns.svc.cluster.local) or as a group +(e.g. *.myns.svc.cluster.local).
      • +
    +

    By default Istio will consider kubernetes.default.svc (i.e. the API Server) as well as all +services in the kube-system namespace to be cluster-local, unless explicitly overridden here.

    +
    -
    -

    Settings

    -
    -

    Settings for the selected services.

    - - - - - - - - - - - -
    FieldDescription
    clusterLocal
    -
    bool
    -
    		 -

    If true, specifies that the client and service endpoints must reside in the same cluster. -By default, in multi-cluster deployments, the Istio control plane assumes all service -endpoints to be reachable from any client in any of the clusters which are part of the -mesh. This configuration option limits the set of service endpoints visible to a client -to be cluster scoped.

    -

    There are some common scenarios when this can be useful:

    -
      -
    • A service (or group of services) is inherently local to the cluster and has local storage -for that cluster. For example, the kube-system namespace (e.g. the Kube API Server).
      • -
    • A mesh administrator wants to slowly migrate services to Istio. They might start by first -having services cluster-local and then slowly transition them to mesh-wide. They could do -this service-by-service (e.g. mysvc.myns.svc.cluster.local) or as a group -(e.g. *.myns.svc.cluster.local).
      • -
    -

    By default Istio will consider kubernetes.default.svc (i.e. the API Server) as well as all -services in the kube-system namespace to be cluster-local, unless explicitly overridden here.

    -