Merge pull request kubernetes-sigs#665 from ayberk/patch-1

Add note for gp3 on outposts
ayberk · Dec 18, 2020 · e0f4887 · e0f4887
2 parents 30c5f38 + f72c31c
commit e0f4887
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/CHANGELOG-0.x.md b/CHANGELOG-0.x.md
@@ -1,7 +1,7 @@
 # v0.8.0
 
 ## Notable changes
-- gp3 is now the default volume type.
+- gp3 is now the default volume type. gp3 is **not** supported on outposts. Outpost customers need to use a different type for their volumes.
 - Images will be built on a Debian base by default. Images built on Amazon Linux will still be available but with the tag suffix `-amazonlinux`.
 - Images will be published to k8s.gcr.io in addition to ECR, GitHub, and Docker Hub.
 

diff --git a/docs/README.md b/docs/README.md
@@ -33,14 +33,15 @@ There are several optional parameters that could be passed into `CreateVolumeReq
 | Parameters                  | Values                                 | Default  | Description         |
 |-----------------------------|----------------------------------------|----------|---------------------|
 | "csi.storage.k8s.io/fsType" | xfs, ext2, ext3, ext4                  | ext4     | File system type that will be formatted during volume creation |
-| "type"                      | io1, io2, gp2, gp3, sc1, st1,standard  | gp3      | EBS volume type     |
+| "type"                      | io1, io2, gp2, gp3, sc1, st1,standard  | gp3*     | EBS volume type     |
 | "iopsPerGB"                 |                                        |          | I/O operations per second per GiB. Required when io1 or io2 volume type is specified. If this value multiplied by the size of a requested volume produces a value below the minimum or above the maximum IOPs allowed for the volume type, as documented [here](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html), AWS will return an error and volume creation will fail |
 | "iops"                      |                                        | 3000     | I/O operations per second. Only effetive when gp3 volume type is specified. If empty, it will set to 3000 as documented [here](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html). |
 | "throughput"                |                                        | 125      | Throughput in MiB/s. Only effective when gp3 volume type is specified. If empty, it will set to 125MiB/s as documented [here](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html). |
 | "encrypted"                 |                                        |          | Whether the volume should be encrypted or not. Valid values are "true" or "false" |
 | "kmsKeyId"                  |                                        |          | The full ARN of the key to use when encrypting the volume. When not specified, the default KMS key is used |
 
 **Notes**:
+* `gp3` is currently not supported on outposts. Outpost customers need to use a different type for their volumes.
 * The parameters are case insensitive.
 
 # EBS CSI Driver on Kubernetes