Uploaded image for project: 'Maistra'
  1. Maistra
  2. MAISTRA-2302

Create maistra/api repository

    XMLWordPrintable

Details

    • Story
    • Resolution: Done
    • Major
    • maistra-2.1.0
    • None
    • None
    • None

    Description

      Our OSSM/Maistra API (ie our custom labels and CRDs) is growing with every release, but we don't have a central location for it yet. To avoid circular dependencies between operator and control plane, we're currently keeping multiple copies of the types.go in multiple repositories, incl. codegen.

      We should create a maistra/api repository that can be imported by both the operator and the control plane. We can then also have proper documentation generated from docstrings in that repository, which we can point people at as an API reference.

       

      Acceptance Criteria:

      • all CRDs and labels are defined in maistra/api repo
      • CRD codegen happens in maistra/api
      • all other repositories import from maistra/api
      • documentation is generated from docstrings

      Attachments

        Issue Links

          is related to

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. MAISTRA-2239 Federation CRDs for easier configuration

          • Blocker - To be worked above all other priorities. This term is chosen when the severity of the issue is very high, has no workaround, or the effort for the change is comparatively low. Issues that may be very publicly visible and could generate significant media attention may also drive a higher priority.
          • Closed

          Task - Represents a small unit of work that is not end-user facing. MAISTRA-2331 Port maistra/istio-operator to use maistra/api

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • New

          Task - Represents a small unit of work that is not end-user facing. MAISTRA-2330 Port maistra/istio to use maistra/api

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • Closed

          Task - Represents a small unit of work that is not end-user facing. MAISTRA-2332 api: Fix issue with SMCP CRD

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • Closed

          Task - Represents a small unit of work that is not end-user facing. MAISTRA-2346 Create automation for maistra/api

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • Closed

          Task - Represents a small unit of work that is not end-user facing. MAISTRA-2399 Move doc generation from operator to api repo

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • Closed

          Activity

            People

              dgrimm@redhat.com Daniel Grimm
              dgrimm@redhat.com Daniel Grimm
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: