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

Image automation migration guide #806

Merged
merged 13 commits into from
Feb 12, 2021
Merged

Image automation migration guide #806

merged 13 commits into from
Feb 12, 2021

Conversation

squaremo
Copy link
Member

@squaremo squaremo commented Jan 27, 2021

Ref: #736

TODO:

  • Fix up some of the links (apparently relative paths don't work)
  • Decide whether to mention migrating on a branch, or explain it in full, or ignore the possibility.

(EDIT) Save these for another guide:

  • Operating the automation like Flux v1:
    • how to pause an automation
    • how to lock an image where it is

@squaremo squaremo force-pushed the image-auto-migration-howto branch 3 times, most recently from f56b910 to 8574367 Compare February 8, 2021 13:39
@stefanprodan stefanprodan mentioned this pull request Feb 10, 2021
29 tasks
@squaremo squaremo marked this pull request as ready for review February 10, 2021 13:43
@squaremo squaremo changed the title WIP automation migration guide Image automation migration guide Feb 10, 2021
@hiddeco hiddeco added area/docs Documentation related issues and pull requests area/image-automation Automated image updates related issues and pull requests labels Feb 12, 2021
Copy link
Member

@stefanprodan stefanprodan left a comment

Choose a reason for hiding this comment

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

LGTM

Awesome guide @squaremo I added a suggestion on using numerical but it's no blocker.

@squaremo squaremo force-pushed the image-auto-migration-howto branch 4 times, most recently from 174d2fe to 1a5f99a Compare February 12, 2021 15:24
squaremo and others added 11 commits February 12, 2021 16:46
This doc describes how to move from using Flux v1 to update image refs
in git, to using Flux v2. There is some overlap with the tutorial on
how to use Flux v2 automation. This how-to spends more time on how to
convert existing configuration to be used with Flux v2.

Signed-off-by: Michael Bridgen <[email protected]>
The Flux v1 migration how-to flows better if the section on how to set
builds up to tag images in the right way is its own document. It's a
lot to skim past when you don't need it, and (since it's a different
layer of yak hair) something you might want to figure out first if you
do need it.

Signed-off-by: Michael Bridgen <[email protected]>
Previously, creating an automation object was the last instruction. It
is easier to describe what to expect at each step when the last step
is to add an update marker in the file to be updated, since the next
thing that should happen is that the automation makes an update as a
consequence.

This commit shifts the sections around so that setting up the
GitRepository and ImageUpdateAutomation are done earlier, and
migrating each file are done after that, and completes the steps
described including checking the expected status at each stage.

Signed-off-by: Michael Bridgen <[email protected]>
Using a commit number is trickier than it sounds. It would need to be
padded to sort correctly, for one thing. It is better to leave it out
than to give an incomplete account.

Signed-off-by: Michael Bridgen <[email protected]>
I have moved TODO comments (that still apply) to the PR description.

Signed-off-by: Michael Bridgen <[email protected]>
Stray characters here and there threw off the markdown engine.

Signed-off-by: Michael Bridgen <[email protected]>
Signed-off-by: Michael Bridgen <[email protected]>
Signed-off-by: Hidde Beydals <[email protected]>
@hiddeco hiddeco force-pushed the image-auto-migration-howto branch from 9b66c5f to 3777044 Compare February 12, 2021 15:54
@hiddeco hiddeco force-pushed the image-auto-migration-howto branch from 3777044 to 51a4dae Compare February 12, 2021 16:01
@hiddeco hiddeco force-pushed the image-auto-migration-howto branch from 51a4dae to 30c1c5c Compare February 12, 2021 16:02
@hiddeco hiddeco merged commit 055eb4a into main Feb 12, 2021
@hiddeco hiddeco deleted the image-auto-migration-howto branch February 12, 2021 16:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Documentation related issues and pull requests area/image-automation Automated image updates related issues and pull requests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants