Chapter 1. Creating an OpenShift Container Platform integration

1. In the OpenShift Container Platform web console, click on the Workloads > Secrets tab.
2. In the Secrets window, select Project:costmanagement-metrics-operator from the dropdown.
3. Click the Create > Key/Value Secret selection.

4. In the Create Key/Value Secret window enter the following information to create a new secret that contains a username key and a password key and a value for each key.

   1. Enter a name for your secret in the Secret Name field.

      basic-auth-secret

   2. In the Key field, enter username.

      username

   3. In the Value field for the key username, enter the actual username for your authorized Red Hat Hybrid Cloud Console user account.

      Value for username key

      your_red_hat_username

   4. Click the Add Key/Value link to add the required password key name and value.

   5. In the Key field, enter password.

      password

   6. In the Value field for the key password, enter the actual password for your authorized Red Hat Hybrid Cloud Console user account.

      Value for password key

      your_red_hat_password

   7. Click the Create button to complete the creation of your basic authorization secret.
   8. After you click the Create button, you can verify the key/value details for the secret.

Procedure

1. Click on the Operators > Installed Operators tab.
2. Locate the row that contains Cost Management Metrics Operator and click on the Cost Management Metrics Operator link that is under the Provided APIs heading.

3. When the CostManagementMetricsConfig window appears, click on the configuration file listed in the Name column.

   The default name is costmanagementmetricscfg-sample.

4. When the costmanagementmetricscfg-sample window appears, click in the YAML tab to open an edit and view window.

5. Locate the following lines in the YAML view.

     authentication:
       type: token

6. Change type: token to type: basic.

7. Insert a new line for secret_name. Enter the value for secret_name, which is the name you previously created.

   Example

     authentication:
       secret_name: basic-auth-secret
       type: basic

8. Click the Save button. A confirmation message appears.

1. In the OpenShift Container Platform web console, click Workloads > Secrets.
2. In the Secrets window, select Project:costmanagement-metrics-operator from the drop-down.
3. Click Create > Key/Value Secret.

4. To create a new secret with a client_id key and a client_secret key, enter the following information in the Create Key/Value Secret window:

   1. In Secret Name, enter a name for your secret:

      service-account-auth-secret

   2. In Key, enter client_id.

      client_id

   3. In the Value field for the key client_id, enter the Client ID for your authorized Red Hat Hybrid Cloud Console user account:

      red_hat_service_account_client_id

   4. Click Add Key/Value to add the client_secret for the key name and value.

   5. In Key, enter client_secret:

      client_secret

   6. In the Value field for the key client_secret, enter the Client secret for your authorized Red Hat Hybrid Cloud Console user account:

      red_hat_service_account_client_secret

   7. Click Create to complete the creation of your service account authorization secret.
   8. Verify that the key/value details for the secret are correct.

Procedure

1. Click Operators > Installed Operators.
2. Locate the row that contains Cost Management Metrics Operator and click the Cost Management Metrics Operator link that is under the Provided APIs heading.

3. When the CostManagementMetricsConfig window appears, click the configuration file in Name.

   The default name is costmanagementmetricscfg-sample.

4. When the costmanagementmetricscfg-sample window appears, click the YAML tab to edit and view the content.

5. Locate the following lines in the YAML window that you opened in the previous step:

    authentication:
      type: token

6. Change type: token to type: service-account.

7. Insert a new line for secret_name. Enter the value for secret_name, which is the name you previously created.

   Example

    authentication:
      secret_name: service-account-auth-secret
      type: service-account

8. Click Save. A confirmation message appears.

Procedure

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

   Note

   The costmanagement-metrics-operator is in the redhat-operators catalog in the registry.redhat.io/redhat/redhat-operator-index:v4.11 index.

   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 click Operators > OperatorHub.
3. Click Cost Management Metrics Operator.
4. The Install Operator window should open. 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 steps

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

Verification steps

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