Visitar URL original
Readme for language plugins with specific info for SDK projects and features · Issue #5786 · operator-framework/operator-sdk · GitHub
Skip to content

Readme for language plugins with specific info for SDK projects and features #5786

Open
Open
Readme for language plugins with specific info for SDK projects and features#5786
Labels
lifecycle/frozenIndicates that an issue or PR should not be auto-closed due to staleness.lifecycle/rottenDenotes an issue or PR that has aged beyond stale and will be auto-closed.needs discussionpriority/important-longtermImportant over the long term, but may not be staffed and/or may need multiple releases to complete.
Milestone
Backlog

Description

@camilamacedo86
camilamacedo86
opened on May 21, 2022

Feature Request

Describe the problem you need a feature to resolve.

For Golang we scaffold a Readme file, see: kubernetes-sigs/kubebuilder#2610
I think it would be nice if we have the same for the other languages.

Additionally, wdyt about we have a helper plugin that adds on top the steps specific for SDK and how to test the bundle with the operator-sdk run bundle.

Describe the solution you'd like.

a) Ensure that we are OK with the default README scaffold via Kubebuilder ( see if we would like not to improve or change it first )
b) Then use this README as a base to create a template for all language plugins
c) Create a new helper plugin in SDK as we have manifest/v2 (https://github.com/operator-framework/operator-sdk/tree/master/internal/plugins/manifests/v2) which does changes on top of the Makefile so that we could encourage and skill up authors and users of these projects use operator-sdk run bundle as specific and nice helpers provided by SDK.

Activity

  1. varshaprasad96 commented on May 23, 2022

    @varshaprasad96
    varshaprasad96
    on May 23, 2022
    Member

    @camilamacedo86 For the step 3, do you mean to create a new plugin for scaffolding an olm bundle to support all OLM commands (like run, upgrade bundle etc). The plugin will basically replace the generate bundle command. If so, that is definitely a priority for Operator-SDK. And since that is an involved process, it would probably need a separate issue to track it down.

  2. asmacdo
    added
    needs discussion
    on May 23, 2022
  3. asmacdo
    added this to the Backlog milestone on May 23, 2022
  4. asmacdo
    added
    priority/important-longtermImportant over the long term, but may not be staffed and/or may need multiple releases to complete.
    on May 23, 2022

  5. camilamacedo86 commented on May 24, 2022

    @camilamacedo86
    camilamacedo86
    on May 24, 2022
    ContributorAuthor

    Hi @varshaprasad96,

    @camilamacedo86 For the step 3, do you mean to create a new plugin for scaffolding an olm bundle to support all OLM commands (like run, upgrade bundle etc). The plugin will basically replace the generate bundle command. If so, that is definitely a priority for Operator-SDK. And since that is an involved process, it would probably need a separate issue to track it down.

    No, This plugin is only to add content to the README file scaffold by default regards what is specific for SKD. Example: Add on the bottom of the readme how to test the solution with the operator-sdk run bundle.

    It is only about the README file content.

  6. openshift-bot commented on Aug 22, 2022

    @openshift-bot
    openshift-bot
    on Aug 22, 2022

    Issues go stale after 90d of inactivity.

    Mark the issue as fresh by commenting /remove-lifecycle stale.
    Stale issues rot after an additional 30d of inactivity and eventually close.
    Exclude this issue from closing by commenting /lifecycle frozen.

    If this issue is safe to close now please do so with /close.

    /lifecycle stale

  7. openshift-ci
    added
    lifecycle/staleDenotes an issue or PR has remained open with no activity and has become stale.
    on Aug 22, 2022

  8. openshift-bot commented on Sep 22, 2022

    @openshift-bot
    openshift-bot
    on Sep 22, 2022

    Stale issues rot after 30d of inactivity.

    Mark the issue as fresh by commenting /remove-lifecycle rotten.
    Rotten issues close after an additional 30d of inactivity.
    Exclude this issue from closing by commenting /lifecycle frozen.

    If this issue is safe to close now please do so with /close.

    /lifecycle rotten
    /remove-lifecycle stale

  9. openshift-ci
    added
    lifecycle/rottenDenotes an issue or PR that has aged beyond stale and will be auto-closed.
    and removed
    lifecycle/staleDenotes an issue or PR has remained open with no activity and has become stale.
    on Sep 22, 2022
  10. camilamacedo86
    added
    lifecycle/frozenIndicates that an issue or PR should not be auto-closed due to staleness.
    on Sep 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    lifecycle/frozenIndicates that an issue or PR should not be auto-closed due to staleness.lifecycle/rottenDenotes an issue or PR that has aged beyond stale and will be auto-closed.needs discussionpriority/important-longtermImportant over the long term, but may not be staffed and/or may need multiple releases to complete.

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions