sigs.k8s.io/kueue@v0.6.2/cmd/experimental/README.md (about)

     1  ## Experimental integrations
     2  
     3  In this folder, you will find integrations of resources with Kueue that are not part of the
     4  kueue binary.
     5  
     6  The Kueue project is not committed to maintaining these integrations long term. They can be used
     7  as samples you can adapt to support arbitrary resources in Kueue.
     8  
     9  Based on user feedback, we might choose to move some of these integrations into the main binary,
    10  where they will be maintained long term.
    11  
    12  ### Existing integrations
    13  
    14  - TBD
    15  
    16  ### Adding new integrations
    17  
    18  If you would like to contribute with an integration, please start by opening an issue in
    19  https://github.com/kubernetes-sigs/kueue/issues
    20  
    21  Keep in mind the following rules for each integration:
    22  - It should have it's own `go.mod` and (optionally) `Makefile`.
    23  - The releases of Kueue won't include binaries and/or images for the experimental integrations.
    24    Users need to build the images from source. Kueue's CI will verify that the images can be build.
    25  - It can use packages in `sigs.k8s.io/kueue`, but it needs to point to a specific version, even if
    26    it's not released. If you need any changes on these packages to support the experimental
    27    integration, they should be submitted in a separate PR.
    28  - The folder should contain an [OWNERS file](https://go.k8s.io/owners).
    29  - If an integration breaks, and the OWNERS are unresponsive, the [Kueue maintainers](/OWNERS) will
    30    mark the integration as stale for at most 2 releases. After that, Kueue maintainers will remove
    31    the folder.
    32  - Based on user feedback, the [Kueue maintainers](/OWNERS), at their discretion, might choose to
    33    move the [integration to pkg/controller/jobs](https://kueue.sigs.k8s.io/docs/tasks/integrate_a_custom_job/).