Chapter 2. Integrate and use cost management with OpenShift Container Platform on a restricted network

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 and configure the following settings:

   1. Enter a value in max_reports_to_store to set the maximum number of reports that you want to store.

   2. 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.

4. Configure restricted network settings by setting the following values:

   1. Set upload_toggle to false:

          upload:
            upload_cycle: 360
            upload_toggle: false

   2. Set source to empty braces:

          source: {}

   3. Set authentication to empty braces:

          authentication: {}

5. 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. 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/*

4. Optional: Run the following command to delete the pod that you used to connect to the PVC:

   $ oc delete -f volume-shell.yaml

Verification

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