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

velero vSphere plugin docs for v1.3.0 #420

Merged
merged 1 commit into from
Dec 4, 2021

Conversation

deepakkinni
Copy link
Collaborator

What this PR does / why we need it:
Updates the current docs.

Which issue(s) this PR fixes:
Fixes: #418

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

NONE

Signed-off-by: Deepak Kinni [email protected]

@svcbot-qecnsdp
Copy link

Sorry, some of the pre-check tests are failing for this PR !

Please check the Jenkins job for more details
https://container-dp.svc.eng.vmware.com/job/CNSDP-CI/649/

docs/guest.md Outdated Show resolved Hide resolved
docs/guest.md Outdated Show resolved Hide resolved
docs/guest.md Outdated Show resolved Hide resolved
docs/vanilla.md Outdated Show resolved Hide resolved
docs/vanilla.md Outdated Show resolved Hide resolved
docs/vanilla.md Outdated Show resolved Hide resolved
docs/vanilla.md Outdated Show resolved Hide resolved
docs/vanilla.md Show resolved Hide resolved
docs/vanilla.md Outdated Show resolved Hide resolved
docs/vanilla.md Show resolved Hide resolved
Copy link
Contributor

@lintongj lintongj left a comment

Choose a reason for hiding this comment

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

A general comment here. I would suggest to add a separate page for the detail of creating the ConfigMap with credential. In the cluster flavor specific landing page, let's add one entry into the list of prerequisites with EMPHASIS.

@deepakkinni
Copy link
Collaborator Author

A general comment here. I would suggest to add a separate page for the detail of creating the ConfigMap with credential. In the cluster flavor specific landing page, let's add one entry into the list of prerequisites with EMPHASIS.

Actually, the ConfigMaps are different for guest and vanilla (no vc credentials secret necessary for guest), so having a common config map page wouldn't be possible.

@lintongj
Copy link
Contributor

lintongj commented Dec 2, 2021

A general comment here. I would suggest to add a separate page for the detail of creating the ConfigMap with credential. In the cluster flavor specific landing page, let's add one entry into the list of prerequisites with EMPHASIS.

Actually, the ConfigMaps are different for guest and vanilla (no vc credentials secret necessary for guest), so having a common config map page wouldn't be possible.

Just maintain different sections in the separate page for vanilla and guest cluster flavor respectively. Otherwise, if put too many detail in the per-cluster landing page, users are easy to get lost.

@svcbot-qecnsdp
Copy link

Congratulations !!

All the pre-check tests passed
https://container-dp.svc.eng.vmware.com/job/CNSDP-CI/657/

@lintongj
Copy link
Contributor

lintongj commented Dec 3, 2021

A general comment here. I would suggest to add a separate page for the detail of creating the ConfigMap with credential. In the cluster flavor specific landing page, let's add one entry into the list of prerequisites with EMPHASIS.

Actually, the ConfigMaps are different for guest and vanilla (no vc credentials secret necessary for guest), so having a common config map page wouldn't be possible.

Just maintain different sections in the separate page for vanilla and guest cluster flavor respectively. Otherwise, if put too many detail in the per-cluster landing page, users are easy to get lost.

@deepakkinni I took one another look at this PR. Ignore my previous comments. Generally, it looks good to organize this newly added section this way.

My only comment here is, would it be better to also add a corresponding section to supervisor.md and call out that it is not required to create such a ConfigMap for plugin in supervisor cluster?

docs/guest.md Show resolved Hide resolved
docs/vanilla.md Show resolved Hide resolved
@xing-yang
Copy link
Contributor

LGTM

@deepakkinni deepakkinni merged commit 1c9483d into vmware-tanzu:main Dec 4, 2021
@svcbot-qecnsdp
Copy link

Congratulations !!

All the pre-check tests passed
https://container-dp.svc.eng.vmware.com/job/CNSDP-CI/658/

deepakkinni pushed a commit to deepakkinni/velero-plugin-for-vsphere that referenced this pull request Dec 8, 2021
Updates the current docs.

Signed-off-by: Deepak Kinni <[email protected]>
deepakkinni pushed a commit that referenced this pull request Dec 17, 2021
[Crossport]velero vSphere plugin docs for v1.3.0 (#420)
@deepakkinni deepakkinni deleted the 1.3_docs branch May 3, 2023 01:41
lipingxue pushed a commit to lipingxue/velero-plugin-for-vsphere that referenced this pull request May 19, 2023
Updates the current docs.

Signed-off-by: Deepak Kinni <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add doc to update 1.3 install
4 participants