feat(docs): document poor performance of sortTagsByDate flag (spinnak…

…er#1639)
costimuraru · Jun 23, 2020 · 2a5429b · 2a5429b
1 parent 942e329
commit 2a5429b
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/docs/commands.md b/docs/commands.md
@@ -8491,7 +8491,7 @@ hal config provider docker-registry account add ACCOUNT [parameters]
  * `--read-permissions`: (*Default*: `[]`) A user must have at least one of these roles in order to view this account's cloud resources.
  * `--repositories`: (*Default*: `[]`) An optional list of repositories to cache images from. If not provided, Spinnaker will attempt to read accessible repositories from the registries _catalog endpoint
  * `--required-group-membership`: (*Default*: `[]`) A user must be a member of at least one specified group in order to make changes to this account's cloud resources.
- * `--sort-tags-by-date`: (*Default*: `false`) Sort tags by creation date.
+ * `--sort-tags-by-date`: (*Default*: `false`) Sort tags by creation date. Not recommended for use with large registries; sorting performance scales poorly due to limitations of the Docker V2 API.
  * `--track-digests`: (*Default*: `false`) Track digest changes. This is not recommended as it consumes a high QPM, and most registries are flaky.
  * `--username`: Your docker registry username
  * `--write-permissions`: (*Default*: `[]`) A user must have at least one of these roles in order to make changes to this account's cloud resources.
@@ -8555,7 +8555,7 @@ hal config provider docker-registry account edit ACCOUNT [parameters]
  * `--remove-write-permission`: Remove this permission to from list of write permissions.
  * `--repositories`: (*Default*: `[]`) An optional list of repositories to cache images from. If not provided, Spinnaker will attempt to read accessible repositories from the registries _catalog endpoint
  * `--required-group-membership`: A user must be a member of at least one specified group in order to make changes to this account's cloud resources.
- * `--sort-tags-by-date`: Sort tags by creation date.
+ * `--sort-tags-by-date`: Sort tags by creation date. Not recommended for use with large registries; sorting performance scales poorly due to limitations of the Docker V2 API.
  * `--track-digests`: Track digest changes. This is not recommended as it consumes a high QPM, and most registries are flaky.
  * `--username`: Your docker registry username
  * `--write-permissions`: A user must have at least one of these roles in order to make changes to this account's cloud resources.

diff --git a/...lyard/cli/command/v1/config/providers/dockerRegistry/DockerRegistryCommandProperties.java b/...lyard/cli/command/v1/config/providers/dockerRegistry/DockerRegistryCommandProperties.java
@@ -61,7 +61,9 @@ class DockerRegistryCommandProperties {
   static final String PAGINATE_SIZE_DESCRIPTION =
       "Paginate size for the docker repository _catalog endpoint.";
 
-  static final String SORT_TAGS_BY_DATE_DESCRIPTION = "Sort tags by creation date.";
+  static final String SORT_TAGS_BY_DATE_DESCRIPTION =
+      "Sort tags by creation date. Not recommended for use with large "
+          + "registries; sorting performance scales poorly due to limitations of the Docker V2 API.";
 
   static final String TRACK_DIGESTS_DESCRIPTION =
       "Track digest changes. This is not recommended as it consumes a high QPM, and most registries are flaky.";