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

ug: offline-update: Enable App fetching instead of preloading #694

Merged
merged 1 commit into from
Mar 5, 2024

Conversation

mike-sul
Copy link
Contributor

The recent changes to ci-scripts and fioctl allows offline update enabling without turning on the preloading/assembling.

PR Template and Checklist

Please complete as much as possible to speed up the reviewing process.

Readiness and adding reviewers as appropriate is required.

All PRs should be reviewed by a technical writer/documentation team and a peer.
If effecting customers—which is a majority of content changes—a member of Customer Success must also review.

Readiness

  • Merge (pending reviews)
  • Merge after date or event
  • Draft

Overview

Why merge this PR? What does it solve?

Checklist

  • Run spelling and grammar check, preferably with linter.
  • Avoid changing any header associated with a link/reference.
  • Step through instructions (or ask someone to do so).
  • Review for wordiness
  • Match tone and style of page/section.
  • Run make linkcheck.
  • View HTML in a browser to check rendering.
  • Use semantic newlines.
  • follow best practices for commits.
    • Descriptive title written in the imperative.
    • Include brief overview of QA steps taken.
    • Mention any related issues numbers.
    • End message with sign off/DCO line (-s, --signoff).
    • Sign commit with your gpg key (-S, --gpg-sign).
    • Squash commits if needed.
  • Request PR review by a technical writer and at least one peer.

Comments

Any thing else that a maintainer/reviewer should know.
This could include potential issues, rational for approach, etc.

The recent changes to `ci-scripts` and `fioctl` allows offline update
enabling without turning on the preloading/assembling.

Signed-off-by: Mike Sul <mike.sul@foundries.io>
@doanac
Copy link
Member

doanac commented Feb 29, 2024

@mike-sul
Copy link
Contributor Author

The provided mechanism will work only for the fioctl version with this change foundriesio/fioctl#379.

I am not sure if we should mention a specific version of fioctl to make it working. I suppose we just align the docs and fioctl releases (target lmp v94).

@mike-sul
Copy link
Contributor Author

mike-sul commented Mar 1, 2024

@vanmaegima @caiotpereira Please, let me know if this change makes sense to you?

This change won't impact existing customers that already turned on the preloading/assemble run to enable offline update (required in order to download apps into an offline bundle). The logic in the fioctl command is smart enough to figure out where to pull apps from.

The goal is to guide new customers to use the new factory configuration parameter containers:offline:enable:true if they would like to include apps into an offline update bundle.

Also, the existing customers that use just offline update and do not need the image assembling/preloading can switch to this way. It will reduce a CI build duration for them because the assemble run is turned off in this case.

Copy link
Member

@vanmaegima vanmaegima left a comment

Choose a reason for hiding this comment

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

Thanks @mike-sul , this makes sense

@mike-sul
Copy link
Contributor Author

mike-sul commented Mar 5, 2024

@vanmaegima @caiotpereira This has been deployed to the prod, so the doc update can be merged now.

@mike-sul mike-sul requested a review from kprosise March 5, 2024 10:28
@kprosise kprosise marked this pull request as ready for review March 5, 2024 12:47
Copy link
Contributor

@kprosise kprosise left a comment

Choose a reason for hiding this comment

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

LGTM, proceeding with merging

@kprosise kprosise merged commit b139d82 into main Mar 5, 2024
3 of 4 checks passed
@kprosise kprosise deleted the offline-without-preloading branch March 5, 2024 13:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants