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 | gcpnetworksecurityclienttlspolicy gcpnetworksecurityclienttlspolicies 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
name: string
namespace: string
resourceID: string
serverValidationCa:
- certificateProviderInstance:
pluginInstance: string
grpcEndpoint:
targetUri: string
sni: string
Fields | |
---|---|
Optional |
Optional. Defines a mechanism to provision client identity (public and private keys) for peer to peer authentication. The presence of this dictates mTLS. |
Optional |
The certificate provider instance specification that will be passed to the data plane, which will be used to load necessary credential information. |
Required* |
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. |
Optional |
gRPC specific configuration to access the gRPC server to obtain the cert and private key. |
Required* |
Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with “unix:”. |
Optional |
Optional. Free-text description of the resource. |
Required |
Immutable. The location for the resource |
Optional |
Immutable. The Project that this resource belongs to. |
Optional |
The project for the resource Allowed value: The Google Cloud resource name of a `Project` resource (format: `projects/{{name}}`). |
Optional |
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
Optional |
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
Optional |
Immutable. Optional. The name of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default. |
Optional |
Required. Defines the mechanism to obtain the Certificate Authority certificate to validate the server certificate. |
Optional |
|
Optional |
The certificate provider instance specification that will be passed to the data plane, which will be used to load necessary credential information. |
Required* |
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. |
Optional |
gRPC specific configuration to access the gRPC server to obtain the CA certificate. |
Required* |
Required. The target URI of the gRPC endpoint. Only UDS path is supported, and should start with “unix:”. |
Optional |
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 |
Conditions represent the latest available observation of the resource's current state. |
conditions[] |
|
conditions[].lastTransitionTime |
Last time the condition transitioned from one status to another. |
conditions[].message |
Human-readable message indicating details about last transition. |
conditions[].reason |
Unique, one-word, CamelCase reason for the condition's last transition. |
conditions[].status |
Status is the status of the condition. Can be True, False, Unknown. |
conditions[].type |
Type is the type of the condition. |
createTime |
Output only. The timestamp when the resource was created. |
observedGeneration |
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 |
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