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

Offline Support for download-starter-project endpoint #851

Closed
michael-valdron opened this issue May 19, 2022 · 1 comment · Fixed by devfile/registry-support#118
Closed
Assignees
Labels
area/registry Devfile registry for stacks and infrastructure kind/enhancement New feature or request
Projects

Comments

@michael-valdron
Copy link
Member

michael-valdron commented May 19, 2022

Which area this feature is related to?

/area registry

Which functionality do you think we should add?

Why is this needed? Is your feature request related to a problem?
for #770
for #329

To allow for starter projects to be stored locally to an offline devfile registry and downloadable from the download-starter-project endpoint.

Detailed description:
Currently, the download-starter-project endpoint will download the starter project for a given devfile from the source specified by the contents of that devfile. In order for this endpoint to work in an offline environment, the user would need to fetch the resources (e.g. the starter projects) manually and package them into the image build for the complete offline registry. Therefore, the process must be able to fetch starter projects from a local path in the registry where devfiles are stored. In this issue, we would like to add the ability to allow the download-starter-project endpoint to determine if the download is to be made from a local resource or a remote one.

Changes in this issue will effect the work being done in Issue #770.

Describe the solution you'd like

When we run GET /devfiles/<stack>/starterProjects/<starterProject> in an offline environment, we want to fetch a pre-packaged starter project rather than fetching it from a remote source as we do by default.

Describe alternatives you've considered

  • Leaving it as is would disable an offline deployment from being to provide a devfile with an accessible URL to download starter projects using tools or direct requests in such environments.
  • Had considered making a location in the registry which if exists would download from that location instead, this might cause issues or complexities when updates are applied to the starter projects in the remote sources. Instead, it might be best to have the user specify a relative path under the starter project URL within the devfile to imply a local download from registry itself.

Additional context

Target Date: 06-17-2022

@michael-valdron michael-valdron added the kind/enhancement New feature or request label May 19, 2022
@michael-valdron michael-valdron self-assigned this May 19, 2022
@michael-valdron michael-valdron added this to Under consideration in Sprint 219 via automation May 19, 2022
@openshift-ci openshift-ci bot added the area/registry Devfile registry for stacks and infrastructure label May 19, 2022
@michael-valdron michael-valdron moved this from Under consideration to To do in Sprint 219 May 19, 2022
@michael-valdron
Copy link
Member Author

There might also need to be consideration for changes to be done in #842.

@michael-valdron michael-valdron moved this from To do to In progress in Sprint 219 May 26, 2022
@michael-valdron michael-valdron moved this from In progress to Review in progress in Sprint 219 Jun 6, 2022
@johnmcollier johnmcollier removed this from Review in progress in Sprint 219 Jun 9, 2022
@johnmcollier johnmcollier added this to To do in Sprint 220 via automation Jun 9, 2022
@johnmcollier johnmcollier moved this from To do to Review in progress in Sprint 220 Jun 9, 2022
Sprint 220 automation moved this from Review in progress to Done Jun 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/registry Devfile registry for stacks and infrastructure kind/enhancement New feature or request
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

1 participant