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

Update operator.yaml and add schedule backup example #15969

Merged
merged 3 commits into from
Jun 3, 2024

Conversation

frouioui
Copy link
Member

Description

This Pull Request adds one more step to the operator example: schedule backup. It comes at the very end of the guide, after Resharding. For this a new 401_ file is added.

The operator.yaml file is also modified to reflect the changes brought by planetscale/vitess-operator#553.

Related Issue(s)

Copy link
Contributor

vitess-bot bot commented May 17, 2024

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels May 17, 2024
@frouioui frouioui added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: Examples and removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels May 17, 2024
@github-actions github-actions bot added this to the v20.0.0 milestone May 17, 2024
Signed-off-by: Florent Poinsard <[email protected]>
@@ -1,4 +1,3 @@
---
apiVersion: apiextensions.k8s.io/v1
Copy link
Member Author

Choose a reason for hiding this comment

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

The file is a copy of the output we get when generating the operator.yaml file in the vitess-operator repository, on top of the PR planetscale/vitess-operator#553

Copy link
Member

@GuptaManan100 GuptaManan100 left a comment

Choose a reason for hiding this comment

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

Rest LGTM

Comment on lines -6158 to -6173
---
apiVersion: scheduling.k8s.io/v1
description: The vitess-operator control plane.
globalDefault: false
kind: PriorityClass
metadata:
name: vitess-operator-control-plane
value: 5000
---
apiVersion: scheduling.k8s.io/v1
description: Vitess components (vttablet, vtgate, vtctld, etcd)
globalDefault: false
kind: PriorityClass
metadata:
name: vitess
value: 1000
Copy link
Member

Choose a reason for hiding this comment

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

I don't think we want to remove this.

Copy link
Member Author

Choose a reason for hiding this comment

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

We are not removing this block, the tool moved it a bit earlier in the file. I have used the raw output of kustomize which I think is what we should do from now on to avoid any conflict or unnecessary changes in the future.

See planetscale/vitess-operator#553 (comment)

@frouioui frouioui mentioned this pull request May 30, 2024
49 tasks
@deepthi
Copy link
Member

deepthi commented May 31, 2024

Added "Do not merge" because the operator PR needs to be merged first, then this one, and then the website PR.

Signed-off-by: Florent Poinsard <[email protected]>
Copy link

codecov bot commented Jun 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.22%. Comparing base (9911880) to head (92fca3b).
Report is 38 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #15969      +/-   ##
==========================================
- Coverage   68.45%   68.22%   -0.23%     
==========================================
  Files        1562     1541      -21     
  Lines      197057   197254     +197     
==========================================
- Hits       134891   134585     -306     
- Misses      62166    62669     +503     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@frouioui
Copy link
Member Author

frouioui commented Jun 3, 2024

DCO is working wrong right now, manually verified signoff

@frouioui frouioui merged commit 1090d42 into vitessio:main Jun 3, 2024
92 of 93 checks passed
@frouioui frouioui deleted the scheduled-backups-example branch June 3, 2024 22:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Examples Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants