Chapter 1. Creating an OpenShift Container Platform integration

Procedure

1. Click the Installed Operators tab.
2. In the list of installed operators, click Cost Management Metrics Operator.A metrics operator window opens.
3. Click the CostManagementMetricsConfig tab to show a list of the configuration file names.
4. In the file name list, click the configuration file that you want to verify. In the default installation, the file name is costmanagementmetricscfg-sample. A Details window opens.

5. Click YAML and check the following items:

   • prometheus_configured and prometheus_connected should be set to true:

       prometheus:
         last_query_start_time: '2021-01-25T20:59:06Z'
         last_query_success_time: '2021-01-25T20:59:06Z'
         prometheus_configured: true
         prometheus_connected: true
         service_address: 'https://thanos-querier.openshift-monitoring.svc:9091'
         skip_tls_verification: false

     Copy to Clipboard Toggle word wrap

   • ingress_path, last_successful_upload_time, last_upload_status, and last_upload_time should all have content:

      upload:
         ingress_path: /api/ingress/v1/upload
         last_successful_upload_time: '2021-01-25T20:59:35Z'
         last_upload_status: 202 Accepted
         last_upload_time: '2021-01-25T20:59:35Z'
         upload: true
         upload_cycle: 360
         upload_wait: 28
         validate_cert: true

     Copy to Clipboard Toggle word wrap

Procedure

1. From Red Hat Hybrid Cloud Console, click Settings.
2. Click Identity & Access Management.
3. Click the tab Service Accounts.
4. Click Create service account.

5. Enter a name and description.

   • The name must start with a letter and end with either a letter or a number. Use only alphanumeric characters and hyphens.
6. Click Create.

7. Copy the Client ID and Client Secret and store them in a safe location.

   • The secret will not be showed again after you close the window.
8. Select the checkbox I have copied the client ID and secret and then click Close.

Procedure

1. In the OpenShift Container Platform web console, click the tab Workloads and then click Secrets.
2. In the Secrets window, click the Create drop-down and then select Key/value secret.

3. You will make two keys: one for your Client ID and one for your Client Secret. Enter the following information in the Create key/value secret window:

   1. Secret Name:

      service-account-auth-secret

      Copy to Clipboard Toggle word wrap

   2. In Key, enter client_id.

      client_id

      Copy to Clipboard Toggle word wrap

   3. In the Value field for the first key client_id`, you can upload the Value for your authorized Red Hat Hybrid Cloud Console user account, or paste it into the text box. You should have saved these credentials when you made your service account.

      red_hat_service_account_client_id

      Copy to Clipboard Toggle word wrap
   4. Next, click Add Key/Value to add the second key/value pair, this time for your Client Secret.

   5. In Key, enter client_secret:

      client_secret

      Copy to Clipboard Toggle word wrap

   6. In the Value field for the second key client_secret, you can upload the Value for your authorized Red Hat Hybrid Cloud Console user account, or paste it into the text box.

      red_hat_service_account_client_secret

      Copy to Clipboard Toggle word wrap
   7. After you verify that the key/value details for the secret are correct, click Create to complete the creation of your service account authorization secret.
4. Copy the name of your secret. You will use it in the following section.

Procedure

1. Click the tab Operators and then click Installed Operators.
2. Find the Cost Management Metrics Operator and click its name.

3. Click the tab Cost Management Metrics Config and then click the configuration file in Name.

   The default name is costmanagementmetricscfg-sample.

1. Click the tab YAML to open the file.

2. Locate the following lines in the YAML file:

    authentication:
      type: token

   Copy to Clipboard Toggle word wrap
3. Change type: token to type: service-account.

4. Insert a new line for secret_name. Enter the secret that you copied in the previous section.

   Example

    authentication:
      secret_name: service-account-auth-secret #Change this line to match your secret name.
      type: service-account

   Copy to Clipboard Toggle word wrap

5. Click Save.

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 click Operators OperatorHub.
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

   Copy to Clipboard Toggle word wrap

       upload:
         upload_cycle: 360

   Copy to Clipboard Toggle word wrap
   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

   Copy to Clipboard Toggle word wrap

7. Set source to empty braces:

       source: {}

   Copy to Clipboard Toggle word wrap

8. Set authentication to empty braces:

       authentication: {}

   Copy to Clipboard Toggle word wrap
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

   Copy to Clipboard Toggle word wrap
   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

   Copy to Clipboard Toggle word wrap

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

   Copy to Clipboard Toggle word wrap
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/*

   Copy to Clipboard Toggle word wrap

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

   $ oc delete -f volume-shell.yaml

   Copy to Clipboard Toggle word wrap

Verification steps

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