XMLWordPrintable

    • False
    • Hide

      None

      Show
      None
    • False
    • 0
    • 0% 0%

      Feature description

      Every object a user can control in the dashboard should be editable as YAML in addition to the form view currently supported.

      For example, if a user creates a "Model Server" or a "Workbench" in the UI, a user should ultimately be able to view/edit the object that the UI creates directly via YAML.

       

      Why is this important?

      • Everything being an object/yaml in k8s is a core foundational piece of why k8s is a popular orchestration platform. Often times it does make sense to provide a great UI to edit and manage objects, but at the end of the day the YAML for the objects is the "Source of Truth".
      • When troubleshooting an issue the first question is most often "Can you share the YAML?". The Support channel of the ODH Slack is a great example of this where most troubleshooting threads ask for the YAML.
      • One thing that OCP does great is providing a form based view to manage objects, but always exposing and making the YAML accessible. This makes it easy for users to discover and better understand what the tool is actually doing and how changes you make through the form impact the actual YAML object.
      • Customers are most often talking to Red Hat about RHODS because they are already familiar with k8s/OCP. The fact that these users are likely already well versed in working with YAML means that providing access to the YAML through the UI can help to bridge what they know on the OCP side to better help them to leverage RHODS.
      • When moving to higher level environments, often times users do not have any direct permissions to the cluster and all changes must be implemented through GitOps. Generally this means that users must extract the YAML objects that they have created through the UI and re-implement them in a GitOps repo.

      Describe alternatives you've considered

      Many of these objects can be found in the OpenShift Console but the fact that different components come from different operators make for a less than desirable experience. On the OCP side you need to either know the name of the object Kind or the operator that provides the object in order to find it.

      The Data Connector is a great example where you need to know that a Data Connector is actually a Secret and you need to know that the dashboard actually creates the secret name as - and is not simply the name you gave the data-connector.

      Another option would be to simply redirect the user to the object in the OCP console with the Edit YAML button mocked up above.

            Unassigned Unassigned
            troyer@redhat.com Trevor Royer
            RHOAI Dashboard
            Votes:
            2 Vote for this issue
            Watchers:
            4 Start watching this issue

              Created:
              Updated: