Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions docs/dev/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

This document describes steps required to update the Sumo Logic Kubernetes Collection Helm Operator.

## Prerequisites

Access to redhat connect is required before proceeding with component images update step
- Join Redhat support slack channel #op-assist-sumologic. Post in #pd-priv-opensource-collection channel, someone from the team will add you.
- If you don't have access to https://connect.redhat.com, Raise a helpdesk ticket to get you added under Sumologic Org's account and also to assocaite your Github account to redhat.

## Components images update (New method)

We need to certify new component images for updated components(ex. otel collector image) on openshift platform
Expand Down Expand Up @@ -191,7 +197,8 @@ mv generated_bundle.yaml bundle.yaml

- Prepare release pull request with changes necessary to create new version of Helm operator
(update version, names, description, creation date),
see [example pull request](https://github.com/SumoLogic/sumologic-kubernetes-collection-helm-operator/pull/35).
see [example pull request for rc release](https://github.com/SumoLogic/sumologic-kubernetes-collection-helm-operator/pull/35),
[example for final release version](https://github.com/SumoLogic/sumologic-kubernetes-collection-helm-operator/pull/176/files).

- Create the release tag for commit with Helm Chart version change, e.g.

Expand All @@ -217,8 +224,6 @@ mv generated_bundle.yaml bundle.yaml
- Compare changes since the last release.
- Prepare release notes.

1. Test new Helm Operator version, please use [this](https://github.com/SumoLogic/sumologic-kubernetes-collection-helm-operator/blob/main/docs/dev/test.md) instruction (please omit first step and use images created for the new Helm Operator version).

1. Submit Helm Operator image for certification in [http://connect.redhat.com/](http://connect.redhat.com/). Please use the instructions here [https://connect.redhat.com/component/view/608aaab7ebd9cca472b09434/images/setup-preflight] to certify the image. Please note, you will need a Redhat (>8.0) or Fedora (>34.0) machine to undergo the steps.
- Example commands upload the operator to redhat container registry(quay.io) and certify them using preflight. Below are just handy commands, refer [redhat certification manual](https://connect.redhat.com/component/view/608aaab7ebd9cca472b09434/images/setup-preflight) to get complete details and then use below commands for reference.

Expand All @@ -237,7 +242,11 @@ mv generated_bundle.yaml bundle.yaml
```


1. Update Helm Operator image in ClusterServiceVersion, please see example [pull request](https://github.com/SumoLogic/sumologic-kubernetes-collection-helm-operator/pull/129).
1. Update Helm Operator image in ClusterServiceVersion, please see example [pull request](https://github.com/SumoLogic/sumologic-kubernetes-collection-helm-operator/pull/129). Once above steps are done for release candidate version, You will be able to see the rc build in openshift components repo. Create PR for updating the release candidate image in ClusterServiceVersion. Once PR is merged, retag release candidate starting from step 1. Why we are doing this is because, only when updating the release candidate's certified component's image, we will be able to be do local testing.

1. Test new Helm Operator RC version, please use [this](https://github.com/SumoLogic/sumologic-kubernetes-collection-helm-operator/blob/main/docs/dev/test.md) instruction (please omit first step and use images created for the new Helm Operator version).

1. Once rc testing is completed, go back to step 1 and tag the actual release tag and certify it. Once it's certified proceed with further release steps below.

1. Prepare pull request to [certified-operators](https://github.com/redhat-openshift-ecosystem/certified-operators), please see [example pull request](https://github.com/redhat-openshift-ecosystem/certified-operators/pull/2754).

Expand Down