How To's

How to cut releases for Opni

For reference, here is a list of the AI Services and their corresponding repositories

UI

• Opni-ui : https://github.com/rancher/opni-ui

AI Services:

• Opni ingest plugin: https://github.com/tybalex/opni-ingest-plugin
• Opni preprocessing service: https://github.com/rancher/opni-preprocessing-service
• Opni DRAIN service: https://github.com/rancher/opni-drain-service
• Opni training controller service: https://github.com/rancher/opni-training-controller
• Opni inferencing service: https://github.com/rancher/opni-inference-service

Filenames in Opni repository that need to be updated:

• Tiltfile
• ci.cue
• packages/opni-agent/opni-agent/charts/Chart.yaml
• packages/opni-agent/opni-agent/package.yaml
• packages/opni/opni/charts/Chart.yaml
• packages/opni/opni/package.yaml
• pkg/resources/opniopensearch/resources.go
• plugins/aiops/pkg/gateway/admin_test.go
• plugins/logging/pkg/gateway/admin.go
• plugins/logging/pkg/gateway/admin_v2.go
• plugins/logging/pkg/gateway/admin_v2_test.go
• plugins/logging/pkg/gateway/plugin_test.go

Steps to cutting a release

1. First cut releases for all of the AI services. You can do this by going to the releases section of the repository and then click on "Draft a new release".

2. Type in the name of the release to add it as a tag and set the branch to the main branch. For the AI services, the naming convention used is v so example for 0.2.0, the release tag and name is v0.2.0

3. If you are cutting an RC, then select the button "Select as a pre-release". Otherwise, select the button "Set as the latest release"

4. Then hit the button Publish release. Repeat this step for all of the AI services.

5. Once the AI releases have been published, go the Opni-ui repository and cut a release there. For the most part, you should be following the same steps used to cut the AI releases but there is one difference. The branch for the opni-ui release is the plugin branch and the release name will be plugin- so for 0.2.0, the release tag and name is plugin-0.2.0.

6. Once the UI repository has been released, go into the Opni repository and update the strings in these files to be set to the latest release. Submit a PR to merge these changes into the main Opni repository.

7. Cut a release for Opni by following the same steps (1-4) for the AI services. Use the main branch as well.