Publish command fixes/improvements #2250
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We had been making some assumptions that the in-cluster registry was being used. We already had the code to pull images from other registries, so this wasn't actually to hard to address. Also added tests to validate.
edvald
force-pushed
the
publish-improvements
branch
from
9be5f32
to
98b77e2
Compare
eysi09
reviewed
Feb 12, 2021
docs/guides/in-cluster-building.md
Outdated
|
|
||
| As usual, you need to specify the `image` field on the `container` module in question. For example: | ||
| You'll generally need to specify the `image` field on the `container` module in question, to indicate where the image should be published. For example: |
There was a problem hiding this comment.
Why generally? Doesn't this always apply? If not, can we mention when it doesn't.
There was a problem hiding this comment.
You don't need that if you're publishing to your deployment registry, for example.
There was a problem hiding this comment.
But I'll clarify that in the docs.
| if (!containerHelpers.hasDockerfile(module, module.version)) { | ||
| log.setState({ msg: `Nothing to publish` }) | ||
| return { published: false } | ||
| } | ||
|
|
||
| const localId = containerHelpers.getLocalImageId(module, module.version) | ||
| const remoteId = containerHelpers.getPublicImageId(module) | ||
| const remoteId = containerHelpers.getPublicImageId(module, tag) | ||
|
|
||
| log.setState({ msg: `Publishing image ${remoteId}...` }) |
There was a problem hiding this comment.
Perhaps out of scope for this one but would be nice to stream the logs from the publish command when at verbose log level.
docs/guides/in-cluster-building.md
Outdated
| You can also set the `--tag` option on the `garden publish` command to override the tag used for images. You can both set a specific tag or you can _use template strings for the tag_. For example, you can | ||
|
|
||
| - Set a specific tag on all published modules: `garden publish --tag "v1.2.3"` | ||
| - Set a custom prefix on tags but include the Garden version hash: `garden publish --tag "v0.1-${module.hash}"` |
There was a problem hiding this comment.
I need to escape the $ for this to work, otherwise I get a zsh: bad substitution error. We should probably mention that here.
There was a problem hiding this comment.
I updated the example to use single-quotes, which solves that matter, and documented that as well.
This should generally make the `garden publish` command a lot more usable. You can now override the default tag at publish-time, and even apply template strings on the tags. For details, please check out the updated "Publishing images" section in the in-cluster building docs, and the updated command docs.
edvald
force-pushed
the
publish-improvements
branch
from
5b15fad
to
0d65aeb
Compare
|
Updated @eysi09 |
eysi09
approved these changes
Feb 22, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It was time to give the publish command a bit of ❤️. Couple of commits:
fix(k8s): garden publish command now works with any deploymentRegistry
We had been making some assumptions that the in-cluster registry was
being used. We already had the code to pull images from other
registries, so this wasn't actually to hard to address. Also added
tests to validate.
feat(publish): add template-able --tag parameter to publish command
This should generally make the
garden publishcommand a lot moreusable. You can now override the default tag at publish-time, and
even apply template strings on the tags.
From the updated in-cluster building docs:
You can also set the
--tagoption on thegarden publishcommand to override the tag used for images. You can both set a specific tag or you can use template strings for the tag. For example, you cangarden publish --tag "v1.2.3"garden publish --tag "v0.1-${module.hash}"garden publish --tag "v0.1-${git.branch}"Generally, you can use any template strings available for module configs for the tags, with the addition of the following:
${module.name}— the name of module being tagged${module.version}— the full Garden version of module being tagged, e.g.v-abcdef1234${module.hash}— the Garden version hash of module being tagged, e.g.abcdef1234(i.e. without thev-prefix)When reviewing, please give the publish command a spin, and try messing about with the
--tagparameter.