PrivateCACAPool

---

Property	Value
Google Cloud Service Name	Private CA
Google Cloud Service Documentation	/certificate-authority-service/docs/
Google Cloud REST Resource Name	v1.projects.locations.caPools
Google Cloud REST Resource Documentation	/certificate-authority-service/docs/reference/rest/v1/projects.locations.caPools
Config Connector Resource Short Names	gcpprivatecacapool gcpprivatecacapools privatecacapool
Config Connector Service Name	privateca.googleapis.com
Config Connector Resource Fully Qualified Name	privatecacapools.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

Annotations

Fields
cnrm.cloud.google.com/state-into-spec

Spec

Schema

issuancePolicy:
  allowedIssuanceModes:
    allowConfigBasedIssuance: boolean
    allowCsrBasedIssuance: boolean
  allowedKeyTypes:
  - ellipticCurve:
      signatureAlgorithm: string
    rsa:
      maxModulusSize: integer
      minModulusSize: integer
  baselineValues:
    additionalExtensions:
    - critical: boolean
      objectId:
        objectIdPath:
        - integer
      value: string
    aiaOcspServers:
    - string
    caOptions:
      isCa: boolean
      maxIssuerPathLength: integer
      zeroMaxIssuerPathLength: boolean
    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
  identityConstraints:
    allowSubjectAltNamesPassthrough: boolean
    allowSubjectPassthrough: boolean
    celExpression:
      description: string
      expression: string
      location: string
      title: string
  maximumLifetime: string
  passthroughExtensions:
    additionalExtensions:
    - objectIdPath:
      - integer
    knownExtensions:
    - string
location: string
projectRef:
  external: string
  name: string
  namespace: string
publishingOptions:
  publishCaCert: boolean
  publishCrl: boolean
resourceID: string
tier: string

Fields
issuancePolicy Optional	object Optional. The IssuancePolicy to control how Certificates will be issued from this CaPool.
issuancePolicy.allowedIssuanceModes Optional	object Optional. If specified, then only methods allowed in the IssuanceModes may be used to issue Certificates.
issuancePolicy.allowedIssuanceModes.allowConfigBasedIssuance Optional	boolean Optional. When true, allows callers to create Certificates by specifying a CertificateConfig.
issuancePolicy.allowedIssuanceModes.allowCsrBasedIssuance Optional	boolean Optional. When true, allows callers to create Certificates by specifying a CSR.
issuancePolicy.allowedKeyTypes Optional	list (object) Optional. If any AllowedKeyType is specified, then the certificate request's public key must match one of the key types listed here. Otherwise, any key may be used.
issuancePolicy.allowedKeyTypes[] Optional	object
issuancePolicy.allowedKeyTypes[].ellipticCurve Optional	object Represents an allowed Elliptic Curve key type.
issuancePolicy.allowedKeyTypes[].ellipticCurve.signatureAlgorithm Optional	string Optional. A signature algorithm that must be used. If this is omitted, any EC-based signature algorithm will be allowed. Possible values: EC_SIGNATURE_ALGORITHM_UNSPECIFIED, ECDSA_P256, ECDSA_P384, EDDSA_25519
issuancePolicy.allowedKeyTypes[].rsa Optional	object Represents an allowed RSA key type.
issuancePolicy.allowedKeyTypes[].rsa.maxModulusSize Optional	integer Optional. The maximum allowed RSA modulus size, in bits. If this is not set, or if set to zero, the service will not enforce an explicit upper bound on RSA modulus sizes.
issuancePolicy.allowedKeyTypes[].rsa.minModulusSize Optional	integer Optional. The minimum allowed RSA modulus size, in bits. If this is not set, or if set to zero, the service-level min RSA modulus size will continue to apply.
issuancePolicy.baselineValues Optional	object Optional. A set of X.509 values that will be applied to all certificates issued through this CaPool. If a certificate request includes conflicting values for the same properties, they will be overwritten by the values defined here. If a certificate request uses a CertificateTemplate that defines conflicting predefined_values for the same properties, the certificate issuance request will fail.
issuancePolicy.baselineValues.additionalExtensions Optional	list (object) Optional. Describes custom X.509 extensions.
issuancePolicy.baselineValues.additionalExtensions[] Optional	object
issuancePolicy.baselineValues.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).
issuancePolicy.baselineValues.additionalExtensions[].objectId Required*	object Required. The OID for this X.509 extension.
issuancePolicy.baselineValues.additionalExtensions[].objectId.objectIdPath Required*	list (integer) Required. The parts of an OID path. The most significant parts of the path come first.
issuancePolicy.baselineValues.additionalExtensions[].objectId.objectIdPath[] Required*	integer
issuancePolicy.baselineValues.additionalExtensions[].value Required*	string Required. The value of this X.509 extension.
issuancePolicy.baselineValues.aiaOcspServers Optional	list (string) Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate.
issuancePolicy.baselineValues.aiaOcspServers[] Optional	string
issuancePolicy.baselineValues.caOptions Optional	object Optional. Describes options in this X509Parameters that are relevant in a CA certificate.
issuancePolicy.baselineValues.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.
issuancePolicy.baselineValues.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.
issuancePolicy.baselineValues.caOptions.zeroMaxIssuerPathLength Optional	boolean Optional. When true, the "path length constraint" in Basic Constraints extension will be set to 0. if both max_issuer_path_length and zero_max_issuer_path_length are unset, the max path length will be omitted from the CA certificate.
issuancePolicy.baselineValues.keyUsage Optional	object Optional. Indicates the intended use for keys that correspond to a certificate.
issuancePolicy.baselineValues.keyUsage.baseKeyUsage Optional	object Describes high-level ways in which a key may be used.
issuancePolicy.baselineValues.keyUsage.baseKeyUsage.certSign Optional	boolean The key may be used to sign certificates.
issuancePolicy.baselineValues.keyUsage.baseKeyUsage.contentCommitment Optional	boolean The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation".
issuancePolicy.baselineValues.keyUsage.baseKeyUsage.crlSign Optional	boolean The key may be used sign certificate revocation lists.
issuancePolicy.baselineValues.keyUsage.baseKeyUsage.dataEncipherment Optional	boolean The key may be used to encipher data.
issuancePolicy.baselineValues.keyUsage.baseKeyUsage.decipherOnly Optional	boolean The key may be used to decipher only.
issuancePolicy.baselineValues.keyUsage.baseKeyUsage.digitalSignature Optional	boolean The key may be used for digital signatures.
issuancePolicy.baselineValues.keyUsage.baseKeyUsage.encipherOnly Optional	boolean The key may be used to encipher only.
issuancePolicy.baselineValues.keyUsage.baseKeyUsage.keyAgreement Optional	boolean The key may be used in a key agreement protocol.
issuancePolicy.baselineValues.keyUsage.baseKeyUsage.keyEncipherment Optional	boolean The key may be used to encipher other keys.
issuancePolicy.baselineValues.keyUsage.extendedKeyUsage Optional	object Detailed scenarios in which a key may be used.
issuancePolicy.baselineValues.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.
issuancePolicy.baselineValues.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".
issuancePolicy.baselineValues.keyUsage.extendedKeyUsage.emailProtection Optional	boolean Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection".
issuancePolicy.baselineValues.keyUsage.extendedKeyUsage.ocspSigning Optional	boolean Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses".
issuancePolicy.baselineValues.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.
issuancePolicy.baselineValues.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".
issuancePolicy.baselineValues.keyUsage.unknownExtendedKeyUsages Optional	list (object) Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message.
issuancePolicy.baselineValues.keyUsage.unknownExtendedKeyUsages[] Optional	object
issuancePolicy.baselineValues.keyUsage.unknownExtendedKeyUsages[].objectIdPath Required*	list (integer) Required. The parts of an OID path. The most significant parts of the path come first.
issuancePolicy.baselineValues.keyUsage.unknownExtendedKeyUsages[].objectIdPath[] Required*	integer
issuancePolicy.baselineValues.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.
issuancePolicy.baselineValues.policyIds[] Optional	object
issuancePolicy.baselineValues.policyIds[].objectIdPath Required*	list (integer) Required. The parts of an OID path. The most significant parts of the path come first.
issuancePolicy.baselineValues.policyIds[].objectIdPath[] Required*	integer
issuancePolicy.identityConstraints Optional	object Optional. Describes constraints on identities that may appear in Certificates issued through this CaPool. If this is omitted, then this CaPool will not add restrictions on a certificate's identity.
issuancePolicy.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.
issuancePolicy.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.
issuancePolicy.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
issuancePolicy.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.
issuancePolicy.identityConstraints.celExpression.expression Optional	string Textual representation of an expression in Common Expression Language syntax.
issuancePolicy.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.
issuancePolicy.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.
issuancePolicy.maximumLifetime Optional	string Optional. The maximum lifetime allowed for issued Certificates. Note that if the issuing CertificateAuthority expires before a Certificate's requested maximum_lifetime, the effective lifetime will be explicitly truncated to match it.
issuancePolicy.passthroughExtensions Optional	object Optional. Describes the set of X.509 extensions that may appear in a Certificate issued through this CaPool. If a certificate request sets extensions that don't appear in the passthrough_extensions, those extensions will be dropped. If a certificate request uses a CertificateTemplate with predefined_values that don't appear here, the certificate issuance request will fail. If this is omitted, then this CaPool will not add restrictions on a certificate's X.509 extensions. These constraints do not apply to X.509 extensions set in this CaPool's baseline_values.
issuancePolicy.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.
issuancePolicy.passthroughExtensions.additionalExtensions[] Optional	object
issuancePolicy.passthroughExtensions.additionalExtensions[].objectIdPath Required*	list (integer) Required. The parts of an OID path. The most significant parts of the path come first.
issuancePolicy.passthroughExtensions.additionalExtensions[].objectIdPath[] Required*	integer
issuancePolicy.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.
issuancePolicy.passthroughExtensions.knownExtensions[] Optional	string
location Required	string Immutable. The location for the resource
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/
publishingOptions Optional	object Optional. The PublishingOptions to follow when issuing Certificates from any CertificateAuthority in this CaPool.
publishingOptions.publishCaCert Optional	boolean Optional. When true, publishes each CertificateAuthority's CA certificate and includes its URL in the "Authority Information Access" X.509 extension in all issued Certificates. If this is false, the CA certificate will not be published and the corresponding X.509 extension will not be written in issued certificates.
publishingOptions.publishCrl Optional	boolean Optional. When true, publishes each CertificateAuthority's CRL and includes its URL in the "CRL Distribution Points" X.509 extension in all issued Certificates. If this is false, CRLs will not be published and the corresponding X.509 extension will not be written in issued certificates. CRLs will expire 7 days from their creation. However, we will rebuild daily. CRLs are also rebuilt shortly after a certificate is revoked.
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.
tier Required	string Immutable. Required. Immutable. The Tier of this CaPool. Possible values: TIER_UNSPECIFIED, ENTERPRISE, DEVOPS

* Field is required when parent field is specified

Status

Schema

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

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.
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.

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: PrivateCACAPool
metadata:
  labels:
    label-two: "value-two"
  name: privatecacapool-sample
spec:
  projectRef:
    external: projects/${PROJECT_ID?}
  location: "us-central1"
  tier: ENTERPRISE
  issuancePolicy:
    allowedKeyTypes:
    - rsa:
        minModulusSize: 64
        maxModulusSize: 128
    - ellipticCurve:
        signatureAlgorithm: ECDSA_P384
    maximumLifetime: 43200s
    allowedIssuanceModes:
      allowCsrBasedIssuance: true
      allowConfigBasedIssuance: false
    baselineValues:
      keyUsage:
        baseKeyUsage:
          digitalSignature: false
          contentCommitment: false
          keyEncipherment: false
          dataEncipherment: false
          keyAgreement: false
          certSign: false
          crlSign: false
          encipherOnly: false
          decipherOnly: false
        extendedKeyUsage:
          serverAuth: false
          clientAuth: false
          codeSigning: false
          emailProtection: false
          timeStamping: false
          ocspSigning: false
        unknownExtendedKeyUsages:
        - objectIdPath:
          - 1
          - 7
      caOptions:
        isCa: false
        maxIssuerPathLength: 7
      policyIds:
      - objectIdPath:
        - 1
        - 7
      aiaOcspServers:
      - string
      additionalExtensions:
      - objectId:
          objectIdPath:
          - 1
          - 7
        critical: false
        value: c3RyaW5nCg==
    identityConstraints:
      celExpression:
        title: Sample expression
        description: Always false
        expression: 'false'
        location: devops.ca_pool.json
      allowSubjectPassthrough: false
      allowSubjectAltNamesPassthrough: false
    passthroughExtensions:
      knownExtensions:
      - BASE_KEY_USAGE
      additionalExtensions:
      - objectIdPath:
        - 1
        - 7

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