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

doc: manage backup plugin in fleet #391

Merged
merged 1 commit into from
Oct 12, 2023

Conversation

Xieql
Copy link
Contributor

@Xieql Xieql commented Oct 11, 2023

What type of PR is this?

/kind documentation

What this PR does / why we need it:

the doc for #381

To support Kurator's unified backup, restore, and migration features, it's imperative to first configure the backup plugin for Fleet,

This guide will walk you through configuring the Velero-based backup plugin for Fleet, laying the groundwork for Kurator's unified backup, restore, and migration capabilities

Which issue(s) this PR fixes:
Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?:


@netlify
Copy link

netlify bot commented Oct 11, 2023

Deploy Preview for kurator-dev ready!

Name Link
🔨 Latest commit 5a113d9
🔍 Latest deploy log https://app.netlify.com/sites/kurator-dev/deploys/65279571c15d8e000814b22f
😎 Deploy Preview https://deploy-preview-391--kurator-dev.netlify.app/docs/fleet-manager/backup-plugin
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@Xieql
Copy link
Contributor Author

Xieql commented Oct 11, 2023

I am not sure if it is suitable to add a pic here, because we already have one at "docs/proposals/backup/image"

provider: huaweicloud
endpoint: http://obs.cn-south-1.myhuaweicloud.com
region: cn-south-1
secretName: obs-credentials
Copy link
Member

Choose a reason for hiding this comment

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

any guide on the secret format?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

already consider it, not sure if it is enough:

line55: For more configuration options, please refer to the Fleet API.

the content of Fleet API link:

image

@Xieql Xieql force-pushed the doc-backup-plugin branch 2 times, most recently from 76184cb to e11e35e Compare October 12, 2023 03:25
@Xieql
Copy link
Contributor Author

Xieql commented Oct 12, 2023

@hzxuzhonghu what about this backup arch digram


### 2. Configuring Object Storage for Velero

Kurator's backup relies on Velero. Hence, [Object Storage](https://velero.io/docs/v1.12/how-velero-works/) is essential to restore Kubernetes resources. We support various object storage options. In this guide, we provide detailed usage instructions for the following configurations:
Copy link
Member

Choose a reason for hiding this comment

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

is essential to store

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed

Signed-off-by: Xieql <xieqianglong@huawei.com>
@Xieql Xieql force-pushed the doc-backup-plugin branch from e11e35e to 5a113d9 Compare October 12, 2023 06:42
Copy link
Member

@hzxuzhonghu hzxuzhonghu left a comment

Choose a reason for hiding this comment

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

/lgtm

@kurator-bot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: hzxuzhonghu

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:

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

@kurator-bot kurator-bot merged commit 76a3b1c into kurator-dev:main Oct 12, 2023
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants