PrivateCACertificateTemplate

---

Property	Value
Google Cloud Service Name	Private CA
Google Cloud Service Documentation	/certificate-authority-service/docs/
Google Cloud REST Resource Name	v1.projects.locations.certificateTemplates
Google Cloud REST Resource Documentation	/certificate-authority-service/docs/reference/rest/v1/projects.locations.certificateTemplates
Config Connector Resource Short Names	gcpprivatecacertificatetemplate gcpprivatecacertificatetemplates privatecacertificatetemplate
Config Connector Service Name	privateca.googleapis.com
Config Connector Resource Fully Qualified Name	privatecacertificatetemplates.privateca.cnrm.cloud.google.com
Can Be Referenced by IAMPolicy/IAMPolicyMember	No
Config Connector Default Average Reconcile Interval In Seconds	600

Custom Resource Definition Properties

Spec

Schema

description: string
identityConstraints:
  allowSubjectAltNamesPassthrough: boolean
  allowSubjectPassthrough: boolean
  celExpression:
    description: string
    expression: string
    location: string
    title: string
location: string
passthroughExtensions:
  additionalExtensions:
  - objectIdPath:
    - integer
  knownExtensions:
  - string
predefinedValues:
  additionalExtensions:
  - critical: boolean
    objectId:
      objectIdPath:
      - integer
    value: string
  aiaOcspServers:
  - string
  caOptions:
    isCa: boolean
    maxIssuerPathLength: integer
  keyUsage:
    baseKeyUsage:
      certSign: boolean
      contentCommitment: boolean
      crlSign: boolean
      dataEncipherment: boolean
      decipherOnly: boolean
      digitalSignature: boolean
      encipherOnly: boolean
      keyAgreement: boolean
      keyEncipherment: boolean
    extendedKeyUsage:
      clientAuth: boolean
      codeSigning: boolean
      emailProtection: boolean
      ocspSigning: boolean
      serverAuth: boolean
      timeStamping: boolean
    unknownExtendedKeyUsages:
    - objectIdPath:
      - integer
  policyIds:
  - objectIdPath:
    - integer
projectRef:
  external: string
  name: string
  namespace: string
resourceID: string

Fields
description Optional	string Optional. A human-readable description of scenarios this template is intended for.
identityConstraints Optional	object Optional. Describes constraints on identities that may be appear in Certificates issued using this template. If this is omitted, then this template will not add restrictions on a certificate's identity.
identityConstraints.allowSubjectAltNamesPassthrough Required*	boolean Required. If this is true, the SubjectAltNames extension may be copied from a certificate request into the signed certificate. Otherwise, the requested SubjectAltNames will be discarded.
identityConstraints.allowSubjectPassthrough Required*	boolean Required. If this is true, the Subject field may be copied from a certificate request into the signed certificate. Otherwise, the requested Subject will be discarded.
identityConstraints.celExpression Optional	object Optional. A CEL expression that may be used to validate the resolved X.509 Subject and/or Subject Alternative Name before a certificate is signed. To see the full allowed syntax and some examples, see https://cloud.google.com/certificate-authority-service/docs/using-cel
identityConstraints.celExpression.description Optional	string Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
identityConstraints.celExpression.expression Optional	string Textual representation of an expression in Common Expression Language syntax.
identityConstraints.celExpression.location Optional	string Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
identityConstraints.celExpression.title Optional	string Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
location Required	string Immutable. The location for the resource
passthroughExtensions Optional	object Optional. Describes the set of X.509 extensions that may appear in a Certificate issued using this CertificateTemplate. If a certificate request sets extensions that don't appear in the passthrough_extensions, those extensions will be dropped. If the issuing CaPool's IssuancePolicy defines baseline_values that don't appear here, the certificate issuance request will fail. If this is omitted, then this template will not add restrictions on a certificate's X.509 extensions. These constraints do not apply to X.509 extensions set in this CertificateTemplate's predefined_values.
passthroughExtensions.additionalExtensions Optional	list (object) Optional. A set of ObjectIds identifying custom X.509 extensions. Will be combined with known_extensions to determine the full set of X.509 extensions.
passthroughExtensions.additionalExtensions[] Optional	object
passthroughExtensions.additionalExtensions[].objectIdPath Required*	list (integer) Required. The parts of an OID path. The most significant parts of the path come first.
passthroughExtensions.additionalExtensions[].objectIdPath[] Required*	integer
passthroughExtensions.knownExtensions Optional	list (string) Optional. A set of named X.509 extensions. Will be combined with additional_extensions to determine the full set of X.509 extensions.
passthroughExtensions.knownExtensions[] Optional	string
predefinedValues Optional	object Optional. A set of X.509 values that will be applied to all issued certificates that use this template. If the certificate request includes conflicting values for the same properties, they will be overwritten by the values defined here. If the issuing CaPool's IssuancePolicy defines conflicting baseline_values for the same properties, the certificate issuance request will fail.
predefinedValues.additionalExtensions Optional	list (object) Optional. Describes custom X.509 extensions.
predefinedValues.additionalExtensions[] Optional	object
predefinedValues.additionalExtensions[].critical Optional	boolean Optional. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error).
predefinedValues.additionalExtensions[].objectId Required*	object Required. The OID for this X.509 extension.
predefinedValues.additionalExtensions[].objectId.objectIdPath Required*	list (integer) Required. The parts of an OID path. The most significant parts of the path come first.
predefinedValues.additionalExtensions[].objectId.objectIdPath[] Required*	integer
predefinedValues.additionalExtensions[].value Required*	string Required. The value of this X.509 extension.
predefinedValues.aiaOcspServers Optional	list (string) Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate.
predefinedValues.aiaOcspServers[] Optional	string
predefinedValues.caOptions Optional	object Optional. Describes options in this X509Parameters that are relevant in a CA certificate.
predefinedValues.caOptions.isCa Optional	boolean Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate.
predefinedValues.caOptions.maxIssuerPathLength Optional	integer Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate.
predefinedValues.keyUsage Optional	object Optional. Indicates the intended use for keys that correspond to a certificate.
predefinedValues.keyUsage.baseKeyUsage Optional	object Describes high-level ways in which a key may be used.
predefinedValues.keyUsage.baseKeyUsage.certSign Optional	boolean The key may be used to sign certificates.
predefinedValues.keyUsage.baseKeyUsage.contentCommitment Optional	boolean The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation".
predefinedValues.keyUsage.baseKeyUsage.crlSign Optional	boolean The key may be used sign certificate revocation lists.
predefinedValues.keyUsage.baseKeyUsage.dataEncipherment Optional	boolean The key may be used to encipher data.
predefinedValues.keyUsage.baseKeyUsage.decipherOnly Optional	boolean The key may be used to decipher only.
predefinedValues.keyUsage.baseKeyUsage.digitalSignature Optional	boolean The key may be used for digital signatures.
predefinedValues.keyUsage.baseKeyUsage.encipherOnly Optional	boolean The key may be used to encipher only.
predefinedValues.keyUsage.baseKeyUsage.keyAgreement Optional	boolean The key may be used in a key agreement protocol.
predefinedValues.keyUsage.baseKeyUsage.keyEncipherment Optional	boolean The key may be used to encipher other keys.
predefinedValues.keyUsage.extendedKeyUsage Optional	object Detailed scenarios in which a key may be used.
predefinedValues.keyUsage.extendedKeyUsage.clientAuth Optional	boolean Corresponds to OID 1.3.6.1.5.5.7.3.2. Officially described as "TLS WWW client authentication", though regularly used for non-WWW TLS.
predefinedValues.keyUsage.extendedKeyUsage.codeSigning Optional	boolean Corresponds to OID 1.3.6.1.5.5.7.3.3. Officially described as "Signing of downloadable executable code client authentication".
predefinedValues.keyUsage.extendedKeyUsage.emailProtection Optional	boolean Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection".
predefinedValues.keyUsage.extendedKeyUsage.ocspSigning Optional	boolean Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses".
predefinedValues.keyUsage.extendedKeyUsage.serverAuth Optional	boolean Corresponds to OID 1.3.6.1.5.5.7.3.1. Officially described as "TLS WWW server authentication", though regularly used for non-WWW TLS.
predefinedValues.keyUsage.extendedKeyUsage.timeStamping Optional	boolean Corresponds to OID 1.3.6.1.5.5.7.3.8. Officially described as "Binding the hash of an object to a time".
predefinedValues.keyUsage.unknownExtendedKeyUsages Optional	list (object) Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message.
predefinedValues.keyUsage.unknownExtendedKeyUsages[] Optional	object
predefinedValues.keyUsage.unknownExtendedKeyUsages[].objectIdPath Required*	list (integer) Required. The parts of an OID path. The most significant parts of the path come first.
predefinedValues.keyUsage.unknownExtendedKeyUsages[].objectIdPath[] Required*	integer
predefinedValues.policyIds Optional	list (object) Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4.
predefinedValues.policyIds[] Optional	object
predefinedValues.policyIds[].objectIdPath Required*	list (integer) Required. The parts of an OID path. The most significant parts of the path come first.
predefinedValues.policyIds[].objectIdPath[] Required*	integer
projectRef Required	object Immutable. The Project that this resource belongs to.
projectRef.external Optional	string The project for the resource Allowed value: The Google Cloud resource name of a `Project` resource (format: `projects/{{name}}`).
projectRef.name Optional	string Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
projectRef.namespace Optional	string Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
resourceID Optional	string Immutable. Optional. The name of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default.

* 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 observation of the resource'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 time at which this CertificateTemplate 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 time at which this CertificateTemplate 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: privateca.cnrm.cloud.google.com/v1beta1
kind: PrivateCACertificateTemplate
metadata:
  labels:
    label-two: "value-two"
  name: privatecacertificatetemplate-sample
spec:
  projectRef:
     # Replace ${PROJECT_ID?} with your project ID
     external: "projects/${PROJECT_ID?}"
  location: "us-central1"
  predefinedValues:
    keyUsage:
      baseKeyUsage:
        digitalSignature: true
        contentCommitment: true
        keyEncipherment: true
        dataEncipherment: true
        keyAgreement: true
        certSign: false
        crlSign: false
        encipherOnly: true
        decipherOnly: true
      extendedKeyUsage:
        serverAuth: true
        clientAuth: true
        codeSigning: true
        emailProtection: true
        timeStamping: true
        ocspSigning: true
      unknownExtendedKeyUsages:
      - objectIdPath:
        - 1
        - 6
    caOptions:
      isCa: false
      maxIssuerPathLength: 6
    policyIds:
    - objectIdPath:
      - 1
      - 6
    aiaOcspServers:
    - string
    additionalExtensions:
    - objectId:
        objectIdPath:
        - 1
        - 6
      critical: true
      value: c3RyaW5nCg==
  identityConstraints:
    celExpression:
      title: Sample expression
      description: Always true
      expression: 'true'
      location: any.file.anywhere
    allowSubjectPassthrough: true
    allowSubjectAltNamesPassthrough: true
  passthroughExtensions:
    knownExtensions:
    - EXTENDED_KEY_USAGE
    additionalExtensions:
    - objectIdPath:
      - 1
      - 6
  description: An basic sample certificate template

Note: If you have any trouble with instantiating the resource, refer to Troubleshoot Config Connector.