Skip to content

Commit

Permalink
update docs and fix make downstream (#364)
Browse files Browse the repository at this point in the history
  • Loading branch information
maskarb authored May 31, 2024
1 parent 2af5a29 commit 8c10aa0
Show file tree
Hide file tree
Showing 7 changed files with 1,726 additions and 2 deletions.
1 change: 1 addition & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -352,6 +352,7 @@ downstream: operator-sdk ## Generate the code changes necessary for the downstre

$(MAKE) manifests

mkdir -p costmanagement-metrics-operator/$(VERSION)/
rm -rf ./bundle costmanagement-metrics-operator/$(VERSION)/

$(OPERATOR_SDK) generate kustomize manifests
Expand Down
34 changes: 34 additions & 0 deletions costmanagement-metrics-operator/3.3.0/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
FROM scratch

# Core bundle labels.
LABEL operators.operatorframework.io.bundle.mediatype.v1=registry+v1
LABEL operators.operatorframework.io.bundle.manifests.v1=manifests/
LABEL operators.operatorframework.io.bundle.metadata.v1=metadata/
LABEL operators.operatorframework.io.bundle.package.v1=costmanagement-metrics-operator
LABEL operators.operatorframework.io.bundle.channels.v1=stable
LABEL operators.operatorframework.io.bundle.channel.default.v1=stable
LABEL operators.operatorframework.io.metrics.builder=operator-sdk-v1.33.0
LABEL operators.operatorframework.io.metrics.mediatype.v1=metrics+v1
LABEL operators.operatorframework.io.metrics.project_layout=go.kubebuilder.io/v4

# Copy files to locations specified by labels.
COPY manifests /manifests/
COPY metadata /metadata/

# Openshift specific labels
LABEL io.k8s.display-name='Cost Management Metrics Operator'
LABEL io.k8s.description='Component required to gather metrics from Prometheus, package and upload them to the cost management service in the cloud. The operator can work in clusters connected to the Internet and air-gapped (with additional configuration and steps)'
LABEL io.openshift.build.commit.id=REPLACE_REF
LABEL io.openshift.build.commit.url=https://github.com/project-koku/koku-metrics-operator/commit/REPLACE_REF
LABEL io.openshift.build.source-location=https://github.com/project-koku/koku-metrics-operator
LABEL io.openshift.maintainer.component='Cost Management Metrics Operator'
LABEL io.openshift.maintainer.product='OpenShift Container Platform'
LABEL io.openshift.tags=openshift
LABEL com.redhat.component=costmanagement-metrics-operator-bundle-container
LABEL com.redhat.delivery.appregistry=false
LABEL com.redhat.delivery.operator.bundle=true
LABEL com.redhat.openshift.versions='v4.12'
LABEL name=openshift/costmanagement-metrics-operator-bundle
LABEL maintainer='<costmanagement@redhat.com>'
LABEL summary='Operator required to upload metrics data to the cost management service in console.redhat.com.'
LABEL version=3.3.0

Large diffs are not rendered by default.

Large diffs are not rendered by default.

13 changes: 13 additions & 0 deletions costmanagement-metrics-operator/3.3.0/metadata/annotations.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
annotations:
# Core bundle annotations.
operators.operatorframework.io.bundle.mediatype.v1: registry+v1
operators.operatorframework.io.bundle.manifests.v1: manifests/
operators.operatorframework.io.bundle.metadata.v1: metadata/
operators.operatorframework.io.bundle.package.v1: costmanagement-metrics-operator
operators.operatorframework.io.bundle.channels.v1: stable
operators.operatorframework.io.bundle.channel.default.v1: stable
operators.operatorframework.io.metrics.builder: operator-sdk-v1.33.0
operators.operatorframework.io.metrics.mediatype.v1: metrics+v1
operators.operatorframework.io.metrics.project_layout: go.kubebuilder.io/v4
# OpenShift specific annotations.
com.redhat.openshift.versions: "4.12"
2 changes: 1 addition & 1 deletion docs/csv-description.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The CostManagement Metrics Operator (`costmanagement-metrics-operator`) collects
## New in v3.3.0:
* 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:
* To receive resource optimization recommendations for your namespaces, you must now first enable each namespace. To enable a namespace, label it with `insights_cost_management_optimizations='true'`. In the CLI, run:
```
oc label namespace NAMESPACE insights_cost_management_optimizations="true" --overwrite=true
```
Expand Down
2 changes: 1 addition & 1 deletion docs/generate-downstream.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
git push
```
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.
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 `costmanagement` to `costmanagement` in the downstream code.
a. Checkout a branch that will be merged into the `downstream-vX.Y.Z` branch:
```
Expand Down

0 comments on commit 8c10aa0

Please sign in to comment.