FilestoreInstance

Property Value
Google Cloud Service Name Cloud Filestore
Google Cloud Service Documentation /filestore/docs
Google Cloud REST Resource Name v1beta1.projects.locations.instances
Google Cloud REST Resource Documentation /filestore/docs/reference/rest/v1beta1/projects.locations.instances
Config Connector Resource Short Names gcpfilestoreinstance
gcpfilestoreinstances
filestoreinstance
Config Connector Service Name file.googleapis.com
Config Connector Resource Fully Qualified Name filestoreinstances.filestore.cnrm.cloud.google.com
Can Be Referenced by IAMPolicy/IAMPolicyMember No

Custom Resource Definition Properties

Spec

Schema

  description: string
  fileShares:
  - capacityGb: integer
    name: string
    nfsExportOptions:
    - accessMode: string
      anonGid: integer
      anonUid: integer
      ipRanges:
      - string
      squashMode: string
    sourceBackupRef:
      external: string
      name: string
      namespace: string
  location: string
  networks:
  - ipAddresses:
    - string
    modes:
    - string
    networkRef:
      external: string
      name: string
      namespace: string
    reservedIPRange: string
  projectRef:
    external: string
    name: string
    namespace: string
  resourceID: string
  tier: string
Fields

description

Optional

string

The description of the instance (2048 characters or less).

fileShares

Optional

list (object)

File system shares on the instance. For this version, only a single file share is supported.

fileShares.[]

Optional

object

fileShares.[].capacityGb

Optional

integer

File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes.

fileShares.[].name

Optional

string

The name of the file share (must be 16 characters or less).

fileShares.[].nfsExportOptions

Optional

list (object)

Nfs Export Options. There is a limit of 10 export options per file share.

fileShares.[].nfsExportOptions.[]

Optional

object

fileShares.[].nfsExportOptions.[].accessMode

Optional

string

Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE. Possible values: ACCESS_MODE_UNSPECIFIED, READ_ONLY, READ_WRITE

fileShares.[].nfsExportOptions.[].anonGid

Optional

integer

An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.

fileShares.[].nfsExportOptions.[].anonUid

Optional

integer

An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.

fileShares.[].nfsExportOptions.[].ipRanges

Optional

list (string)

List of either an IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or CIDR ranges in the format `{octet1}.{octet2}.{octet3}.{octet4}/{mask size}` which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.

fileShares.[].nfsExportOptions.[].ipRanges.[]

Optional

string

fileShares.[].nfsExportOptions.[].squashMode

Optional

string

Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH. Possible values: SQUASH_MODE_UNSPECIFIED, NO_ROOT_SQUASH, ROOT_SQUASH

fileShares.[].sourceBackupRef

Optional

object

fileShares.[].sourceBackupRef.external

Optional

string

The resource name of the backup, in the format `projects/{project_number}/locations/{location_id}/backups/{backup_id}`, that this file share has been restored from.

fileShares.[].sourceBackupRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

fileShares.[].sourceBackupRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

location

Required

string

The location for the resource

networks

Optional

list (object)

VPC networks to which the instance is connected. For this version, only a single network is supported.

networks.[]

Optional

object

networks.[].ipAddresses

Optional

list (string)

Output only. IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or IPv6 addresses in the format `{block1}:{block2}:{block3}:{block4}:{block5}:{block6}:{block7}:{block8}`.

networks.[].ipAddresses.[]

Optional

string

networks.[].modes

Optional

list (string)

Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.

networks.[].modes.[]

Optional

string

networks.[].networkRef

Optional

object

networks.[].networkRef.external

Optional

string

The name of the Google Compute Engine [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected.

networks.[].networkRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

networks.[].networkRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

networks.[].reservedIPRange

Optional

string

A /29 CIDR block in one of the [internal IP address ranges](https://www.arin.net/reference/research/statistics/address_filters/) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Cloud Filestore instances in the selected VPC network.

projectRef

Required

object

The Project that this resource belongs to.

projectRef.external

Optional

string

The project for the resource

projectRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

projectRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceID

Optional

string

Immutable. Optional. The name of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default.

tier

Optional

string

The service tier of the instance. Possible values: TIER_UNSPECIFIED, STANDARD, PREMIUM, BASIC_HDD, BASIC_SSD, HIGH_SCALE_SSD

Status

Schema

  conditions:
  - lastTransitionTime: string
    message: string
    reason: string
    status: string
    type: string
  createTime: string
  etag: string
  observedGeneration: integer
  state: string
  statusMessage: string
Fields
conditions

list (object)

Conditions represent the latest available observation of the resource's current state.

conditions.[]

object

conditions.[].lastTransitionTime

string

Last time the condition transitioned from one status to another.

conditions.[].message

string

Human-readable message indicating details about last transition.

conditions.[].reason

string

Unique, one-word, CamelCase reason for the condition's last transition.

conditions.[].status

string

Status is the status of the condition. Can be True, False, Unknown.

conditions.[].type

string

Type is the type of the condition.

createTime

string

Output only. The time when the instance was created.

etag

string

Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.

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.

state

string

Output only. The instance state. Possible values: STATE_UNSPECIFIED, CREATING, READY, REPAIRING, DELETING, ERROR

statusMessage

string

Output only. Additional information about the instance state, if available.

Sample YAML(s)

Typical Use Case

  # Copyright 2020 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: filestore.cnrm.cloud.google.com/v1beta1
  kind: FilestoreInstance
  metadata:
    name: filestoreinstance-sample
  spec:
    description: "A sample filestore instance"
    fileShares:
      - capacityGb: 4800
        name: my_share
        nfsExportOptions:
          - accessMode: READ_WRITE
            anonGid: 65534
            anonUid: 65534
            ipRanges:
              - 172.217.14.238
            squashMode: ROOT_SQUASH
    location: us-central1-c
    networks:
      - networkRef:
          name: filestoreinstance-dep
        modes:
          - MODE_IPV4
        reservedIPRange: 10.0.0.0/29
    tier: PREMIUM
  ---
  apiVersion: compute.cnrm.cloud.google.com/v1beta1
  kind: ComputeNetwork
  metadata:
    name: filestoreinstance-dep
  spec:
    autoCreateSubnetworks: false