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

Add a concrete example on how to restore a cert-manager installation #1353

Merged

Conversation

inteon
Copy link
Member

@inteon inteon commented Dec 1, 2023

The /docs/devops-tips/backup page was already describing how to backup using Velero.
However, there was no concrete example that shows how to do this.
This PR adds that example (including a workaround to properly restore the owner reference on a Certificate created by ingress-shim).

You can use Velero locally using these commands (see https://velero.io/docs/v1.12/contributions/minio/):

kubectl apply --server-side -f ./examples/minio/00-minio-deployment.yaml

./velero install \
    --provider aws \
    --plugins velero/velero-plugin-for-aws:v1.2.1 \
    --bucket velero \
    --secret-file ./credentials-velero \
    --use-volume-snapshots=false \
    --backup-location-config region=minio,s3ForcePathStyle="true",s3Url=http://minio.velero.svc:9000

@jetstack-bot jetstack-bot added the dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. label Dec 1, 2023
@inteon inteon requested a review from wallrj December 1, 2023 09:06
@jetstack-bot jetstack-bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Dec 1, 2023
Signed-off-by: Tim Ramlot <42113979+inteon@users.noreply.github.com>
@inteon inteon force-pushed the add_concrete_velero_example branch from 1039157 to 29b7ea1 Compare December 1, 2023 09:09
Copy link

netlify bot commented Dec 1, 2023

Deploy Preview for cert-manager-website ready!

Name Link
🔨 Latest commit 6e597d4
🔍 Latest deploy log https://app.netlify.com/sites/cert-manager-website/deploys/6569b2137bed0800084c7c81
😎 Deploy Preview https://deploy-preview-1353--cert-manager-website.netlify.app
📱 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.

@cert-manager cert-manager deleted a comment from netlify bot Dec 1, 2023
Copy link
Member

@wallrj wallrj left a comment

Choose a reason for hiding this comment

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

Thanks @inteon

It's interesting to see some examples of how to use the velero CLI.

I was surprised that the instructions recommend restoring the cert-manager app in the same phase as the custom resources.
My expectation was that the cert-manager app would be excluded from the backup, because it can so easily be re-installed from the Helm chart or manifests.
Or else that cert-manager (and other platform apps) would be backed up and restored separately from the applications that run on the platform.
But I have no idea how people actually use Velero.

Perhaps this will trigger some reactions from our users, who can refine the instructions with their real world experiences.

I found a couple of related issues:

/lgtm
/hold because I think we should remove the word "recommend"

content/docs/devops-tips/backup.md Outdated Show resolved Hide resolved
content/docs/devops-tips/backup.md Outdated Show resolved Hide resolved
@jetstack-bot jetstack-bot added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. lgtm Indicates that a PR is ready to be merged. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Dec 1, 2023
Signed-off-by: Tim Ramlot <42113979+inteon@users.noreply.github.com>
@jetstack-bot jetstack-bot removed the lgtm Indicates that a PR is ready to be merged. label Dec 1, 2023
@inteon inteon requested a review from wallrj December 1, 2023 10:20
Copy link
Member

@wallrj wallrj left a comment

Choose a reason for hiding this comment

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

Great.

/lgtm

@jetstack-bot jetstack-bot added the lgtm Indicates that a PR is ready to be merged. label Dec 1, 2023
@jetstack-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: wallrj

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

@inteon
Copy link
Member Author

inteon commented Dec 1, 2023

/unhold

@jetstack-bot jetstack-bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Dec 1, 2023
@jetstack-bot jetstack-bot merged commit a8ff50a into cert-manager:master Dec 1, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. lgtm Indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants