Add tags plugin to handle image tagging and deployment of tagged app images #1225

michaelshobbs · 2015-06-10T21:22:26Z

as with most "simple" things, this was not as straightforward as we've been fairly lax about how $IMAGE is set.

add tag plugin, documentation & tests
- tag:add
- tag:deploy
- tag:list
- tag:rm
consolidate setting $IMAGE to verify_app_name()
extend verify_app_name() to accept $TAG (image tag)
created get_running_image_tag()
consolidate release/deploy calls to release_and_deploy()
add $TAG to appropriate pluginhook calls
- pre-deploy
- docker-args-deploy
- docker-args-run
- pre-release
- pre-release-buildstep
- pre-release-dockerfile
- post-release
- post-release-buildstep
- post-release-dockerfile
make apps:destroy container/image cleanup more robust (read: actually destroy an app and all its artifcats)

josegonzalez · 2015-06-10T21:44:32Z

Do images get tagged on deploy atm? Would be nice to do that automatically - heroku-style at least, could be optional.

michaelshobbs · 2015-06-10T22:03:19Z

Tagging is not automatic at the moment. I wanted to provide the method to do it first before automating it.

I am also not sure what makes sense as far as naming and retention. Automatic tagging could definitely eat up disk space quickly.

josegonzalez · 2015-06-10T22:51:23Z

Ah in that you'd have things to rollback to etc.

Are there new pluginhooks for when an image is tagged?

michaelshobbs · 2015-06-10T22:55:47Z

No new pluginhooks here

josegonzalez · 2015-06-10T22:56:42Z

GIVE ME PLUGINHOOKS

josegonzalez · 2015-06-10T23:00:42Z

plz

michaelshobbs · 2015-06-10T23:08:16Z

Can you be more specific about what functionality you'd like? Example use-case?

josegonzalez · 2015-06-10T23:10:27Z

I'd like to be able to:

push a tag after it has been created to a docker hub
remove tags from docker hub if they have been removed on a server

Basically it.

michaelshobbs · 2015-06-11T01:15:23Z

Done.

michaelshobbs · 2015-06-12T16:11:40Z

@josegonzalez thoughts on where to communicate to plugin devs that they need to get the image name + tag from get_running_image_tag() when developing non *-build plugins that require the image name?

josegonzalez · 2015-06-12T16:31:30Z

Uh what? I'm not sure I understand your question.

michaelshobbs · 2015-06-12T17:36:01Z

Yeah sorry I was poorly multi-tasking when I wrote that.

This PR exposes to the user control over the $IMAGE variable that was previously hard-coded (in multiple places) to dokku/$APP. Currently plugins that need to modify the app image also hard-code this variable. This practice will need to change for those plugins in order to modify the correct image when tags are in use. So my question is, how should we communicate this change in behavior?

Does that make more sense?

josegonzalez · 2015-06-12T18:40:47Z

That sounds like a breaking change, and we should make a 0.4.0 release to handle it imo.

michaelshobbs · 2015-06-12T18:44:49Z

Totally agree with you there. We should probably call it out in the release notes for 0.4.0 and update the plugin dev docs to call it out specifically. I'll do the latter now and update this PR.

josegonzalez · 2015-06-12T18:46:10Z

Anything else we want to do for 0.4.0? We may as well do that now-ish.

michaelshobbs · 2015-06-12T18:46:57Z

what about buildkit and plugn?

https://github.com/progrium/dokku/wiki/Refactoring

…ag()

michaelshobbs · 2015-09-02T19:24:05Z

@josegonzalez this needs another code review pass given its age

josegonzalez · 2015-09-03T18:08:52Z

docs/development/pluginhooks.md

Do all our built-in hooks follow this pattern?

Just ones that use an image but depending on your thoughts on how $IMAGE is set we can revert this and make a new function call to get the app image name and tag.

Yeah I'd rather it be clear as to how variables are set than placing magic in random places like this ;)

josegonzalez · 2015-09-04T00:11:14Z

dokku

The output after this is duplicated in release_and_deploy I think.

u2mejc · 2015-09-04T00:43:59Z

plugins/tag/commands

@michaelshobbs $ make you holler! 💸

https://gist.github.com/michaelshobbs/90b2445e4d2c8da5ff40

points! well played

josegonzalez · 2015-09-04T01:43:38Z

docs/process-management.md

Should this go in the deployment doc instead?

yes. moving.

allow tagging and deployment of tagged app images

josegonzalez · 2015-09-04T02:23:03Z

Image tagging == crushed.

josegonzalez · 2015-09-10T03:47:59Z

@michaelshobbs A few questions now that I'm using this (ffs I should have tested this before):

Why are we using $IMAGE_REPO:$IMAGE_TAG as the format for a tag?
Is it possible to override the $IMAGE_REPO prefix? For instance, quay.io requires that you specify your tag prefix as quay.io/username/repository.
What happens if we have an app with multiple containers (web, worker, cron)? Which one gets tagged? Can we specify a container type to get tagged?

michaelshobbs · 2015-09-10T04:05:57Z

To close the loop here

$IMAGE_REPO:$IMAGE_TAG is the string used to reference an image
$IMAGE_REPO is hardcoded to be dokku/$APP
containers != images

If you want to push to a docker registry then use a plugin that implements the tags-create/tags-destroy trigger as in the documentation example. http://progrium.viewdocs.io/dokku/development/pluginhooks/#user-content-tags-create

josegonzalez · 2015-09-10T04:19:25Z

To setup a mobius loop:

I am not a smart man and didn't realize how tags work...
I'll be creating a quay.io plugin integration for dokku (pushing/pulling image tags and deploying them to applications).

Thanks @michaelshobbs for setting me straight :)

josegonzalez added bc-break type: enhancement labels Jul 3, 2015

josegonzalez added the 0.4.0 label Aug 26, 2015

michaelshobbs self-assigned this Sep 1, 2015

michaelshobbs added 6 commits September 2, 2015 11:18

allow tagging and deployment of tagged app images

04a4da7

call tag-add and tag-remove pluginhooks

5be7641

fix my copypasta in unit test

1c8722c

[ci skip] add documentation note about $IMAGE and get_running_image_t…

d8828c2

…ag()

use get_running_image_tag in new enter plugin

d696013

errant use of local. derp

8be5c87

michaelshobbs force-pushed the mh-image-tagging branch from 48996f9 to 8be5c87 Compare September 2, 2015 19:04

[ci skip] fix up docs

2f16b06

josegonzalez reviewed Sep 3, 2015
View reviewed changes

josegonzalez reviewed Sep 4, 2015
View reviewed changes

dokku Outdated

Copy link

Member

josegonzalez Sep 4, 2015

Choose a reason for hiding this comment

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

The output after this is duplicated in release_and_deploy I think.

create get_app_image_repo() to define our app image pattern and use it

9c37069

michaelshobbs force-pushed the mh-image-tagging branch from c697116 to 9c37069 Compare September 4, 2015 00:21

remove duplicate output

ccb9e4a

u2mejc reviewed Sep 4, 2015
View reviewed changes

rename tag to tags. make verbs more consistent

5f7c442

josegonzalez reviewed Sep 4, 2015
View reviewed changes

michaelshobbs added 2 commits September 3, 2015 18:55

[ci skip] move taging to deployment doc

74e1bf9

make local consistent in functions

9eb30d9

josegonzalez added a commit that referenced this pull request Sep 4, 2015

Merge pull request #1225 from progrium/mh-image-tagging

0904c3d

allow tagging and deployment of tagged app images

josegonzalez merged commit 0904c3d into master Sep 4, 2015

josegonzalez deleted the mh-image-tagging branch September 4, 2015 02:22

josegonzalez changed the title ~~allow tagging and deployment of tagged app images~~ Allow tags plugin to handle image tagging and deployment of tagged app images Sep 15, 2015

josegonzalez changed the title ~~Allow tags plugin to handle image tagging and deployment of tagged app images~~ Add tags plugin to handle image tagging and deployment of tagged app images Sep 19, 2015

josegonzalez unassigned michaelshobbs Dec 6, 2015

josegonzalez added merge-level: minor and removed bc-break labels Jul 17, 2020

Uh oh!

Add tags plugin to handle image tagging and deployment of tagged app images #1225

Add tags plugin to handle image tagging and deployment of tagged app images #1225

Uh oh!

Conversation

michaelshobbs commented Jun 10, 2015

Uh oh!

josegonzalez commented Jun 10, 2015

Uh oh!

michaelshobbs commented Jun 10, 2015

Uh oh!

josegonzalez commented Jun 10, 2015

Uh oh!

michaelshobbs commented Jun 10, 2015

Uh oh!

josegonzalez commented Jun 10, 2015

Uh oh!

josegonzalez commented Jun 10, 2015

Uh oh!

michaelshobbs commented Jun 10, 2015

Uh oh!

josegonzalez commented Jun 10, 2015

Uh oh!

michaelshobbs commented Jun 11, 2015

Uh oh!

michaelshobbs commented Jun 12, 2015

Uh oh!

josegonzalez commented Jun 12, 2015

Uh oh!

michaelshobbs commented Jun 12, 2015

Uh oh!

josegonzalez commented Jun 12, 2015

Uh oh!

michaelshobbs commented Jun 12, 2015

Uh oh!

josegonzalez commented Jun 12, 2015

Uh oh!

michaelshobbs commented Jun 12, 2015

Uh oh!

michaelshobbs commented Sep 2, 2015

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

josegonzalez commented Sep 4, 2015

Uh oh!

josegonzalez commented Sep 10, 2015

Uh oh!

michaelshobbs commented Sep 10, 2015

Uh oh!

josegonzalez commented Sep 10, 2015

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants