Document the issue with using properly formatted timeoutForDataDownload

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: To fully approve this pull request, please assign additional approvers. We suggest the following additional approver: elsonrodriguez

Assign the PR to them by writing /assign @elsonrodriguez in a comment when ready.

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files: - **[OWNERS](https://github.com/kubeflow/experimental-kvc/blob/master/OWNERS)** Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment

[k8s-ci-robot]

Hi @ashahba. Thanks for your PR.

I'm waiting for a kubeflow member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.

[ashahba]

@balajismaniam it is not clearly documented that one bad value causes all volumemangers to hang. That is the point of this PR 🙂 Here is one:

apiVersion: kvc.kubeflow.org/v1
kind: VolumeManager
metadata:
  name: scratchpad-notimeout-hangs
  namespace: ashahba
spec:
  volumeConfigs:
    - id: "scratchpad-notimeout-bad-03"
      sourceType: "S3"
      sourceURL: "SOME_S3_PATH"
      accessMode: "ReadWriteOnce"
      endpointURL: "https://storage.googleapis.com"
      capacity: 100Mi
      replicas: 2
      labels:
        key1: scratchpad-notimeout-hangs
      options:
        awsCredentialsSecretName: gcs-creds
        timeoutForDataDownload: 10

Once this is deployed all attempts to create volumemanager is going to fail.

I0518 16:28:32.451026       1 reflector.go:240] Listing and watching *v1.VolumeManager from github.com/kubeflow/experimental-kvc/pkg/client/informers/externalversions/factory.go:60
E0518 16:28:32.453485       1 reflector.go:205] github.com/kubeflow/experimental-kvc/pkg/client/informers/externalversions/factory.go:60: Failed to list *v1.VolumeManager: v1.VolumeManagerList.Items: []v1.VolumeManager: v1.VolumeManager.Spec: v1.VolumeManagerSpec.VolumeConfigs: []v1.VolumeConfig: v1.VolumeConfig.Options: ReadString: expects " or n, but found 1, error found in #10 byte of ...|ownload":10},"replic|..., bigger context ...|SecretName":"gcs-creds","timeoutForDataDownload":10},"replicas":2,"sourceType":"S3","sourceURL":"s3:|...

So the point is the emphasize 🙂

[balajismaniam]

@ashahba It is already documented elsewhere. During offline discussions you mentioned that the controller crashed when you added incorrect time formats. Please document or open an issue for that. I'm closing this PR for now.

[ashahba]

Sounds good @balajismaniam but I tried to document it here in this PR: https://github.com/kubeflow/experimental-kvc/pull/50/files#diff-2872b51e38bcd053c0e88c4fe5c28fd2R347

[balajismaniam]

@ashahba That is already documented. To be clear, I'm asking you to document the controller crash error using an issue or PR fixing that issue.