Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(CNV-53188): improve disk-uploader usage guidance #576

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

codingben
Copy link
Member

What this PR does / why we need it:

Add more details to explain an usage of
EXPORT_SOURCE_KIND. Also, Add an example of the
Secret object, that will be referenced by
SECRET_NAME.

Release note:

None

Add more details to explain an usage of
EXPORT_SOURCE_KIND. Also, Add an example of the
Secret object, that will be referenced by
SECRET_NAME.

Signed-off-by: Ben Oukhanov <[email protected]>
@kubevirt-bot kubevirt-bot added release-note-none Denotes a PR that doesn't merit a release note. dco-signoff: yes Indicates the PR's author has DCO signed all their commits. labels Dec 16, 2024
@kubevirt-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign 0xfelix for approval. For more information see the Kubernetes Code Review Process.

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

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Copy link

openshift-ci bot commented Dec 16, 2024

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: codingben
Once this PR has been reviewed and has the lgtm label, please assign 0xfelix for approval. For more information see the Code Review Process.

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

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@codingben
Copy link
Member Author

@codingben
Copy link
Member Author

/cc @jcanocan @lyarwood

apiVersion: v1
data:
accessKeyId: <ACCESS_KEY_ID>
secretKey: <SECRET_KEY>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This requires still instructions how to get the ACCESS_KEY_ID and SECRET_KEY. E.g. the base64 encoding, and the command line to generate this comfortably. Maybe you can also mention that the instructions from https://tekton.dev/docs/pipelines/auth/#configuring-docker-authentication-for-docker will not work here.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd prefer not to re-write any instructions of using Quay or Kubernetes's, I think it would be enough for the user to google it. I can add a note about it if you really want it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please point me to any documentation about the format of the accessKeyId and secretKey ? I think even CNV downstream doc is still missing it. If the task would accept the credentials in the default dockerconfigjson format like shown in quay.io's web ui or in tekton documented, I would agree with you. But this task is expecting a format which seems to be special for kubevirt, and so we should document it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dco-signoff: yes Indicates the PR's author has DCO signed all their commits. release-note-none Denotes a PR that doesn't merit a release note. size/M
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants