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 Tilt configs #3119

Merged
merged 16 commits into from Dec 8, 2020
Merged

Add Tilt configs #3119

merged 16 commits into from Dec 8, 2020

Conversation

carlisia
Copy link
Contributor

@carlisia carlisia commented Nov 30, 2020

Closes #2501.

This is what it looks like with everything enabled. Any change to the Velero/restic server or any of the plugins is reflected in the logs within seconds:

image

Signed-off-by: Carlisia carlisia@vmware.com

nrb
nrb previously requested changes Nov 30, 2020
Tiltfile Outdated Show resolved Hide resolved
tilt-resources/examples/backupstoragelocations.yaml Outdated Show resolved Hide resolved
@github-actions github-actions bot requested a review from nrb November 30, 2020 21:02
Tiltfile Outdated
# Set up a local_resource build of the Velero binary. The binary is written to .tiltbuild/velero.
local_resource(
"velero_manager",
cmd = "cd " + "." + ';mkdir -p .tiltbuild;PKG=github.com/vmware-tanzu/velero BIN=velero GOOS=linux GOARCH=amd64 VERSION=main GIT_SHA=aa4730970037ce29 GIT_TREE_STATE=dirty OUTPUT_DIR=.tiltbuild ./hack/build.sh',
Copy link
Contributor

Choose a reason for hiding this comment

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

If this works, I think we could update the build.sh script to make the GIT_SHA optional, or look up the value in the Tiltfile once at the start.

That way, the value's not hardcoded to something that may confuse a dev looking at their binary someday and wondering why the built SHA doesn't match what they're actually building.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This worked. I have to do the same with the plugin bit.

Ok, I'll changed the build.sh.

Should PKG be set to github.com/vmware-tanzu/velero or to where the local src code is?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm pointing the PKG variable to local code. Let me know if it should be different.

@github-actions github-actions bot requested a review from nrb December 1, 2020 23:57
@carlisia
Copy link
Contributor Author

carlisia commented Dec 1, 2020

Ready for review.

@carlisia
Copy link
Contributor Author

carlisia commented Dec 2, 2020

Made some improvements:

  • changed .tiltbuild to _tiltbuild
  • added a separate local build to build a binary for the user's machine (this way we don't need to run make local when making changes to the CLI
  • added a config to pass in the user's local goos
  • renamed the Tilt resources to be more meaningful and shorter
  • added a tip to the documentation to create an alias to the user's local binary included above

@carlisia
Copy link
Contributor Author

carlisia commented Dec 2, 2020

A note: for the plugins, I am also now making a call to the plugin hack/build.sh: https://github.com/vmware-tanzu/velero/pull/3119/files#diff-c2ee8653e1d6b85f0aadf87cd438a9250806c052877248442be4d434cbc52425R178

However, plugins maintained by others might not have this build setup and, if they don't, this will fail. Should I change to call go build inline for this case?

Other than this, it's ready for review.

@nrb
Copy link
Contributor

nrb commented Dec 2, 2020

However, plugins maintained by others might not have this build setup and, if they don't, this will fail. Should I change to call go build inline for this case?

We could, though it's worth asking if we're making this universal, or for core development. Another option is to say that if you want to use the Tiltfile for development the hack/build.sh entrypoint is necessary, which may not be so bad anyway - consider that even if we do plain go build, each plugin might have their own settings/flags that they want to introduce at build time. Maybe they really want CGO turned on. By using a script name vs a bare command in the Tiltfile, they would have a way to include those settings without editing the Tiltfile.

@carlisia
Copy link
Contributor Author

carlisia commented Dec 2, 2020

consider that even if we do plain go build, each plugin might have their own settings/flags that they want to introduce at build time

This is a winning argument. And it is also not bad at all since 1, we have examples and 2, it's such a simple and small file.

So, let's 🚢 this!

Copy link
Contributor

@zubron zubron left a comment

Choose a reason for hiding this comment

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

This is really awesome so far, @carlisia! I'm still working on a review but I have some questions/comments in the meantime :)

site/content/docs/main/tilt.md Outdated Show resolved Hide resolved
**default_registry** (String, default=""): The image registry to use if you need to push images. See the [Tilt
*documentation](https://docs.tilt.dev/api.html#api.default_registry) for more details.

**provider_repos** (Array[]String, default=[]): A list of paths to all the provider plugins you want to make changes to. Each provider must have a
Copy link
Contributor

Choose a reason for hiding this comment

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

It's not necessary or a blocker, but it would be nice to get the PRs for the plugin repos merged first so that the tl;dr above works out of the box. I made the mistake of following that without checking out the plugin repo PRs with their tilt settings.

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm leaving this comment here as a note for others that we should get the other PRs reviewed and merged first :)

site/content/docs/main/tilt.md Outdated Show resolved Hide resolved
go.sum Outdated Show resolved Hide resolved
Tiltfile Outdated Show resolved Hide resolved
Tiltfile Outdated Show resolved Hide resolved
Tiltfile Outdated Show resolved Hide resolved
Tiltfile Outdated Show resolved Hide resolved
@github-actions github-actions bot requested review from nrb and zubron December 2, 2020 21:41
@carlisia carlisia force-pushed the c-tilt branch 2 times, most recently from 1a8c96c to 3ef8fa9 Compare December 2, 2020 23:42
Carlisia added 7 commits December 4, 2020 08:18
Signed-off-by: Carlisia <carlisia@vmware.com>
Signed-off-by: Carlisia <carlisia@vmware.com>
Signed-off-by: Carlisia <carlisia@vmware.com>
Signed-off-by: Carlisia <carlisia@vmware.com>
Signed-off-by: Carlisia <carlisia@vmware.com>
Signed-off-by: Carlisia <carlisia@vmware.com>
Signed-off-by: Carlisia <carlisia@vmware.com>
Signed-off-by: Carlisia <carlisia@vmware.com>
@carlisia
Copy link
Contributor Author

carlisia commented Dec 4, 2020

This is ready for review again.

site/content/docs/main/tilt.md Outdated Show resolved Hide resolved
site/content/docs/main/tilt.md Outdated Show resolved Hide resolved
Signed-off-by: Carlisia <carlisia@vmware.com>
@github-actions github-actions bot requested a review from zubron December 4, 2020 22:43
zubron
zubron previously approved these changes Dec 4, 2020
Copy link
Contributor

@zubron zubron left a comment

Choose a reason for hiding this comment

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

Woo! Thank you so much for this, @carlisia!! This is an awesome change and I'm looking forward to using it 🤩

Signed-off-by: Carlisia <carlisia@vmware.com>
Copy link
Contributor

@ashish-amarnath ashish-amarnath left a comment

Choose a reason for hiding this comment

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

LGTM! 🚢

Copy link
Contributor

@zubron zubron left a comment

Choose a reason for hiding this comment

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

🥳

@zubron zubron merged commit 5eb64eb into vmware-tanzu:main Dec 8, 2020
@carlisia carlisia deleted the c-tilt branch December 8, 2020 18:50
georgettica pushed a commit to georgettica/velero that referenced this pull request Dec 23, 2020
* Adding Tilt configs

Signed-off-by: Carlisia <carlisia@vmware.com>

* Fix spelling

Signed-off-by: Carlisia <carlisia@vmware.com>

* Reuse sample BSL yaml file

Signed-off-by: Carlisia <carlisia@vmware.com>

* Minor fix and more documentation

Signed-off-by: Carlisia <carlisia@vmware.com>

* Reuse our build.sh script

Signed-off-by: Carlisia <carlisia@vmware.com>

* Finish tweaking Tilt build

Signed-off-by: Carlisia <carlisia@vmware.com>

* Improvements

Signed-off-by: Carlisia <carlisia@vmware.com>

* This will make a better startup config

Signed-off-by: Carlisia <carlisia@vmware.com>

* Code review + improvements

Signed-off-by: Carlisia <carlisia@vmware.com>

* Improvements

Signed-off-by: Carlisia <carlisia@vmware.com>

* Reset go.sum

Signed-off-by: Carlisia <carlisia@vmware.com>

* Address code reviews

Signed-off-by: Carlisia <carlisia@vmware.com>

* Improve Tilt code

Signed-off-by: Carlisia <carlisia@vmware.com>

* Address code reviews

Signed-off-by: Carlisia <carlisia@vmware.com>

* Fix links

Signed-off-by: Carlisia <carlisia@vmware.com>

* Add CSI image to example deployment

Signed-off-by: Carlisia <carlisia@vmware.com>
georgettica pushed a commit to georgettica/velero that referenced this pull request Jan 26, 2021
* Adding Tilt configs

Signed-off-by: Carlisia <carlisia@vmware.com>

* Fix spelling

Signed-off-by: Carlisia <carlisia@vmware.com>

* Reuse sample BSL yaml file

Signed-off-by: Carlisia <carlisia@vmware.com>

* Minor fix and more documentation

Signed-off-by: Carlisia <carlisia@vmware.com>

* Reuse our build.sh script

Signed-off-by: Carlisia <carlisia@vmware.com>

* Finish tweaking Tilt build

Signed-off-by: Carlisia <carlisia@vmware.com>

* Improvements

Signed-off-by: Carlisia <carlisia@vmware.com>

* This will make a better startup config

Signed-off-by: Carlisia <carlisia@vmware.com>

* Code review + improvements

Signed-off-by: Carlisia <carlisia@vmware.com>

* Improvements

Signed-off-by: Carlisia <carlisia@vmware.com>

* Reset go.sum

Signed-off-by: Carlisia <carlisia@vmware.com>

* Address code reviews

Signed-off-by: Carlisia <carlisia@vmware.com>

* Improve Tilt code

Signed-off-by: Carlisia <carlisia@vmware.com>

* Address code reviews

Signed-off-by: Carlisia <carlisia@vmware.com>

* Fix links

Signed-off-by: Carlisia <carlisia@vmware.com>

* Add CSI image to example deployment

Signed-off-by: Carlisia <carlisia@vmware.com>
vadasambar pushed a commit to vadasambar/velero that referenced this pull request Feb 3, 2021
* Adding Tilt configs

Signed-off-by: Carlisia <carlisia@vmware.com>

* Fix spelling

Signed-off-by: Carlisia <carlisia@vmware.com>

* Reuse sample BSL yaml file

Signed-off-by: Carlisia <carlisia@vmware.com>

* Minor fix and more documentation

Signed-off-by: Carlisia <carlisia@vmware.com>

* Reuse our build.sh script

Signed-off-by: Carlisia <carlisia@vmware.com>

* Finish tweaking Tilt build

Signed-off-by: Carlisia <carlisia@vmware.com>

* Improvements

Signed-off-by: Carlisia <carlisia@vmware.com>

* This will make a better startup config

Signed-off-by: Carlisia <carlisia@vmware.com>

* Code review + improvements

Signed-off-by: Carlisia <carlisia@vmware.com>

* Improvements

Signed-off-by: Carlisia <carlisia@vmware.com>

* Reset go.sum

Signed-off-by: Carlisia <carlisia@vmware.com>

* Address code reviews

Signed-off-by: Carlisia <carlisia@vmware.com>

* Improve Tilt code

Signed-off-by: Carlisia <carlisia@vmware.com>

* Address code reviews

Signed-off-by: Carlisia <carlisia@vmware.com>

* Fix links

Signed-off-by: Carlisia <carlisia@vmware.com>

* Add CSI image to example deployment

Signed-off-by: Carlisia <carlisia@vmware.com>
dharmab pushed a commit to dharmab/velero that referenced this pull request May 25, 2021
* Adding Tilt configs

Signed-off-by: Carlisia <carlisia@vmware.com>

* Fix spelling

Signed-off-by: Carlisia <carlisia@vmware.com>

* Reuse sample BSL yaml file

Signed-off-by: Carlisia <carlisia@vmware.com>

* Minor fix and more documentation

Signed-off-by: Carlisia <carlisia@vmware.com>

* Reuse our build.sh script

Signed-off-by: Carlisia <carlisia@vmware.com>

* Finish tweaking Tilt build

Signed-off-by: Carlisia <carlisia@vmware.com>

* Improvements

Signed-off-by: Carlisia <carlisia@vmware.com>

* This will make a better startup config

Signed-off-by: Carlisia <carlisia@vmware.com>

* Code review + improvements

Signed-off-by: Carlisia <carlisia@vmware.com>

* Improvements

Signed-off-by: Carlisia <carlisia@vmware.com>

* Reset go.sum

Signed-off-by: Carlisia <carlisia@vmware.com>

* Address code reviews

Signed-off-by: Carlisia <carlisia@vmware.com>

* Improve Tilt code

Signed-off-by: Carlisia <carlisia@vmware.com>

* Address code reviews

Signed-off-by: Carlisia <carlisia@vmware.com>

* Fix links

Signed-off-by: Carlisia <carlisia@vmware.com>

* Add CSI image to example deployment

Signed-off-by: Carlisia <carlisia@vmware.com>
ywk253100 pushed a commit to ywk253100/velero that referenced this pull request Jun 29, 2021
* Adding Tilt configs

Signed-off-by: Carlisia <carlisia@vmware.com>

* Fix spelling

Signed-off-by: Carlisia <carlisia@vmware.com>

* Reuse sample BSL yaml file

Signed-off-by: Carlisia <carlisia@vmware.com>

* Minor fix and more documentation

Signed-off-by: Carlisia <carlisia@vmware.com>

* Reuse our build.sh script

Signed-off-by: Carlisia <carlisia@vmware.com>

* Finish tweaking Tilt build

Signed-off-by: Carlisia <carlisia@vmware.com>

* Improvements

Signed-off-by: Carlisia <carlisia@vmware.com>

* This will make a better startup config

Signed-off-by: Carlisia <carlisia@vmware.com>

* Code review + improvements

Signed-off-by: Carlisia <carlisia@vmware.com>

* Improvements

Signed-off-by: Carlisia <carlisia@vmware.com>

* Reset go.sum

Signed-off-by: Carlisia <carlisia@vmware.com>

* Address code reviews

Signed-off-by: Carlisia <carlisia@vmware.com>

* Improve Tilt code

Signed-off-by: Carlisia <carlisia@vmware.com>

* Address code reviews

Signed-off-by: Carlisia <carlisia@vmware.com>

* Fix links

Signed-off-by: Carlisia <carlisia@vmware.com>

* Add CSI image to example deployment

Signed-off-by: Carlisia <carlisia@vmware.com>
@eleanor-millman eleanor-millman added this to Backlog in Documentation Dec 1, 2021
gyaozhou pushed a commit to gyaozhou/velero-read that referenced this pull request May 14, 2022
* Adding Tilt configs

Signed-off-by: Carlisia <carlisia@vmware.com>

* Fix spelling

Signed-off-by: Carlisia <carlisia@vmware.com>

* Reuse sample BSL yaml file

Signed-off-by: Carlisia <carlisia@vmware.com>

* Minor fix and more documentation

Signed-off-by: Carlisia <carlisia@vmware.com>

* Reuse our build.sh script

Signed-off-by: Carlisia <carlisia@vmware.com>

* Finish tweaking Tilt build

Signed-off-by: Carlisia <carlisia@vmware.com>

* Improvements

Signed-off-by: Carlisia <carlisia@vmware.com>

* This will make a better startup config

Signed-off-by: Carlisia <carlisia@vmware.com>

* Code review + improvements

Signed-off-by: Carlisia <carlisia@vmware.com>

* Improvements

Signed-off-by: Carlisia <carlisia@vmware.com>

* Reset go.sum

Signed-off-by: Carlisia <carlisia@vmware.com>

* Address code reviews

Signed-off-by: Carlisia <carlisia@vmware.com>

* Improve Tilt code

Signed-off-by: Carlisia <carlisia@vmware.com>

* Address code reviews

Signed-off-by: Carlisia <carlisia@vmware.com>

* Fix links

Signed-off-by: Carlisia <carlisia@vmware.com>

* Add CSI image to example deployment

Signed-off-by: Carlisia <carlisia@vmware.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area/Documentation Enhancement/Dev Internal or Developer-focused Enhancement to Velero
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a Tilt setup for rapid local development
4 participants