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

Create deployment scope detection mechanism for index generator #1197

Closed
michael-valdron opened this issue Jul 18, 2023 · 10 comments
Closed
Assignees
Labels
area/registry Devfile registry for stacks and infrastructure demo Issue or PR candidate for a demo at the end of the Sprint lifecycle/rotten Rotten items. These items have been stale for 60 days and are now closed. lifecycle/stale Stale items. These items have not been updated for 90 days. severity/blocker Issues that prevent developers from working status/blocked

Comments

@michael-valdron
Copy link
Member

michael-valdron commented Jul 18, 2023

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?

Allows index server to serve clients an index schema, /v2index response, which contains new field(s) for getting the deployment scope (innerloop/outerloop) of a stack.

Detailed description:

Since the release of devfile 2.2.0, more and more stack under the devfile registry have been adopting outerloop support within the newest versions. However, with there being certain stacks which have not adopted outerloop support yet along with legacy stack versions which would not either comes no guarantee that all devfile 2.2.0 stacks will support outerloop.

In addition, there can also exist new stacks going forward which only support outerloop as well.

With the introduction of new field(s) under the index schema which indicates the deployment scope of the stacks, this can make it easier for clients to filter to the scopes they need.

Describe the solution you'd like

  1. A new field or fields which indicate the deployment scope of stacks (tracking this in Add new field which indicates the deployment scope of stacks/samples #1321)
  2. A function for checking if a Kubernetes or OpenShift deployment spec exists
  3. A function for detecting the deployment scope and to fill in this information during generation of the index
  4. Unit test cases for these functions

Innerloop Detection Example

hasInnerloopCommandGroups := commandGroups["run"] || commandGroups["debug"]
hasInnerloopComponents := false

for _, component := range components {
  if component.Container != nil {
    hasInnerloopComponents = true
    break
  }
}

if hasInnerloopComponents && hasInnerloopCommandGroups {
  deploymentScopes["innerloop"] = true
}

Describe alternatives you've considered

The alternative is to advise clients on how to perform deployment scope detection on the client side of the devfile response from the index server.

Additional context

Blocked by #1322 for detail on implementation of the detection mechanism and by #1321 for the new deployment scope field.

@michael-valdron michael-valdron self-assigned this Jul 18, 2023
@openshift-ci openshift-ci bot added the area/registry Devfile registry for stacks and infrastructure label Jul 18, 2023
@michael-valdron michael-valdron moved this to Backlog in Devfile Project Jul 18, 2023
@michael-valdron michael-valdron added the severity/blocker Issues that prevent developers from working label Jul 18, 2023
@michael-valdron
Copy link
Member Author

#959 will include the addition of the deployment scope filter on completion of this issue.

@thepetk thepetk moved this from Backlog to To Do 📝 in Devfile Project Aug 4, 2023
@michael-valdron michael-valdron moved this from To Do 📝 to Backlog in Devfile Project Oct 13, 2023
@michael-valdron michael-valdron moved this from Backlog to To Do 📝 in Devfile Project Oct 16, 2023
@thepetk thepetk added the demo Issue or PR candidate for a demo at the end of the Sprint label Oct 16, 2023
@michael-valdron
Copy link
Member Author

Complexity sizing: August 4, 2023
Time sizing: October 19, 2023

@michael-valdron
Copy link
Member Author

Based on #1321 & #1322 refinement and sizing this issue will need to be resized to its current details and scope. Moved out of sprint and rescheduled for an upcoming refinement call.

@michael-valdron
Copy link
Member Author

Previous points are 8 complexity based / 8 time based

@michael-valdron
Copy link
Member Author

blocked by #959 to provide filtering before field implementation: #959 (comment)

Copy link

This issue is stale because it has been open for 90 days with no activity. Remove stale label or comment or this will be closed in 60 days.

@github-actions github-actions bot added the lifecycle/stale Stale items. These items have not been updated for 90 days. label Feb 28, 2024
@michael-valdron
Copy link
Member Author

Still needed and waiting on #959 to be resolved.

@github-actions github-actions bot removed the lifecycle/stale Stale items. These items have not been updated for 90 days. label Mar 6, 2024
@michael-valdron
Copy link
Member Author

#959 is resolved, and this issue is now unblocked.

@michael-valdron michael-valdron moved this from Backlog to To Do 📝 in Devfile Project Apr 15, 2024
@michael-valdron
Copy link
Member Author

#1321 is still blocking this issue, need to replace effort towards resolving that one: #1321 (comment)

@michael-valdron michael-valdron moved this from To Do 📝 to Backlog in Devfile Project Apr 25, 2024
Copy link

This issue is stale because it has been open for 90 days with no activity. Remove stale label or comment or this will be closed in 60 days.

@github-actions github-actions bot added the lifecycle/stale Stale items. These items have not been updated for 90 days. label Sep 21, 2024
@github-actions github-actions bot added the lifecycle/rotten Rotten items. These items have been stale for 60 days and are now closed. label Nov 21, 2024
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Nov 21, 2024
@github-project-automation github-project-automation bot moved this from Backlog to Done ✅ in Devfile Project Nov 21, 2024
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 demo Issue or PR candidate for a demo at the end of the Sprint lifecycle/rotten Rotten items. These items have been stale for 60 days and are now closed. lifecycle/stale Stale items. These items have not been updated for 90 days. severity/blocker Issues that prevent developers from working status/blocked
Projects
Status: Done ✅
Development

No branches or pull requests

2 participants