Uploaded image for project: 'OpenShift Console'
  1. OpenShift Console
  2. CONSOLE-3289

SPIKE: Create an official example plugin for partners to learn from

XMLWordPrintable

    • Icon: Story Story
    • Resolution: Done
    • Icon: Critical Critical
    • None
    • None
    • None
    • HAC Infra OCP - Sprint 227, HAC Infra OCP - Sprint 228

      As a partner which has experience with React but has no experience with patternfly/ocp/dynamic plugins, I want to have an example plugin which I can use as a starting point for my development so I will get off to a good start.

      A customer use case:

      1. customer has an operator and custom resources (what custom resource to use? something basic? would secure control constraint be a good example for this custom resource?)
      2. wants to expose those to the ui 
      3. walk through the steps to accomplish that with 
        1. list pages
        2. detail pages
        3. actions - custom action / create / delete
        4. create/edit form for a custom resource
        5. add a tab to an existing resource detail page (ie adding pdb to pods page)

      Start with sams plugin template:
      https://github.com/spadgett/console-plugin-template

      (Need input on suggested steps below. IE mimic the flow if we wanted to add a new resource to the console ui, what would be the route for completing that task.)

      Staged outline of how to build a plugin:

      stage 1: template to create a plugin with a single nav item

      stage 2: add a list view

      stage 3: add actions to the page

      In the end bring in a new resource that is managed by your new dynamic plugin

      Acceptance criteria:

      • Create stories that will cover work necessary to create plugins that will provide real world examples for partners to learn from

       

      Conclusion:

      • Minimal Dynamic Plugin for the CronTab CRD which is also used in official k8s docs for various examples
      • Advanced Dynamic Plugin for the VerticalPodAutoscaler
        • In co-op with Node team (Ryan Phillips's team) - Deliver part of their operator

              jhadvig@redhat.com Jakub Hadvig
              tjelinek@redhat.com Tomas Jelinek (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated:
                Resolved: