-
Notifications
You must be signed in to change notification settings - Fork 16.7k
stable/velero: Update Velero to v1.2.0 #18492
Conversation
Hi @carlisia. Thanks for your PR. I'm waiting for a helm member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great, thanks @carlisia. If we can remove the Velero version change, we can just do a patch bump on the chart here
Ah the plugin docs is relevant to 1.2.0, so we should hold this and use this PR to release 1.2.0. #17585 can then rebase once this is merged. /hold |
26db60a
to
8b376c5
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great! couple minor things
|
||
### Configuration |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this information added elsewhere? There's the CLI command example, but it lacks the description/required fields from this table, which I find useful.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We had talked about this in the past in the context of the velero install
command. What we had decided was to have the CLI itself be the source of documentation, instead of trying to keep such documentation up to date in multiple places. At least this is my recollection, and also doesn't mean we can't change it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, that's true of velero install
, though the Helm chart is a bit different. For example, all of these options can (an normally, should) be in a values.yaml file versus just being on the command line. Also, when they're on the command line, they're not their own flags, but rather key/value pairs given to set
.
There's also options like credentials.existingSecret
that aren't in velero install
that have some interactions with other values. That's not immediately clear from just the command line instructions here.
Finally, there's also Helm standards that mention documenting what's possible in a values.yaml
file.
I think I'd propose having both the CLI example that was added as well as the table here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Gotcha. But these values are all documented in values.yaml
. Do they need to be duplicated in the readme too?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, I don't think they need to duplicated - in the values.yaml
is fine. I'll mark this as resolved.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the convention is to actually have them documented. Personally I find dot notation way better searchable than YAML notation. Example:
configuration.backupStorageLocation.config.storageAccount
vs
configuration:
# a lot of documentation
# a lot of documentation
# a lot of documentation
# a lot of documentation
# a lot of documentation
backupStorageLocation:
# a lot of documentation
# a lot of documentation
# a lot of documentation
# a lot of documentation
# a lot of documentation
config:
# a lot of documentation
# a lot of documentation
# a lot of documentation
# a lot of documentation
# a lot of documentation
storageAccount
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's a good point. While it's well taken, I think in order to get Helm users onto v1.2, we should defer this discussion to a separate PR and focus this one on any changes necessary to get 1.2 installable at this stage.
Should we include a facility within velero to allow for the helm chart to install the necessary plugin(s) which now require the |
/hold cancel |
@billimek the docs have been updated to reflect that in this PR: https://github.com/helm/charts/pull/18492/files#diff-600a674d7d9abb8a92992fae1f8bc6d5R54. I do think we can make this UX a little nicer by making it simpler to specify plugin images, but maybe something we can address in a follow up PR? |
I commented on Google groups in regards to the (old, the 1.1.0) Helm chart yesterday, see here https://groups.google.com/forum/#!topic/projectvelero/pUm3CyrIusA A fix for the first issue should be straightforward and I would love to supply a pull but where-to ? The second issue I am not sure if you guys feel like that should be steered by the Helm chart, as customisation can be done via a ConfigMap according to https://velero.io/docs/master/restic/ , it would certainly make things simpler.
|
@thabach Thanks for reporting those problems. Could you file those as separate issues in this repo and assign them to me, so we can get them addressed? I don't know that we'll include them in this PR, but we may do a follow-up point release. |
@nrb just realised that I was sitting on an old |
@carlisia are you able to rebase this and fix conflicts? |
Getting this rebased now.. |
81be461
to
614db71
Compare
@prydonius / @nrb PTAL. |
/ok-to-test |
helm upgrade <RELEASE NAME> --set initContainers.backupStorageLocation.name=aws,initContainers.volumeSnapshotLocation.name=aws stable/velero | ||
``` | ||
|
||
## Upgrading |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's add an "Upgrading to v1.2.0" subsection here. I think we can also remove the "Upgrading to v0.11.0" section, and I'd be fine dropping the "Upgrading to v1.0.0" section as well.
otherwise, LGTM! |
@carlisia looks like this is good to go once the conflicts are resolved! |
stable/velero/Chart.yaml
Outdated
description: A Helm chart for velero | ||
name: velero | ||
version: 2.5.0 | ||
version: 2.6.0 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
version: 2.6.0 | |
version: 2.7.0 |
stable/velero/values.yaml
Outdated
# - name: plugins | ||
# mountPath: /target | ||
# - mountPath: /target | ||
# name: plugin |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
# name: plugin | |
# name: plugins |
stable/velero/values.yaml
Outdated
# - name: | ||
# image: | ||
# - name: velero-plugin-for-aws | ||
# image: velero/velero-plugin-for-aws:v1.0.0-beta.1 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
# image: velero/velero-plugin-for-aws:v1.0.0-beta.1 | |
# image: velero/velero-plugin-for-aws:v1.0.0 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
where do I need to specify the plugins inside of the helm chart. Is there a reference to the values file? Actualy im having an issue upgrading.
#19427
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You have to specify it in the initContainers
field in the values file like is exemplified here. Hope this was the answer you were looking for.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I could solve the problem by using init containers:
initContainers:
- name: velero-plugin-for-microsoft-azure
image: velero/velero-plugin-for-microsoft-azure:v1.0.0
volumeMounts:
- name: plugins
mountPath: /target
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@JoaoBraveCoding yes, thats it. I think I didn´t see your message on Friday, but today. Thank you!
priorityClassName: {} | ||
|
||
# Init containers to add to the Velero deployment's pod spec. Optional. | ||
# Init containers to add to the Velero deployment's pod spec. At least one plugin provider image is required. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this would be very helpful, otherwise i wont know where to add the plugins to the chart
@carlisia let's try to get this rebased and merged soon so we get updated and don't continue to hit merge conflicts! |
Signed-off-by: Carlisia <[email protected]>
Signed-off-by: Carlisia <[email protected]>
Signed-off-by: Carlisia <[email protected]>
Signed-off-by: Carlisia <[email protected]>
6957095
to
2446b15
Compare
/ok-to-test |
/lgtm |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: carlisia, nrb 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 |
* Update Velero to v1.2.0 Signed-off-by: Carlisia <[email protected]> * Bump release version Signed-off-by: Carlisia <[email protected]> * Fix docs Signed-off-by: Carlisia <[email protected]> * Code reviews Signed-off-by: Carlisia <[email protected]>
* Update Velero to v1.2.0 Signed-off-by: Carlisia <[email protected]> * Bump release version Signed-off-by: Carlisia <[email protected]> * Fix docs Signed-off-by: Carlisia <[email protected]> * Code reviews Signed-off-by: Carlisia <[email protected]> Signed-off-by: Artur <[email protected]>
Signed-off-by: Carlisia [email protected]
Is this a new chart
What this PR does / why we need it:
Which issue this PR fixes
(optional, in
fixes #<issue number>(, fixes #<issue_number>, ...)
format, will close that issue when PR gets merged)Special notes for your reviewer:
Checklist
[Place an '[x]' (no spaces) in all applicable fields. Please remove unrelated fields.]
[stable/mychartname]
)