crds/sql_v1beta1_sqlinstance.yaml

# Copyright 2025 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: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: cnrm.cloud.google.com/version: 1.128.0 creationTimestamp: null labels: cnrm.cloud.google.com/managed-by-kcc: "true" cnrm.cloud.google.com/stability-level: stable cnrm.cloud.google.com/system: "true" cnrm.cloud.google.com/tf2crd: "true" name: sqlinstances.sql.cnrm.cloud.google.com spec: group: sql.cnrm.cloud.google.com names: categories: - gcp kind: SQLInstance listKind: SQLInstanceList plural: sqlinstances shortNames: - gcpsqlinstance - gcpsqlinstances singular: sqlinstance scope: Namespaced versions: - additionalPrinterColumns: - jsonPath: .metadata.creationTimestamp name: Age type: date - description: When 'True', the most recent reconcile of the resource succeeded jsonPath: .status.conditions[?(@.type=='Ready')].status name: Ready type: string - description: The reason for the value in 'Ready' jsonPath: .status.conditions[?(@.type=='Ready')].reason name: Status type: string - description: The last transition time for the value in 'Status' jsonPath: .status.conditions[?(@.type=='Ready')].lastTransitionTime name: Status Age type: date name: v1beta1 schema: openAPIV3Schema: description: SQLInstance is the Schema for the sql API properties: apiVersion: description: 'APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' type: string kind: description: 'Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' type: string metadata: type: object spec: properties: cloneSource: description: Create this database as a clone of a source instance. Immutable. properties: binLogCoordinates: description: Binary log coordinates, if specified, identify the position up to which the source instance is cloned. If not specified, the source instance is cloned up to the most recent binary log coordinates. properties: binLogFileName: description: Name of the binary log file for a Cloud SQL instance. type: string binLogPosition: description: Position (offset) within the binary log file. format: int64 type: integer type: object databaseNames: description: (SQL Server only) Clone only the specified databases from the source instance. Clone all databases if empty. items: type: string type: array pointInTime: description: Timestamp, if specified, identifies the time to which the source instance is cloned. type: string sqlInstanceRef: description: The source SQLInstance to clone oneOf: - not: required: - external required: - name - not: anyOf: - required: - name - required: - namespace required: - external properties: external: description: The SQLInstance selfLink, when not managed by Config Connector. type: string name: description: The `name` field of a `SQLInstance` resource. type: string namespace: description: The `namespace` field of a `SQLInstance` resource. type: string type: object type: object databaseVersion: description: The MySQL, PostgreSQL or SQL Server (beta) version to use. Supported values include MYSQL_5_6, MYSQL_5_7, MYSQL_8_0, POSTGRES_9_6, POSTGRES_10, POSTGRES_11, POSTGRES_12, POSTGRES_13, POSTGRES_14, POSTGRES_15, SQLSERVER_2017_STANDARD, SQLSERVER_2017_ENTERPRISE, SQLSERVER_2017_EXPRESS, SQLSERVER_2017_WEB. Database Version Policies includes an up-to-date reference of supported versions. type: string encryptionKMSCryptoKeyRef: oneOf: - not: required: - external required: - name - not: anyOf: - required: - name - required: - namespace required: - external properties: external: description: A reference to an externally managed KMSCryptoKey. Should be in the format `projects/[kms_project_id]/locations/[region]/keyRings/[key_ring_id]/cryptoKeys/[key]`. type: string name: description: The `name` of a `KMSCryptoKey` resource. type: string namespace: description: The `namespace` of a `KMSCryptoKey` resource. type: string type: object instanceType: description: The type of the instance. The valid values are:- 'SQL_INSTANCE_TYPE_UNSPECIFIED', 'CLOUD_SQL_INSTANCE', 'ON_PREMISES_INSTANCE' and 'READ_REPLICA_INSTANCE'. type: string maintenanceVersion: description: Maintenance version. type: string masterInstanceRef: oneOf: - not: required: - external required: - name - not: anyOf: - required: - name - required: - namespace required: - external properties: external: description: The SQLInstance selfLink, when not managed by Config Connector. type: string name: description: The `name` field of a `SQLInstance` resource. type: string namespace: description: The `namespace` field of a `SQLInstance` resource. type: string type: object region: description: Immutable. The region the instance will sit in. Note, Cloud SQL is not available in all regions. A valid region must be provided to use this resource. If a region is not provided in the resource definition, the provider region will be used instead, but this will be an apply-time error for instances if the provider region is not supported with Cloud SQL. If you choose not to provide the region argument for this resource, make sure you understand this. type: string replicaConfiguration: description: The configuration for replication. properties: caCertificate: description: Immutable. PEM representation of the trusted CA's x509 certificate. type: string clientCertificate: description: Immutable. PEM representation of the replica's x509 certificate. type: string clientKey: description: Immutable. PEM representation of the replica's private key. The corresponding public key in encoded in the client_certificate. type: string connectRetryInterval: description: Immutable. The number of seconds between connect retries. MySQL's default is 60 seconds. format: int64 type: integer dumpFilePath: description: Immutable. Path to a SQL file in Google Cloud Storage from which replica instances are created. Format is gs://bucket/filename. type: string failoverTarget: description: Immutable. Specifies if the replica is the failover target. If the field is set to true the replica will be designated as a failover replica. If the master instance fails, the replica instance will be promoted as the new master instance. Not supported for Postgres. type: boolean masterHeartbeatPeriod: description: Immutable. Time in ms between replication heartbeats. format: int64 type: integer password: description: Immutable. Password for the replication connection. properties: value: description: Value of the field. Cannot be used if 'valueFrom' is specified. type: string valueFrom: description: Source for the field's value. Cannot be used if 'value' is specified. properties: secretKeyRef: description: Reference to a value with the given key in the given Secret in the resource's namespace. properties: key: description: Key that identifies the value to be extracted. type: string name: description: Name of the Secret to extract a value from. type: string required: - key - name type: object type: object type: object sslCipher: description: Immutable. Permissible ciphers for use in SSL encryption. type: string username: description: Immutable. Username for replication connection. type: string verifyServerCertificate: description: Immutable. True if the master's common name value is checked during the SSL handshake. type: boolean type: object resourceID: description: Immutable. Optional. The name of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default. type: string rootPassword: description: Initial root password. Required for MS SQL Server. properties: value: description: Value of the field. Cannot be used if 'valueFrom' is specified. type: string valueFrom: description: Source for the field's value. Cannot be used if 'value' is specified. properties: secretKeyRef: description: Reference to a value with the given key in the given Secret in the resource's namespace. properties: key: description: Key that identifies the value to be extracted. type: string name: description: Name of the Secret to extract a value from. type: string required: - key - name type: object type: object type: object settings: description: The settings to use for the database. The configuration is detailed below. properties: activationPolicy: description: This specifies when the instance should be active. Can be either ALWAYS, NEVER or ON_DEMAND. type: string activeDirectoryConfig: properties: domain: description: Domain name of the Active Directory for SQL Server (e.g., mydomain.com). type: string required: - domain type: object advancedMachineFeatures: properties: threadsPerCore: description: The number of threads per physical core. Can be 1 or 2. format: int64 type: integer type: object authorizedGaeApplications: description: DEPRECATED. This property is only applicable to First Generation instances, and First Generation instances are now deprecated. see https://cloud.google.com/sql/docs/mysql/deprecation-notice for information on how to upgrade to Second Generation instances. Specifying this field has no-ops; it's recommended to remove this field from your configuration. items: type: string type: array availabilityType: description: The availability type of the Cloud SQL instance, high availability (REGIONAL) or single zone (ZONAL). For all instances, ensure that settings.backup_configuration.enabled is set to true. For MySQL instances, ensure that settings.backup_configuration.binary_log_enabled is set to true. For Postgres instances, ensure that settings.backup_configuration.point_in_time_recovery_enabled is set to true. Defaults to ZONAL. type: string backupConfiguration: properties: backupRetentionSettings: properties: retainedBackups: description: Number of backups to retain. format: int64 type: integer retentionUnit: description: The unit that 'retainedBackups' represents. Defaults to COUNT. type: string required: - retainedBackups type: object binaryLogEnabled: description: True if binary logging is enabled. If settings.backup_configuration.enabled is false, this must be as well. Can only be used with MySQL. type: boolean enabled: description: True if backup configuration is enabled. type: boolean location: description: Location of the backup configuration. type: string pointInTimeRecoveryEnabled: description: True if Point-in-time recovery is enabled. type: boolean startTime: description: HH:MM format time indicating when backup configuration starts. type: string transactionLogRetentionDays: description: The number of days of transaction logs we retain for point in time restore, from 1-7. (For PostgreSQL Enterprise Plus instances, from 1 to 35.). format: int64 type: integer type: object collation: description: Immutable. The name of server instance collation. type: string connectorEnforcement: description: Specifies if connections must use Cloud SQL connectors. type: string crashSafeReplication: description: DEPRECATED. This property is only applicable to First Generation instances, and First Generation instances are now deprecated. see https://cloud.google.com/sql/docs/mysql/deprecation-notice for information on how to upgrade to Second Generation instances. Specifying this field has no-ops; it's recommended to remove this field from your configuration. type: boolean dataCacheConfig: description: Data cache configurations. properties: dataCacheEnabled: description: Whether data cache is enabled for the instance. type: boolean type: object databaseFlags: items: properties: name: description: Name of the flag. type: string value: description: Value of the flag. type: string required: - name - value type: object type: array deletionProtectionEnabled: description: Configuration to protect against accidental instance deletion. type: boolean denyMaintenancePeriod: properties: endDate: description: End date before which maintenance will not take place. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01. type: string startDate: description: Start date after which maintenance will not take place. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01. type: string time: description: 'Time in UTC when the "deny maintenance period" starts on start_date and ends on end_date. The time is in format: HH:mm:SS, i.e., 00:00:00.' type: string required: - endDate - startDate - time type: object diskAutoresize: description: Enables auto-resizing of the storage size. Defaults to true. type: boolean diskAutoresizeLimit: description: The maximum size, in GB, to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit. format: int64 type: integer diskSize: description: The size of data disk, in GB. Size of a running instance cannot be reduced but can be increased. The minimum value is 10GB. format: int64 type: integer diskType: description: 'Immutable. The type of data disk: PD_SSD or PD_HDD. Defaults to PD_SSD.' type: string edition: description: The edition of the instance, can be ENTERPRISE or ENTERPRISE_PLUS. type: string insightsConfig: description: Configuration of Query Insights. properties: queryInsightsEnabled: description: True if Query Insights feature is enabled. type: boolean queryPlansPerMinute: description: Number of query execution plans captured by Insights per minute for all queries combined. Between 0 and 20. Default to 5. format: int64 type: integer queryStringLength: description: Maximum query length stored in bytes. Between 256 and 4500. Default to 1024. format: int64 type: integer recordApplicationTags: description: True if Query Insights will record application tags from query when enabled. type: boolean recordClientAddress: description: True if Query Insights will record client address when enabled. type: boolean type: object ipConfiguration: properties: allocatedIpRange: description: 'The name of the allocated ip range for the private ip CloudSQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.' type: string authorizedNetworks: items: properties: expirationTime: type: string name: type: string value: type: string required: - value type: object type: array enablePrivatePathForGoogleCloudServices: description: Whether Google Cloud services such as BigQuery are allowed to access data in this Cloud SQL instance over a private IP connection. SQLSERVER database type is not supported. type: boolean ipv4Enabled: description: Whether this Cloud SQL instance should be assigned a public IPV4 address. At least ipv4_enabled must be enabled or a private_network must be configured. type: boolean privateNetworkRef: oneOf: - not: required: - external required: - name - not: anyOf: - required: - name - required: - namespace required: - external properties: external: description: A reference to an externally managed Compute Network resource. Should be in the format `projects/{{projectID}}/global/networks/{{network}}`. type: string name: description: The `name` field of a `ComputeNetwork` resource. type: string namespace: description: The `namespace` field of a `ComputeNetwork` resource. type: string type: object pscConfig: description: PSC settings for a Cloud SQL instance. items: properties: allowedConsumerProjects: description: List of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric). items: type: string type: array pscEnabled: description: Whether PSC connectivity is enabled for this instance. type: boolean type: object type: array requireSsl: type: boolean sslMode: description: Specify how SSL connection should be enforced in DB connections. This field provides more SSL enforcment options compared to requireSsl. To change this field, also set the correspoding value in requireSsl if it has been set. type: string type: object locationPreference: properties: followGaeApplication: description: A Google App Engine application whose zone to remain in. Must be in the same region as this instance. type: string secondaryZone: description: The preferred Compute Engine zone for the secondary/failover. type: string zone: description: The preferred compute engine zone. type: string type: object maintenanceWindow: description: Declares a one-hour maintenance window when an Instance can automatically restart to apply updates. The maintenance window is specified in UTC time. properties: day: description: Day of week (1-7), starting on Monday. format: int64 type: integer hour: description: Hour of day (0-23), ignored if day not set. format: int64 type: integer updateTrack: description: Receive updates earlier (canary) or later (stable). type: string type: object passwordValidationPolicy: properties: complexity: description: Password complexity. type: string disallowUsernameSubstring: description: Disallow username as a part of the password. type: boolean enablePasswordPolicy: description: Whether the password policy is enabled or not. type: boolean minLength: description: Minimum number of characters allowed. format: int64 type: integer passwordChangeInterval: description: Minimum interval after which the password can be changed. This flag is only supported for PostgresSQL. type: string reuseInterval: description: Number of previous passwords that cannot be reused. format: int64 type: integer required: - enablePasswordPolicy type: object pricingPlan: description: Pricing plan for this instance, can only be PER_USE. type: string replicationType: description: DEPRECATED. This property is only applicable to First Generation instances, and First Generation instances are now deprecated. see https://cloud.google.com/sql/docs/mysql/deprecation-notice for information on how to upgrade to Second Generation instances. Specifying this field has no-ops; it's recommended to remove this field from your configuration. type: string sqlServerAuditConfig: properties: bucketRef: description: The name of the destination bucket (e.g., gs://mybucket). oneOf: - not: required: - external required: - name - not: anyOf: - required: - name - required: - namespace required: - external properties: external: description: The StorageBucket selfLink, when not managed by Config Connector. type: string name: description: The `name` field of a `StorageBucket` resource. type: string namespace: description: The `namespace` field of a `StorageBucket` resource. type: string type: object retentionInterval: description: 'How long to keep generated audit files. A duration in seconds with up to nine fractional digits, terminated by ''s''. Example: "3.5s"..' type: string uploadInterval: description: 'How often to upload generated audit files. A duration in seconds with up to nine fractional digits, terminated by ''s''. Example: "3.5s".' type: string type: object tier: description: The machine type to use. See tiers for more details and supported versions. Postgres supports only shared-core machine types, and custom machine types such as db-custom-2-13312. See the Custom Machine Type Documentation to learn about specifying custom machine types. type: string timeZone: description: Immutable. The time_zone to be used by the database engine (supported only for SQL Server), in SQL Server timezone format. type: string required: - tier type: object required: - settings type: object status: properties: availableMaintenanceVersions: description: Available Maintenance versions. items: type: string type: array conditions: description: Conditions represent the latest available observations of the SQLInstance's current state. items: properties: lastTransitionTime: description: Last time the condition transitioned from one status to another. type: string message: description: Human-readable message indicating details about last transition. type: string reason: description: Unique, one-word, CamelCase reason for the condition's last transition. type: string status: description: Status is the status of the condition. Can be True, False, Unknown. type: string type: description: Type is the type of the condition. type: string type: object type: array connectionName: description: The connection name of the instance to be used in connection strings. For example, when connecting with Cloud SQL Proxy. type: string dnsName: description: The dns name of the instance. type: string firstIpAddress: type: string instanceType: description: The type of the instance. The valid values are:- 'SQL_INSTANCE_TYPE_UNSPECIFIED', 'CLOUD_SQL_INSTANCE', 'ON_PREMISES_INSTANCE' and 'READ_REPLICA_INSTANCE'. type: string ipAddress: items: properties: ipAddress: type: string timeToRetire: type: string type: type: string type: object type: array observedGeneration: description: 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. format: int64 type: integer privateIpAddress: type: string pscServiceAttachmentLink: description: The link to service attachment of PSC instance. type: string publicIpAddress: type: string selfLink: description: The URI of the created resource. type: string serverCaCert: properties: cert: description: The CA Certificate used to connect to the SQL Instance via SSL. type: string commonName: description: The CN valid for the CA Cert. type: string createTime: description: Creation time of the CA Cert. type: string expirationTime: description: Expiration time of the CA Cert. type: string sha1Fingerprint: description: SHA Fingerprint of the CA Cert. type: string type: object serviceAccountEmailAddress: description: The service account email address assigned to the instance. type: string type: object required: - spec type: object served: true storage: true subresources: status: {} status: acceptedNames: kind: "" plural: "" conditions: null storedVersions: null

crds/sql_v1beta1_sqlinstance.yaml (825 lines of code) (raw):