Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update whats new in 3.3.0 #360

Merged
merged 6 commits into from
May 31, 2024
Merged

update whats new in 3.3.0 #360

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a833940
update whats new in 3.3.0
maskarb May 30, 2024
d5c7e8d
update docs for generating downstream code
maskarb May 30, 2024
29f3520
fix list
maskarb May 30, 2024
559be56
docs update
maskarb May 30, 2024
b672d18
update upload command
maskarb May 30, 2024
3589323
update upload command
maskarb May 30, 2024
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
12 changes: 9 additions & 3 deletions docs/csv-description.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,13 @@ The Koku Metrics Operator (`koku-metrics-operator`) collects the metrics require
* Restricted network installation: this operator can function on a restricted network. In this mode, the operator stores the packaged reports for manual retrieval.

## New in v3.3.0:
* __DEPRECATION NOTICE__: Basic authentication is deprecated and will not be supported beyond December 31, 2024. If the default token authentication method cannot be used, you must switch to [service account](https://console.redhat.com/iam/service-accounts) authentication ([more on creating a service account](https://access.redhat.com/articles/7036194)). Once you have created your service account, follow [this documentation](https://access.redhat.com/documentation/en-us/cost_management_service/1-latest/html-single/integrating_openshift_container_platform_data_into_cost_management/index#service-account-authentication_adding-an-ocp-int) on how to configure your operator to use service account authentication.
* Storage reports now contain `node`, `csi_driver`, and `csi_volume_handle` fields.
* The PVC capacity is now populated using the `kube_persistentvolume_capacity_bytes` metric instead of `kubelet_volume_stats_capacity_bytes`.
* Resource optimizations are now opt-in per namespace. All namespaces for which recommendations are wanted must be labeled with `insights_cost_management_optimizations='true'`. Namespaces can be labeled with:
```
oc label namespace NAMESPACE insights_cost_management_optimizations="true" --overwrite=true
```
* __DEPRECATION NOTICE__: Basic authentication is deprecated and will not be supported beyond December 31, 2024. If the default token authentication method cannot be used, you must switch to [service account](https://console.redhat.com/iam/service-accounts) authentication ([more on creating a service account](https://access.redhat.com/articles/7036194)). Once you have created your service account, follow [this documentation](https://access.redhat.com/documentation/en-us/cost_management_service/1-latest/html-single/integrating_openshift_container_platform_data_into_cost_management/index#service-account-authentication_adding-an-ocp-int) on how to configure your operator to use service account authentication. Service-accounts must also be used if manually uploading payloads to console.redhat.com.

## New in v3.2.1:
* The minimum supported configuration for `upload_cycle` is now 60 (minutes).
Expand Down Expand Up @@ -266,6 +272,6 @@ Creating an integration:
## Upload the reports to cost managment
Uploading reports to cost managment is done through curl:

$ curl -vvvv -F "file=@FILE_NAME.tar.gz;type=application/vnd.redhat.hccm.tar+tgz" https://console.redhat.com/api/ingress/v1/upload -u USERNAME:PASS
$ curl -vvvv -F "file=@FILE_NAME.tar.gz;type=application/vnd.redhat.hccm.tar+tgz" https://console.redhat.com/api/ingress/v1/upload -H "Authorization: Bearer ${ACCESS_TOKEN}"

where `USERNAME` and `PASS` correspond to the user credentials for [console.redhat.com](https://console.redhat.com), and `FILE_NAME` is the name of the report to upload.
where `FILE_NAME` is the name of the report to upload. The `ACCESS_TOKEN` is acquired using a [service-account](https://access.redhat.com/articles/7036194).
15 changes: 4 additions & 11 deletions docs/generate-downstream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
**Prerequisite:**
**Prerequisite:**
* rename ([install with Homebrew on OSX](https://formulae.brew.sh/formula/rename#default))

**Steps:**
Expand All @@ -7,12 +7,10 @@
```
git fetch origin
git switch --no-track -c downstream-vX.Y.Z origin/main
git push downstream-vX.Y.Z
git push
```

2. Branch `downstream-vX.Y.Z` so we can make the updates for the downstream code:

When generating the downstream code, we must vendor the packages. This directory is very large and makes reviewing the PR in Github difficult. To make the review process easier, we should separate the code changes and the package vendoring into separate commits:
2. Branch `downstream-vX.Y.Z` so we can make the updates for the downstream code. The only difference between upstream and downstream is the name of the API. We rename `koku` to `costmanagement` in the downstream code.

a. Checkout a branch that will be merged into the `downstream-vX.Y.Z` branch:
```
Expand All @@ -24,12 +22,7 @@
$ make downstream
```

c. Vendor the packages:
```
$ make downstream-vendor
```

d. Add/commit/push:
c. Add/commit/push:
```
$ git add/commit/push
```
Expand Down