Integrating OpenShift Container Platform data into cost management

Procedure

1. Log in to the OpenShift Container Platform web console and navigate the Software Catalog page.

   Note

   If you are using OpenShift Container Platform 4.18 or earlier, navigate to the Operator Hub page.

2. Enter Cost Management in the seach box and then select Cost Managment Metrics Operator. The Cost Management Metrics Operator install page opens.
3. Click Install. The Install Operator page opens.
4. Click Install at the bottom of the Install Operator page.
5. Click Installed Operators in the left-hand navigation. A page with a list of installed operators opens.
6. Click Cost Management Metrics Operator.
7. Click Create CostManagementMetricsConfig. The configuration YAML file opens.
8. Scroll to the bottom of the YAML file and change create_source: false to create_source: true. When create_source is set to true, an OpenShift integration is created. Note that if you previously created an OpenShift integration in the Red Hat Hybrid Cloud Console, you should leave the value of create_source as false.

9. Change name:'' to the name of your integration, for example:

   name: my-openshift-cost-source

   If you do not provide a name, the operator name defaults to the cluster ID.

10. Click Create.

Procedure

1. To verify the package manifests have the supported install modes and available channels, enter the following command:

   oc describe packagemanifests costmanagement-metrics-operator -n openshift-marketplace

2. Create an OperatorGroup object and a subscription object.

   • To create a subscription object, see the OpenShift documentation Installing from OperatorHub using the CLI.

3. If you are not using token authentication, configure your Operator to use service account authorization. To use this method, add your service account to a User Access Group that has a Cloud Administrator role. Ensure the service account inherits the permissions of the user group. For more information, see Limiting access to cost managment resources.

   1. Retrieve your client_id and client_secret from the Red Hat Hybrid Cloud Console service account.

   2. Encode the value of your service account’s client_id in base64. In your terminal, enter:

      echo -n "<red_hat_service_account_client_id>" | base64

   3. Encode the value of your service account’s client_secret in base64. In your terminal, enter:

      echo -n "<red_hat_service_account_client_secret>" | base64

4. Create a YAML file to store your secrets. Paste the client_id and client_secret in the data.client_id and data.client_secret fields.

   Example.yaml

   kind: Secret
   apiVersion: v1
   metadata:
     name: service-account-auth-secret
     namespace: costmanagement-metrics-operator
   data:
     client_id: <base64_encoded_red_hat_service_account_client_id>
     client_secret: <base64_encoded_red_hat_service_account_client_secret>

5. Deploy your secret YAML file with the following command:

   oc apply -f example.yaml

6. To use service authentication for the cost management Operator, edit the custom resource definition for the Operator. You must edit the custom resource example YAML so that authentication.type is set to service-account. You must also add a line so that authentication.secret_name is set to the name of your secret. In this earlier example, the name of the secret is service-account-auth-secret.

   Custom resource example

   kind: CostManagementMetricsConfig
   apiVersion: costmanagement-metrics-cfg.openshift.io/v1beta1
   metadata:
     name: costmanagementmetricscfg-sample-v1beta1
     namespace: costmanagement-metrics-operator
   spec:
     authentication:
       type: service-account
       secret_name: service-account-auth-secret
     packaging:
       max_reports_to_store: 30
       max_size_MB: 100
     prometheus_config:
       collect_previous_data: true
       context_timeout: 120
       disable_metrics_collection_cost_management: false
       disable_metrics_collection_resource_optimization: false
     source:
       check_cycle: 1440
       create_source: false
       name: ''
     upload:
       upload_cycle: 360
       upload_toggle: true

7. To create an integration automatically without using the wizard in Red Hat Hybrid Cloud Console, edit the custom resource example YAML so that source.create_source is set to true and source.name is set to a name. In this example, the name is set to cluster2.

   Source creation example

   kind: CostManagementMetricsConfig
   apiVersion: costmanagement-metrics-cfg.openshift.io/v1beta1
   metadata:
     name: costmanagementmetricscfg-sample-v1beta1
     namespace: costmanagement-metrics-operator
   spec:
     authentication:
       type: service-account
       secret_name: service-account-auth-secret
     packaging:
       max_reports_to_store: 30
       max_size_MB: 100
     prometheus_config:
       collect_previous_data: true
       context_timeout: 120
       disable_metrics_collection_cost_management: false
       disable_metrics_collection_resource_optimization: false
     source:
       check_cycle: 1440
       create_source: true
       name: 'cluster2'
     upload:
       upload_cycle: 360
       upload_toggle: true

Procedure

1. From Red Hat Hybrid Cloud Console, click Settings Menu > Integrations.
2. Click the Red Hat tab.
3. Click Add integration, which opens the Add a cloud integration wizard.
4. In Select your integration type, click Red Hat OpenShift Container Platform.
5. In Application, click cost management. Then click Next.
6. Enter a name in Integration name. Then click Next.
7. In a new tab, access the OpenShift Container Platform web console. Go to Home → Overview and copy your Cluster Identifier.
8. Back in cost management, enter your Cluster Identifier. Then click Next.
9. Review the details and click Add to create the integration.

Procedure

1. Complete the following OpenShift Container Platform procedure to create a local mirror of the costmanagement-metrics-operator: Using Operator Lifecycle Manager in disconnected environments.

   Note

   The costmanagement-metrics-operator is in the redhat-operators catalog in the registry.redhat.io/redhat/redhat-operator-index:OCP_VERSION where OCP_VERSION matches the cluster version.

   Prune unwanted objects from the index before you push to the mirrored registry, but do not delete the costmanagement-metrics-operator package.

2. Log in to the OpenShift Container Platform web console and navigate the Software Catalog page.

   Note

   If you are using OpenShift Container Platform 4.18 or earlier, navigate to the Operator Hub page.

3. Click Cost Management Metrics Operator.
4. The Install Operator window opens. Select the costmanagement-metrics-operator namespace that you want to install. If the namespace does not exist, it gets created.
5. Click Install.

Procedure

1. From the OpenShift Container Platform web console, select Operators > Installed Operators > costmanagement-metrics-operator > CostManagementMetricsConfig > Create Instance.

2. Set a storage amount. If you do not specify an amount, the operator creates a default persistent volume claim (PVC) called costmanagement-metrics-operator-data with 10Gi of storage.

   Note

   To configure the costmanagement-metrics-operator to use a different PVC, edit volume_claim_template in YAML view.

3. Select YAML view.
4. Enter a value in max_reports_to_store to set the maximum number of reports that you want to store.

5. Enter a value in upload_cycle to set how many minutes you want to pass between each report generation.

       packaging:
         max_reports_to_store: 30
         max_size_MB: 100

       upload:
         upload_cycle: 360

   Important

   The costmanagement-metrics-operator creates one report every 360 minutes by default. The default value of 30 reports and 360 minutes gives you 7.5 days of reports.

   After the maximum number of reports generate, any subsequent reports replace the oldest report in storage. To avoid losing reports, download them from your PVC.

6. Set upload_toggle to false:

       upload:
         upload_cycle: 360
         upload_toggle: false

7. Set source to empty braces:

       source: {}

8. Set authentication to empty braces:

       authentication: {}

9. Click Create.

Verification

1. Select the CostManagementMetricsConfig that you created.
2. Click YAML view.

3. Verify that a report was created by viewing the data in packaging:

       packaging:
         last_successful_packaging_time: `current date and time`
         max_reports_to_store: 30
         max_size_MB: 100
         number_of_reports_stored: 1
         packaged_files:
           - >-
               /tmp/costmanagement-metrics-operator-reports/upload/YYYYMMDDTHHMMSS-cost-mgmt.tar.gz

   Note

   After configuration, costmanagement-metrics-operator generates an initial report. These reports are in packaged_files.

Procedure

1. Create the following pod and set claimName to the PVC with the report data:

   kind: Pod
   apiVersion: v1
   metadata:
     name: volume-shell
     namespace: costmanagement-metrics-operator
   spec:
     volumes:
     - name: costmanagement-metrics-operator-reports
       persistentVolumeClaim:
         claimName: costmanagement-metrics-operator-data
     containers:
     - name: volume-shell
       image: busybox
       command: ['sleep', '3600']
       volumeMounts:
       - name: costmanagement-metrics-operator-reports
         mountPath: /tmp/costmanagement-metrics-operator-reports

2. Run rsync to copy all of the files from the PVC to a local folder:

   $ oc rsync volume-shell:/tmp/costmanagement-metrics-operator-reports/upload local/path/to/save/folder

3. Confirm that the files were copied.

4. Run the following command to connect to the pod and delete the contents of the upload folder:

   $ oc rsh volume-shell
   $ rm /tmp/costmanagement-metrics-operator-reports/upload/*

5. (Optional) Run the following command to delete the pod that you used to connect to the PVC:

   $ oc delete -f volume-shell.yaml

6. View your PVC usage.

   In the OpenShift tab in Red Hat Hybrid Cloud Console, your PVCs with the highest usage automatically populate under Persistent Volume Claims. To view all PVCs, click more at the end of the section.

   You can filter your PVC data by the following fields: * Persistent volume claim * Cluster * StorageClass

Verification steps

1. From cost management, click OpenShift.
2. On the OpenShift details page, confirm that you have OpenShift usage data for your cluster.