github.com/npaton/distribution@v2.3.1-rc.0+incompatible/docs/storage-drivers/gcs.md (about)

     1  <!--[metadata]>
     2  +++
     3  title = "GCS storage driver"
     4  description = "Explains how to use the Google Cloud Storage drivers"
     5  keywords = ["registry, service, driver, images, storage,  gcs, google, cloud"]
     6  +++
     7  <![end-metadata]-->
     8  
     9  
    10  # Google Cloud Storage driver
    11  
    12  An implementation of the `storagedriver.StorageDriver` interface which uses Google Cloud for object storage.
    13  
    14  ## Parameters
    15  
    16  
    17  <table>
    18    <tr>
    19      <th>Parameter</th>
    20      <th>Required</th>
    21      <th>Description</th>
    22    </tr>
    23    <tr>
    24      <td>
    25        <code>bucket</code>
    26      </td>
    27      <td>
    28        yes
    29      </td>
    30      <td>
    31        Storage bucket name.
    32      </td>
    33    </tr>
    34    <tr>
    35      <td>
    36        <code>keyfile</code>
    37      </td>
    38      <td>
    39        no
    40      </td>
    41      <td>
    42        A private service account key file in JSON format. Instead of a key file <a href="https://developers.google.com/identity/protocols/application-default-credentials">Google Application Default Credentials</a> can be used.
    43      </td>
    44    </tr>
    45     <tr>
    46      <td>
    47        <code>rootdirectory</code>
    48      </td>
    49      <td>
    50        no
    51      </td>
    52      <td>
    53        This is a prefix that will be applied to all Google Cloud Storage keys to allow you to segment data in your bucket if necessary.
    54    </tr>
    55  
    56  </table>
    57  
    58  
    59  `bucket`: The name of your Google Cloud Storage bucket where you wish to store objects (needs to already be created prior to driver initialization).
    60  
    61  `keyfile`: (optional) A private key file in JSON format, used for [Service Account Authentication](https://cloud.google.com/storage/docs/authentication#service_accounts).
    62  
    63  **Note** Instead of a key file you can use [Google Application Default Credentials](https://developers.google.com/identity/protocols/application-default-credentials).
    64  
    65  `rootdirectory`: (optional) The root directory tree in which all registry files will be stored. Defaults to the empty string (bucket root).