From 01a3add6737313c9a7c233503373b7a8ff686f2d Mon Sep 17 00:00:00 2001 From: Letha Date: Wed, 1 Nov 2023 10:55:13 -0700 Subject: [PATCH] Updates GCP resource docs (#2435) --- providers/gcp/resources/gcp.lr | 368 ++++++++++++++++----------------- 1 file changed, 184 insertions(+), 184 deletions(-) diff --git a/providers/gcp/resources/gcp.lr b/providers/gcp/resources/gcp.lr index b55c1c6499..cc88969224 100644 --- a/providers/gcp/resources/gcp.lr +++ b/providers/gcp/resources/gcp.lr @@ -80,57 +80,57 @@ private gcp.projects { // Google Cloud Platform Project gcp.project @defaults("name") { - // Unique, user-assigned id of the project + // Unique, user-assigned ID of the project id string - // The unique resource name + // Unique resource name name() string // Parent ID parentId() string // Deprecated. Use `id` instead. number() string - // The project lifecycle state + // Project lifecycle state state() string // Deprecated. Use `state` instead. lifecycleState() string // Creation time createTime() time - // The labels associated with this project + // Labels associated with this project labels() map[string]string // IAM policy iamPolicy() []gcp.resourcemanager.binding - // List of available and enabled services for project + // List of available and enabled services for the project services() []gcp.service // List of recommendations recommendations() []gcp.recommendation // GCP GKE resources gke() gcp.project.gkeService - // GCP Compute Resources for the Project + // GCP Compute resources for the project compute() gcp.project.computeService - // GCP Pub/Sub-related Resources + // GCP pub/sub-related resources pubsub() gcp.project.pubsubService // KMS-related resources kms() gcp.project.kmsService - // GCP Contacts for the project + // GCP contacts for the project essentialContacts() []gcp.essentialContact // API keys apiKeys() []gcp.project.apiKey // Logging resources logging() gcp.project.loggingservice - // GCP Cloud SQL Resources + // GCP Cloud SQL resources sql() gcp.project.sqlService - // GCP IAM Resources + // GCP IAM resources iam() gcp.project.iamService // Common instance metadata for the project commonInstanceMetadata() map[string]string // GCP Cloud DNS dns() gcp.project.dnsService - // GCP BigQuery Resources + // GCP BigQuery resources bigquery() gcp.project.bigqueryService // GCP Cloud Functions cloudFunctions() []gcp.project.cloudFunction // GCP Dataproc resources dataproc() gcp.project.dataprocService - // GCP Cloud Run Resources + // GCP Cloud Run resources cloudRun() gcp.project.cloudRunService // Access approval settings accessApprovalSettings() gcp.accessApprovalSettings @@ -152,17 +152,17 @@ gcp.service @defaults("name") { title string // Service state state string - // Checks if the service is enabled + // Whether the service is enabled enabled() bool } -// GCP recommendation along with a suggested action +// GCP Recommendation and Suggested Action gcp.recommendation { // ID of recommendation id string // Project ID projectId string - // Zone Name + // Zone name zoneName string // Description of the recommendation name string @@ -170,17 +170,17 @@ gcp.recommendation { recommender string // The primary impact that this recommendation can have primaryImpact dict - // Optional set of additional impact that this recommendation may have + // Optional set of additional impact that this recommendation can have additionalImpact []dict - // Describing recommended changes to resources + // Recommended changes to resources content dict - // Category of Primary Impact + // Category of primary impact category string // Recommendation's priority priority string // Last time this recommendation was refreshed lastRefreshTime time - // State and Metadata about Recommendation + // State and metadata of recommendation state dict } @@ -208,17 +208,17 @@ private gcp.project.computeService { images() []gcp.project.computeService.image // Google Compute Engine firewalls in a project firewalls() []gcp.project.computeService.firewall - // Google Compute Engine VPC Network in a project + // Google Compute Engine VPC network in a project networks() []gcp.project.computeService.network - // Logical partition of a Virtual Private Cloud network + // Logical partition of a VPC network subnetworks() []gcp.project.computeService.subnetwork - // Cloud Routers in project + // Cloud Routers in a project routers() []gcp.project.computeService.router // Google Compute Engine machine types in a project machineTypes() []gcp.project.computeService.machineType - // Project Regions + // Project regions regions() []gcp.project.computeService.region - // Project Zones + // Project zones zones() []gcp.project.computeService.zone // List of backend services backendServices() []gcp.project.computeService.backendService @@ -278,7 +278,7 @@ private gcp.project.computeService.forwardingRule { ipProtocol string // Whether to use all ports for forwarding traffic allPorts bool - // Whether to allow accessing the load balancer from all regions + // Whether to allow access to the load balancer from all regions allowGlobalAccess bool // Backend service to which the forwarding rule sends traffic backendService string @@ -286,7 +286,7 @@ private gcp.project.computeService.forwardingRule { created time // Optional resource description description string - // IP version that is used by this forwarding rule + // IP version that this forwarding rule uses ipVersion string // Whether this load balancer can be used as a collector for packet mirroring isMirroringCollector bool @@ -294,7 +294,7 @@ private gcp.project.computeService.forwardingRule { labels map[string]string // Forwarding rule type loadBalancingScheme string - // Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients + // Opaque filter criteria used by the load balancer to restrict routing configuration to a limited set of xDS-compliant clients metadataFilters []dict // Forwarding rule name name string @@ -304,7 +304,7 @@ private gcp.project.computeService.forwardingRule { network() gcp.project.computeService.network // Network tier used for configuring this load balancer networkTier string - // Whether the forwarding rule should try to auto-generate a DNS zone or not + // Whether the forwarding rule should try to auto-generate a DNS zone noAutomateDnsZone bool // Port range to forward portRange string @@ -312,15 +312,15 @@ private gcp.project.computeService.forwardingRule { ports []string // Region URL regionUrl string - // Service Directory resources to register this forwarding rule with + // Service Directory resources with which to register this forwarding rule serviceDirectoryRegistrations []dict // Optional prefix to the service name for this forwarding rule serviceLabel string // Internal fully qualified service name for this forwarding rule serviceName string - // URL of the subnetwork that the load balanced IP belongs to + // URL of the subnetwork to which the load balanced IP belongs subnetworkUrl string - // Subnetwork that the load balanced IP belongs to + // Subnetwork to which the load balanced IP belongs subnetwork() gcp.project.computeService.subnetwork // URL of the target resource to receive the matched traffic targetUrl string @@ -332,7 +332,7 @@ private gcp.project.computeService.region @defaults("name") { id string // Name of the resource name string - // Resource Description + // Resource description description string // Status of the region status string @@ -350,7 +350,7 @@ private gcp.project.computeService.zone @defaults("name") { id string // Name of the resource name string - // Resource Description + // Resource description description string // Status of the zone status string @@ -370,11 +370,11 @@ private gcp.project.computeService.machineType @defaults("name") { description string // Number of virtual CPUs that are available to the instance guestCpus int - // Indicates if the machine has a shared CPU + // Whether the machine has a shared CPU isSharedCpu bool // Maximum persistent disks allowed maximumPersistentDisks int - // Maximum total persistent disks size (GB) allowed. + // Maximum total persistent disks size (GB) allowed maximumPersistentDisksSizeGb int // Physical memory available to the instance (MB) memoryMb int @@ -386,7 +386,7 @@ private gcp.project.computeService.machineType @defaults("name") { // GCP Compute Instances private gcp.project.computeService.instance @defaults("name") { - // Unique identifier for the resource + // Unique identifier for the instance id string // Project ID projectId string @@ -396,19 +396,19 @@ private gcp.project.computeService.instance @defaults("name") { description string // Confidential instance configuration confidentialInstanceConfig dict - // Indicates if this instance is allowed to send and receive packets with non-matching destination or source IPs + // Whether the instance is allowed to send and receive packets with non-matching destination or source IPs canIpForward bool - // The CPU platform used by this instance + // CPU platform used by this instance cpuPlatform string // Creation timestamp created time - // Indicates if instance is protected against deletion + // Whether the instance is protected against deletion deletionProtection bool - // Indicates if the instance has Display enabled + // Whether the instance has display enabled enableDisplay bool // Attached list of accelerator cards guestAccelerators []dict - // Instance Fingerprint + // Instance fingerprint fingerprint string // Hostname of the instance hostname string @@ -422,15 +422,15 @@ private gcp.project.computeService.instance @defaults("name") { lastStopTimestamp time // Last suspended timestamp lastSuspendedTimestamp time - // Instance Metadata + // Instance metadata metadata map[string]string // Minimum CPU platform for the VM instance minCpuPlatform string - // Network configurations for this instance + // Network configurations for the instance networkInterfaces []dict // private IPv6 google access type for the VM privateIpv6GoogleAccess string - // Reservations that this instance can consume from + // Reservations from which this instance can consume reservationAffinity dict // Resource policies applied to this instance resourcePolicies []string @@ -438,13 +438,13 @@ private gcp.project.computeService.instance @defaults("name") { physicalHostResourceStatus string // Scheduling options scheduling dict - // Indicates if Shielded Instance integrity monitoring is enabled + // Whether Shielded Instance integrity monitoring is enabled enableIntegrityMonitoring bool - // Indicates if Shielded Instance secure boot is enabled + // Whether Shielded Instance secure boot is enabled enableSecureBoot bool - // Indicates if Shielded Instance vTPM is enabled + // Whether Shielded Instance vTPM is enabled enableVtpm bool - // Indicates if VM has been restricted for start because Compute Engine has detected suspicious activity + // Whether VM has been restricted from starting because Compute Engine has detected suspicious activity startRestricted bool // Instance status status string @@ -458,7 +458,7 @@ private gcp.project.computeService.instance @defaults("name") { totalEgressBandwidthTier string // Service accounts authorized for this instance serviceAccounts []gcp.project.computeService.serviceaccount - // Disks associated with this instance + // Disks associated with the instance disks []gcp.project.computeService.attachedDisk // Machine type machineType() gcp.project.computeService.machineType @@ -498,13 +498,13 @@ private gcp.project.computeService.disk @defaults("name") { locationHint string // Physical block size of the persistent disk physicalBlockSizeBytes int - // Indicates how many IOPS to provision for the disk + // How many IOPS to provision for the disk provisionedIops int // Size, in GB, of the persistent disk sizeGb int // The status of disk creation status string - // Disk Zone + // Disk zone zone gcp.project.computeService.zone // Creation timestamp created time @@ -558,7 +558,7 @@ private gcp.project.computeService.snapshot @defaults("name") { architecture string // Indicates if snapshot was automatically created autoCreated bool - // Snapshot Chain + // Snapshot chain chainName string // Size in bytes of the snapshot at creation time creationSizeBytes int @@ -612,7 +612,7 @@ private gcp.project.computeService.image @defaults("id name") { // GCP Compute Firewall private gcp.project.computeService.firewall @defaults("name") { - // Unique Identifier + // Unique identifier id string // Project ID projectId string @@ -624,15 +624,15 @@ private gcp.project.computeService.firewall @defaults("name") { priority int // Direction of traffic direction string - // Indicates whether the firewall rule is disabled + // Whether the firewall rule is disabled disabled bool - // Source Ranges + // Source ranges sourceRanges []string - // Source Service Accounts + // Source service accounts sourceServiceAccounts []string - // Source Tags + // Source tags sourceTags []string - // If defined the rule applies only to traffic that has destination IP address + // Range of destination IP addresses for which the rule applies to traffic destinationRanges []string // List of service accounts targetServiceAccounts []string @@ -646,7 +646,7 @@ private gcp.project.computeService.firewall @defaults("name") { // GCP Compute VPC Network resource private gcp.project.computeService.network @defaults("name") { - // Unique Identifier + // Unique identifier id string // Project ID projectId string @@ -660,7 +660,7 @@ private gcp.project.computeService.network @defaults("name") { enableUlaInternalIpv6 bool // Gateway address for default routing gatewayIPv4 string - // Maximum Transmission Unit in bytes + // Maximum transmission unit size in bytes mtu int // Network firewall policy enforcement order networkFirewallPolicyEnforcementOrder string @@ -670,17 +670,17 @@ private gcp.project.computeService.network @defaults("name") { peerings []dict // The network-wide routing mode to use routingMode string - // Network mode - legacy, custom or auto + // Network mode: legacy, custom or auto mode string - // List of URLs for the subnetwork in this network + // List of URLs for the subnetwork in the network subnetworkUrls []string - // Subnetworks in this network + // Subnetworks in the network subnetworks() []gcp.project.computeService.subnetwork } // GCP Compute VPC Network Partitioning private gcp.project.computeService.subnetwork @defaults("name") { - // Unique Identifier + // Unique identifier id string // Project ID projectId string @@ -688,7 +688,7 @@ private gcp.project.computeService.subnetwork @defaults("name") { name string // An optional description of this resource description string - // Indicates if flow logging for this subnetwork + // Whether flow logging is enabled for the subnetwork enableFlowLogs bool // External IPv6 address range externalIpv6Prefix string @@ -706,9 +706,9 @@ private gcp.project.computeService.subnetwork @defaults("name") { ipv6CidrRange string // VPC flow logging configuration logConfig gcp.project.computeService.subnetwork.logConfig - // VMs in this subnet can access Google services without assigned external IP addresses + // Whether VMs in this subnet can access Google services without assigned external IP addresses privateIpGoogleAccess bool - // VMs in this subnet can access Google services without assigned external IPv6 addresses + // VMs in this subnet that can access Google services without assigned external IPv6 addresses privateIpv6GoogleAccess string // Purpose of the resource purpose string @@ -726,7 +726,7 @@ private gcp.project.computeService.subnetwork @defaults("name") { created time } -// GCP Compute VPC Network Partitioning log configuration +// GCP Compute VPC Network Partitioning Log Configuration private gcp.project.computeService.subnetwork.logConfig @defaults("enable") { // Internal ID id string @@ -734,11 +734,11 @@ private gcp.project.computeService.subnetwork.logConfig @defaults("enable") { aggregationInterval string // Whether to enable flow logging for this subnetwork enable bool - // Used to define which VPC flow logs should be exported to Cloud Logging + // Which VPC flow logs are exported to Cloud Logging filterExpression string - // Sampling rate of VPC flow logs within the subnetwork where 1.0 means all collected logs are reported and 0.0 means no logs are reported + // Sampling rate of VPC flow logs within the subnetwork (1.0 means all collected logs are reported and 0.0 means no logs are reported.) flowSampling float - // Whether all, none or a subset of metadata should be added to the reported VPC flow logs + // Whether all, none, or a subset of metadata are added to the reported VPC flow logs metadata string // Metadata fields to be added to the reported VPC flow logs metadataFields []string @@ -746,7 +746,7 @@ private gcp.project.computeService.subnetwork.logConfig @defaults("enable") { // GCP Compute Cloud Router private gcp.project.computeService.router @defaults("name") { - // Unique Identifier + // Unique identifier id string // Name of the resource name string @@ -756,7 +756,7 @@ private gcp.project.computeService.router @defaults("name") { bgp dict // BGP routing stack configuration to establish BGP peering bgpPeers []dict - // Indicates if a router is dedicated for use with encrypted VLAN attachments + // Whether a router is dedicated for use with encrypted VLAN attachments encryptedInterconnectRouter bool // NAT services created in this router nats []dict @@ -764,7 +764,7 @@ private gcp.project.computeService.router @defaults("name") { created time } -// GCP Compute backend service +// GCP Compute Backend Service private gcp.project.computeService.backendService @defaults("name") { // Unique identifier id string @@ -834,7 +834,7 @@ private gcp.project.computeService.backendService @defaults("name") { timeoutSec int } -// GCP Compute backend service backend +// GCP Compute Backend Service Backend private gcp.project.computeService.backendService.backend @defaults("description") { // Internal ID id string @@ -864,7 +864,7 @@ private gcp.project.computeService.backendService.backend @defaults("description maxUtilization float } -// GCP Compute backend service CDN policy +// GCP Compute Backend Service CDN Policy private gcp.project.computeService.backendService.cdnPolicy { // Internal ID id string @@ -880,15 +880,15 @@ private gcp.project.computeService.backendService.cdnPolicy { defaultTtl int // Maximum allowed TTL for cached content maxTtl int - // Negative caching allows per-status code TTLs to be set, in order to apply fine-grained caching for common errors or redirects + // Whether negative caching allows per-status code TTLs to be set in order to apply fine-grained caching for common errors or redirects negativeCaching bool // Negative caching policy negativeCachingPolicy []dict - // Whether Cloud CDN will combine multiple concurrent cache fill requests into a small number of requests to the origin + // Whether Cloud CDN combines multiple concurrent cache fill requests into a small number of requests to the origin requestCoalescing bool // Serve existing content from the cache when revalidating content with the origin serveWhileStale int - // Maximum number of seconds the response to a signed URL request will be considered fresh + // Maximum number of seconds the response to a signed URL request is considered fresh signedUrlCacheMaxAgeSec int // Names of the keys for signing request URLs signedUrlKeyNames []string @@ -952,7 +952,7 @@ private gcp.project.sqlService.instance @defaults("name") { connectionName string // Creation timestamp created time - // Current disk usage of the instance in bytes. This is deprecated; use monitoring should be used instead. + // Deprecated currentDiskSize int // Current database version running on the instance databaseInstalledVersion string @@ -972,7 +972,7 @@ private gcp.project.sqlService.instance @defaults("name") { ipAddresses []gcp.project.sqlService.instance.ipMapping // Current software version on the instance maintenanceVersion string - // Name of the instance that will act as primary in the replica + // Name of the instance that acts as primary in the replica masterInstanceName string // Maximum disk size in bytes maxDiskSize int @@ -994,11 +994,11 @@ private gcp.project.sqlService.instance @defaults("name") { databases() []gcp.project.sqlService.instance.database } -// GCP Cloud SQL Instance database +// GCP Cloud SQL Instance Database private gcp.project.sqlService.instance.database @defaults("name") { // Project ID projectId string - // Charset value + // Character set value charset string // Collation collation string @@ -1030,7 +1030,7 @@ private gcp.project.sqlService.instance.settings { instanceName string // When the instance is activated activationPolicy string - // Active Directory configuration (relevant only for Cloud SQL for SQL Server) + // Entra ID (formerly Active Directory) configuration (relevant only for Cloud SQL for SQL Server) activeDirectoryConfig dict // Availability type availabilityType string @@ -1042,7 +1042,7 @@ private gcp.project.sqlService.instance.settings { connectorEnforcement string // Whether database flags for crash-safe replication are enabled crashSafeReplicationEnabled bool - // Size of data disk, in GB + // Size of the data disk, in GB dataDiskSizeGb int // Type of the data disk dataDiskType string @@ -1056,7 +1056,7 @@ private gcp.project.sqlService.instance.settings { denyMaintenancePeriods []gcp.project.sqlService.instance.settings.denyMaintenancePeriod // Insights configuration insightsConfig dict - // IP Management settings + // IP management settings ipConfiguration gcp.project.sqlService.instance.settings.ipConfiguration // Location preference settings locationPreference dict @@ -1070,7 +1070,7 @@ private gcp.project.sqlService.instance.settings { replicationType string // Instance settings version settingsVersion int - // SQL server specific audit configuration + // SQL-server-specific audit configuration sqlServerAuditConfig dict // Configuration to increase storage size automatically storageAutoResize bool @@ -1136,11 +1136,11 @@ private gcp.project.sqlService.instance.settings.ipConfiguration { private gcp.project.sqlService.instance.settings.maintenanceWindow @defaults("day hour") { // Internal ID id string - // Day of week (1-7), starting on Monday + // Day of week (1-7, 1 is Monday) day int - // Hour of day - 0 to 23 + // Hour of day (0 to 23) hour int - // Maintenance timing setting: canary (Earlier) or stable (Later) + // Maintenance time setting: canary (earlier) or stable (later) updateTrack string } @@ -1170,7 +1170,7 @@ private gcp.project.bigqueryService @defaults("projectId") { datasets() []gcp.project.bigqueryService.dataset } -// GCP BigQuery dataset +// GCP BigQuery Dataset private gcp.project.bigqueryService.dataset @defaults("id name") { // Dataset ID id string @@ -1202,7 +1202,7 @@ private gcp.project.bigqueryService.dataset @defaults("id name") { routines() []gcp.project.bigqueryService.routine } -// GCP BigQuery dataset access entry +// GCP BigQuery Dataset Access Entry private gcp.project.bigqueryService.dataset.accessEntry @defaults("role entity entityType") { // Internal ID id string @@ -1222,7 +1222,7 @@ private gcp.project.bigqueryService.dataset.accessEntry @defaults("role entity e datasetRef dict } -// GCP BigQuery table +// GCP BigQuery Table private gcp.project.bigqueryService.table @defaults("id") { // Table ID id string @@ -1256,7 +1256,7 @@ private gcp.project.bigqueryService.table @defaults("id") { type string // Time when this table expires expirationTime time - // Cloud KMS encryption key that will be used to protect BigQuery table + // Cloud KMS encryption key that is used to protect BigQuery table kmsName string // Indicates when the base table was snapshot snapshotTime time @@ -1300,11 +1300,11 @@ private gcp.project.bigqueryService.model @defaults("id") { type string // Expiration time of the model expirationTime time - // Cloud KMS encryption key that will be used to protect BigQuery model + // Cloud KMS encryption key that is used to protect BigQuery model kmsName string } -// GCP BigQuery routine +// GCP BigQuery Routine private gcp.project.bigqueryService.routine @defaults("id") { // Routine ID id string @@ -1334,9 +1334,9 @@ private gcp.project.dnsService { policies() []gcp.project.dnsService.policy } -// Cloud DNS managed zone is a resource that represents a DNS zone hosted by the Cloud DNS service +// Cloud DNS Managed Zone (a resource that represents a DNS zone hosted by the Cloud DNS service) private gcp.project.dnsService.managedzone @defaults("name") { - // Managed Zone ID + // Managed zone ID id string // Project ID projectId string @@ -1348,7 +1348,7 @@ private gcp.project.dnsService.managedzone @defaults("name") { dnssecConfig dict // DNS name of this managed zone dnsName string - // Optionally specifies the NameServerSet for this ManagedZone + // Optionally specifies the name server set for this managed zone nameServerSet string // Delegated to these virtual name servers nameServers []string @@ -1356,11 +1356,11 @@ private gcp.project.dnsService.managedzone @defaults("name") { visibility string // Creation timestamp created time - // Cloud DNS RecordSet in zone + // Cloud DNS record set in the zone recordSets() []gcp.project.dnsService.recordset } -// Cloud DNS RecordSet +// Cloud DNS Record Set private gcp.project.dnsService.recordset @defaults("name") { // Project ID projectId string @@ -1370,7 +1370,7 @@ private gcp.project.dnsService.recordset @defaults("name") { rrdatas []string // SignatureRrdatas: As defined in RFC 4034 signatureRrdatas []string - // Number of seconds that this ResourceRecordSet can be cached by resolvers + // Number of seconds that this resource record set can be cached by resolvers ttl int // The identifier of a supported record type type string @@ -1386,9 +1386,9 @@ private gcp.project.dnsService.policy @defaults("name") { name string // User-friendly description of the resource description string - // Indicates if DNS queries sent by VMs or applications over VPN connections are allowed + // Whether DNS queries sent by VMs or applications over VPN connections are allowed enableInboundForwarding bool - // Indicates if logging is enabled + // Whether logging is enabled enableLogging bool // List of network names specifying networks to which this policy is applied networkNames []string @@ -1422,21 +1422,21 @@ private gcp.project.gkeService.cluster @defaults("name") { network string // The IP address range of the container pods in this cluster clusterIpv4Cidr string - // The name of the Google Compute Engine subnetwork to which the cluster is connected. + // The name of the Google Compute Engine subnetwork to which the cluster is connected subnetwork string // The list of node pools for the cluster nodePools []gcp.project.gkeService.cluster.nodepool - // The list of Google Compute Engine zones in which the cluster's nodes should be located. + // The list of Google Compute Engine zones in which the cluster's nodes should be located locations []string // Enable Kubernetes alpha features enableKubernetesAlpha bool // Whether Autopilot is enabled for the cluster autopilotEnabled bool - // Deprecated. Use location instead. + // Deprecated; use location instead zone string // Name of the Google Compute Engine zone/region in which the cluster exists location string - // The IP address of this cluster's master endpoint + // The IP address of the cluster's master endpoint endpoint string // The initial Kubernetes version for this cluster initialClusterVersion string @@ -1444,7 +1444,7 @@ private gcp.project.gkeService.cluster @defaults("name") { currentMasterVersion string // The current status of this cluster status string - // The resource labels for the cluster to use to annotate any related Google Compute Engine resources. + // The resource labels for the cluster to use to annotate any related Google Compute Engine resources resourceLabels map[string]string // Creation time created time @@ -1502,9 +1502,9 @@ private gcp.project.gkeService.cluster.addonsConfig { private gcp.project.gkeService.cluster.ipAllocationPolicy { // Internal ID id string - // Whether alias IPs will be used for pod IPs in the cluster + // Whether alias IPs are used for pod IPs in the cluster useIpAliases bool - // Whether a new subnetwork will be created automatically for the cluster + // Whether a new subnetwork is created automatically for the cluster createSubnetwork bool // Custom subnetwork name to be used if createSubnetwork is true subnetworkName string @@ -1566,9 +1566,9 @@ private gcp.project.gkeService.cluster.nodepool @defaults("name") { config gcp.project.gkeService.cluster.nodepool.config // The initial node count for the pool initialNodeCount int - // The list of Google Compute Engine zones in which the NodePool's nodes should be located. + // The list of Google Compute Engine zones in which the NodePool's nodes should be located locations []string - // Networking configuration for this node pool. + // Networking configuration for this node pool networkConfig gcp.project.gkeService.cluster.nodepool.networkConfig // The Kubernetes version version string @@ -1580,7 +1580,7 @@ private gcp.project.gkeService.cluster.nodepool @defaults("name") { management dict } -// GCP GKE node pool-level network configuration +// GCP GKE Node Pool-Level Network Configuration private gcp.project.gkeService.cluster.nodepool.networkConfig @defaults("podRange podIpv4CidrBlock") { // Internal ID id string @@ -1592,7 +1592,7 @@ private gcp.project.gkeService.cluster.nodepool.networkConfig @defaults("podRang performanceConfig gcp.project.gkeService.cluster.nodepool.networkConfig.performanceConfig } -// GCP GKE node pool network performance configuration +// GCP GKE Node Pool Network Performance Configuration private gcp.project.gkeService.cluster.nodepool.networkConfig.performanceConfig @defaults("totalEgressBandwidthTier") { // Internal ID id string @@ -1600,7 +1600,7 @@ private gcp.project.gkeService.cluster.nodepool.networkConfig.performanceConfig totalEgressBandwidthTier string } -// GCP GKE node pool configuration +// GCP GKE Node Pool Configuration private gcp.project.gkeService.cluster.nodepool.config @defaults("machineType diskSizeGb") { // Internal ID id string @@ -1628,7 +1628,7 @@ private gcp.project.gkeService.cluster.nodepool.config @defaults("machineType di tags []string // Whether the nodes are created as preemptible VM instances. preemptible bool - // A list of hardware accelerators to be attached to each node + // A list of hardware accelerators to attach to each node accelerators []gcp.project.gkeService.cluster.nodepool.config.accelerator // Type of the disk attached to each node diskType string @@ -1660,7 +1660,7 @@ private gcp.project.gkeService.cluster.nodepool.config @defaults("machineType di confidentialNodes gcp.project.gkeService.cluster.nodepool.config.confidentialNodes } -// GCP GKE node pool hardware accelerators configuration +// GCP GKE Node Pool Hardware Accelerators Configuration private gcp.project.gkeService.cluster.nodepool.config.accelerator @defaults("type count") { // Internal ID id string @@ -1684,7 +1684,7 @@ private gcp.project.gkeService.cluster.nodepool.config.accelerator.gpuSharingCon strategy string } -// GCP GKE Kubernetes node taint +// GCP GKE Kubernetes Node Taint private gcp.project.gkeService.cluster.nodepool.config.nodeTaint @defaults("key value effect") { // Internal ID id string @@ -1696,7 +1696,7 @@ private gcp.project.gkeService.cluster.nodepool.config.nodeTaint @defaults("key effect string } -// GCP GKE node pool sandbox configuration +// GCP GKE Node Pool Sandbox Configuration private gcp.project.gkeService.cluster.nodepool.config.sandboxConfig @defaults("type") { // Internal ID id string @@ -1704,25 +1704,25 @@ private gcp.project.gkeService.cluster.nodepool.config.sandboxConfig @defaults(" type string } -// GCP GKE node pool shielded instance configuration +// GCP GKE Node Pool Shielded Instance Configuration private gcp.project.gkeService.cluster.nodepool.config.shieldedInstanceConfig @defaults("enableSecureBoot enableIntegrityMonitoring") { // Internal ID id string - // Defines whether the instance has Secure Boot enabled + // Whether the instance has Secure Boot enabled enableSecureBoot bool - // Defines whether the instance has integrity monitoring enabled + // Whether the instance has integrity monitoring enabled enableIntegrityMonitoring bool } -// GCP GKE node pool parameters that can be configured on Linux nodes +// GCP GKE Node Pool Parameters That Can Be Configured on Linux Nodes private gcp.project.gkeService.cluster.nodepool.config.linuxNodeConfig @defaults("sysctls") { // Internal ID id string - // The Linux kernel parameters to be applied to the nodes and all pods running on them + // The Linux kernel parameters to apply to the nodes and all pods running on them sysctls map[string]string } -// GCP GKE node pool kubelet configuration +// GCP GKE Node Pool Kubelet Configuration private gcp.project.gkeService.cluster.nodepool.config.kubeletConfig @defaults("cpuManagerPolicy podPidsLimit") { // Internal ID id string @@ -1734,7 +1734,7 @@ private gcp.project.gkeService.cluster.nodepool.config.kubeletConfig @defaults(" podPidsLimit int } -// GCP GKE node pool GCFS configuration +// GCP GKE Node Pool GCFS Configuration private gcp.project.gkeService.cluster.nodepool.config.gcfsConfig @defaults("enabled") { // Internal ID id string @@ -1742,15 +1742,15 @@ private gcp.project.gkeService.cluster.nodepool.config.gcfsConfig @defaults("ena enabled bool } -// GCP GKE node pool advanced machine features configuration +// GCP GKE Node Pool Advanced Machine Features Configuration private gcp.project.gkeService.cluster.nodepool.config.advancedMachineFeatures @defaults("threadsPerCore") { // Internal ID id string - // The number of threads per physical core. If unset, the maximum number of threads supported per core by the underlying processor is assumed + // Number of threads per physical core (if unset, assumes the maximum number of threads supported per core by the underlying processor) threadsPerCore int } -// GCP GKE node pool GVNIC configuration +// GCP GKE Node Pool GVNIC Configuration private gcp.project.gkeService.cluster.nodepool.config.gvnicConfig @defaults("enabled") { // Internal ID id string @@ -1758,7 +1758,7 @@ private gcp.project.gkeService.cluster.nodepool.config.gvnicConfig @defaults("en enabled bool } -// GCP GKE node pool confidential nodes configuration +// GCP GKE Node Pool Confidential Nodes Configuration private gcp.project.gkeService.cluster.nodepool.config.confidentialNodes @defaults("enabled") { // Internal ID id string @@ -1766,7 +1766,7 @@ private gcp.project.gkeService.cluster.nodepool.config.confidentialNodes @defaul enabled bool } -// GCP Pub/Sub resources +// GCP Pub/Sub Resources private gcp.project.pubsubService { // Project ID projectId string @@ -1778,7 +1778,7 @@ private gcp.project.pubsubService { snapshots() []gcp.project.pubsubService.snapshot } -// GCP Pub/Sub topic +// GCP Pub/Sub Topic private gcp.project.pubsubService.topic @defaults("name") { // Project ID projectId string @@ -1788,7 +1788,7 @@ private gcp.project.pubsubService.topic @defaults("name") { config() gcp.project.pubsubService.topic.config } -// GCP Pub/Sub topic configuration +// GCP Pub/Sub Topic Configuration private gcp.project.pubsubService.topic.config @defaults("kmsKeyName messageStoragePolicy") { // Project ID projectId string @@ -1796,13 +1796,13 @@ private gcp.project.pubsubService.topic.config @defaults("kmsKeyName messageStor topicName string // Labels associated with this topic labels map[string]string - // Cloud KMS key used to protect access to messages published to this topic + // Cloud KMS key used to protect access to messages published to the topic kmsKeyName string // Message storage policy messageStoragePolicy gcp.project.pubsubService.topic.config.messagestoragepolicy } -// GCP Pub/Sub topic message storage policy +// GCP Pub/Sub Topic Message Storage Policy private gcp.project.pubsubService.topic.config.messagestoragepolicy @defaults("allowedPersistenceRegions"){ // Parent configuration ID configId string @@ -1810,7 +1810,7 @@ private gcp.project.pubsubService.topic.config.messagestoragepolicy @defaults("a allowedPersistenceRegions []string } -// GCP Pub/Sub subscription +// GCP Pub/Sub Subscription private gcp.project.pubsubService.subscription @defaults("name") { // Project ID projectId string @@ -1820,7 +1820,7 @@ private gcp.project.pubsubService.subscription @defaults("name") { config() gcp.project.pubsubService.subscription.config } -// GCP Pub/Sub subscription configuration +// GCP Pub/Sub Subscription Configuration private gcp.project.pubsubService.subscription.config @defaults("topic.name ackDeadline expirationPolicy") { // Project ID projectId string @@ -1836,13 +1836,13 @@ private gcp.project.pubsubService.subscription.config @defaults("topic.name ackD retainAckedMessages bool // How long to retain messages in the backlog after they're published retentionDuration time - // Specifies the conditions for a subscription's expiration + // Conditions for a subscription's expiration expirationPolicy time // The labels associated with this subscription labels map[string]string } -// GCP Pub/Sub Configuration for subscriptions that operate in push mode +// GCP Pub/Sub Configuration for Subscriptions That Operate in Push Mode private gcp.project.pubsubService.subscription.config.pushconfig @defaults("attributes") { // Parent configuration ID configId string @@ -1852,7 +1852,7 @@ private gcp.project.pubsubService.subscription.config.pushconfig @defaults("attr attributes map[string]string } -// GCP Pub/Sub snapshot +// GCP Pub/Sub Snapshot private gcp.project.pubsubService.snapshot @defaults("name") { // Project ID projectId string @@ -1863,7 +1863,7 @@ private gcp.project.pubsubService.snapshot @defaults("name") { // When the snapshot expires expiration time } -// GCP KMS resources +// GCP KMS Resources private gcp.project.kmsService { // Project ID projectId string @@ -1873,7 +1873,7 @@ private gcp.project.kmsService { keyrings() []gcp.project.kmsService.keyring } -// GCP KMS keyring +// GCP KMS Keyring private gcp.project.kmsService.keyring @defaults("name") { // Project ID projectId string @@ -1889,7 +1889,7 @@ private gcp.project.kmsService.keyring @defaults("name") { cryptokeys() []gcp.project.kmsService.keyring.cryptokey } -// GCP KMS crypto key +// GCP KMS Crypto Key private gcp.project.kmsService.keyring.cryptokey @defaults("name purpose") { // Full resource path resourcePath string @@ -1921,7 +1921,7 @@ private gcp.project.kmsService.keyring.cryptokey @defaults("name purpose") { iamPolicy() []gcp.resourcemanager.binding } -// GCP KMS crypto key version +// GCP KMS Crypto Key Version private gcp.project.kmsService.keyring.cryptokey.version @defaults("name state") { // Full resource path resourcePath string @@ -1929,9 +1929,9 @@ private gcp.project.kmsService.keyring.cryptokey.version @defaults("name state") name string // Crypto key version's current state state string - // The protection level describing how crypto operations perform with this crypto key version + // Protection level describing how crypto operations perform with this crypto key version protectionLevel string - // Algorithm that this crypto key version supports + // Algorithm that the crypto key version supports algorithm string // Statement generated and signed by HSM at key creation time attestation gcp.project.kmsService.keyring.cryptokey.version.attestation @@ -1943,7 +1943,7 @@ private gcp.project.kmsService.keyring.cryptokey.version @defaults("name state") destroyed time // Destroy event timestamp destroyEventTime time - // Name of the import job used in the most recent import of this crypto key version + // Name of the import job used in the most recent import of the crypto key version importJob string // Time at which this crypto key version's key material was imported importTime time @@ -1955,7 +1955,7 @@ private gcp.project.kmsService.keyring.cryptokey.version @defaults("name state") reimportEligible bool } -// GCP KMS crypto key version attestation +// GCP KMS Crypto Key Version Attestation private gcp.project.kmsService.keyring.cryptokey.version.attestation { // Crypto key version name cryptoKeyVersionName string @@ -1965,7 +1965,7 @@ private gcp.project.kmsService.keyring.cryptokey.version.attestation { certificateChains gcp.project.kmsService.keyring.cryptokey.version.attestation.certificatechains } -// GCP KMS crypto key version attestation certificate chains +// GCP KMS Crypto Key Version Attestation Certificate Chains private gcp.project.kmsService.keyring.cryptokey.version.attestation.certificatechains { // Crypto key version name cryptoKeyVersionName string @@ -2003,7 +2003,7 @@ private gcp.essentialContact @defaults("email notificationCategories") { validationState string } -// GCP Project API key +// GCP Project API Key private gcp.project.apiKey @defaults("name") { // The ID of the key id string @@ -2043,7 +2043,7 @@ private gcp.project.apiKey.restrictions { serverKeyRestrictions dict } -// GCP Logging resources +// GCP Logging Resources private gcp.project.loggingservice { // Project ID projectId string @@ -2055,7 +2055,7 @@ private gcp.project.loggingservice { sinks() []gcp.project.loggingservice.sink } -// GCP Logging bucket +// GCP Logging Bucket private gcp.project.loggingservice.bucket @defaults("name") { // Project ID projectId string @@ -2075,13 +2075,13 @@ private gcp.project.loggingservice.bucket @defaults("name") { name string // Log entry field paths that are denied access in this bucket restrictedFields []string - // Logs will be retained by default for this amount of time, after which they will automatically be deleted + // Amount of time for which logs will be retained by default, after which they're' automatically deleted retentionDays int // Last update timestamp of the bucket updated time } -// GCP Logging bucket index config +// GCP Logging Bucket Index Config private gcp.project.loggingservice.bucket.indexConfig @defaults("id") { // Internal ID id string @@ -2093,7 +2093,7 @@ private gcp.project.loggingservice.bucket.indexConfig @defaults("id") { type string } -// GCP Logging metric +// GCP Logging Metric private gcp.project.loggingservice.metric @defaults("description filter") { // Metric ID id string @@ -2107,7 +2107,7 @@ private gcp.project.loggingservice.metric @defaults("description filter") { alertPolicies() []gcp.project.monitoringService.alertPolicy } -// GCP Logging sink +// GCP Logging Sink private gcp.project.loggingservice.sink @defaults("destination") { // Sink ID id string @@ -2115,7 +2115,7 @@ private gcp.project.loggingservice.sink @defaults("destination") { projectId string // Export destination destination string - // Storage bucket to which the sink exports. Only set for sinks with a destination storage bucket + // Storage bucket to which the sink exports (only set for sinks with a destination storage bucket) storageBucket() gcp.project.storageService.bucket // Optional advanced logs filter filter string @@ -2155,7 +2155,7 @@ private gcp.project.iamService.serviceAccount @defaults("displayName name") { keys() []gcp.project.iamService.serviceAccount.key } -// GCP service account keys +// GCP Service Account Keys private gcp.project.iamService.serviceAccount.key @defaults("name") { // Service account key name name string @@ -2176,9 +2176,9 @@ private gcp.project.iamService.serviceAccount.key @defaults("name") { private gcp.project.cloudFunction @defaults("name") { // Project ID projectId string - // Cloud Function name + // Cloud function name name string - // Cloud Function description + // Cloud function description description string // Location of the archive with the function's source code sourceArchiveUrl string @@ -2253,7 +2253,7 @@ private gcp.project.dataprocService { clusters() []gcp.project.dataprocService.cluster } -// GCP Dataproc cluster +// GCP Dataproc Cluster private gcp.project.dataprocService.cluster @defaults("name") { // Project ID projectId string @@ -2275,7 +2275,7 @@ private gcp.project.dataprocService.cluster @defaults("name") { virtualClusterConfig gcp.project.dataprocService.cluster.virtualClusterConfig } -// GCP Dataproc cluster config +// GCP Dataproc Cluster Config private gcp.project.dataprocService.cluster.config { // Parent resource path parentResourcePath string @@ -2313,7 +2313,7 @@ private gcp.project.dataprocService.cluster.config { worker gcp.project.dataprocService.cluster.config.instance } -// GCP Dataproc cluster endpoint config +// GCP Dataproc Cluster Endpoint Config private gcp.project.dataprocService.cluster.config.gceCluster { // Internal ID id string @@ -2327,7 +2327,7 @@ private gcp.project.dataprocService.cluster.config.gceCluster { metadata map[string]string // Compute Engine network to be used for machine communications networkUri string - // Node Group Affinity for sole-tenant clusters + // Node group affinity for sole-tenant clusters nodeGroupAffinity dict // Type of IPv6 access for the cluster privateIpv6GoogleAccess string @@ -2349,7 +2349,7 @@ private gcp.project.dataprocService.cluster.config.gceCluster { zoneUri string } -// GCP Dataproc cluster GCE Cluster reservation affinity config +// GCP Dataproc Cluster GCE Cluster Reservation Affinity Config private gcp.project.dataprocService.cluster.config.gceCluster.reservationAffinity { // Internal ID id string @@ -2361,7 +2361,7 @@ private gcp.project.dataprocService.cluster.config.gceCluster.reservationAffinit values []string } -// GCP Dataproc cluster GCE Cluster shielded instance config +// GCP Dataproc Cluster GCE Cluster Shielded Instance Config private gcp.project.dataprocService.cluster.config.gceCluster.shieldedInstanceConfig { // Internal ID id string @@ -2383,7 +2383,7 @@ private gcp.project.dataprocService.cluster.config.gkeCluster { nodePoolTarget []dict } -// GCP Dataproc cluster lifecycle config +// GCP Dataproc Cluster Lifecycle Config private gcp.project.dataprocService.cluster.config.lifecycle { // Internal ID id string @@ -2425,7 +2425,7 @@ private gcp.project.dataprocService.cluster.config.instance { preemptibility string } -// GCP Dataproc cluster instance disk config +// GCP Dataproc Cluster Instance Disk Config private gcp.project.dataprocService.cluster.config.instance.diskConfig { // Internal ID id string @@ -2439,7 +2439,7 @@ private gcp.project.dataprocService.cluster.config.instance.diskConfig { numLocalSsds int } -// GCP Dataproc cluster status +// GCP Dataproc Cluster Status private gcp.project.dataprocService.cluster.status @defaults("state") { // Internal ID id string @@ -2453,7 +2453,7 @@ private gcp.project.dataprocService.cluster.status @defaults("state") { substate string } -// GCP Dataproc cluster virtual cluster config +// GCP Dataproc Cluster Virtual Cluster Config private gcp.project.dataprocService.cluster.virtualClusterConfig { // Parent resource path parentResourcePath string @@ -2464,7 +2464,7 @@ private gcp.project.dataprocService.cluster.virtualClusterConfig { // Cloud Storage bucket used to stage job dependencies, config files, and job driver console output stagingBucket string } -// GCP Cloud Run resources +// GCP Cloud Run Resources private gcp.project.cloudRunService { // Project ID projectId string @@ -2478,7 +2478,7 @@ private gcp.project.cloudRunService { jobs() []gcp.project.cloudRunService.job } -// GCP Cloud Run operation +// GCP Cloud Run Operation private gcp.project.cloudRunService.operation @defaults("name") { // Project ID projectId string @@ -2488,7 +2488,7 @@ private gcp.project.cloudRunService.operation @defaults("name") { done bool } -// GCP Cloud Run service +// GCP Cloud Run Service private gcp.project.cloudRunService.service @defaults("name") { // Service identifier id string @@ -2544,7 +2544,7 @@ private gcp.project.cloudRunService.service @defaults("name") { reconciling bool } -// GCP Cloud Run service revision template +// GCP Cloud Run Service Revision Template private gcp.project.cloudRunService.service.revisionTemplate @defaults("name") { // Internal ID id string @@ -2578,7 +2578,7 @@ private gcp.project.cloudRunService.service.revisionTemplate @defaults("name") { maxInstanceRequestConcurrency int } -// GCP Cloud Run service revision template container +// GCP Cloud Run Service Revision Template Container private gcp.project.cloudRunService.container @defaults("name image") { // Internal ID id string @@ -2606,7 +2606,7 @@ private gcp.project.cloudRunService.container @defaults("name image") { startupProbe gcp.project.cloudRunService.container.probe } -// GCP Cloud Run service revision template container probe +// GCP Cloud Run Service Revision Template Container Probe private gcp.project.cloudRunService.container.probe { // Internal ID id string @@ -2624,7 +2624,7 @@ private gcp.project.cloudRunService.container.probe { tcpSocket dict } -// GCP Cloud Run condition +// GCP Cloud Run Condition private gcp.project.cloudRunService.condition @defaults("type state message") { // Internal ID id string @@ -2640,7 +2640,7 @@ private gcp.project.cloudRunService.condition @defaults("type state message") { severity string } -// GCP Cloud Run job +// GCP Cloud Run Job private gcp.project.cloudRunService.job { // Job identifier id string @@ -2688,7 +2688,7 @@ private gcp.project.cloudRunService.job { reconciling bool } -// GCP Cloud Run job execution template +// GCP Cloud Run Job Execution Template private gcp.project.cloudRunService.job.executionTemplate { // Internal ID id string @@ -2704,7 +2704,7 @@ private gcp.project.cloudRunService.job.executionTemplate { template gcp.project.cloudRunService.job.executionTemplate.taskTemplate } -// GCP Cloud Run job execution template task template +// GCP Cloud Run Job Execution Template Task Template private gcp.project.cloudRunService.job.executionTemplate.taskTemplate { // Internal ID id string @@ -2730,7 +2730,7 @@ private gcp.project.cloudRunService.job.executionTemplate.taskTemplate { maxRetries int } -// GCP access approval settings +// GCP Access Approval Settings private gcp.accessApprovalSettings { // Resource path resourcePath string @@ -2748,7 +2748,7 @@ private gcp.accessApprovalSettings { invalidKeyVersion bool } -// GCP monitoring resources +// GCP Monitoring Resources private gcp.project.monitoringService { // Project ID projectId string @@ -2756,7 +2756,7 @@ private gcp.project.monitoringService { alertPolicies() []gcp.project.monitoringService.alertPolicy } -// GCP monitoring alert policy +// GCP Monitoring Alert Policy private gcp.project.monitoringService.alertPolicy { // Project ID projectId string