NetworkSecurityClientTLSPolicy

Property	Value
Google Cloud Service Name	Network Security
Google Cloud Service Documentation	/traffic-director/docs/
Google Cloud REST Resource Name	v1beta1/projects.locations.clientTlsPolicies
Google Cloud REST Resource Documentation	/traffic-director/docs/reference/network-security/rest/v1beta1/projects.locations.clientTlsPolicies
Config Connector Resource Short Names	gcpnetworksecurityclienttlspolicies gcpnetworksecurityclienttlspolicy networksecurityclienttlspolicy
Config Connector Service Name	networksecurity.googleapis.com
Config Connector Resource Fully Qualified Name	networksecurityclienttlspolicies.networksecurity.cnrm.cloud.google.com
Can Be Referenced by IAMPolicy/IAMPolicyMember	Yes
IAMPolicy/IAMPartialPolicy Supports Conditions	Yes
IAMPolicyMember Supports Conditions	No
Supports IAM Audit Configs	No
IAM External Reference Format	projects/{{project}}/locations/{{location}}/clientTlsPolicies/{{name}}
Config Connector Default Average Reconcile Interval In Seconds	600

Custom Resource Definition Properties

Spec

Schema

clientCertificate:
  certificateProviderInstance:
    pluginInstance: string
  grpcEndpoint:
    targetUri: string
description: string
location: string
projectRef:
  external: string
  kind: string
  name: string
  namespace: string
resourceID: string
serverValidationCa:
- certificateProviderInstance:
    pluginInstance: string
  grpcEndpoint:
    targetUri: string
sni: string

Fields

Fields
`clientCertificate` Optional	`object` Optional. Defines a mechanism to provision client identity (public and private keys) for peer to peer authentication. The presence of this dictates mTLS.
`clientCertificate.certificateProviderInstance` Optional	`object` Optional. The certificate provider instance specification that will be passed to the data plane, which will be used to load necessary credential information.
`clientCertificate.certificateProviderInstance.pluginInstance` Required*	`string` Required. Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance.
`clientCertificate.grpcEndpoint` Optional	`object` Optional. gRPC specific configuration to access the gRPC server to obtain the cert and private key.
`clientCertificate.grpcEndpoint.targetUri` Required*	`string` Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:".
`description` Optional	`string` Optional. Free-text description of the resource.
`location` Required	`string` The location of this resource.
`projectRef` Optional	`object` The project that this resource belongs to.
`projectRef.external` Optional	`string` The `projectID` field of a project, when not managed by Config Connector.
`projectRef.kind` Optional	`string` The kind of the Project resource; optional but must be `Project` if provided.
`projectRef.name` Optional	`string` The `name` field of a `Project` resource.
`projectRef.namespace` Optional	`string` The `namespace` field of a `Project` resource.
`resourceID` Optional	`string` The NetworkSecurityClientTLSPolicy name. If not given, the metadata.name will be used.
`serverValidationCa` Optional	`list (object)` Optional. Defines the mechanism to obtain the Certificate Authority certificate to validate the server certificate. If empty, client does not validate the server certificate.
`serverValidationCa[]` Optional	`object`
`serverValidationCa[].certificateProviderInstance` Optional	`object` Optional. The certificate provider instance specification that will be passed to the data plane, which will be used to load necessary credential information.
`serverValidationCa[].certificateProviderInstance.pluginInstance` Required*	`string` Required. Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance.
`serverValidationCa[].grpcEndpoint` Optional	`object` Optional. gRPC specific configuration to access the gRPC server to obtain the CA certificate.
`serverValidationCa[].grpcEndpoint.targetUri` Required*	`string` Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:".
`sni` Optional	`string` Optional. Server Name Indication string to present to the server during TLS handshake. E.g: "secure.example.com".

clientCertificate

Optional

object

Optional. Defines a mechanism to provision client identity (public and private keys) for peer to peer authentication. The presence of this dictates mTLS.

clientCertificate.certificateProviderInstance

Optional

object

Optional. The certificate provider instance specification that will be passed to the data plane, which will be used to load necessary credential information.

clientCertificate.certificateProviderInstance.pluginInstance

Required*

string

Required. Plugin instance name, used to locate and load CertificateProvider instance configuration. Set to "google_cloud_private_spiffe" to use Certificate Authority Service certificate provider instance.

clientCertificate.grpcEndpoint

Optional

object

Optional. gRPC specific configuration to access the gRPC server to obtain the cert and private key.

clientCertificate.grpcEndpoint.targetUri

Required*

string

Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:".

description

Optional

string

Optional. Free-text description of the resource.

location

Required

string

The location of this resource.

projectRef

Optional

object

The project that this resource belongs to.

projectRef.external

Optional

string

The `projectID` field of a project, when not managed by Config Connector.

projectRef.kind

Optional

string

The kind of the Project resource; optional but must be `Project` if provided.

projectRef.name

Optional

string

The `name` field of a `Project` resource.

projectRef.namespace

Optional

string

The `namespace` field of a `Project` resource.

resourceID

Optional

string

The NetworkSecurityClientTLSPolicy name. If not given, the metadata.name will be used.

serverValidationCa

Optional

list (object)

Optional. Defines the mechanism to obtain the Certificate Authority certificate to validate the server certificate. If empty, client does not validate the server certificate.

serverValidationCa[]

Optional

object

serverValidationCa[].certificateProviderInstance

Optional

object

Optional. The certificate provider instance specification that will be passed to the data plane, which will be used to load necessary credential information.

serverValidationCa[].certificateProviderInstance.pluginInstance

Required*

string

serverValidationCa[].grpcEndpoint

Optional

object

Optional. gRPC specific configuration to access the gRPC server to obtain the CA certificate.

serverValidationCa[].grpcEndpoint.targetUri

Required*

string

Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with "unix:".

sni

Optional

string

Optional. Server Name Indication string to present to the server during TLS handshake. E.g: "secure.example.com".

* Field is required when parent field is specified

Status

Schema

conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
createTime: string
observedGeneration: integer
updateTime: string

Fields
`conditions`	`list (object)` Conditions represent the latest available observations of the object's current state.
`conditions[]`	`object`
`conditions[].lastTransitionTime`	`string` Last time the condition transitioned from one status to another.
`conditions[].message`	`string` Human-readable message indicating details about last transition.
`conditions[].reason`	`string` Unique, one-word, CamelCase reason for the condition's last transition.
`conditions[].status`	`string` Status is the status of the condition. Can be True, False, Unknown.
`conditions[].type`	`string` Type is the type of the condition.
`createTime`	`string` Output only. The timestamp when the resource was created.
`observedGeneration`	`integer` ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource.
`updateTime`	`string` Output only. The timestamp when the resource was updated.

Sample YAML(s)

Typical Use Case

# Copyright 2021 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: networksecurity.cnrm.cloud.google.com/v1beta1
kind: NetworkSecurityClientTLSPolicy
metadata:
  name: networksecurityclienttlspolicy-sample
  labels:
    label-one: "value-one"
spec:
  description: Sample global client TLS policy
  location: global
  sni: example.com
  clientCertificate:
    certificateProviderInstance:
      pluginInstance: google_cloud_private_spiffe
  serverValidationCa:
    - certificateProviderInstance:
        pluginInstance: google_cloud_private_spiffe